@mbc-cqrs-serverless/ui-setting 1.3.4 → 1.4.0

package/README.md

@@ -314,6 +314,42 @@ await dataSettingService.create(tenantCode, {
 
 Full documentation available at [https://mbc-cqrs-serverless.mbc-net.com/](https://mbc-cqrs-serverless.mbc-net.com/)
 
+## Configurable table name
+
+`SettingModule` stores its data on the `master` DynamoDB table by default
+(shared with `MasterModule`). Pass `tableName` to override it (backward
+compatible). Both `register` and `registerAsync` accept it:
+
+```ts
+SettingModule.register({
+  enableSettingController: true,
+  tableName: 'master', // default: 'master'
+})
+
+SettingModule.registerAsync({ tableName: 'master', inject: [] })
+
+// When combined with MasterModule on the same table, let MasterModule own the
+// data-sync pipeline and defer the alias:
+SettingModule.register({
+  enableSettingController: true,
+  registerEventHandlerAlias: false,
+})
+```
+
+> **Shared table:** `SettingModule` and `MasterModule` share the same physical
+> table. When you use both:
+> 1. Register them with the **same** `tableName`, otherwise their data is split
+>    across two tables.
+> 2. Set `registerEventHandlerAlias: false` on `SettingModule` so `MasterModule`
+>    owns the `<tableName>_CommandEventHandler` alias. If both modules own the
+>    alias, the app still boots but logs a **warning** — which module's data-sync
+>    handlers run is then import-order dependent, so setting the flag is required
+>    for deterministic behavior.
+>
+> **Provisioning:** A custom `tableName` must exist as physical tables
+> (`-command` / `-data` / `-history`). Add the raw base name to
+> `prisma/dynamodbs/cqrs.json` and define the tables in your IaC.
+
 ## License
 
 Copyright © 2024-2025, Murakami Business Consulting, Inc. [https://www.mbc-net.com/](https://www.mbc-net.com/)

package/dist/setting.module-definition.d.ts

@@ -1,5 +1,38 @@
+import { IDataSyncHandler } from '@mbc-cqrs-serverless/core';
+import { ModuleMetadata, Type } from '@nestjs/common';
+/**
+ * ui-setting stores its data on the master table by default, so `tableName`
+ * defaults to 'master'. When combined with MasterModule, both modules MUST use
+ * the same `tableName` value.
+ *
+ * NOTE: this value must stay in sync with `TABLE_NAME` in
+ * `@mbc-cqrs-serverless/master` (packages/master/src/constants/index.ts). It is
+ * duplicated here to avoid a package dependency; if the master default table
+ * name ever changes, update this constant too.
+ */
+export declare const DEFAULT_UI_SETTING_TABLE_NAME = "master";
 export interface SettingModuleOptions {
     enableSettingController?: boolean;
     enableDataController?: boolean;
+    /** DynamoDB base table name. Default: 'master' (shared with MasterModule). */
+    tableName?: string;
+    dataSyncHandlers?: Type<IDataSyncHandler>[];
+    /**
+     * Whether SettingModule owns the `<tableName>_CommandEventHandler` alias.
+     * Defaults to `true`. When combined with MasterModule on the same (default
+     * 'master') table, set this to `false` so MasterModule owns the alias and the
+     * duplicate-alias guard does not trip.
+     */
+    registerEventHandlerAlias?: boolean;
+}
+export interface SettingModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    enableSettingController?: boolean;
+    enableDataController?: boolean;
+    tableName?: string;
+    dataSyncHandlers?: Type<IDataSyncHandler>[];
+    registerEventHandlerAlias?: boolean;
+    inject?: any[];
+    /** ui-setting needs no runtime-resolved options; provided for API symmetry. */
+    useFactory?: (...args: any[]) => Promise<unknown> | unknown;
 }
 export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<SettingModuleOptions, "register", "create", {}>, MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: SettingModuleOptions & Partial<{}>;

package/dist/setting.module-definition.js

@@ -1,7 +1,18 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OPTIONS_TYPE = exports.MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = void 0;
+exports.OPTIONS_TYPE = exports.MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = exports.DEFAULT_UI_SETTING_TABLE_NAME = void 0;
 const common_1 = require("@nestjs/common");
+/**
+ * ui-setting stores its data on the master table by default, so `tableName`
+ * defaults to 'master'. When combined with MasterModule, both modules MUST use
+ * the same `tableName` value.
+ *
+ * NOTE: this value must stay in sync with `TABLE_NAME` in
+ * `@mbc-cqrs-serverless/master` (packages/master/src/constants/index.ts). It is
+ * duplicated here to avoid a package dependency; if the master default table
+ * name ever changes, update this constant too.
+ */
+exports.DEFAULT_UI_SETTING_TABLE_NAME = 'master';
 _a = new common_1.ConfigurableModuleBuilder().build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN, exports.OPTIONS_TYPE = _a.OPTIONS_TYPE;
 //# sourceMappingURL=setting.module-definition.js.map

package/dist/setting.module-definition.js.map

@@ -1 +1 @@
-{"version":3,"file":"setting.module-definition.js","sourceRoot":"","sources":["../src/setting.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA0D;AAM7C,KACX,IAAI,kCAAyB,EAAwB,CAAC,KAAK,EAAE,EADhD,+BAAuB,+BAAE,4BAAoB,4BAAE,oBAAY,mBACX"}
+{"version":3,"file":"setting.module-definition.js","sourceRoot":"","sources":["../src/setting.module-definition.ts"],"names":[],"mappings":";;;;AACA,2CAAgF;AAEhF;;;;;;;;;GASG;AACU,QAAA,6BAA6B,GAAG,QAAQ,CAAA;AA6BxC,KACX,IAAI,kCAAyB,EAAwB,CAAC,KAAK,EAAE,EADhD,+BAAuB,+BAAE,4BAAoB,4BAAE,oBAAY,mBACX"}

package/dist/setting.module.d.ts

@@ -1,5 +1,6 @@
 import { DynamicModule } from '@nestjs/common';
-import { ConfigurableModuleClass, OPTIONS_TYPE } from './setting.module-definition';
+import { ConfigurableModuleClass, OPTIONS_TYPE, SettingModuleAsyncOptions } from './setting.module-definition';
 export declare class SettingModule extends ConfigurableModuleClass {
     static register(options: typeof OPTIONS_TYPE): DynamicModule;
+    static registerAsync(options: SettingModuleAsyncOptions): DynamicModule;
 }

package/dist/setting.module.js

@@ -16,34 +16,62 @@ const setting_service_1 = require("./services/setting.service");
 const setting_module_definition_1 = require("./setting.module-definition");
 let SettingModule = class SettingModule extends setting_module_definition_1.ConfigurableModuleClass {
     static register(options) {
-        const module = super.register(options);
-        const { enableDataController, enableSettingController } = options;
-        if (enableDataController || enableSettingController) {
-            if (!module.controllers) {
-                module.controllers = [];
-            }
-            if (enableDataController) {
-                module.controllers.push(data_setting_controller_1.DataSettingController);
-            }
-            if (enableSettingController) {
-                module.controllers.push(setting_controller_1.SettingController);
-            }
+        const base = super.register(options);
+        const controllers = [...(base.controllers ?? [])];
+        const imports = [...(base.imports ?? [])];
+        const providers = [...(base.providers ?? [])];
+        const handlers = options.dataSyncHandlers ?? [];
+        providers.push(...handlers);
+        if (options.enableDataController) {
+            controllers.push(data_setting_controller_1.DataSettingController);
         }
-        return {
-            ...module,
-        };
+        if (options.enableSettingController) {
+            controllers.push(setting_controller_1.SettingController);
+        }
+        imports.push((0, core_1.buildDomainCommandModule)(setting_module_definition_1.DEFAULT_UI_SETTING_TABLE_NAME, {
+            tableName: options.tableName,
+            dataSyncHandlers: handlers,
+            registerEventHandlerAlias: options.registerEventHandlerAlias,
+        }));
+        return { ...base, providers, controllers, imports };
+    }
+    static registerAsync(options) {
+        const base = super.registerAsync({
+            imports: options.imports,
+            inject: options.inject ?? [],
+            useFactory: async (...args) => {
+                await options.useFactory?.(...args);
+                return {
+                    enableDataController: options.enableDataController,
+                    enableSettingController: options.enableSettingController,
+                    tableName: options.tableName ?? setting_module_definition_1.DEFAULT_UI_SETTING_TABLE_NAME,
+                    dataSyncHandlers: options.dataSyncHandlers,
+                };
+            },
+        });
+        const controllers = [...(base.controllers ?? [])];
+        const imports = [...(base.imports ?? [])];
+        const providers = [...(base.providers ?? [])];
+        const handlers = options.dataSyncHandlers ?? [];
+        providers.push(...handlers);
+        if (options.enableDataController) {
+            controllers.push(data_setting_controller_1.DataSettingController);
+        }
+        if (options.enableSettingController) {
+            controllers.push(setting_controller_1.SettingController);
+        }
+        imports.push((0, core_1.buildDomainCommandModule)(setting_module_definition_1.DEFAULT_UI_SETTING_TABLE_NAME, {
+            tableName: options.tableName,
+            dataSyncHandlers: handlers,
+            registerEventHandlerAlias: options.registerEventHandlerAlias,
+        }));
+        return { ...base, providers, controllers, imports };
     }
 };
 exports.SettingModule = SettingModule;
 exports.SettingModule = SettingModule = __decorate([
     (0, common_1.Module)({
-        imports: [
-            core_1.CommandModule.register({
-                tableName: 'master',
-            }),
-            core_1.DataStoreModule,
-            core_1.QueueModule,
-        ],
+        imports: [core_1.DataStoreModule, core_1.QueueModule],
         providers: [setting_service_1.SettingService, data_setting_service_1.DataSettingService],
         exports: [setting_service_1.SettingService, data_setting_service_1.DataSettingService],
     })

package/dist/setting.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"setting.module.js","sourceRoot":"","sources":["../src/setting.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,oDAIkC;AAClC,2CAAsD;AAEtD,mFAA6E;AAC7E,yEAAoE;AACpE,0EAAoE;AACpE,gEAA2D;AAC3D,2EAGoC;AAY7B,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,mDAAuB;IACxD,MAAM,CAAC,QAAQ,CAAC,OAA4B;QAC1C,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;QAEtC,MAAM,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,GAAG,OAAO,CAAA;QAEjE,IAAI,oBAAoB,IAAI,uBAAuB,EAAE,CAAC;YACpD,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBACxB,MAAM,CAAC,WAAW,GAAG,EAAE,CAAA;YACzB,CAAC;YACD,IAAI,oBAAoB,EAAE,CAAC;gBACzB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,+CAAqB,CAAC,CAAA;YAChD,CAAC;YACD,IAAI,uBAAuB,EAAE,CAAC;gBAC5B,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,sCAAiB,CAAC,CAAA;YAC5C,CAAC;QACH,CAAC;QAED,OAAO;YACL,GAAG,MAAM;SACV,CAAA;IACH,CAAC;CACF,CAAA;AAtBY,sCAAa;wBAAb,aAAa;IAXzB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,oBAAa,CAAC,QAAQ,CAAC;gBACrB,SAAS,EAAE,QAAQ;aACpB,CAAC;YACF,sBAAe;YACf,kBAAW;SACZ;QACD,SAAS,EAAE,CAAC,gCAAc,EAAE,yCAAkB,CAAC;QAC/C,OAAO,EAAE,CAAC,gCAAc,EAAE,yCAAkB,CAAC;KAC9C,CAAC;GACW,aAAa,CAsBzB"}
+{"version":3,"file":"setting.module.js","sourceRoot":"","sources":["../src/setting.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,oDAIkC;AAClC,2CAAsD;AAEtD,mFAA6E;AAC7E,yEAAoE;AACpE,0EAAoE;AACpE,gEAA2D;AAC3D,2EAKoC;AAO7B,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,mDAAuB;IACxD,MAAM,CAAC,QAAQ,CAAC,OAA4B;QAC1C,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;QACpC,MAAM,WAAW,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,CAAA;QACjD,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAA;QAEzC,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAA;QAC7C,MAAM,QAAQ,GAAG,OAAO,CAAC,gBAAgB,IAAI,EAAE,CAAA;QAC/C,SAAS,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAA;QAE3B,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACjC,WAAW,CAAC,IAAI,CAAC,+CAAqB,CAAC,CAAA;QACzC,CAAC;QACD,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;YACpC,WAAW,CAAC,IAAI,CAAC,sCAAiB,CAAC,CAAA;QACrC,CAAC;QAED,OAAO,CAAC,IAAI,CACV,IAAA,+BAAwB,EAAC,yDAA6B,EAAE;YACtD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,gBAAgB,EAAE,QAAQ;YAC1B,yBAAyB,EAAE,OAAO,CAAC,yBAAyB;SAC7D,CAAC,CACH,CAAA;QAED,OAAO,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,CAAA;IACrD,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,OAAkC;QACrD,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC;YAC/B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;YAC5B,UAAU,EAAE,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE;gBACnC,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;gBACnC,OAAO;oBACL,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;oBAClD,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;oBACxD,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,yDAA6B;oBAC7D,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;iBAC3C,CAAA;YACH,CAAC;SACF,CAAC,CAAA;QACF,MAAM,WAAW,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,CAAA;QACjD,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAA;QACzC,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAA;QAC7C,MAAM,QAAQ,GAAG,OAAO,CAAC,gBAAgB,IAAI,EAAE,CAAA;QAC/C,SAAS,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAA;QAE3B,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACjC,WAAW,CAAC,IAAI,CAAC,+CAAqB,CAAC,CAAA;QACzC,CAAC;QACD,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;YACpC,WAAW,CAAC,IAAI,CAAC,sCAAiB,CAAC,CAAA;QACrC,CAAC;QAED,OAAO,CAAC,IAAI,CACV,IAAA,+BAAwB,EAAC,yDAA6B,EAAE;YACtD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,gBAAgB,EAAE,QAAQ;YAC1B,yBAAyB,EAAE,OAAO,CAAC,yBAAyB;SAC7D,CAAC,CACH,CAAA;QAED,OAAO,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,CAAA;IACrD,CAAC;CACF,CAAA;AAjEY,sCAAa;wBAAb,aAAa;IALzB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,sBAAe,EAAE,kBAAW,CAAC;QACvC,SAAS,EAAE,CAAC,gCAAc,EAAE,yCAAkB,CAAC;QAC/C,OAAO,EAAE,CAAC,gCAAc,EAAE,yCAAkB,CAAC;KAC9C,CAAC;GACW,aAAa,CAiEzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mbc-cqrs-serverless/ui-setting",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "description": "Setting master data",
   "keywords": [
     "mbc",
@@ -41,7 +41,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@mbc-cqrs-serverless/core": "1.3.4"
+    "@mbc-cqrs-serverless/core": "1.4.0"
   },
-  "gitHead": "e5b2e10fe73ebd89bf26b23942752d4ebe79388e"
+  "gitHead": "972a2726e2696e94e988dfc3135086b13cf2345b"
 }