@haatlabs-core/nest-auth

中文文档
0.18.5发布于 2026/11/14Apache-2.0TypeScriptESM + CJS近 30 天下载 5001

NestJS sign-in by emailed code, sessions, API keys, roles and the guard every route goes through.

原始使用文档
文档目录3 节
  1. Install
  2. @haatlabs-core/nest-auth/admin
  3. @haatlabs-core/nest-auth/shopify

@haatlabs-core/nest-auth

Signing in to an app's API: emailed codes, sessions, API keys, and the guard every route goes through. Configured by the app; every name comes from the app's name.

AuthModule.forRoot({
  appName: 'shop',                 // cookies shop_session / shop_csrf, keys shop_…, Redis shop:…
  displayName: 'Shop',             // email copy
  wholeOrganizationMessage: 'Lists are in the Shop dashboard: sign in there to use them',
  stores: {
    identity: { useFactory: (db) => new IdentityRepository(db.db, tables), inject: [SYSTEM_DB] },
    apiKeys: { useFactory: (sys, app) => new ApiKeyRepository(sys.db, app.db, tables), inject: [SYSTEM_DB, APP_DB] },
  },
  apiKeyAdmission: { useFactory: (features) => apiFeatureGate(features), inject: [FeatureRepository] }, // or 'allow'
  bearer: { useFactory: (embedded) => embedded, inject: [EmbeddedAuthService] },  // Shopify session tokens
  meExtras: { useFactory: (features) => meFeatures(features), inject: [FeatureRepository] },
});
  • The guard denies by default: every route needs a principal unless @Public(), every write needs MEMBER unless @MinRole(...) says otherwise, cookie writes need the CSRF token, the role is read again on every request, and a refused bearer token never falls back to the cookie. @StandaloneOnly() refuses the embedded app; @WholeOrganization() refuses a store-only principal (Shopify staff of a store in an organization made on the dashboard), with the app's wholeOrganizationMessage or the route's own words (@WholeOrganization('...')), and ahead of @StandaloneOnly()'s refusal.
  • API keys are checked against the app's pattern (built from its escaped prefix) and, unless 'allow', against apiKeyAdmission at creation and on every use.
  • Sign-in codes work once, for ten minutes, for the email and purpose they were sent for, and are gone after five wrong guesses. With a fixed code (SIGN_IN_FIXED_CODE), a mail failure still signs in.
  • EmailSignInController (only with bearer): a store installed from Shopify gives its owner an email to sign in with, once.
  • @haatlabs-core/nest-auth/password: argon2id for administrators' passwords (argon2 is an optional peer).

Needs the app's global providers for nest-common's CONFIG, LOGGER, REDIS, RATE_LIMITER (built with keyPrefix: '<appName>:') and MAILER.

Install

pnpm add @haatlabs-core/nest-auth

It leaves these packages to your app, so the app holds one copy: @fastify/cookie, @nestjs/common, @nestjs/core, @nestjs/platform-fastify, drizzle-orm, fastify, ioredis, reflect-metadata, rxjs, zod, argon2.

@haatlabs-core/nest-auth/admin

Platform administrators' sign-in, apart from merchants': its own cookie (<appName>_admin, SameSite=Strict, sent to /api/v1/admin only, no lifetime of its own), sessions and guard. AdminAuthModule.forRoot({ appName, store }) gives POST /api/v1/admin/login, POST /api/v1/admin/logout and GET /api/v1/admin/me; the app's own administrators' routes use @Public() @UseGuards(AdminGuard) and @CurrentAdmin(). A session ends when the account's password or access changes (platform_admins.updated_at), after two idle hours, or twelve in all; signing in again elsewhere leaves it alone. runAdminUserCommand(store, argv, { hashPassword }) is the operator's admin-user command. It needs the optional peer argon2: loading /admin hashes a dummy password, so that an unknown address takes as long to refuse as a wrong password. A cookiePath of its own must cover /api/v1/admin, or forRoot refuses it.

@haatlabs-core/nest-auth/shopify

Connecting stores by Shopify's OAuth, and the embedded app's sign-in.

ShopifyAuthModule.forRoot({
  appName: 'shop',
  stores: { useFactory: (repo) => repo, inject: [SystemStoreRepository] },  // ShopifyStores
  canConnect: { useFactory: (limits) => limits, inject: [StoreLimits] },   // or 'allow'
  afterInstall: { useFactory: (hooks) => (shop, token) => hooks.subscribe(shop, token), inject: [WebhookSubscriptions] },
});
AuthModule.forRoot({ ..., bearer: { useFactory: (e) => e, inject: [EmbeddedAuthService] } });
  • GET /api/v1/auth/shopify/install and /callback: the state is tied to the browser by the <appName>_oauth cookie, the callback's signature is checked, and a dashboard connection is completed by the admin who started it, with room for the store (canConnect) at both ends. A refusal a person sees is a page (CONNECT_PROBLEM_PAGE).
  • EmbeddedAuthService verifies a session token, installs a shop opening the app for the first time, replaces a token that needs it, and gives staff of a store in a dashboard organization a store-only principal.
  • Without Shopify config, or without TOKEN_CIPHER, the routes answer 404 and session tokens 401.

版本与发布记录

@haatlabs-core/nest-auth 共发布 27 个版本,首次发布于 2026/10/23;过去 12 个月发布了 27 个版本。

版本发布日期距今
0.18.5latest2026/11/143 天前
0.18.42026/11/134 天前
0.18.32026/11/134 天前
0.18.22026/11/134 天前
0.18.12026/11/134 天前
0.18.02026/11/134 天前

关于 @haatlabs-core/nest-auth 的常见问题

@haatlabs-core/nest-auth 是什么?

NestJS sign-in by emailed code, sessions, API keys, roles and the guard every route goes through.

如何安装 @haatlabs-core/nest-auth?

在项目目录运行 npm install @haatlabs-core/nest-auth,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:zod(^4.6.5)、rxjs(^7.8.2)、fastify(^5.12.5)、ioredis(^6.0.0)、drizzle-orm(^0.45.3)、@nestjs/core(^12.1.2)、@nestjs/common(^12.1.2)、@fastify/cookie(^11.1.2)、reflect-metadata(^0.2.2)、@nestjs/platform-fastify(^12.1.2)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@haatlabs-core/nest-auth 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@haatlabs-core/nest-auth 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@haatlabs-core/nest-auth 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@haatlabs-core/nest-auth 可以商用吗?

@haatlabs-core/nest-auth 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@haatlabs-core/nest-auth 的下载量有多少?

根据 npm 官方下载统计,@haatlabs-core/nest-auth 在 2026/10/17 – 2026/11/15 这 30 天内被下载 5,001 次,日均约 167 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@haatlabs-core/nest-auth 还在维护吗?

最新版本 0.18.5 发布于 2026/11/14(3 天前);至今共发布 27 个版本,其中过去 12 个月发布了 27 个;首次发布于 2026/10/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。