@mbc-cqrs-serverless/core/dist/commands/command-module.helper.d.ts

CQRS and event base core

import { DynamicModule, Provider, Type } from '@nestjs/common';
import { IDataSyncHandler } from '../interfaces/data-sync-handler.interface';
/**
 * Structural (build-time) options that every domain module forwards to
 * {@link CommandModule}. The table name is a deploy-time constant, so it must be
 * known synchronously at module-composition time — the `<tableName>_CommandEventHandler`
 * provider alias is created eagerly by `CommandModule.register`.
 */
export interface DomainCommandModuleOptions {
    /** Raw DynamoDB base table name (physical name = `${NODE_ENV}-${APP_NAME}-${tableName}`). */
    tableName?: string;
    dataSyncHandlers?: Type<IDataSyncHandler>[];
    /**
     * Whether this module owns the `<tableName>_CommandEventHandler` alias.
     * Defaults to `true`. Set to `false` when sharing a table already owned by
     * another module (avoids a duplicate-alias collision).
     */
    registerEventHandlerAlias?: boolean;
}
/**
 * Compose {@link CommandModule} for a domain module, applying the domain's
 * default table name when the caller omitted one.
 *
 * Used by BOTH `register()` and `registerAsync()` so the static
 * `<tableName>_CommandEventHandler` alias is always generated from a
 * build-time-known table name (dynamic provider tokens cannot be produced from
 * an async factory result).
 *
 * The `dataSyncHandlers` are NOT registered as CommandModule providers here
 * (`registerHandlerProviders: false`) — the domain module registers them as its
 * own providers so they can resolve domain-scoped tokens (e.g. PRISMA_SERVICE).
 * CommandService still resolves them globally via
 * `ModuleRef.get(HandlerClass, { strict: false })`.
 */
export declare function buildDomainCommandModule(defaultTableName: string, options: DomainCommandModuleOptions): DynamicModule;
/**
 * Build the `PRISMA_SERVICE` provider for the synchronous `register()` path.
 * Fails fast when `prismaService` is missing, because the domain services
 * inject the token unconditionally.
 */
export declare function buildPrismaProviderSync(prismaService: Type<any> | undefined, token: string | symbol): Provider;
/**
 * Build the `PRISMA_SERVICE` provider for the `registerAsync()` path.
 *
 * The async factory must return the **resolved PrismaService instance** (not the
 * class) under `prismaService` — typically by injecting it:
 *
 * ```ts
 * registerAsync({ imports: [PrismaModule], inject: [PrismaService],
 *   useFactory: (prisma) => ({ prismaService: prisma }) })
 * ```
 *
 * The instance is aliased to the token directly, so Nest's own dependency graph
 * guarantees PrismaService is constructed first (even when it is provided
 * asynchronously via `forRootAsync`). Resolving the class via `ModuleRef.get`
 * here would NOT be ordered against an async PrismaService and could inject
 * `null`.
 */
export declare function buildPrismaProviderAsync(optionsToken: string | symbol, prismaToken: string | symbol): Provider;