@nestjs/cqrs 11.0.1 → 11.0.3

package/README.md

@@ -12,7 +12,6 @@
 <a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
 <a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
 <a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/dm/@nestjs/core.svg" alt="NPM Downloads" /></a>
-<a href="https://coveralls.io/github/nestjs/nest?branch=master"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#5" alt="Coverage" /></a>
 <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
 <a href="https://opencollective.com/nest#backer"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
 <a href="https://opencollective.com/nest#sponsor"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>

package/dist/command-bus.d.ts

@@ -7,6 +7,9 @@ import { CqrsModuleOptions, ICommand, ICommandBus, ICommandHandler, ICommandPubl
 import { AsyncContext } from './scopes/async.context';
 import { ObservableBus } from './utils/observable-bus';
 export type CommandHandlerType<T extends ICommand = ICommand> = Type<ICommandHandler<T>>;
+/**
+ * @publicApi
+ */
 export declare class CommandBus<CommandBase extends ICommand = ICommand> extends ObservableBus<CommandBase> implements ICommandBus<CommandBase> {
     private readonly moduleRef;
     private readonly options?;

package/dist/command-bus.js

@@ -24,6 +24,9 @@ const default_command_pubsub_1 = require("./helpers/default-command-pubsub");
 const index_1 = require("./index");
 const async_context_1 = require("./scopes/async.context");
 const observable_bus_1 = require("./utils/observable-bus");
+/**
+ * @publicApi
+ */
 let CommandBus = CommandBus_1 = class CommandBus extends observable_bus_1.ObservableBus {
     constructor(moduleRef, options) {
         super();

package/dist/cqrs.module.d.ts

@@ -1,20 +1,20 @@
 import { DynamicModule, OnApplicationBootstrap } from '@nestjs/common';
 import { CommandBus } from './command-bus';
 import { EventBus } from './event-bus';
-import { CqrsModuleOptions, IEvent } from './interfaces';
+import { CqrsModuleAsyncOptions, CqrsModuleOptions, IEvent } from './interfaces';
 import { QueryBus } from './query-bus';
 import { ExplorerService } from './services/explorer.service';
+/**
+ * @publicApi
+ */
 export declare class CqrsModule<EventBase extends IEvent = IEvent> implements OnApplicationBootstrap {
     private readonly explorerService;
     private readonly eventBus;
     private readonly commandBus;
     private readonly queryBus;
-    /**
-     * Registers CQRS module globally.
-     * @param options CQRS module options.
-     * @returns A dynamic module.
-     */
     static forRoot(options?: CqrsModuleOptions): DynamicModule;
+    static forRootAsync(options: CqrsModuleAsyncOptions): DynamicModule;
+    private static createAsyncProviders;
     constructor(explorerService: ExplorerService<EventBase>, eventBus: EventBus<EventBase>, commandBus: CommandBus, queryBus: QueryBus);
     onApplicationBootstrap(): void;
 }

package/dist/cqrs.module.js

@@ -20,12 +20,10 @@ const query_bus_1 = require("./query-bus");
 const explorer_service_1 = require("./services/explorer.service");
 const unhandled_exception_bus_1 = require("./unhandled-exception-bus");
 const aggregate_root_storage_1 = require("./storages/aggregate-root.storage");
+/**
+ * @publicApi
+ */
 let CqrsModule = CqrsModule_1 = class CqrsModule {
-    /**
-     * Registers CQRS module globally.
-     * @param options CQRS module options.
-     * @returns A dynamic module.
-     */
     static forRoot(options) {
         return {
             module: CqrsModule_1,
@@ -38,6 +36,57 @@ let CqrsModule = CqrsModule_1 = class CqrsModule {
             global: true,
         };
     }
+    static forRootAsync(options) {
+        return {
+            module: CqrsModule_1,
+            global: true,
+            imports: options.imports || [],
+            providers: [...this.createAsyncProviders(options)],
+            exports: [constants_1.CQRS_MODULE_OPTIONS],
+        };
+    }
+    static createAsyncProviders(options) {
+        if (options.useValue) {
+            return [
+                {
+                    provide: constants_1.CQRS_MODULE_OPTIONS,
+                    useValue: options.useValue,
+                },
+            ];
+        }
+        if (options.useFactory) {
+            return [
+                {
+                    provide: constants_1.CQRS_MODULE_OPTIONS,
+                    useFactory: options.useFactory,
+                    inject: options.inject || [],
+                },
+            ];
+        }
+        if (options.useClass) {
+            return [
+                {
+                    provide: options.useClass,
+                    useClass: options.useClass,
+                },
+                {
+                    provide: constants_1.CQRS_MODULE_OPTIONS,
+                    useFactory: async (optionsFactory) => optionsFactory.createCqrsOptions(),
+                    inject: [options.useClass],
+                },
+            ];
+        }
+        if (options.useExisting) {
+            return [
+                {
+                    provide: constants_1.CQRS_MODULE_OPTIONS,
+                    useFactory: async (optionsFactory) => optionsFactory.createCqrsOptions(),
+                    inject: [options.useExisting],
+                },
+            ];
+        }
+        throw new Error('Invalid CqrsModuleAsyncOptions configuration. Provide useValue, useFactory, useClass, or useExisting.');
+    }
     constructor(explorerService, eventBus, commandBus, queryBus) {
         this.explorerService = explorerService;
         this.eventBus = eventBus;

package/dist/decorators/command-handler.decorator.d.ts

@@ -11,5 +11,7 @@ import { ICommand } from '../index';
  * @param options injectable options passed on to the "@Injectable" decorator.
  *
  * @see https://docs.nestjs.com/recipes/cqrs#commands
+ *
+ * @publicApi
  */
 export declare const CommandHandler: (command: ICommand | (new (...args: any[]) => ICommand), options?: InjectableOptions) => ClassDecorator;

package/dist/decorators/command-handler.decorator.js

@@ -15,6 +15,8 @@ const constants_1 = require("./constants");
  * @param options injectable options passed on to the "@Injectable" decorator.
  *
  * @see https://docs.nestjs.com/recipes/cqrs#commands
+ *
+ * @publicApi
  */
 const CommandHandler = (command, options) => {
     return (target) => {

package/dist/decorators/events-handler.decorator.d.ts

@@ -11,5 +11,7 @@ import { IEvent } from '../index';
  * @param options injectable options passed on to the "@Injectable" decorator.
  *
  * @see https://docs.nestjs.com/recipes/cqrs#events
+ *
+ * @publicApi
  */
 export declare const EventsHandler: (...events: (IEvent | (new (...args: any[]) => IEvent) | InjectableOptions)[]) => ClassDecorator;

package/dist/decorators/events-handler.decorator.js

@@ -15,11 +15,13 @@ const constants_1 = require("./constants");
  * @param options injectable options passed on to the "@Injectable" decorator.
  *
  * @see https://docs.nestjs.com/recipes/cqrs#events
+ *
+ * @publicApi
  */
 const EventsHandler = (...events) => {
     return (target) => {
         const last = events[events.length - 1];
-        if (typeof last !== 'function' && 'scope' in last) {
+        if (last && typeof last !== 'function' && 'scope' in last) {
             (0, common_1.Injectable)(last)(target);
             events.pop();
         }

package/dist/decorators/publishable.decorator.d.ts

@@ -1,5 +1,7 @@
 /**
  * Merges event publisher with the decorated class.
  * Implements the `publish` and `publishAll` methods in a similar way to {@link EventPublisher#mergeClassContext}.
+ *
+ * @publicApi
  */
 export declare function Publishable(): ClassDecorator;

package/dist/decorators/publishable.decorator.js

@@ -5,6 +5,8 @@ const aggregate_root_storage_1 = require("../storages/aggregate-root.storage");
 /**
  * Merges event publisher with the decorated class.
  * Implements the `publish` and `publishAll` methods in a similar way to {@link EventPublisher#mergeClassContext}.
+ *
+ * @publicApi
  */
 function Publishable() {
     return (target) => {

package/dist/decorators/query-handler.decorator.d.ts

@@ -11,5 +11,7 @@ import { IQuery } from '../interfaces';
  * @param options injectable options passed on to the "@Injectable" decorator.
  *
  * @see https://docs.nestjs.com/recipes/cqrs#queries
+ *
+ * @publicApi
  */
 export declare const QueryHandler: (query: IQuery, options?: InjectableOptions) => ClassDecorator;

package/dist/decorators/query-handler.decorator.js

@@ -15,6 +15,8 @@ const constants_1 = require("./constants");
  * @param options injectable options passed on to the "@Injectable" decorator.
  *
  * @see https://docs.nestjs.com/recipes/cqrs#queries
+ *
+ * @publicApi
  */
 const QueryHandler = (query, options) => {
     return (target) => {

package/dist/decorators/saga.decorator.d.ts

@@ -3,5 +3,7 @@ import 'reflect-metadata';
  * Decorator that marks a class as a Nest saga. Sagas may listen and react to 1..N events.
  *
  * @see https://docs.nestjs.com/recipes/cqrs#sagas
+ *
+ * @publicApi
  */
 export declare const Saga: () => PropertyDecorator;

package/dist/decorators/saga.decorator.js

@@ -7,6 +7,8 @@ const constants_1 = require("./constants");
  * Decorator that marks a class as a Nest saga. Sagas may listen and react to 1..N events.
  *
  * @see https://docs.nestjs.com/recipes/cqrs#sagas
+ *
+ * @publicApi
  */
 const Saga = () => {
     return (target, propertyKey) => {

package/dist/event-bus.d.ts

@@ -8,6 +8,9 @@ import { AsyncContext } from './scopes';
 import { UnhandledExceptionBus } from './unhandled-exception-bus';
 import { ObservableBus } from './utils';
 export type EventHandlerType<EventBase extends IEvent = IEvent> = Type<IEventHandler<EventBase>>;
+/**
+ * @publicApi
+ */
 export declare class EventBus<EventBase extends IEvent = IEvent> extends ObservableBus<EventBase> implements IEventBus<EventBase>, OnModuleDestroy {
     private readonly commandBus;
     private readonly moduleRef;

package/dist/event-bus.js

@@ -27,6 +27,9 @@ const default_pubsub_1 = require("./helpers/default-pubsub");
 const scopes_1 = require("./scopes");
 const unhandled_exception_bus_1 = require("./unhandled-exception-bus");
 const utils_1 = require("./utils");
+/**
+ * @publicApi
+ */
 let EventBus = EventBus_1 = class EventBus extends utils_1.ObservableBus {
     constructor(commandBus, moduleRef, unhandledExceptionBus, options) {
         super();

package/dist/event-publisher.d.ts

@@ -5,19 +5,22 @@ import { AsyncContext } from './scopes';
 export interface Constructor<T> {
     new (...args: any[]): T;
 }
+/**
+ * @publicApi
+ */
 export declare class EventPublisher<EventBase extends IEvent = IEvent> {
     private readonly eventBus;
     constructor(eventBus: EventBus<EventBase>);
     /**
      * Merge the event publisher into the provided class.
-     * This is required to make `publish` and `publishAll` available on the `AgreggateRoot` class.
+     * This is required to make `publish` and `publishAll` available on the `AggregateRoot` class.
      * @param metatype The class to merge into.
      * @param asyncContext The async context (if scoped).
      */
     mergeClassContext<T extends Constructor<AggregateRoot<EventBase>>>(metatype: T, asyncContext?: AsyncContext): T;
     /**
      * Merge the event publisher into the provided object.
-     * This is required to make `publish` and `publishAll` available on the `AgreggateRoot` class instance.
+     * This is required to make `publish` and `publishAll` available on the `AggregateRoot` class instance.
      * @param object The object to merge into.
      * @param asyncContext The async context (if scoped).
      */

package/dist/event-publisher.js

@@ -12,13 +12,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventPublisher = void 0;
 const common_1 = require("@nestjs/common");
 const event_bus_1 = require("./event-bus");
+/**
+ * @publicApi
+ */
 let EventPublisher = class EventPublisher {
     constructor(eventBus) {
         this.eventBus = eventBus;
     }
     /**
      * Merge the event publisher into the provided class.
-     * This is required to make `publish` and `publishAll` available on the `AgreggateRoot` class.
+     * This is required to make `publish` and `publishAll` available on the `AggregateRoot` class.
      * @param metatype The class to merge into.
      * @param asyncContext The async context (if scoped).
      */
@@ -35,7 +38,7 @@ let EventPublisher = class EventPublisher {
     }
     /**
      * Merge the event publisher into the provided object.
-     * This is required to make `publish` and `publishAll` available on the `AgreggateRoot` class instance.
+     * This is required to make `publish` and `publishAll` available on the `AggregateRoot` class instance.
      * @param object The object to merge into.
      * @param asyncContext The async context (if scoped).
      */

package/dist/exceptions/command-not-found.exception.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @publicApi
+ */
 export declare class CommandHandlerNotFoundException extends Error {
     constructor(commandName: string);
 }

package/dist/exceptions/command-not-found.exception.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandHandlerNotFoundException = void 0;
+/**
+ * @publicApi
+ */
 class CommandHandlerNotFoundException extends Error {
     constructor(commandName) {
         super(`No handler found for the command: "${commandName}".`);

package/dist/exceptions/invalid-command-handler.exception.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @publicApi
+ */
 export declare class InvalidCommandHandlerException extends Error {
     constructor();
 }

package/dist/exceptions/invalid-command-handler.exception.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvalidCommandHandlerException = void 0;
+/**
+ * @publicApi
+ */
 class InvalidCommandHandlerException extends Error {
     constructor() {
         super(`An invalid command handler has been provided. Please ensure that the provided handler is a class annotated with @CommandHandler and contains an 'execute' method.`);

package/dist/exceptions/invalid-events-handler.exception.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @publicApi
+ */
 export declare class InvalidEventsHandlerException extends Error {
     constructor();
 }

package/dist/exceptions/invalid-events-handler.exception.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvalidEventsHandlerException = void 0;
+/**
+ * @publicApi
+ */
 class InvalidEventsHandlerException extends Error {
     constructor() {
         super(`An invalid events handler has been provided. Please ensure that the provided handler is a class annotated with @EventsHandler and contains a 'handle' method.`);

package/dist/exceptions/invalid-saga.exception.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @publicApi
+ */
 export declare class InvalidSagaException extends Error {
     constructor();
 }

package/dist/exceptions/invalid-saga.exception.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvalidSagaException = void 0;
+/**
+ * @publicApi
+ */
 class InvalidSagaException extends Error {
     constructor() {
         super(`Invalid saga. Each saga should return Observable stream.`);

package/dist/exceptions/query-not-found.exception.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @publicApi
+ */
 export declare class QueryHandlerNotFoundException extends Error {
     constructor(queryName: string);
 }

package/dist/exceptions/query-not-found.exception.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QueryHandlerNotFoundException = void 0;
+/**
+ * @publicApi
+ */
 class QueryHandlerNotFoundException extends Error {
     constructor(queryName) {
         super(`No handler found for the query: "${queryName}"`);

package/dist/exceptions/unsupported-saga-scope.exception.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @publicApi
+ */
 export declare class UnsupportedSagaScopeException extends Error {
     constructor();
 }

package/dist/exceptions/unsupported-saga-scope.exception.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnsupportedSagaScopeException = void 0;
+/**
+ * @publicApi
+ */
 class UnsupportedSagaScopeException extends Error {
     constructor() {
         super(`Request-scoped saga hosts are not supported. Instead, you should retrieve async-context-specific instances within the saga itself, using the "ModuleRef" provider.`);

package/dist/interfaces/commands/command-bus.interface.d.ts

@@ -3,6 +3,8 @@ import { AsyncContext } from '../../scopes/async.context';
 import { ICommand } from './command.interface';
 /**
  * Represents a command bus.
+ *
+ * @publicApi
  */
 export interface ICommandBus<CommandBase extends ICommand = ICommand> {
     /**

package/dist/interfaces/commands/command-handler.interface.d.ts

@@ -3,6 +3,8 @@ import { ICommand } from './command.interface';
 /**
  * Represents a command handler.
  * Command handlers are used to execute commands.
+ *
+ * @publicApi
  */
 export type ICommandHandler<TCommand extends ICommand = any, TResult = any> = TCommand extends Command<infer InferredCommandResult> ? {
     /**

package/dist/interfaces/commands/command-publisher.interface.d.ts

@@ -1,4 +1,9 @@
 import { ICommand } from './command.interface';
+/**
+ * Represents a command publisher.
+ *
+ * @publicApi
+ */
 export interface ICommandPublisher<CommandBase extends ICommand = ICommand> {
     publish<T extends CommandBase = CommandBase>(command: T): any;
 }

package/dist/interfaces/cqrs-module-options.interface.d.ts

@@ -5,6 +5,8 @@ import { IUnhandledExceptionPublisher } from './exceptions/unhandled-exception-p
 import { IQueryPublisher } from './queries/query-publisher.interface';
 /**
  * Options for the CqrsModule.
+ *
+ * @publicApi
  */
 export interface CqrsModuleOptions {
     /**
@@ -38,3 +40,26 @@ export interface CqrsModuleOptions {
      */
     rethrowUnhandled?: boolean;
 }
+import { Provider, Type } from '@nestjs/common';
+/**
+ * Options for the CqrsModuleOptionsFactory.
+ *
+ * @publicApi
+ */
+export interface CqrsModuleOptionsFactory {
+    createCqrsOptions(): Promise<CqrsModuleOptions> | CqrsModuleOptions;
+}
+/**
+ * Options for the CqrsModuleAsyncOptions.
+ *
+ * @publicApi
+ */
+export interface CqrsModuleAsyncOptions {
+    imports?: any[];
+    useExisting?: Type<CqrsModuleOptionsFactory>;
+    useClass?: Type<CqrsModuleOptionsFactory>;
+    useFactory?: (...args: any[]) => Promise<CqrsModuleOptions> | CqrsModuleOptions;
+    useValue?: CqrsModuleOptions;
+    inject?: any[];
+    extraProviders?: Provider[];
+}

package/dist/interfaces/queries/query-bus.interface.d.ts

@@ -3,6 +3,8 @@ import { AsyncContext } from '../../scopes/async.context';
 import { IQuery } from './query.interface';
 /**
  * Represents a query bus.
+ *
+ * @publicApi
  */
 export interface IQueryBus<QueryBase extends IQuery = IQuery> {
     /**

package/dist/interfaces/queries/query-handler.interface.d.ts

@@ -2,6 +2,8 @@ import { Query } from '../../classes';
 import { IQuery } from './query.interface';
 /**
  * Represents a query handler.
+ *
+ * @publicApi
  */
 export type IQueryHandler<T extends IQuery = any, TRes = any> = T extends Query<infer InferredQueryResult> ? {
     /**

package/dist/interfaces/queries/query-publisher.interface.d.ts

@@ -1,4 +1,9 @@
 import { IQuery } from './query.interface';
+/**
+ * Represents a query publisher.
+ *
+ * @publicApi
+ */
 export interface IQueryPublisher<QueryBase extends IQuery = IQuery> {
     publish<T extends QueryBase = QueryBase>(query: T): any;
 }

package/dist/query-bus.d.ts

@@ -7,6 +7,9 @@ import { CqrsModuleOptions, IQuery, IQueryBus, IQueryHandler, IQueryPublisher, I
 import { AsyncContext } from './scopes';
 import { ObservableBus } from './utils/observable-bus';
 export type QueryHandlerType<QueryBase extends IQuery = IQuery, QueryResultBase extends IQueryResult = IQueryResult> = Type<IQueryHandler<QueryBase, QueryResultBase>>;
+/**
+ * @publicApi
+ */
 export declare class QueryBus<QueryBase extends IQuery = IQuery> extends ObservableBus<QueryBase> implements IQueryBus<QueryBase> {
     private readonly moduleRef;
     private readonly options?;

package/dist/query-bus.js

@@ -24,6 +24,9 @@ const invalid_query_handler_exception_1 = require("./exceptions/invalid-query-ha
 const default_query_pubsub_1 = require("./helpers/default-query-pubsub");
 const scopes_1 = require("./scopes");
 const observable_bus_1 = require("./utils/observable-bus");
+/**
+ * @publicApi
+ */
 let QueryBus = QueryBus_1 = class QueryBus extends observable_bus_1.ObservableBus {
     constructor(moduleRef, options) {
         super();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/cqrs",
-  "version": "11.0.1",
+  "version": "11.0.3",
   "description": "A lightweight CQRS module for Nest framework (node.js)",
   "license": "MIT",
   "url": "https://github.com/nestjs/cqrs#readme",
@@ -19,29 +19,29 @@
     "test:e2e": "jest --config ./test/jest-e2e.json --runInBand"
   },
   "devDependencies": {
-    "@commitlint/cli": "19.7.1",
-    "@commitlint/config-angular": "19.7.1",
-    "@eslint/eslintrc": "3.2.0",
-    "@eslint/js": "9.19.0",
-    "@nestjs/common": "11.0.7",
-    "@nestjs/core": "11.0.7",
-    "@nestjs/testing": "11.0.7",
+    "@commitlint/cli": "19.8.0",
+    "@commitlint/config-angular": "19.8.0",
+    "@eslint/eslintrc": "3.3.1",
+    "@eslint/js": "9.23.0",
+    "@nestjs/common": "11.0.12",
+    "@nestjs/core": "11.0.12",
+    "@nestjs/testing": "11.0.12",
     "@types/jest": "29.5.14",
-    "@types/node": "22.13.0",
-    "eslint": "9.19.0",
-    "eslint-config-prettier": "10.0.1",
-    "eslint-plugin-prettier": "5.2.3",
-    "globals": "15.14.0",
+    "@types/node": "22.13.11",
+    "eslint": "9.23.0",
+    "eslint-config-prettier": "10.1.1",
+    "eslint-plugin-prettier": "5.2.4",
+    "globals": "16.0.0",
     "husky": "9.1.7",
     "jest": "29.7.0",
-    "lint-staged": "15.4.3",
-    "prettier": "3.4.2",
+    "lint-staged": "15.5.0",
+    "prettier": "3.5.3",
     "reflect-metadata": "0.2.2",
     "release-it": "18.1.2",
-    "rxjs": "7.8.1",
-    "ts-jest": "29.2.5",
-    "typescript": "5.7.3",
-    "typescript-eslint": "8.22.0"
+    "rxjs": "7.8.2",
+    "ts-jest": "29.2.6",
+    "typescript": "5.8.2",
+    "typescript-eslint": "8.27.0"
   },
   "peerDependencies": {
     "@nestjs/common": "^10.0.0 || ^11.0.0",