@starci/hfs 5.2.0 → 5.3.0

package/templates/be/auth-lite/src/modules/domain/identity/persistence/account-doors.port.ts

@@ -0,0 +1,98 @@
+// Managed by starci app sync (slot be.identity.sign-in); do not edit: run "npx starci app sync --execute".
+import type { EntityManager } from "typeorm"
+import { callDbFunction, returnedRows, rowShape } from "@modules/platform/database"
+
+/** The account an address stands for, with the stored hash the password is checked against. */
+export interface AccountByEmail {
+    /** The account id. */
+    readonly id: string
+    /** The sign-in address. */
+    readonly email: string
+    /** The stored bcrypt hash, or null for an account that signs in with Google only. */
+    readonly encrypted_password: string | null
+    /** When the mailbox was confirmed, or null. */
+    readonly email_confirmed_at: Date | null
+    /** True when the account is deleted or banned at the database's now(). */
+    readonly disabled: boolean
+}
+
+/** The standing of an account found by id. */
+export interface AccountById {
+    /** The account id. */
+    readonly id: string
+    /** The sign-in address, or null. */
+    readonly email: string | null
+    /** True when the account is deleted or banned at the database's now(). */
+    readonly disabled: boolean
+}
+
+/** An account to create: the id, the address, the profile keys as JSON text and the instant. */
+export interface NewAccount {
+    /** The account id. */
+    readonly id: string
+    /** The sign-in address, lower-cased. */
+    readonly email: string
+    /** The bcrypt hash, or null for an account that signs in with Google only. */
+    readonly hash: string | null
+    /** Whether the mailbox counts as confirmed. */
+    readonly confirmed: boolean
+    /** The profile keys as JSON text. */
+    readonly meta: string
+    /** The instant of creation. */
+    readonly now: Date
+}
+
+const isAccountByEmail: (value: unknown) => value is AccountByEmail = rowShape({
+    id: "string",
+    email: "string",
+    encrypted_password: "string?",
+    email_confirmed_at: "date?",
+    disabled: "boolean",
+})
+const isAccountById: (value: unknown) => value is AccountById = rowShape({ id: "string", email: "string?", disabled: "boolean" })
+const isLinkedAccount = rowShape({ be_auth_user_by_google: "string?" })
+const isCreatedAccount = rowShape({ be_auth_create_user: "string" })
+
+/**
+ * The account doors: the SECURITY DEFINER functions of the baseline migration through which the application role reads and writes
+ * auth.users and auth.identities. It holds no grant on schema auth, so no other path reaches an account.
+ */
+export const accountDoors = {
+    /** The account of an exact address, or undefined. */
+    async userByEmail(manager: EntityManager, email: string): Promise<AccountByEmail | undefined> {
+        const [row] = returnedRows(await callDbFunction(manager, "public.be_auth_user_by_email", [email]), isAccountByEmail)
+        return row
+    },
+    /** The standing of an account by id, or undefined. */
+    async userById(manager: EntityManager, userId: string): Promise<AccountById | undefined> {
+        const [row] = returnedRows(await callDbFunction(manager, "public.be_auth_user_by_id", [userId]), isAccountById)
+        return row
+    },
+    /** The account a Google subject is linked to, or null. */
+    async userByGoogle(manager: EntityManager, subject: string): Promise<string | null> {
+        const [row] = returnedRows(await callDbFunction(manager, "public.be_auth_user_by_google", [subject]), isLinkedAccount)
+        return row?.be_auth_user_by_google ?? null
+    },
+    /** Creates an account and answers its id. */
+    async createUser(manager: EntityManager, account: NewAccount): Promise<string | undefined> {
+        const args = [account.id, account.email, account.hash, account.confirmed, account.meta, account.now]
+        const [row] = returnedRows(await callDbFunction(manager, "public.be_auth_create_user", args), isCreatedAccount)
+        return row?.be_auth_create_user
+    },
+    /** Links a Google subject to an account, or refreshes the link. */
+    async linkGoogle(manager: EntityManager, userId: string, subject: string, data: string, now: Date): Promise<void> {
+        await callDbFunction(manager, "public.be_auth_link_google", [userId, subject, data, now])
+    },
+    /** Stamps the confirmation of a mailbox (a spent confirmation link) without recording a sign-in. */
+    async confirmUser(manager: EntityManager, userId: string, now: Date): Promise<void> {
+        await callDbFunction(manager, "public.be_auth_confirm_user", [userId, now])
+    },
+    /** Sets the password hash of an account; `confirm` also confirms the mailbox, as a spent reset link proves it. */
+    async setPassword(manager: EntityManager, userId: string, hash: string, confirm: boolean, now: Date): Promise<void> {
+        await callDbFunction(manager, "public.be_auth_set_password", [userId, hash, confirm, now])
+    },
+    /** Records a sign-in, confirms the mailbox when asked, and fills the profile keys the person has not set. */
+    async touchUser(manager: EntityManager, userId: string, now: Date, confirm: boolean, meta: string): Promise<void> {
+        await callDbFunction(manager, "public.be_auth_touch_user", [userId, now, confirm, meta])
+    },
+}

package/templates/be/auth-lite/src/modules/domain/identity/persistence/entities/identity-email-token.entity.ts

@@ -0,0 +1,34 @@
+// Managed by starci app sync (slot be.identity.sign-in); do not edit: run "npx starci app sync --execute".
+import { Column, Entity, PrimaryColumn } from "typeorm"
+
+@Entity({ schema: "public", name: "identity_email_tokens" })
+/** One single-use link token that confirms a mailbox or resets a password, mapped from public.identity_email_tokens; only its digest is kept. */
+export class IdentityEmailTokenEntity {
+    /** The token row id. */
+    @PrimaryColumn({ name: "id", type: "uuid" })
+    id!: string
+
+    /** The account the link is for. */
+    @Column({ name: "user_id", type: "uuid" })
+    userId!: string
+
+    /** What the link does: `confirm` or `reset`. */
+    @Column({ name: "purpose", type: "varchar", length: 16 })
+    purpose!: string
+
+    /** The SHA-256 digest of the token in the link; the token itself is never stored. */
+    @Column({ name: "token_hash", type: "varchar", length: 64 })
+    tokenHash!: string
+
+    /** When the link stops working. */
+    @Column({ name: "expires_at", type: "timestamptz" })
+    expiresAt!: Date
+
+    /** When the link was spent, or null while it is live. */
+    @Column({ name: "used_at", type: "timestamptz", nullable: true })
+    usedAt!: Date | null
+
+    /** When the link was issued. */
+    @Column({ name: "created_at", type: "timestamptz" })
+    createdAt!: Date
+}

package/templates/be/auth-lite/src/modules/domain/identity/persistence/entities/index.ts

@@ -1,17 +1,10 @@
 // Managed by starci app sync (slot be.identity.sign-in); do not edit: run "npx starci app sync --execute".
-import { AuthIdentityEntity } from "./auth-identity.entity"
-import { AuthUserEntity } from "./auth-user.entity"
 import { IdentityAttemptEntity } from "./identity-attempt.entity"
+import { IdentityEmailTokenEntity } from "./identity-email-token.entity"
 import { IdentityRefreshTokenEntity } from "./identity-refresh-token.entity"
 import { IdentitySessionEntity } from "./identity-session.entity"
 
-export { AuthIdentityEntity, AuthUserEntity, IdentityAttemptEntity, IdentityRefreshTokenEntity, IdentitySessionEntity }
+export { IdentityAttemptEntity, IdentityEmailTokenEntity, IdentityRefreshTokenEntity, IdentitySessionEntity }
 
 /** The entities of the identity capability, named in PRIMARY_ENTITIES of platform/database/entities.ts. */
-export const identityEntities: ReadonlyArray<new () => object> = [
-    AuthIdentityEntity,
-    AuthUserEntity,
-    IdentityAttemptEntity,
-    IdentityRefreshTokenEntity,
-    IdentitySessionEntity,
-]
+export const identityEntities: ReadonlyArray<new () => object> = [IdentityAttemptEntity, IdentityEmailTokenEntity, IdentityRefreshTokenEntity, IdentitySessionEntity]

package/templates/be/auth-lite/src/modules/domain/identity/sign-in.service.spec.ts

@@ -48,6 +48,23 @@ describe("IdentitySignInService", () => {
         expect(await subject.jwks()).toEqual({ keys: [] })
     })
 
+    it("signs the caller out of every other device, keeping the session of the token", async () => {
+        const { subject, sessions } = await build()
+        sessions.endOthers.mockResolvedValue()
+
+        await subject.endOthers({ id: "u-1", role: "authenticated", sessionId: "s-1" })
+
+        expect(sessions.endOthers).toHaveBeenCalledWith("u-1", "s-1")
+    })
+
+    it("refuses to sign out the other devices of a token that names no session", async () => {
+        const { subject, sessions } = await build()
+        sessions.endOthers.mockRejectedValue(new AuthError("IDENTITY_UNAUTHENTICATED"))
+
+        await expect(subject.endOthers({ id: "u-1", role: "authenticated" })).rejects.toMatchObject({ code: IdentityErrorCode.Unauthenticated })
+        expect(sessions.endOthers).toHaveBeenCalledWith("u-1", undefined)
+    })
+
     it("turns a refusal of the package into the error family that owns its code", async () => {
         const { subject, doors } = await build()
         doors.refresh.mockRejectedValue(new AuthError("IDENTITY_REFRESH_REUSED"))

package/templates/be/auth-lite/src/modules/domain/identity/sign-in.service.ts

@@ -1,6 +1,7 @@
 // Managed by starci app sync (slot be.identity.sign-in); do not edit: run "npx starci app sync --execute".
 import { Injectable } from "@nestjs/common"
 import { AuthError, PassportError, PassportErrorCode } from "@modules/integrations/passport"
+import type { Principal } from "@modules/platform/cqrs"
 import { IdentityError, IdentityErrorCode } from "./errors/identity.error"
 import { InjectAuthDoors, InjectAuthSessions } from "./identity.decorators"
 import type { AccessGrant, AuthDoors, AuthSessions, GoogleRedirect, HttpExchange, JwksDocument } from "@modules/integrations/passport"
@@ -71,6 +72,11 @@ export class IdentitySignInService {
         return this.refusing(() => this.doors.completeGoogle(exchange))
     }
 
+    /** Signs the person out of every other device; the session of the caller stays. */
+    endOthers(principal: Principal): Promise<void> {
+        return this.refusing(() => this.sessions.endOthers(principal.id, principal.sessionId))
+    }
+
     /** The public key document access tokens verify against. */
     jwks(): Promise<JwksDocument> {
         return this.refusing(() => this.sessions.jwks())

package/templates/be/auth-lite/src/tests/fixtures/builders/identity.builder.ts

@@ -1,44 +1,40 @@
 // Managed by starci app sync (slot be.identity.sign-in); do not edit: run "npx starci app sync --execute".
 const BEFORE = new Date("2026-02-03T04:00:00.000Z")
-const AFTER = new Date("2026-02-03T05:00:00.000Z")
 
-/** The kinds of account a sign-in spec needs. */
-export type AuthUserVariant = "live" | "banned" | "ban-ended" | "deleted" | "unconfirmed" | "addressless" | "passwordless" | "created"
+/** The kinds of account the sign-in reads by address. */
+export type AccountByEmailVariant = "live" | "disabled" | "unconfirmed" | "passwordless" | "invited"
 
-/** A row of auth.users as the sign-in reads it (the shape of AuthUserEntity). */
-export interface AuthUserRow {
+/** The kinds of account the sign-in reads by id. */
+export type AccountByIdVariant = "live" | "disabled" | "addressless"
+
+/** A row of the by-address door: `disabled` is what the database decided at its own now(). */
+export interface AccountByEmailRow {
     id: string
-    aud: string | null
-    role: string | null
-    email: string | null
-    encryptedPassword: string | null
-    emailConfirmedAt: Date | null
-    lastSignInAt: Date | null
-    bannedUntil: Date | null
-    deletedAt: Date | null
-    isAnonymous: boolean
-    createdAt: Date | null
-    updatedAt: Date | null
+    email: string
+    encrypted_password: string | null
+    email_confirmed_at: Date | null
+    disabled: boolean
 }
 
-/** Until when an account of this variant is banned, or null. */
-const bannedUntilOf = (variant: AuthUserVariant): Date | null => {
-    if (variant === "banned") return AFTER
-    return variant === "ban-ended" ? BEFORE : null
+/** A row of the by-id door. */
+export interface AccountByIdRow {
+    id: string
+    email: string | null
+    disabled: boolean
 }
 
-/** A confirmed, live password account of the given variant; \`created\` is the account the first Google sign-in makes (the first id the fake ids hand out). */
-export const authUserRow = (variant: AuthUserVariant = "live"): AuthUserRow => ({
-    id: variant === "created" ? "00000000-0000-4000-8000-000000000001" : "u-1",
-    aud: "authenticated",
-    role: "authenticated",
+/** The row the by-address door answers for a confirmed password account of the given variant. */
+export const accountByEmailRow = (variant: AccountByEmailVariant = "live"): AccountByEmailRow => ({
+    id: "u-1",
+    email: "a@example.test",
+    encrypted_password: variant === "passwordless" || variant === "invited" ? null : "hash",
+    email_confirmed_at: variant === "unconfirmed" || variant === "invited" ? null : BEFORE,
+    disabled: variant === "disabled",
+})
+
+/** The row the by-id door answers for the account of the given variant; `id` is the account the spec stands for. */
+export const accountByIdRow = (variant: AccountByIdVariant = "live", id = "u-1"): AccountByIdRow => ({
+    id,
     email: variant === "addressless" ? null : "a@example.test",
-    encryptedPassword: variant === "passwordless" || variant === "created" ? null : "hash",
-    emailConfirmedAt: variant === "unconfirmed" ? null : BEFORE,
-    lastSignInAt: null,
-    bannedUntil: bannedUntilOf(variant),
-    deletedAt: variant === "deleted" ? BEFORE : null,
-    isAnonymous: false,
-    createdAt: BEFORE,
-    updatedAt: BEFORE,
+    disabled: variant === "disabled",
 })

package/templates/be/inbox/module-definition.ts.tpl

@@ -1,12 +1,5 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineCapabilityModule } from "@starci/nest-kit"
 import type { @@Provider@@InboxOptions } from "./@@provider@@-inbox.options"
 
-const built = new ConfigurableModuleBuilder<@@Provider@@InboxOptions>()
-    .setExtras({ isGlobal: false }, (definition, extras) => ({ ...definition, global: extras.isGlobal }))
-    .build()
-type Host = ConfigurableModuleHost<@@Provider@@InboxOptions, "register", "create", { isGlobal: boolean }>
-
 /** The configurable-module class the module extends. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, OPTIONS_TYPE } = defineCapabilityModule<@@Provider@@InboxOptions>()

package/templates/be/inbox/platform/event-bus/event-bus.module-definition.ts.tpl

@@ -1,14 +1,5 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineCapabilityModule } from "@starci/nest-kit"
 import type { EventBusOptions } from "./event-bus.options"
 
-const built = new ConfigurableModuleBuilder<EventBusOptions>()
-    .setExtras({ isGlobal: false }, (definition, extras) => ({ ...definition, global: extras.isGlobal }))
-    .build()
-type Host = ConfigurableModuleHost<EventBusOptions, "register", "create", { isGlobal: boolean }>
-
 /** The configurable-module class the module extends. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } = defineCapabilityModule<EventBusOptions>()

package/templates/be/inbox/platform/inbox/inbox.module-definition.ts.tpl

@@ -1,12 +1,5 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineCapabilityModule } from "@starci/nest-kit"
 import type { InboxOptions } from "./inbox.options"
 
-const built = new ConfigurableModuleBuilder<InboxOptions>()
-    .setExtras({ isGlobal: false }, (definition, extras) => ({ ...definition, global: extras.isGlobal }))
-    .build()
-type Host = ConfigurableModuleHost<InboxOptions, "register", "create", { isGlobal: boolean }>
-
 /** The configurable-module class the module extends. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, OPTIONS_TYPE } = defineCapabilityModule<InboxOptions>()

package/templates/be/patterns/api/feature.module-definition.ts.tpl

@@ -1,12 +1,6 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineConfigurableModule } from "@starci/nest-kit"
 import type { @@Feature@@ApiOptions } from "./@@feature@@.options"
 
-const built = new ConfigurableModuleBuilder<@@Feature@@ApiOptions>().setClassMethodName("register").build()
-type Host = ConfigurableModuleHost<@@Feature@@ApiOptions, "register", "create", {}>
-
 /** The configurable-module base of the @@feature@@ module. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } =
+    defineConfigurableModule<@@Feature@@ApiOptions>()

package/templates/be/patterns/api/graphql.module-definition.ts.tpl

@@ -1,12 +1,6 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineConfigurableModule } from "@starci/nest-kit"
 import type { @@Feature@@GraphqlOptions } from "./@@feature@@-graphql.options"
 
-const built = new ConfigurableModuleBuilder<@@Feature@@GraphqlOptions>().setClassMethodName("register").build()
-type Host = ConfigurableModuleHost<@@Feature@@GraphqlOptions, "register", "create", {}>
-
 /** The configurable-module base of the @@feature@@-graphql module. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } =
+    defineConfigurableModule<@@Feature@@GraphqlOptions>()

package/templates/be/patterns/cli/group.module-definition.ts.tpl

@@ -1,12 +1,5 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineConfigurableModule } from "@starci/nest-kit"
 import type { @@Group@@Options } from "./@@group@@.options"
 
-const built = new ConfigurableModuleBuilder<@@Group@@Options>().setClassMethodName("register").build()
-type Host = ConfigurableModuleHost<@@Group@@Options, "register", "create", {}>
-
 /** The configurable-module base of the @@group@@ module. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } = defineConfigurableModule<@@Group@@Options>()

package/templates/be/patterns/event-bus/platform/event-bus.module-definition.ts.tpl

@@ -1,15 +1,8 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineCapabilityModule } from "@starci/nest-kit"
 import { EVENT_BUS_OPTIONS } from "./event-bus.decorators"
 import type { EventBusOptions } from "./event-bus.options"
 
-const built = new ConfigurableModuleBuilder<EventBusOptions>({
+/** The configurable-module base of the event bus; `isGlobal` is decided by the app root. */
+export const { ConfigurableModuleClass, OPTIONS_TYPE } = defineCapabilityModule<EventBusOptions>({
     optionsInjectionToken: EVENT_BUS_OPTIONS,
 })
-    .setExtras({ isGlobal: false }, (definition, extras) => ({ ...definition, global: extras.isGlobal }))
-    .build()
-type Host = ConfigurableModuleHost<EventBusOptions, "register", "create", { isGlobal: boolean }>
-
-/** The configurable-module base of the event bus; `isGlobal` is decided by the app root. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE

package/templates/be/patterns/idempotency/platform/inbox/inbox.module-definition.ts.tpl

@@ -1,12 +1,5 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineCapabilityModule } from "@starci/nest-kit"
 import type { InboxOptions } from "./inbox.options"
 
-const built = new ConfigurableModuleBuilder<InboxOptions>()
-    .setExtras({ isGlobal: false }, (definition, extras) => ({ ...definition, global: extras.isGlobal }))
-    .build()
-type Host = ConfigurableModuleHost<InboxOptions, "register", "create", { isGlobal: boolean }>
-
 /** The configurable-module base of the inbox capability; `isGlobal` is decided by the app root. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, OPTIONS_TYPE } = defineCapabilityModule<InboxOptions>()

package/templates/be/patterns/jobs/job.module-definition.ts.tpl

@@ -1,12 +1,5 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineConfigurableModule } from "@starci/nest-kit"
 import type { @@Job@@Options } from "./@@job@@.options"
 
-const built = new ConfigurableModuleBuilder<@@Job@@Options>().setClassMethodName("register").build()
-type Host = ConfigurableModuleHost<@@Job@@Options, "register", "create", {}>
-
 /** The configurable-module base of the @@job@@ module. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } = defineConfigurableModule<@@Job@@Options>()

package/templates/be/patterns/jobs/job.queue.module-definition.ts.tpl

@@ -1,12 +1,6 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineConfigurableModule } from "@starci/nest-kit"
 import type { @@Job@@QueueOptions } from "./@@job@@-queue.options"
 
-const built = new ConfigurableModuleBuilder<@@Job@@QueueOptions>().setClassMethodName("register").build()
-type Host = ConfigurableModuleHost<@@Job@@QueueOptions, "register", "create", {}>
-
 /** The configurable-module base of the @@job@@-queue module. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } =
+    defineConfigurableModule<@@Job@@QueueOptions>()

package/templates/be/patterns/jobs/platform/jobs.module-definition.ts.tpl

@@ -1,15 +1,8 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineCapabilityModule } from "@starci/nest-kit"
 import { JOBS_OPTIONS } from "./jobs.decorators"
 import type { JobsOptions } from "./jobs.options"
 
-const built = new ConfigurableModuleBuilder<JobsOptions>({
+/** The configurable-module base of the jobs; `isGlobal` is decided by the app root. */
+export const { ConfigurableModuleClass, OPTIONS_TYPE } = defineCapabilityModule<JobsOptions>({
     optionsInjectionToken: JOBS_OPTIONS,
 })
-    .setExtras({ isGlobal: false }, (definition, extras) => ({ ...definition, global: extras.isGlobal }))
-    .build()
-type Host = ConfigurableModuleHost<JobsOptions, "register", "create", { isGlobal: boolean }>
-
-/** The configurable-module base of the jobs; `isGlobal` is decided by the app root. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE

package/templates/be/patterns/projections/projection.module-definition.ts.tpl

@@ -1,12 +1,5 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineCapabilityModule } from "@starci/nest-kit"
 import type { @@Name@@Options } from "./@@name@@.options"
 
-const built = new ConfigurableModuleBuilder<@@Name@@Options>()
-    .setExtras({ isGlobal: false }, (definition, extras) => ({ ...definition, global: extras.isGlobal }))
-    .build()
-type Host = ConfigurableModuleHost<@@Name@@Options, "register", "create", { isGlobal: boolean }>
-
 /** The configurable-module base of the @@name@@ projection; `isGlobal` is decided by the app root. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, OPTIONS_TYPE } = defineCapabilityModule<@@Name@@Options>()

package/templates/be/patterns/queues/platform/queue.module-definition.ts.tpl

@@ -1,15 +1,8 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineCapabilityModule } from "@starci/nest-kit"
 import { QUEUE_OPTIONS } from "./queue.decorators"
 import type { QueueRegistrationOptions } from "./queue.options"
 
-const built = new ConfigurableModuleBuilder<QueueRegistrationOptions>({
+/** The configurable-module base of the queues; `isGlobal` is decided by the app root. */
+export const { ConfigurableModuleClass, OPTIONS_TYPE } = defineCapabilityModule<QueueRegistrationOptions>({
     optionsInjectionToken: QUEUE_OPTIONS,
 })
-    .setExtras({ isGlobal: false }, (definition, extras) => ({ ...definition, global: extras.isGlobal }))
-    .build()
-type Host = ConfigurableModuleHost<QueueRegistrationOptions, "register", "create", { isGlobal: boolean }>
-
-/** The configurable-module base of the queues; `isGlobal` is decided by the app root. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE

package/templates/be/patterns/queues/queue.module-definition.ts.tpl

@@ -1,12 +1,5 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineConfigurableModule } from "@starci/nest-kit"
 import type { @@Queue@@Options } from "./@@queue@@.options"
 
-const built = new ConfigurableModuleBuilder<@@Queue@@Options>().setClassMethodName("register").build()
-type Host = ConfigurableModuleHost<@@Queue@@Options, "register", "create", {}>
-
 /** The configurable-module base of the @@queue@@ module. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } = defineConfigurableModule<@@Queue@@Options>()

package/templates/be/patterns/reactors/message.module-definition.ts.tpl

@@ -1,12 +1,6 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineConfigurableModule } from "@starci/nest-kit"
 import type { @@Reactor@@MessageOptions } from "./@@reactor@@-message.options"
 
-const built = new ConfigurableModuleBuilder<@@Reactor@@MessageOptions>().setClassMethodName("register").build()
-type Host = ConfigurableModuleHost<@@Reactor@@MessageOptions, "register", "create", {}>
-
 /** The configurable-module base of the @@reactor@@-message module. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } =
+    defineConfigurableModule<@@Reactor@@MessageOptions>()

package/templates/be/patterns/reactors/reactor.module-definition.ts.tpl

@@ -1,12 +1,5 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineConfigurableModule } from "@starci/nest-kit"
 import type { @@Reactor@@Options } from "./@@reactor@@.options"
 
-const built = new ConfigurableModuleBuilder<@@Reactor@@Options>().setClassMethodName("register").build()
-type Host = ConfigurableModuleHost<@@Reactor@@Options, "register", "create", {}>
-
 /** The configurable-module base of the @@reactor@@ module. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } = defineConfigurableModule<@@Reactor@@Options>()

package/templates/be/patterns/realtime/channel.graphql.module-definition.ts.tpl

@@ -1,12 +1,6 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineConfigurableModule } from "@starci/nest-kit"
 import type { @@Channel@@GraphqlOptions } from "./@@channel@@-graphql.options"
 
-const built = new ConfigurableModuleBuilder<@@Channel@@GraphqlOptions>().setClassMethodName("register").build()
-type Host = ConfigurableModuleHost<@@Channel@@GraphqlOptions, "register", "create", {}>
-
 /** The configurable-module base of the @@channel@@-graphql module. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } =
+    defineConfigurableModule<@@Channel@@GraphqlOptions>()

package/templates/be/patterns/realtime/channel.sse.module-definition.ts.tpl

@@ -1,12 +1,6 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineConfigurableModule } from "@starci/nest-kit"
 import type { @@Channel@@SseOptions } from "./@@channel@@-sse.options"
 
-const built = new ConfigurableModuleBuilder<@@Channel@@SseOptions>().setClassMethodName("register").build()
-type Host = ConfigurableModuleHost<@@Channel@@SseOptions, "register", "create", {}>
-
 /** The configurable-module base of the @@channel@@-sse module. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } =
+    defineConfigurableModule<@@Channel@@SseOptions>()

package/templates/be/patterns/realtime/channel.websocket.module-definition.ts.tpl

@@ -1,12 +1,6 @@
-import { ConfigurableModuleBuilder, type ConfigurableModuleHost } from "@nestjs/common"
+import { defineConfigurableModule } from "@starci/nest-kit"
 import type { @@Channel@@WebsocketOptions } from "./@@channel@@-websocket.options"
 
-const built = new ConfigurableModuleBuilder<@@Channel@@WebsocketOptions>().setClassMethodName("register").build()
-type Host = ConfigurableModuleHost<@@Channel@@WebsocketOptions, "register", "create", {}>
-
 /** The configurable-module base of the @@channel@@-websocket module. */
-export const ConfigurableModuleClass: Host["ConfigurableModuleClass"] = built.ConfigurableModuleClass
-/** The injection token of the registered options. */
-export const MODULE_OPTIONS_TOKEN: Host["MODULE_OPTIONS_TOKEN"] = built.MODULE_OPTIONS_TOKEN
-/** The options of a synchronous registration, for the register signature. */
-export const OPTIONS_TYPE: Host["OPTIONS_TYPE"] = built.OPTIONS_TYPE
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } =
+    defineConfigurableModule<@@Channel@@WebsocketOptions>()