@nestjs/cqrs 7.0.0-next.3 → 8.0.1

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

@@ -3,8 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventsHandler = void 0;
 require("reflect-metadata");
 const constants_1 = require("./constants");
-exports.EventsHandler = (...events) => {
+/**
+ * Decorator that marks a class as a Nest event handler. An event handler
+ * handles events executed by your application code.
+ *
+ * The decorated class must implement the `IEventHandler` interface.
+ *
+ * @param events one or more event *types* to be handled by this handler.
+ *
+ * @see https://docs.nestjs.com/recipes/cqrs#events
+ */
+const EventsHandler = (...events) => {
     return (target) => {
         Reflect.defineMetadata(constants_1.EVENTS_HANDLER_METADATA, events, target);
     };
 };
+exports.EventsHandler = EventsHandler;

package/dist/decorators/index.js

@@ -7,8 +7,8 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
-}
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./command-handler.decorator"), exports);
 __exportStar(require("./events-handler.decorator"), exports);

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

@@ -1,3 +1,13 @@
 import 'reflect-metadata';
 import { IQuery } from '../interfaces';
+/**
+ * Decorator that marks a class as a Nest query handler. A query handler
+ * handles queries executed by your application code.
+ *
+ * The decorated class must implement the `IQueryHandler` interface.
+ *
+ * @param query query *type* to be handled by this handler.
+ *
+ * @see https://docs.nestjs.com/recipes/cqrs#queries
+ */
 export declare const QueryHandler: (query: IQuery) => ClassDecorator;

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

@@ -3,8 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.QueryHandler = void 0;
 require("reflect-metadata");
 const constants_1 = require("./constants");
-exports.QueryHandler = (query) => {
+const uuid_1 = require("uuid");
+/**
+ * Decorator that marks a class as a Nest query handler. A query handler
+ * handles queries executed by your application code.
+ *
+ * The decorated class must implement the `IQueryHandler` interface.
+ *
+ * @param query query *type* to be handled by this handler.
+ *
+ * @see https://docs.nestjs.com/recipes/cqrs#queries
+ */
+const QueryHandler = (query) => {
     return (target) => {
+        if (!Reflect.hasMetadata(constants_1.QUERY_METADATA, query)) {
+            Reflect.defineMetadata(constants_1.QUERY_METADATA, { id: (0, uuid_1.v4)() }, query);
+        }
         Reflect.defineMetadata(constants_1.QUERY_HANDLER_METADATA, query, target);
     };
 };
+exports.QueryHandler = QueryHandler;

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

@@ -1,2 +1,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
+ */
 export declare const Saga: () => PropertyDecorator;

package/dist/decorators/saga.decorator.js

@@ -3,9 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Saga = void 0;
 require("reflect-metadata");
 const constants_1 = require("./constants");
-exports.Saga = () => {
+/**
+ * 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
+ */
+const Saga = () => {
     return (target, propertyKey) => {
         const properties = Reflect.getMetadata(constants_1.SAGA_METADATA, target.constructor) || [];
         Reflect.defineMetadata(constants_1.SAGA_METADATA, [...properties, propertyKey], target.constructor);
     };
 };
+exports.Saga = Saga;

package/dist/event-bus.js

@@ -21,91 +21,88 @@ const exceptions_1 = require("./exceptions");
 const default_get_event_name_1 = require("./helpers/default-get-event-name");
 const default_pubsub_1 = require("./helpers/default-pubsub");
 const utils_1 = require("./utils");
-let EventBus = (() => {
-    let EventBus = class EventBus extends utils_1.ObservableBus {
-        constructor(commandBus, moduleRef) {
-            super();
-            this.commandBus = commandBus;
-            this.moduleRef = moduleRef;
-            this.subscriptions = [];
-            this.getEventName = default_get_event_name_1.defaultGetEventName;
-            this.useDefaultPublisher();
+let EventBus = class EventBus extends utils_1.ObservableBus {
+    constructor(commandBus, moduleRef) {
+        super();
+        this.commandBus = commandBus;
+        this.moduleRef = moduleRef;
+        this.subscriptions = [];
+        this.getEventName = default_get_event_name_1.defaultGetEventName;
+        this.useDefaultPublisher();
+    }
+    get publisher() {
+        return this._publisher;
+    }
+    set publisher(_publisher) {
+        this._publisher = _publisher;
+    }
+    onModuleDestroy() {
+        this.subscriptions.forEach((subscription) => subscription.unsubscribe());
+    }
+    publish(event) {
+        return this._publisher.publish(event);
+    }
+    publishAll(events) {
+        if (this._publisher.publishAll) {
+            return this._publisher.publishAll(events);
         }
-        get publisher() {
-            return this._publisher;
-        }
-        set publisher(_publisher) {
-            this._publisher = _publisher;
-        }
-        onModuleDestroy() {
-            this.subscriptions.forEach((subscription) => subscription.unsubscribe());
-        }
-        publish(event) {
-            return this._publisher.publish(event);
-        }
-        publishAll(events) {
-            if (this._publisher.publishAll) {
-                return this._publisher.publishAll(events);
-            }
-            return (events || []).map((event) => this._publisher.publish(event));
-        }
-        bind(handler, name) {
-            const stream$ = name ? this.ofEventName(name) : this.subject$;
-            const subscription = stream$.subscribe((event) => handler.handle(event));
-            this.subscriptions.push(subscription);
-        }
-        registerSagas(types = []) {
-            const sagas = types
-                .map((target) => {
-                const metadata = Reflect.getMetadata(constants_1.SAGA_METADATA, target) || [];
-                const instance = this.moduleRef.get(target, { strict: false });
-                if (!instance) {
-                    throw new exceptions_1.InvalidSagaException();
-                }
-                return metadata.map((key) => instance[key]);
-            })
-                .reduce((a, b) => a.concat(b), []);
-            sagas.forEach((saga) => this.registerSaga(saga));
-        }
-        register(handlers = []) {
-            handlers.forEach((handler) => this.registerHandler(handler));
-        }
-        registerHandler(handler) {
-            const instance = this.moduleRef.get(handler, { strict: false });
+        return (events || []).map((event) => this._publisher.publish(event));
+    }
+    bind(handler, name) {
+        const stream$ = name ? this.ofEventName(name) : this.subject$;
+        const subscription = stream$.subscribe((event) => handler.handle(event));
+        this.subscriptions.push(subscription);
+    }
+    registerSagas(types = []) {
+        const sagas = types
+            .map((target) => {
+            const metadata = Reflect.getMetadata(constants_1.SAGA_METADATA, target) || [];
+            const instance = this.moduleRef.get(target, { strict: false });
             if (!instance) {
-                return;
-            }
-            const eventsNames = this.reflectEventsNames(handler);
-            eventsNames.map((event) => this.bind(instance, event.name));
-        }
-        ofEventName(name) {
-            return this.subject$.pipe(operators_1.filter((event) => this.getEventName(event) === name));
-        }
-        registerSaga(saga) {
-            if (!util_1.isFunction(saga)) {
                 throw new exceptions_1.InvalidSagaException();
             }
-            const stream$ = saga(this);
-            if (!(stream$ instanceof rxjs_1.Observable)) {
-                throw new exceptions_1.InvalidSagaException();
-            }
-            const subscription = stream$
-                .pipe(operators_1.filter((e) => !!e))
-                .subscribe((command) => this.commandBus.execute(command));
-            this.subscriptions.push(subscription);
+            return metadata.map((key) => instance[key].bind(instance));
+        })
+            .reduce((a, b) => a.concat(b), []);
+        sagas.forEach((saga) => this.registerSaga(saga));
+    }
+    register(handlers = []) {
+        handlers.forEach((handler) => this.registerHandler(handler));
+    }
+    registerHandler(handler) {
+        const instance = this.moduleRef.get(handler, { strict: false });
+        if (!instance) {
+            return;
         }
-        reflectEventsNames(handler) {
-            return Reflect.getMetadata(constants_1.EVENTS_HANDLER_METADATA, handler);
+        const eventsNames = this.reflectEventsNames(handler);
+        eventsNames.map((event) => this.bind(instance, event.name));
+    }
+    ofEventName(name) {
+        return this.subject$.pipe((0, operators_1.filter)((event) => this.getEventName(event) === name));
+    }
+    registerSaga(saga) {
+        if (!(0, util_1.isFunction)(saga)) {
+            throw new exceptions_1.InvalidSagaException();
         }
-        useDefaultPublisher() {
-            this._publisher = new default_pubsub_1.DefaultPubSub(this.subject$);
+        const stream$ = saga(this);
+        if (!(stream$ instanceof rxjs_1.Observable)) {
+            throw new exceptions_1.InvalidSagaException();
         }
-    };
-    EventBus = __decorate([
-        common_1.Injectable(),
-        __metadata("design:paramtypes", [command_bus_1.CommandBus,
-            core_1.ModuleRef])
-    ], EventBus);
-    return EventBus;
-})();
+        const subscription = stream$
+            .pipe((0, operators_1.filter)((e) => !!e))
+            .subscribe((command) => this.commandBus.execute(command));
+        this.subscriptions.push(subscription);
+    }
+    reflectEventsNames(handler) {
+        return Reflect.getMetadata(constants_1.EVENTS_HANDLER_METADATA, handler);
+    }
+    useDefaultPublisher() {
+        this._publisher = new default_pubsub_1.DefaultPubSub(this.subject$);
+    }
+};
+EventBus = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [command_bus_1.CommandBus,
+        core_1.ModuleRef])
+], EventBus);
 exports.EventBus = EventBus;

package/dist/event-publisher.js

@@ -12,31 +12,34 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventPublisher = void 0;
 const common_1 = require("@nestjs/common");
 const event_bus_1 = require("./event-bus");
-let EventPublisher = (() => {
-    let EventPublisher = class EventPublisher {
-        constructor(eventBus) {
-            this.eventBus = eventBus;
-        }
-        mergeClassContext(metatype) {
-            const eventBus = this.eventBus;
-            return class extends metatype {
-                publish(event) {
-                    eventBus.publish(event);
-                }
-            };
-        }
-        mergeObjectContext(object) {
-            const eventBus = this.eventBus;
-            object.publish = (event) => {
+let EventPublisher = class EventPublisher {
+    constructor(eventBus) {
+        this.eventBus = eventBus;
+    }
+    mergeClassContext(metatype) {
+        const eventBus = this.eventBus;
+        return class extends metatype {
+            publish(event) {
                 eventBus.publish(event);
-            };
-            return object;
-        }
-    };
-    EventPublisher = __decorate([
-        common_1.Injectable(),
-        __metadata("design:paramtypes", [event_bus_1.EventBus])
-    ], EventPublisher);
-    return EventPublisher;
-})();
+            }
+            publishAll(events) {
+                eventBus.publishAll(events);
+            }
+        };
+    }
+    mergeObjectContext(object) {
+        const eventBus = this.eventBus;
+        object.publish = (event) => {
+            eventBus.publish(event);
+        };
+        object.publishAll = (events) => {
+            eventBus.publishAll(events);
+        };
+        return object;
+    }
+};
+EventPublisher = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [event_bus_1.EventBus])
+], EventPublisher);
 exports.EventPublisher = EventPublisher;

package/dist/exceptions/index.js

@@ -7,8 +7,8 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
-}
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./command-not-found.exception"), exports);
 __exportStar(require("./invalid-command-handler.exception"), exports);

package/dist/helpers/default-get-event-name.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultGetEventName = void 0;
-exports.defaultGetEventName = (event) => {
+const defaultGetEventName = (event) => {
     const { constructor } = Object.getPrototypeOf(event);
     return constructor.name;
 };
+exports.defaultGetEventName = defaultGetEventName;

package/dist/index.js

@@ -1,4 +1,10 @@
 "use strict";
+/*
+ * Nest CQRS Module
+ * Copyright(c) 2017-... Kamil Mysliwiec
+ * www.kamilmysliwiec.com
+ * MIT Licensed
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
@@ -7,8 +13,8 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
-}
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./aggregate-root"), exports);
 __exportStar(require("./command-bus"), exports);

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

@@ -1,4 +1,4 @@
 import { ICommand } from './command.interface';
 export interface ICommandBus<CommandBase extends ICommand = ICommand> {
-    execute<T extends CommandBase>(command: T): Promise<any>;
+    execute<T extends CommandBase, R = any>(command: T): Promise<R>;
 }

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

@@ -0,0 +1,3 @@
+export interface CommandMetadata {
+    id: string;
+}

package/dist/interfaces/commands/command-metadata.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/index.js

@@ -7,8 +7,8 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
-}
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./commands/command-bus.interface"), exports);
 __exportStar(require("./commands/command-handler.interface"), exports);

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

@@ -0,0 +1,3 @@
+export interface QueryMetadata {
+    id: string;
+}

package/dist/interfaces/queries/query-metadata.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/dist/operators/index.js

@@ -7,7 +7,7 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
-}
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./of-type"), exports);

package/dist/operators/of-type.d.ts

@@ -1,4 +1,12 @@
 import { Type } from '@nestjs/common';
 import { Observable } from 'rxjs';
 import { IEvent } from '../interfaces';
+/**
+ * Filter values depending on their instance type (comparison is made
+ * using native `instanceof`).
+ *
+ * @param types List of types implementing `IEvent`.
+ *
+ * @return A stream only emitting the filtered instances.
+ */
 export declare function ofType<TInput extends IEvent, TOutput extends IEvent>(...types: Type<TOutput>[]): (source: Observable<TInput>) => Observable<TOutput>;

package/dist/operators/of-type.js

@@ -2,8 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ofType = void 0;
 const operators_1 = require("rxjs/operators");
+/**
+ * Filter values depending on their instance type (comparison is made
+ * using native `instanceof`).
+ *
+ * @param types List of types implementing `IEvent`.
+ *
+ * @return A stream only emitting the filtered instances.
+ */
 function ofType(...types) {
     const isInstanceOf = (event) => !!types.find((classType) => event instanceof classType);
-    return (source) => source.pipe(operators_1.filter(isInstanceOf));
+    return (source) => source.pipe((0, operators_1.filter)(isInstanceOf));
 }
 exports.ofType = ofType;

package/dist/query-bus.d.ts

@@ -12,10 +12,10 @@ export declare class QueryBus<QueryBase extends IQuery = IQuery> extends Observa
     get publisher(): IQueryPublisher<QueryBase>;
     set publisher(_publisher: IQueryPublisher<QueryBase>);
     execute<T extends QueryBase, TResult = any>(query: T): Promise<TResult>;
-    bind<T extends QueryBase, TResult = any>(handler: IQueryHandler<T, TResult>, name: string): void;
+    bind<T extends QueryBase, TResult = any>(handler: IQueryHandler<T, TResult>, queryId: string): void;
     register(handlers?: QueryHandlerType<QueryBase>[]): void;
     protected registerHandler(handler: QueryHandlerType<QueryBase>): void;
-    private getQueryName;
-    private reflectQueryName;
+    private getQueryId;
+    private reflectQueryId;
     private useDefaultPublisher;
 }

package/dist/query-bus.js

@@ -27,64 +27,67 @@ const exceptions_1 = require("./exceptions");
 const invalid_query_handler_exception_1 = require("./exceptions/invalid-query-handler.exception");
 const default_query_pubsub_1 = require("./helpers/default-query-pubsub");
 const observable_bus_1 = require("./utils/observable-bus");
-let QueryBus = (() => {
-    let QueryBus = class QueryBus extends observable_bus_1.ObservableBus {
-        constructor(moduleRef) {
-            super();
-            this.moduleRef = moduleRef;
-            this.handlers = new Map();
-            this.useDefaultPublisher();
-        }
-        get publisher() {
-            return this._publisher;
-        }
-        set publisher(_publisher) {
-            this._publisher = _publisher;
-        }
-        execute(query) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const queryName = this.getQueryName(query);
-                const handler = this.handlers.get(queryName);
-                if (!handler) {
-                    throw new exceptions_1.QueryHandlerNotFoundException(queryName);
-                }
-                this.subject$.next(query);
-                const result = yield handler.execute(query);
-                return result;
-            });
-        }
-        bind(handler, name) {
-            this.handlers.set(name, handler);
-        }
-        register(handlers = []) {
-            handlers.forEach((handler) => this.registerHandler(handler));
-        }
-        registerHandler(handler) {
-            const instance = this.moduleRef.get(handler, { strict: false });
-            if (!instance) {
-                return;
-            }
-            const target = this.reflectQueryName(handler);
-            if (!target) {
-                throw new invalid_query_handler_exception_1.InvalidQueryHandlerException();
+let QueryBus = class QueryBus extends observable_bus_1.ObservableBus {
+    constructor(moduleRef) {
+        super();
+        this.moduleRef = moduleRef;
+        this.handlers = new Map();
+        this.useDefaultPublisher();
+    }
+    get publisher() {
+        return this._publisher;
+    }
+    set publisher(_publisher) {
+        this._publisher = _publisher;
+    }
+    execute(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryId = this.getQueryId(query);
+            const handler = this.handlers.get(queryId);
+            if (!handler) {
+                throw new exceptions_1.QueryHandlerNotFoundException(queryId);
             }
-            this.bind(instance, target.name);
+            this.subject$.next(query);
+            const result = yield handler.execute(query);
+            return result;
+        });
+    }
+    bind(handler, queryId) {
+        this.handlers.set(queryId, handler);
+    }
+    register(handlers = []) {
+        handlers.forEach((handler) => this.registerHandler(handler));
+    }
+    registerHandler(handler) {
+        const instance = this.moduleRef.get(handler, { strict: false });
+        if (!instance) {
+            return;
         }
-        getQueryName(query) {
-            const { constructor } = Object.getPrototypeOf(query);
-            return constructor.name;
+        const target = this.reflectQueryId(handler);
+        if (!target) {
+            throw new invalid_query_handler_exception_1.InvalidQueryHandlerException();
         }
-        reflectQueryName(handler) {
-            return Reflect.getMetadata(constants_1.QUERY_HANDLER_METADATA, handler);
+        this.bind(instance, target);
+    }
+    getQueryId(query) {
+        const { constructor: queryType } = Object.getPrototypeOf(query);
+        const queryMetadata = Reflect.getMetadata(constants_1.QUERY_METADATA, queryType);
+        if (!queryMetadata) {
+            throw new exceptions_1.QueryHandlerNotFoundException(queryType.name);
         }
-        useDefaultPublisher() {
-            this._publisher = new default_query_pubsub_1.DefaultQueryPubSub(this.subject$);
-        }
-    };
-    QueryBus = __decorate([
-        common_1.Injectable(),
-        __metadata("design:paramtypes", [core_1.ModuleRef])
-    ], QueryBus);
-    return QueryBus;
-})();
+        return queryMetadata.id;
+    }
+    reflectQueryId(handler) {
+        const query = Reflect.getMetadata(constants_1.QUERY_HANDLER_METADATA, handler);
+        const queryMetadata = Reflect.getMetadata(constants_1.QUERY_METADATA, query);
+        return queryMetadata.id;
+    }
+    useDefaultPublisher() {
+        this._publisher = new default_query_pubsub_1.DefaultQueryPubSub(this.subject$);
+    }
+};
+QueryBus = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [core_1.ModuleRef])
+], QueryBus);
 exports.QueryBus = QueryBus;