@mbc-cqrs-serverless/core 1.0.14 → 1.0.16

package/dist/commands/data.service.d.ts

@@ -1,6 +1,24 @@
 import { DynamoDbService } from '../data-store/dynamodb.service';
 import { CommandModel, CommandModuleOptions, DataListEntity, DataModel, DetailKey } from '../interfaces';
 declare const TABLE_NAME: unique symbol;
+/**
+ * Service for reading data from DynamoDB.
+ * Provides query operations for the read side of CQRS.
+ *
+ * @example
+ * ```typescript
+ * @Injectable()
+ * export class OrderService {
+ *   constructor(
+ *     @InjectDataService() private readonly dataService: DataService
+ *   ) {}
+ *
+ *   async getOrder(pk: string, sk: string) {
+ *     return this.dataService.getItem({ pk, sk });
+ *   }
+ * }
+ * ```
+ */
 export declare class DataService {
     private readonly options;
     private readonly dynamoDbService;
@@ -9,8 +27,32 @@ export declare class DataService {
     constructor(options: CommandModuleOptions, dynamoDbService: DynamoDbService);
     set tableName(name: string);
     get tableName(): string;
+    /**
+     * Publishes command data to the data table.
+     * Updates or creates the data record based on the command.
+     *
+     * @param cmd - The command model to publish
+     * @returns The published data model
+     */
     publish(cmd: CommandModel): Promise<DataModel>;
+    /**
+     * Retrieves a single item from the data table.
+     *
+     * @param key - The partition key and sort key
+     * @returns The data model or undefined if not found
+     */
     getItem(key: DetailKey): Promise<DataModel>;
+    /**
+     * Lists items by partition key with optional filtering and pagination.
+     *
+     * @param pk - The partition key to query
+     * @param opts - Optional query parameters
+     * @param opts.sk - Sort key filter expression
+     * @param opts.startFromSk - Start key for pagination
+     * @param opts.limit - Maximum number of items to return
+     * @param opts.order - Sort order ('asc' or 'desc')
+     * @returns List of data entities with pagination info
+     */
     listItemsByPk(pk: string, opts?: {
         sk?: {
             skExpession: string;

package/dist/commands/data.service.js

@@ -21,6 +21,24 @@ const interfaces_1 = require("../interfaces");
 const command_module_definition_1 = require("./command.module-definition");
 const enums_1 = require("./enums");
 const TABLE_NAME = Symbol('data');
+/**
+ * Service for reading data from DynamoDB.
+ * Provides query operations for the read side of CQRS.
+ *
+ * @example
+ * ```typescript
+ * @Injectable()
+ * export class OrderService {
+ *   constructor(
+ *     @InjectDataService() private readonly dataService: DataService
+ *   ) {}
+ *
+ *   async getOrder(pk: string, sk: string) {
+ *     return this.dataService.getItem({ pk, sk });
+ *   }
+ * }
+ * ```
+ */
 let DataService = DataService_1 = class DataService {
     constructor(options, dynamoDbService) {
         this.options = options;
@@ -34,6 +52,13 @@ let DataService = DataService_1 = class DataService {
     get tableName() {
         return this[TABLE_NAME];
     }
+    /**
+     * Publishes command data to the data table.
+     * Updates or creates the data record based on the command.
+     *
+     * @param cmd - The command model to publish
+     * @returns The published data model
+     */
     async publish(cmd) {
         const pk = cmd.pk;
         const sk = (0, key_1.removeSortKeyVersion)(cmd.sk);
@@ -66,9 +91,26 @@ let DataService = DataService_1 = class DataService {
         await this.dynamoDbService.putItem(this.tableName, dataModel);
         return dataModel;
     }
+    /**
+     * Retrieves a single item from the data table.
+     *
+     * @param key - The partition key and sort key
+     * @returns The data model or undefined if not found
+     */
     async getItem(key) {
         return await this.dynamoDbService.getItem(this.tableName, key);
     }
+    /**
+     * Lists items by partition key with optional filtering and pagination.
+     *
+     * @param pk - The partition key to query
+     * @param opts - Optional query parameters
+     * @param opts.sk - Sort key filter expression
+     * @param opts.startFromSk - Start key for pagination
+     * @param opts.limit - Maximum number of items to return
+     * @param opts.order - Sort order ('asc' or 'desc')
+     * @returns List of data entities with pagination info
+     */
     async listItemsByPk(pk, opts) {
         const { lastSk, items } = await this.dynamoDbService.listItemsByPk(this.tableName, pk, opts?.sk, opts?.startFromSk, opts?.limit, opts?.order);
         return new interfaces_1.DataListEntity({

package/dist/commands/data.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"data.service.js","sourceRoot":"","sources":["../../src/commands/data.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAA2D;AAE3D,qEAAgE;AAChE,wCAAqD;AACrD,8CAOsB;AACtB,2EAAkE;AAClE,mCAAmC;AAEnC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;AAG1B,IAAM,WAAW,mBAAjB,MAAM,WAAW;IAItB,YAEmB,OAA6B,EAC7B,eAAgC;QADhC,YAAO,GAAP,OAAO,CAAsB;QAC7B,oBAAe,GAAf,eAAe,CAAiB;QAEjD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAChD,IAAI,CAAC,OAAO,CAAC,SAAS,EACtB,iBAAS,CAAC,IAAI,CACf,CAAA;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,GAAG,aAAW,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;IACnE,CAAC;IAED,IAAI,SAAS,CAAC,IAAY;QACxB,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;IACzB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,CAAA;IACzB,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAiB;QAC7B,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,CAAA;QACjB,MAAM,EAAE,GAAG,IAAA,0BAAoB,EAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;QAC3C,MAAM,SAAS,GAAc;YAC3B,GAAG,IAAI;YACP,EAAE;YACF,EAAE;YACF,EAAE,EAAE,GAAG,CAAC,EAAE;YACV,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,UAAU,EAAE,GAAG,CAAC,UAAU;YAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,GAAG,EAAE,GAAG,CAAC,GAAG;YACZ,UAAU,EAAE,GAAG,CAAC,UAAU;YAC1B,GAAG,EAAE,GAAG,CAAC,EAAE;YACX,GAAG,EAAE,GAAG,CAAC,EAAE;YACX,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,GAAG,EAAE,GAAG,CAAC,GAAG;YACZ,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,SAAS,EAAE,IAAI,EAAE,SAAS,IAAI,GAAG,CAAC,SAAS;YAC3C,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,SAAS,EAAE,IAAI,EAAE,SAAS,IAAI,GAAG,CAAC,SAAS;YAC3C,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,SAAS,EAAE,IAAI,EAAE,SAAS,IAAI,GAAG,CAAC,SAAS;YAC3C,SAAS,EAAE,GAAG,CAAC,SAAS;SACzB,CAAA;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;QACzC,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;QAE7D,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAc;QAC1B,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;IAChE,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,IASC;QAED,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAChE,IAAI,CAAC,SAAS,EACd,EAAE,EACF,IAAI,EAAE,EAAE,EACR,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,KAAK,CACZ,CAAA;QAED,OAAO,IAAI,2BAAc,CAAC;YACxB,MAAM;YACN,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,uBAAU,CAAC,IAAI,CAAC,CAAC;SACjD,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AA1FY,kCAAW;sBAAX,WAAW;IADvB,IAAA,mBAAU,GAAE;IAMR,WAAA,IAAA,eAAM,EAAC,gDAAoB,CAAC,CAAA;6CAEK,kCAAe;GAPxC,WAAW,CA0FvB"}
+{"version":3,"file":"data.service.js","sourceRoot":"","sources":["../../src/commands/data.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAA2D;AAE3D,qEAAgE;AAChE,wCAAqD;AACrD,8CAOsB;AACtB,2EAAkE;AAClE,mCAAmC;AAEnC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;AAEjC;;;;;;;;;;;;;;;;;GAiBG;AAEI,IAAM,WAAW,mBAAjB,MAAM,WAAW;IAItB,YAEmB,OAA6B,EAC7B,eAAgC;QADhC,YAAO,GAAP,OAAO,CAAsB;QAC7B,oBAAe,GAAf,eAAe,CAAiB;QAEjD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAChD,IAAI,CAAC,OAAO,CAAC,SAAS,EACtB,iBAAS,CAAC,IAAI,CACf,CAAA;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,GAAG,aAAW,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;IACnE,CAAC;IAED,IAAI,SAAS,CAAC,IAAY;QACxB,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;IACzB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,CAAA;IACzB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAC,GAAiB;QAC7B,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,CAAA;QACjB,MAAM,EAAE,GAAG,IAAA,0BAAoB,EAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;QAC3C,MAAM,SAAS,GAAc;YAC3B,GAAG,IAAI;YACP,EAAE;YACF,EAAE;YACF,EAAE,EAAE,GAAG,CAAC,EAAE;YACV,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,UAAU,EAAE,GAAG,CAAC,UAAU;YAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,GAAG,EAAE,GAAG,CAAC,GAAG;YACZ,UAAU,EAAE,GAAG,CAAC,UAAU;YAC1B,GAAG,EAAE,GAAG,CAAC,EAAE;YACX,GAAG,EAAE,GAAG,CAAC,EAAE;YACX,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,GAAG,EAAE,GAAG,CAAC,GAAG;YACZ,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,SAAS,EAAE,IAAI,EAAE,SAAS,IAAI,GAAG,CAAC,SAAS;YAC3C,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,SAAS,EAAE,IAAI,EAAE,SAAS,IAAI,GAAG,CAAC,SAAS;YAC3C,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,SAAS,EAAE,IAAI,EAAE,SAAS,IAAI,GAAG,CAAC,SAAS;YAC3C,SAAS,EAAE,GAAG,CAAC,SAAS;SACzB,CAAA;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;QACzC,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;QAE7D,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,GAAc;QAC1B,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;IAChE,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,IASC;QAED,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAChE,IAAI,CAAC,SAAS,EACd,EAAE,EACF,IAAI,EAAE,EAAE,EACR,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,KAAK,CACZ,CAAA;QAED,OAAO,IAAI,2BAAc,CAAC;YACxB,MAAM;YACN,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,uBAAU,CAAC,IAAI,CAAC,CAAC;SACjD,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAlHY,kCAAW;sBAAX,WAAW;IADvB,IAAA,mBAAU,GAAE;IAMR,WAAA,IAAA,eAAM,EAAC,gDAAoB,CAAC,CAAA;6CAEK,kCAAe;GAPxC,WAAW,CAkHvB"}

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

@@ -1,7 +1,25 @@
 import { CanActivate } from '@nestjs/common';
+/**
+ * Decorator that applies authentication and role-based access control.
+ * Combines RolesGuard with Swagger documentation.
+ *
+ * @param roles - Required roles for access
+ * @example
+ * ```typescript
+ * @Controller('orders')
+ * export class OrderController {
+ *   @Post()
+ *   @Auth('admin', 'manager')
+ *   createOrder() {}
+ * }
+ * ```
+ */
 export declare function Auth(...roles: string[]): <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
 export declare function AuthGuard({ guard, roles, }: {
     guard?: CanActivate | Function;
     roles: string[];
 }): <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+/**
+ * Decorator that adds tenant code header requirement to Swagger docs.
+ */
 export declare function HeaderTenant(): MethodDecorator & ClassDecorator;

package/dist/decorators/auth.decorator.js

@@ -8,6 +8,21 @@ const swagger_1 = require("@nestjs/swagger");
 const constants_1 = require("../constants");
 const guard_1 = require("../guard");
 const roles_decorator_1 = require("./roles.decorator");
+/**
+ * Decorator that applies authentication and role-based access control.
+ * Combines RolesGuard with Swagger documentation.
+ *
+ * @param roles - Required roles for access
+ * @example
+ * ```typescript
+ * @Controller('orders')
+ * export class OrderController {
+ *   @Post()
+ *   @Auth('admin', 'manager')
+ *   createOrder() {}
+ * }
+ * ```
+ */
 function Auth(...roles) {
     return AuthGuard({ roles });
 }
@@ -16,6 +31,9 @@ function AuthGuard({ guard = guard_1.RolesGuard, roles, }) {
         description: 'Request unauthorized',
     }));
 }
+/**
+ * Decorator that adds tenant code header requirement to Swagger docs.
+ */
 function HeaderTenant() {
     return (0, swagger_1.ApiHeader)({
         name: constants_1.HEADER_TENANT_CODE,

package/dist/decorators/auth.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.decorator.js","sourceRoot":"","sources":["../../src/decorators/auth.decorator.ts"],"names":[],"mappings":";;AAWA,oBAEC;AAED,8BAgBC;AAED,oCAQC;AAzCD,2CAAwE;AACxE,6CAIwB;AAExB,4CAAiD;AACjD,oCAAqC;AACrC,uDAAyC;AAEzC,SAAgB,IAAI,CAAC,GAAG,KAAe;IACrC,OAAO,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;AAC7B,CAAC;AAED,SAAgB,SAAS,CAAC,EACxB,KAAK,GAAG,kBAAU,EAClB,KAAK,GAKN;IACC,OAAO,IAAA,wBAAe,EACpB,IAAA,uBAAK,EAAC,GAAG,KAAK,CAAC,EACf,IAAA,kBAAS,EAAC,KAAK,CAAC,EAChB,IAAA,uBAAa,GAAE,EACf,IAAA,iCAAuB,EAAC;QACtB,WAAW,EAAE,sBAAsB;KACpC,CAAC,CACH,CAAA;AACH,CAAC;AAED,SAAgB,YAAY;IAC1B,OAAO,IAAA,mBAAS,EAAC;QACf,IAAI,EAAE,8BAAkB;QACxB,WAAW,EAAE,6BAA6B;QAC1C,QAAQ,EAAE,IAAI;QACd,eAAe,EAAE,KAAK;QACtB,OAAO,EAAE,QAAQ;KAClB,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"auth.decorator.js","sourceRoot":"","sources":["../../src/decorators/auth.decorator.ts"],"names":[],"mappings":";;AA0BA,oBAEC;AAED,8BAgBC;AAKD,oCAQC;AA3DD,2CAAwE;AACxE,6CAIwB;AAExB,4CAAiD;AACjD,oCAAqC;AACrC,uDAAyC;AAEzC;;;;;;;;;;;;;;GAcG;AACH,SAAgB,IAAI,CAAC,GAAG,KAAe;IACrC,OAAO,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;AAC7B,CAAC;AAED,SAAgB,SAAS,CAAC,EACxB,KAAK,GAAG,kBAAU,EAClB,KAAK,GAKN;IACC,OAAO,IAAA,wBAAe,EACpB,IAAA,uBAAK,EAAC,GAAG,KAAK,CAAC,EACf,IAAA,kBAAS,EAAC,KAAK,CAAC,EAChB,IAAA,uBAAa,GAAE,EACf,IAAA,iCAAuB,EAAC;QACtB,WAAW,EAAE,sBAAsB;KACpC,CAAC,CACH,CAAA;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,YAAY;IAC1B,OAAO,IAAA,mBAAS,EAAC;QACf,IAAI,EAAE,8BAAkB;QACxB,WAAW,EAAE,6BAA6B;QAC1C,QAAQ,EAAE,IAAI;QACd,eAAe,EAAE,KAAK;QACtB,OAAO,EAAE,QAAQ;KAClB,CAAC,CAAA;AACJ,CAAC"}

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

@@ -1,3 +1,18 @@
 import 'reflect-metadata';
 import { IEvent } from '../interfaces/event.interface';
+/**
+ * Decorator that marks a class as an event handler.
+ * The handler will be invoked when the specified event is published.
+ *
+ * @param event - The event class or instance to handle
+ * @example
+ * ```typescript
+ * @EventHandler(OrderCreatedEvent)
+ * export class OrderCreatedHandler implements IEventHandler<OrderCreatedEvent> {
+ *   async handle(event: OrderCreatedEvent) {
+ *     // Handle the event
+ *   }
+ * }
+ * ```
+ */
 export declare const EventHandler: (event: IEvent | (new (...args: any[]) => IEvent)) => ClassDecorator;

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

@@ -4,6 +4,21 @@ exports.EventHandler = void 0;
 require("reflect-metadata");
 const ulid_1 = require("ulid");
 const constants_1 = require("./constants");
+/**
+ * Decorator that marks a class as an event handler.
+ * The handler will be invoked when the specified event is published.
+ *
+ * @param event - The event class or instance to handle
+ * @example
+ * ```typescript
+ * @EventHandler(OrderCreatedEvent)
+ * export class OrderCreatedHandler implements IEventHandler<OrderCreatedEvent> {
+ *   async handle(event: OrderCreatedEvent) {
+ *     // Handle the event
+ *   }
+ * }
+ * ```
+ */
 const EventHandler = (event) => {
     return (target) => {
         if (!Reflect.hasOwnMetadata(constants_1.EVENT_METADATA, event)) {

package/dist/decorators/event-handler.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"event-handler.decorator.js","sourceRoot":"","sources":["../../src/decorators/event-handler.decorator.ts"],"names":[],"mappings":";;;AAAA,4BAAyB;AAEzB,+BAA2B;AAG3B,2CAAoE;AAE7D,MAAM,YAAY,GAAG,CAC1B,KAAgD,EAChC,EAAE;IAClB,OAAO,CAAC,MAAc,EAAE,EAAE;QACxB,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,0BAAc,EAAE,KAAK,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,cAAc,CAAC,0BAAc,EAAE,EAAE,EAAE,EAAE,IAAA,WAAI,GAAE,EAAE,EAAE,KAAK,CAAC,CAAA;QAC/D,CAAC;QACD,OAAO,CAAC,cAAc,CAAC,kCAAsB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IAC/D,CAAC,CAAA;AACH,CAAC,CAAA;AATY,QAAA,YAAY,gBASxB"}
+{"version":3,"file":"event-handler.decorator.js","sourceRoot":"","sources":["../../src/decorators/event-handler.decorator.ts"],"names":[],"mappings":";;;AAAA,4BAAyB;AAEzB,+BAA2B;AAG3B,2CAAoE;AAEpE;;;;;;;;;;;;;;GAcG;AACI,MAAM,YAAY,GAAG,CAC1B,KAAgD,EAChC,EAAE;IAClB,OAAO,CAAC,MAAc,EAAE,EAAE;QACxB,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,0BAAc,EAAE,KAAK,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,cAAc,CAAC,0BAAc,EAAE,EAAE,EAAE,EAAE,IAAA,WAAI,GAAE,EAAE,EAAE,KAAK,CAAC,CAAA;QAC/D,CAAC;QACD,OAAO,CAAC,cAAc,CAAC,kCAAsB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IAC/D,CAAC,CAAA;AACH,CAAC,CAAA;AATY,QAAA,YAAY,gBASxB"}

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

@@ -1 +1,13 @@
+/**
+ * Decorator that sets required roles for route access.
+ * Used with RolesGuard to enforce role-based access control.
+ *
+ * @param roles - List of allowed roles
+ * @example
+ * ```typescript
+ * @Get()
+ * @Roles('admin', 'manager')
+ * findAll() {}
+ * ```
+ */
 export declare const Roles: (...roles: string[]) => import("@nestjs/common").CustomDecorator<string>;

package/dist/decorators/roles.decorator.js

@@ -3,6 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Roles = void 0;
 const common_1 = require("@nestjs/common");
 const constants_1 = require("./constants");
+/**
+ * Decorator that sets required roles for route access.
+ * Used with RolesGuard to enforce role-based access control.
+ *
+ * @param roles - List of allowed roles
+ * @example
+ * ```typescript
+ * @Get()
+ * @Roles('admin', 'manager')
+ * findAll() {}
+ * ```
+ */
 const Roles = (...roles) => (0, common_1.SetMetadata)(constants_1.ROLE_METADATA, roles);
 exports.Roles = Roles;
 //# sourceMappingURL=roles.decorator.js.map

package/dist/decorators/roles.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"roles.decorator.js","sourceRoot":"","sources":["../../src/decorators/roles.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA4C;AAE5C,2CAA2C;AAEpC,MAAM,KAAK,GAAG,CAAC,GAAG,KAAe,EAAE,EAAE,CAAC,IAAA,oBAAW,EAAC,yBAAa,EAAE,KAAK,CAAC,CAAA;AAAjE,QAAA,KAAK,SAA4D"}
+{"version":3,"file":"roles.decorator.js","sourceRoot":"","sources":["../../src/decorators/roles.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA4C;AAE5C,2CAA2C;AAE3C;;;;;;;;;;;GAWG;AACI,MAAM,KAAK,GAAG,CAAC,GAAG,KAAe,EAAE,EAAE,CAAC,IAAA,oBAAW,EAAC,yBAAa,EAAE,KAAK,CAAC,CAAA;AAAjE,QAAA,KAAK,SAA4D"}

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

@@ -1,6 +1,18 @@
 import { ClassConstructor } from 'class-transformer';
 import { EnvironmentVariables } from '../env.validation';
+/**
+ * Configuration options for the root AppModule.
+ * Used when bootstrapping the NestJS application.
+ *
+ * @example
+ * bootstrap({
+ *   rootModule: AppModule,
+ *   envCls: CustomEnvironmentVariables,
+ * })
+ */
 export interface AppModuleOptions {
+    /** The root NestJS module class */
     rootModule: any;
+    /** Optional custom environment variables class for validation */
     envCls?: ClassConstructor<EnvironmentVariables>;
 }

package/dist/interfaces/command-input-model.interface.d.ts

@@ -1,19 +1,43 @@
+/**
+ * Interface for complete command input data.
+ * Used when creating or fully updating an entity.
+ */
 export interface CommandInputModel {
+    /** Partition key. Format: {tenantCode}#{entityType} */
     pk: string;
+    /** Sort key. Format: {entityType}#{entityId} */
     sk: string;
+    /** Unique entity identifier */
     id: string;
+    /** Business code */
     code: string;
+    /** Display name */
     name: string;
+    /** Version for optimistic locking */
     version: number;
+    /** Tenant code for isolation */
     tenantCode: string;
+    /** Entity type */
     type: string;
+    /** Soft delete flag */
     isDeleted?: boolean;
+    /** Sequence number */
     seq?: number;
+    /** Time-to-live in seconds */
     ttl?: number;
+    /** Custom attributes */
     attributes?: Record<string, any>;
 }
+/**
+ * Interface for partial command input data.
+ * Used when updating only specific fields of an entity.
+ * Requires pk, sk, and version for identification and locking.
+ */
 export interface CommandPartialInputModel extends Partial<CommandInputModel> {
+    /** Partition key (required) */
     pk: string;
+    /** Sort key (required) */
     sk: string;
+    /** Version for optimistic locking (required) */
     version: number;
 }

package/dist/interfaces/command-model.interface.d.ts

@@ -1,13 +1,30 @@
 import { CommandInputModel } from './command-input-model.interface';
+/**
+ * Complete command model stored in the command (write) table.
+ * Extends CommandInputModel with audit fields and processing metadata.
+ *
+ * This represents a single versioned command record in event sourcing.
+ * Each command creates a new version with sk format: {baseSk}@{version}
+ */
 export interface CommandModel extends CommandInputModel {
+    /** Processing status (e.g., 'PENDING', 'COMPLETED', 'FAILED') */
     status?: string;
+    /** Event source identifier (e.g., 'POST /api/master', 'SQS') */
     source?: string;
+    /** Unique request ID for tracing and idempotency */
     requestId?: string;
+    /** Timestamp when the command was created */
     createdAt?: Date;
+    /** Timestamp when the command was last updated */
     updatedAt?: Date;
+    /** User ID who created the command */
     createdBy?: string;
+    /** User ID who last updated the command */
     updatedBy?: string;
+    /** IP address of the creator */
     createdIp?: string;
+    /** IP address of the last updater */
     updatedIp?: string;
+    /** Step Functions task token for async workflows */
     taskToken?: string;
 }

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

@@ -1,8 +1,22 @@
 import { Type } from '@nestjs/common';
 import { IDataSyncHandler } from './data-sync-handler.interface';
+/**
+ * Configuration options for CommandModule.
+ * Used when importing CommandModule.register() in your application.
+ *
+ * @example
+ * CommandModule.register({
+ *   tableName: 'my-table',
+ *   dataSyncHandlers: [OrderDataSyncHandler],
+ * })
+ */
 export interface CommandModuleOptions {
+    /** DynamoDB table name for command storage */
     tableName: string;
+    /** If true, skips errors from previous command versions */
     skipError?: boolean;
+    /** Custom handlers for syncing command data to read models */
     dataSyncHandlers?: Type<IDataSyncHandler>[];
+    /** If true, disables the default data sync handler */
     disableDefaultHandler?: boolean;
 }

package/dist/interfaces/command.dto.d.ts

@@ -1,4 +1,19 @@
 import { CommandInputModel } from './command-input-model.interface';
+/**
+ * Base DTO class for command input validation.
+ * Implements CommandInputModel with class-validator decorators.
+ *
+ * @example
+ * ```typescript
+ * class CreateOrderDto extends CommandDto {
+ *   @IsString()
+ *   customerId: string;
+ *
+ *   @IsNumber()
+ *   amount: number;
+ * }
+ * ```
+ */
 export declare class CommandDto implements CommandInputModel {
     pk: string;
     sk: string;

package/dist/interfaces/command.dto.js

@@ -12,6 +12,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandDto = void 0;
 const swagger_1 = require("@nestjs/swagger");
 const class_validator_1 = require("class-validator");
+/**
+ * Base DTO class for command input validation.
+ * Implements CommandInputModel with class-validator decorators.
+ *
+ * @example
+ * ```typescript
+ * class CreateOrderDto extends CommandDto {
+ *   @IsString()
+ *   customerId: string;
+ *
+ *   @IsNumber()
+ *   amount: number;
+ * }
+ * ```
+ */
 class CommandDto {
 }
 exports.CommandDto = CommandDto;

package/dist/interfaces/command.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"command.dto.js","sourceRoot":"","sources":["../../src/interfaces/command.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAkE;AAClE,qDAA2E;AAI3E,MAAa,UAAU;CAiDtB;AAjDD,gCAiDC;AA9CC;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;sCACD;AAIV;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;sCACD;AAIV;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;sCACD;AAIV;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;wCACC;AAIZ;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;wCACC;AAIZ;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;2CACI;AAIf;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,4BAAU,GAAE;;8CACK;AAIlB;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;wCACC;AAKZ;IAHC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;uCACC;AAKZ;IAHC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;uCACC;AAKZ;IAHC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;IACZ,IAAA,2BAAS,GAAE;;6CACO"}
+{"version":3,"file":"command.dto.js","sourceRoot":"","sources":["../../src/interfaces/command.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAkE;AAClE,qDAA2E;AAI3E;;;;;;;;;;;;;;GAcG;AACH,MAAa,UAAU;CAiDtB;AAjDD,gCAiDC;AA9CC;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;sCACD;AAIV;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;sCACD;AAIV;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;sCACD;AAIV;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;wCACC;AAIZ;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;wCACC;AAIZ;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;2CACI;AAIf;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,4BAAU,GAAE;;8CACK;AAIlB;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;wCACC;AAKZ;IAHC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;uCACC;AAKZ;IAHC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;uCACC;AAKZ;IAHC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;IACZ,IAAA,2BAAS,GAAE;;6CACO"}

package/dist/interfaces/command.entity.d.ts

@@ -1,5 +1,12 @@
 import { CommandModel } from './command-model.interface';
 import { DetailKey } from './detail-key.interface';
+/**
+ * Entity class implementing CommandModel for API responses.
+ * Includes Swagger decorators for API documentation.
+ *
+ * Use this class when returning command data from REST endpoints.
+ * The `key` getter provides convenient access to the DynamoDB key pair.
+ */
 export declare class CommandEntity implements CommandModel {
     source?: string;
     isDeleted?: boolean;

package/dist/interfaces/command.entity.js

@@ -11,6 +11,13 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandEntity = void 0;
 const swagger_1 = require("@nestjs/swagger");
+/**
+ * Entity class implementing CommandModel for API responses.
+ * Includes Swagger decorators for API documentation.
+ *
+ * Use this class when returning command data from REST endpoints.
+ * The `key` getter provides convenient access to the DynamoDB key pair.
+ */
 class CommandEntity {
     get key() {
         return {

package/dist/interfaces/command.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"command.entity.js","sourceRoot":"","sources":["../../src/interfaces/command.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAkE;AAKlE,MAAa,aAAa;IA4CxB,IAAI,GAAG;QACL,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,EAAE,EAAE,IAAI,CAAC,EAAE;SACZ,CAAA;IACH,CAAC;CACF;AAlDD,sCAkDC;AAhDC;IADC,IAAA,6BAAmB,GAAE;;6CACP;AAEf;IADC,IAAA,6BAAmB,GAAE;;gDACH;AAEnB;IADC,IAAA,6BAAmB,GAAE;;6CACP;AAEf;IADC,IAAA,6BAAmB,GAAE;;gDACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;8BACV,IAAI;gDAAA;AAEhB;IADC,IAAA,6BAAmB,GAAE;8BACV,IAAI;gDAAA;AAEhB;IADC,IAAA,6BAAmB,GAAE;;gDACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;gDACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;gDACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;gDACJ;AAElB;IADC,IAAA,qBAAW,GAAE;;yCACJ;AAEV;IADC,IAAA,qBAAW,GAAE;;yCACJ;AAEV;IADC,IAAA,qBAAW,GAAE;;yCACJ;AAEV;IADC,IAAA,qBAAW,GAAE;;2CACF;AAEZ;IADC,IAAA,qBAAW,GAAE;;2CACF;AAEZ;IADC,IAAA,qBAAW,GAAE;;8CACC;AAEf;IADC,IAAA,qBAAW,GAAE;;iDACI;AAElB;IADC,IAAA,qBAAW,GAAE;;2CACF;AAEZ;IADC,IAAA,6BAAmB,GAAE;;0CACV;AAEZ;IADC,IAAA,6BAAmB,GAAE;;0CACV"}
+{"version":3,"file":"command.entity.js","sourceRoot":"","sources":["../../src/interfaces/command.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAkE;AAKlE;;;;;;GAMG;AACH,MAAa,aAAa;IA4CxB,IAAI,GAAG;QACL,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,EAAE,EAAE,IAAI,CAAC,EAAE;SACZ,CAAA;IACH,CAAC;CACF;AAlDD,sCAkDC;AAhDC;IADC,IAAA,6BAAmB,GAAE;;6CACP;AAEf;IADC,IAAA,6BAAmB,GAAE;;gDACH;AAEnB;IADC,IAAA,6BAAmB,GAAE;;6CACP;AAEf;IADC,IAAA,6BAAmB,GAAE;;gDACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;8BACV,IAAI;gDAAA;AAEhB;IADC,IAAA,6BAAmB,GAAE;8BACV,IAAI;gDAAA;AAEhB;IADC,IAAA,6BAAmB,GAAE;;gDACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;gDACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;gDACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;gDACJ;AAElB;IADC,IAAA,qBAAW,GAAE;;yCACJ;AAEV;IADC,IAAA,qBAAW,GAAE;;yCACJ;AAEV;IADC,IAAA,qBAAW,GAAE;;yCACJ;AAEV;IADC,IAAA,qBAAW,GAAE;;2CACF;AAEZ;IADC,IAAA,qBAAW,GAAE;;2CACF;AAEZ;IADC,IAAA,qBAAW,GAAE;;8CACC;AAEf;IADC,IAAA,qBAAW,GAAE;;iDACI;AAElB;IADC,IAAA,qBAAW,GAAE;;2CACF;AAEZ;IADC,IAAA,6BAAmB,GAAE;;0CACV;AAEZ;IADC,IAAA,6BAAmB,GAAE;;0CACV"}

package/dist/interfaces/command.options.interface.d.ts

@@ -1,6 +1,19 @@
 import { IInvoke } from '../context';
+/**
+ * Options passed to command service methods.
+ * Contains context information needed for command processing.
+ *
+ * @example
+ * await commandService.publishAsync(input, {
+ *   source: 'POST /api/orders',
+ *   invokeContext: { event, context }
+ * })
+ */
 export interface ICommandOptions {
+    /** Origin of the command (e.g., 'POST /api/orders', 'SQS', 'StepFunction') */
     source?: string;
+    /** Unique request ID for tracing - auto-generated if not provided */
     requestId?: string;
+    /** Lambda invoke context containing event and AWS context */
     invokeContext: IInvoke;
 }

package/dist/interfaces/data-list.entity.d.ts

@@ -1,4 +1,19 @@
 import { DataEntity } from './data.entity';
+/**
+ * Paginated list response for data queries.
+ * Used when listing items by partition key with cursor-based pagination.
+ *
+ * @example
+ * // API response
+ * {
+ *   "total": 100,
+ *   "lastSk": "ITEM#50",
+ *   "items": [...]
+ * }
+ *
+ * // Next page request uses lastSk as cursor
+ * GET /items?pk=ORDER&startSk=ITEM#50
+ */
 export declare class DataListEntity {
     total?: number;
     lastSk?: string;

package/dist/interfaces/data-list.entity.js

@@ -12,6 +12,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataListEntity = void 0;
 const swagger_1 = require("@nestjs/swagger");
 const data_entity_1 = require("./data.entity");
+/**
+ * Paginated list response for data queries.
+ * Used when listing items by partition key with cursor-based pagination.
+ *
+ * @example
+ * // API response
+ * {
+ *   "total": 100,
+ *   "lastSk": "ITEM#50",
+ *   "items": [...]
+ * }
+ *
+ * // Next page request uses lastSk as cursor
+ * GET /items?pk=ORDER&startSk=ITEM#50
+ */
 class DataListEntity {
     constructor(data) {
         Object.assign(this, data);

package/dist/interfaces/data-list.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-list.entity.js","sourceRoot":"","sources":["../../src/interfaces/data-list.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAkE;AAElE,+CAA0C;AAE1C,MAAa,cAAc;IAUzB,YAAY,IAA6B;QACvC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC3B,CAAC;CACF;AAbD,wCAaC;AAXC;IADC,IAAA,6BAAmB,GAAE;;6CACR;AAEd;IADC,IAAA,6BAAmB,GAAE;;8CACP;AAIf;IAHC,IAAA,qBAAW,EAAC;QACX,IAAI,EAAE,CAAC,wBAAU,CAAC;KACnB,CAAC;;6CACiB"}
+{"version":3,"file":"data-list.entity.js","sourceRoot":"","sources":["../../src/interfaces/data-list.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAkE;AAElE,+CAA0C;AAE1C;;;;;;;;;;;;;;GAcG;AACH,MAAa,cAAc;IAUzB,YAAY,IAA6B;QACvC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC3B,CAAC;CACF;AAbD,wCAaC;AAXC;IADC,IAAA,6BAAmB,GAAE;;6CACR;AAEd;IADC,IAAA,6BAAmB,GAAE;;8CACP;AAIf;IAHC,IAAA,qBAAW,EAAC;QACX,IAAI,EAAE,CAAC,wBAAU,CAAC;KACnB,CAAC;;6CACiB"}

package/dist/interfaces/data-model.interface.d.ts

@@ -1,5 +1,18 @@
 import { CommandModel } from './command-model.interface';
+/**
+ * Data model stored in the data (read) table.
+ * Represents the current/projected state of an entity for queries.
+ *
+ * In CQRS, this is the read-side projection derived from command events.
+ * Unlike CommandModel, DataModel stores only the latest state without version suffix.
+ *
+ * @example
+ * Command table: pk='ORDER#123', sk='ITEM#A@3' (version 3)
+ * Data table:    pk='ORDER#123', sk='ITEM#A' (current state)
+ */
 export interface DataModel extends Omit<CommandModel, 'status'> {
+    /** Command partition key - references source command record */
     cpk?: string;
+    /** Command sort key with version - references exact command version */
     csk?: string;
 }

package/dist/interfaces/data.entity.d.ts

@@ -1,5 +1,23 @@
 import { DataModel } from './data-model.interface';
 import { DetailKey } from './detail-key.interface';
+/**
+ * Base entity class for all data stored in DynamoDB.
+ * Implements the DataModel interface with common fields for CQRS operations.
+ *
+ * @example
+ * ```typescript
+ * const entity = new DataEntity({
+ *   pk: 'TENANT001#ORDER',
+ *   sk: 'ORDER#123',
+ *   id: '123',
+ *   code: 'ORD-001',
+ *   name: 'Sample Order',
+ *   version: 1,
+ *   tenantCode: 'TENANT001',
+ *   type: 'ORDER',
+ * });
+ * ```
+ */
 export declare class DataEntity implements DataModel {
     cpk?: string;
     csk?: string;
@@ -11,13 +29,21 @@ export declare class DataEntity implements DataModel {
     updatedBy?: string;
     createdIp?: string;
     updatedIp?: string;
+    /** Partition key for DynamoDB. Format: {tenantCode}#{entityType} */
     pk: string;
+    /** Sort key for DynamoDB. Format: {entityType}#{entityId} */
     sk: string;
+    /** Unique identifier for the entity */
     id: string;
+    /** Business code for the entity */
     code: string;
+    /** Display name of the entity */
     name: string;
+    /** Version number for optimistic locking */
     version: number;
+    /** Tenant code for multi-tenant isolation */
     tenantCode: string;
+    /** Entity type identifier */
     type: string;
     seq?: number;
     ttl?: number;

package/dist/interfaces/data.entity.js

@@ -11,6 +11,24 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataEntity = void 0;
 const swagger_1 = require("@nestjs/swagger");
+/**
+ * Base entity class for all data stored in DynamoDB.
+ * Implements the DataModel interface with common fields for CQRS operations.
+ *
+ * @example
+ * ```typescript
+ * const entity = new DataEntity({
+ *   pk: 'TENANT001#ORDER',
+ *   sk: 'ORDER#123',
+ *   id: '123',
+ *   code: 'ORD-001',
+ *   name: 'Sample Order',
+ *   version: 1,
+ *   tenantCode: 'TENANT001',
+ *   type: 'ORDER',
+ * });
+ * ```
+ */
 class DataEntity {
     constructor(data) {
         Object.assign(this, data);

package/dist/interfaces/data.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"data.entity.js","sourceRoot":"","sources":["../../src/interfaces/data.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAkE;AAKlE,MAAa,UAAU;IA8CrB,YAAY,IAAyB;QACnC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC3B,CAAC;IAED,IAAI,GAAG;QACL,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,EAAE,EAAE,IAAI,CAAC,EAAE;SACZ,CAAA;IACH,CAAC;CACF;AAxDD,gCAwDC;AAtDC;IADC,IAAA,6BAAmB,GAAE;;uCACV;AAEZ;IADC,IAAA,6BAAmB,GAAE;;uCACV;AAEZ;IADC,IAAA,6BAAmB,GAAE;;0CACP;AAEf;IADC,IAAA,6BAAmB,GAAE;;6CACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;8BACV,IAAI;6CAAA;AAEhB;IADC,IAAA,6BAAmB,GAAE;8BACV,IAAI;6CAAA;AAEhB;IADC,IAAA,6BAAmB,GAAE;;6CACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;6CACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;6CACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;6CACJ;AAElB;IADC,IAAA,qBAAW,GAAE;;sCACJ;AAEV;IADC,IAAA,qBAAW,GAAE;;sCACJ;AAEV;IADC,IAAA,qBAAW,GAAE;;sCACJ;AAEV;IADC,IAAA,qBAAW,GAAE;;wCACF;AAEZ;IADC,IAAA,qBAAW,GAAE;;wCACF;AAEZ;IADC,IAAA,qBAAW,GAAE;;2CACC;AAEf;IADC,IAAA,qBAAW,GAAE;;8CACI;AAElB;IADC,IAAA,qBAAW,GAAE;;wCACF;AAEZ;IADC,IAAA,6BAAmB,GAAE;;uCACV;AAEZ;IADC,IAAA,6BAAmB,GAAE;;uCACV;AAEZ;IADC,IAAA,6BAAmB,GAAE;;6CACH"}
+{"version":3,"file":"data.entity.js","sourceRoot":"","sources":["../../src/interfaces/data.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAkE;AAKlE;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,UAAU;IA6DrB,YAAY,IAAyB;QACnC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC3B,CAAC;IAED,IAAI,GAAG;QACL,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,EAAE,EAAE,IAAI,CAAC,EAAE;SACZ,CAAA;IACH,CAAC;CACF;AAvED,gCAuEC;AArEC;IADC,IAAA,6BAAmB,GAAE;;uCACV;AAEZ;IADC,IAAA,6BAAmB,GAAE;;uCACV;AAEZ;IADC,IAAA,6BAAmB,GAAE;;0CACP;AAEf;IADC,IAAA,6BAAmB,GAAE;;6CACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;8BACV,IAAI;6CAAA;AAEhB;IADC,IAAA,6BAAmB,GAAE;8BACV,IAAI;6CAAA;AAEhB;IADC,IAAA,6BAAmB,GAAE;;6CACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;6CACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;6CACJ;AAElB;IADC,IAAA,6BAAmB,GAAE;;6CACJ;AAGlB;IADC,IAAA,qBAAW,GAAE;;sCACJ;AAIV;IADC,IAAA,qBAAW,GAAE;;sCACJ;AAIV;IADC,IAAA,qBAAW,GAAE;;sCACJ;AAIV;IADC,IAAA,qBAAW,GAAE;;wCACF;AAIZ;IADC,IAAA,qBAAW,GAAE;;wCACF;AAIZ;IADC,IAAA,qBAAW,GAAE;;2CACC;AAIf;IADC,IAAA,qBAAW,GAAE;;8CACI;AAIlB;IADC,IAAA,qBAAW,GAAE;;wCACF;AAEZ;IADC,IAAA,6BAAmB,GAAE;;uCACV;AAEZ;IADC,IAAA,6BAAmB,GAAE;;uCACV;AAEZ;IADC,IAAA,6BAAmB,GAAE;;6CACH"}

package/dist/interfaces/ddb-update-item.interface.d.ts

@@ -1,19 +1,52 @@
+/**
+ * DynamoDB Update Expression Types
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html
+ */
+/** Primitive value types supported by DynamoDB */
 export type DdbValueType = boolean | number | string | Record<string, any>;
+/** All DynamoDB value types including arrays */
 export type DdbValueAllType = DdbValueType | DdbValueType[];
+/**
+ * Path-value pair for SET operations.
+ * Used with if_not_exists() and list_append() functions.
+ */
 export type DdbUpdateSetPathValue = {
+    /** Attribute path (e.g., 'attributes.count') */
     path: string;
+    /** Value to set */
     value: DdbValueAllType;
 };
+/**
+ * SET operation value with optional modifiers.
+ * Supports atomic counters and list operations.
+ */
 export type DdbUpdateSetValue = {
+    /** Increment numeric value by this amount */
     incrementBy?: number;
+    /** Decrement numeric value by this amount */
     decrementBy?: number;
+    /** Set value only if attribute doesn't exist */
     ifNotExists?: string | DdbUpdateSetPathValue;
+    /** Append to list attribute */
     listAppend?: string[] | DdbUpdateSetPathValue;
 };
+/**
+ * DynamoDB UpdateItem expression builder.
+ * Provides type-safe interface for update operations.
+ *
+ * @example
+ * const update: DdbUpdateItem = {
+ *   set: { name: 'New Name', 'attributes.count': { incrementBy: 1 } },
+ *   remove: { oldField: true }
+ * }
+ */
 export interface DdbUpdateItem {
+    /** SET expression - add or modify attributes */
     set?: Record<string, DdbValueAllType | DdbUpdateSetValue>;
+    /** REMOVE expression - delete attributes or list elements */
     remove?: Record<string, boolean | {
         index: number;
     }>;
+    /** DELETE expression - remove elements from a set */
     delete?: Record<string, DdbValueType>;
 }

package/dist/interfaces/ddb-update-item.interface.js

@@ -1,3 +1,7 @@
 "use strict";
+/**
+ * DynamoDB Update Expression Types
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ddb-update-item.interface.js.map

package/dist/interfaces/ddb-update-item.interface.js.map

@@ -1 +1 @@
-{"version":3,"file":"ddb-update-item.interface.js","sourceRoot":"","sources":["../../src/interfaces/ddb-update-item.interface.ts"],"names":[],"mappings":""}
+{"version":3,"file":"ddb-update-item.interface.js","sourceRoot":"","sources":["../../src/interfaces/ddb-update-item.interface.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/dist/interfaces/detail-key.interface.d.ts

@@ -1,4 +1,10 @@
+/**
+ * Interface for DynamoDB composite key.
+ * Used to identify items in the data store.
+ */
 export interface DetailKey {
+    /** Partition key */
     pk: string;
+    /** Sort key */
     sk: string;
 }

package/dist/interfaces/detail.dto.d.ts

@@ -1,4 +1,12 @@
 import { DetailKey } from './detail-key.interface';
+/**
+ * DTO for retrieving a single item by its DynamoDB key.
+ * Used in GET, PUT, DELETE operations that target a specific item.
+ *
+ * @example
+ * // GET /items/:pk/:sk
+ * // Request: { pk: "ORDER#123", sk: "ITEM#A" }
+ */
 export declare class DetailDto implements DetailKey {
     pk: string;
     sk: string;

package/dist/interfaces/detail.dto.js

@@ -12,6 +12,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DetailDto = void 0;
 const swagger_1 = require("@nestjs/swagger");
 const class_validator_1 = require("class-validator");
+/**
+ * DTO for retrieving a single item by its DynamoDB key.
+ * Used in GET, PUT, DELETE operations that target a specific item.
+ *
+ * @example
+ * // GET /items/:pk/:sk
+ * // Request: { pk: "ORDER#123", sk: "ITEM#A" }
+ */
 class DetailDto {
 }
 exports.DetailDto = DetailDto;

package/dist/interfaces/detail.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"detail.dto.js","sourceRoot":"","sources":["../../src/interfaces/detail.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAA6C;AAC7C,qDAA0C;AAI1C,MAAa,SAAS;CAQrB;AARD,8BAQC;AALC;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;qCACD;AAIV;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;qCACD"}
+{"version":3,"file":"detail.dto.js","sourceRoot":"","sources":["../../src/interfaces/detail.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAA6C;AAC7C,qDAA0C;AAI1C;;;;;;;GAOG;AACH,MAAa,SAAS;CAQrB;AARD,8BAQC;AALC;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;qCACD;AAIV;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;;qCACD"}

package/dist/interfaces/event-factory.interface.d.ts

@@ -1,11 +1,24 @@
 import { DynamoDBStreamEvent, EventBridgeEvent, S3Event, SNSEvent, SQSEvent } from 'aws-lambda';
 import { StepFunctionsEvent } from './aws/step-function.interface';
 import { IEvent } from './event.interface';
+/**
+ * Factory interface for transforming AWS events into domain events.
+ * Implement this to customize how incoming AWS events are parsed.
+ *
+ * Each transform method receives the raw AWS event and returns
+ * an array of domain events to be processed by handlers.
+ */
 export interface IEventFactory<TEvent extends IEvent = any> {
+    /** Transform SQS messages into domain events */
     transformSqs(event: SQSEvent): Promise<TEvent[]>;
+    /** Transform SNS notifications into domain events */
     transformSns(event: SNSEvent): Promise<TEvent[]>;
+    /** Transform DynamoDB Stream records into domain events */
     transformDynamodbStream(event: DynamoDBStreamEvent): Promise<TEvent[]>;
+    /** Transform EventBridge events into domain events */
     transformEventBridge(event: EventBridgeEvent<any, any>): Promise<TEvent[]>;
+    /** Transform Step Functions task input into domain events */
     transformStepFunction(event: StepFunctionsEvent<any>): Promise<TEvent[]>;
+    /** Transform S3 notifications into domain events */
     transformS3(event: S3Event): Promise<TEvent[]>;
 }

package/dist/interfaces/event-raw.interface.d.ts

@@ -1,2 +1,6 @@
+/**
+ * Marker interface for raw AWS Lambda events.
+ * Extend this interface to type your custom event payloads.
+ */
 export interface IRawEvent {
 }

package/dist/interfaces/event.interface.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Base interface for domain events.
+ * All events should implement this interface.
+ */
 export interface IEvent {
+    /** Source identifier of the event */
     source: string;
 }

package/dist/interfaces/master.interface.d.ts

@@ -1,4 +1,8 @@
 import { DetailKey } from './detail-key.interface';
+/**
+ * Interface for master data providers.
+ * Implement this to create custom data sources for master data lookup.
+ */
 export interface IMasterDataProvider {
     /**
      * Get the data for a specific key.

package/dist/interfaces/notification.interface.d.ts

@@ -1,24 +1,53 @@
+/**
+ * Real-time notification payload for WebSocket/AppSync subscriptions.
+ * Published when data changes occur in the system.
+ */
 export interface INotification {
+    /** Unique notification ID */
     id: string;
+    /** Source DynamoDB table name */
     table: string;
+    /** Partition key of the changed item */
     pk: string;
+    /** Sort key of the changed item */
     sk: string;
+    /** Tenant code for filtering notifications */
     tenantCode: string;
+    /** Type of change: 'INSERT', 'MODIFY', 'REMOVE' */
     action: string;
+    /** Optional payload with changed data */
     content?: object;
 }
+/**
+ * Email attachment for SES notifications.
+ */
 export interface Attachment {
+    /** Filename shown to recipient */
     filename: string;
+    /** File content as Buffer */
     content: Buffer;
+    /** MIME type (e.g., 'application/pdf') */
     contentType?: string;
 }
+/**
+ * Email notification configuration for SES.
+ * Used by NotificationService to send emails.
+ */
 export interface EmailNotification {
+    /** Sender email address (uses default if not specified) */
     fromAddr?: string;
+    /** List of recipient email addresses */
     toAddrs: string[];
+    /** Optional CC recipients */
     ccAddrs?: string[];
+    /** Optional BCC recipients */
     bccAddrs?: string[];
+    /** Email subject line */
     subject: string;
+    /** Email body as HTML */
     body: string;
+    /** Optional reply-to addresses */
     replyToAddrs?: string[];
+    /** Optional file attachments */
     attachments?: Attachment[];
 }

package/dist/interfaces/paginate.dto.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Base DTO for paginated list requests.
+ * Provides page-based pagination with configurable page size.
+ *
+ * @example
+ * // GET /items?page=2&pageSize=20
+ */
 export declare class PaginateDto {
     /**
      * Current page number

package/dist/interfaces/paginate.dto.js

@@ -13,6 +13,13 @@ exports.PaginateDto = void 0;
 const swagger_1 = require("@nestjs/swagger");
 const class_transformer_1 = require("class-transformer");
 const class_validator_1 = require("class-validator");
+/**
+ * Base DTO for paginated list requests.
+ * Provides page-based pagination with configurable page size.
+ *
+ * @example
+ * // GET /items?page=2&pageSize=20
+ */
 class PaginateDto {
     constructor(partial) {
         /**

package/dist/interfaces/paginate.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"paginate.dto.js","sourceRoot":"","sources":["../../src/interfaces/paginate.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAqD;AACrD,yDAA6C;AAC7C,qDAA4C;AAE5C,MAAa,WAAW;IAqBtB,YAAY,OAA6B;QApBzC;;;WAGG;QAKH,SAAI,GAAY,CAAC,CAAA;QAEjB;;;WAGG;QAKH,aAAQ,GAAY,EAAE,CAAA;QAGpB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAC9B,CAAC;CACF;AAxBD,kCAwBC;AAfC;IAJC,IAAA,6BAAmB,GAAE;IACrB,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvC,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,CAAC,CAAC;;yCACU;AAUjB;IAJC,IAAA,6BAAmB,GAAE;IACrB,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvC,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,CAAC,CAAC;;6CACe"}
+{"version":3,"file":"paginate.dto.js","sourceRoot":"","sources":["../../src/interfaces/paginate.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAqD;AACrD,yDAA6C;AAC7C,qDAA4C;AAE5C;;;;;;GAMG;AACH,MAAa,WAAW;IAqBtB,YAAY,OAA6B;QApBzC;;;WAGG;QAKH,SAAI,GAAY,CAAC,CAAA;QAEjB;;;WAGG;QAKH,aAAQ,GAAY,EAAE,CAAA;QAGpB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAC9B,CAAC;CACF;AAxBD,kCAwBC;AAfC;IAJC,IAAA,6BAAmB,GAAE;IACrB,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvC,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,CAAC,CAAC;;yCACU;AAUjB;IAJC,IAAA,6BAAmB,GAAE;IACrB,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvC,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,CAAC,CAAC;;6CACe"}

package/dist/interfaces/search.dto.d.ts

@@ -1,4 +1,11 @@
 import { PaginateDto } from './paginate.dto';
+/**
+ * DTO for search operations with filtering and sorting.
+ * Extends PaginateDto with search-specific parameters.
+ *
+ * @example
+ * // GET /items?keyword=test&pk=ORDER&orderBys=createdAt:desc
+ */
 export declare class SearchDto extends PaginateDto {
     /**
      * search keyword

package/dist/interfaces/search.dto.js

@@ -14,6 +14,13 @@ const swagger_1 = require("@nestjs/swagger");
 const class_transformer_1 = require("class-transformer");
 const class_validator_1 = require("class-validator");
 const paginate_dto_1 = require("./paginate.dto");
+/**
+ * DTO for search operations with filtering and sorting.
+ * Extends PaginateDto with search-specific parameters.
+ *
+ * @example
+ * // GET /items?keyword=test&pk=ORDER&orderBys=createdAt:desc
+ */
 class SearchDto extends paginate_dto_1.PaginateDto {
 }
 exports.SearchDto = SearchDto;

package/dist/interfaces/search.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"search.dto.js","sourceRoot":"","sources":["../../src/interfaces/search.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAqD;AACrD,yDAA6C;AAC7C,qDAAsD;AAEtD,iDAA4C;AAE5C,MAAa,SAAU,SAAQ,0BAAW;CA0BzC;AA1BD,8BA0BC;AApBC;IAFC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;;0CACG;AAIhB;IAFC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;;qCACF;AAKX;IAHC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;IACZ,IAAA,6BAAmB,GAAE;;qCACX;AAIX;IAFC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;;qCACF;AAMX;IAJC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACxB,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;;2CAChD"}
+{"version":3,"file":"search.dto.js","sourceRoot":"","sources":["../../src/interfaces/search.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAqD;AACrD,yDAA6C;AAC7C,qDAAsD;AAEtD,iDAA4C;AAE5C;;;;;;GAMG;AACH,MAAa,SAAU,SAAQ,0BAAW;CA0BzC;AA1BD,8BA0BC;AApBC;IAFC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;;0CACG;AAIhB;IAFC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;;qCACF;AAKX;IAHC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;IACZ,IAAA,6BAAmB,GAAE;;qCACX;AAIX;IAFC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;;qCACF;AAMX;IAJC,IAAA,6BAAmB,GAAE;IACrB,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACxB,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;;2CAChD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mbc-cqrs-serverless/core",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "description": "CQRS and event base core",
   "keywords": [
     "mbc",
@@ -88,5 +88,5 @@
     "serverless-step-functions-local": "^0.5.1",
     "supertest": "^7.0.0"
   },
-  "gitHead": "799960ab779dab7f9ce9be3cb83083f019a29208"
+  "gitHead": "4ab967474160873735b8cb816272a7012b8940d5"
 }