@common-stack/server-core 7.2.1-alpha.31 → 7.2.1-alpha.32

package/lib/moleculer-generation/typedProxyService.d.ts

@@ -0,0 +1,116 @@
+/**
+ * @file typed-proxy-service.ts
+ * @description Provides utilities for auto-generating proxy service methods
+ * with type-safe Zod schema validation from service interfaces.
+ *
+ * This allows proxy services to be lightweight and automatically stay in sync
+ * with their corresponding Moleculer services.
+ */
+import type { ServiceBroker } from 'moleculer';
+import type { CdmLogger } from '@cdm-logger/core';
+import type { z } from 'zod';
+import { type ExcludedServiceMethods } from './serviceGenerationUtils';
+/**
+ * Exclude base service CRUD methods and lifecycle methods from auto-generation
+ * @deprecated Use ExcludedServiceMethods from serviceGenerationUtils instead
+ */
+type ExcludedProxyMethods = ExcludedServiceMethods;
+/**
+ * Extract all method names from a service interface (excluding base methods)
+ */
+export type ProxyServiceMethods<T> = {
+    [K in keyof T]: T[K] extends Function ? (K extends ExcludedProxyMethods ? never : K) : never;
+}[keyof T];
+/**
+ * Configuration for auto-generating proxy service methods
+ */
+export type AutoProxyServiceConfig<TService> = {
+    /**
+     * Zod schemas for method parameters
+     * Maps method names to their Zod schema objects
+     */
+    schemas: Partial<{
+        [K in ProxyServiceMethods<TService>]: z.ZodObject<any>;
+    }>;
+    /**
+     * Optional: Override the action name for specific methods
+     * By default, action name is the method name
+     */
+    actionNameOverrides?: Partial<{
+        [K in ProxyServiceMethods<TService>]: string;
+    }>;
+    /**
+     * Optional: Include only specific methods
+     * If not specified, all non-excluded methods are included
+     */
+    include?: Array<ProxyServiceMethods<TService>>;
+    /**
+     * Optional: Exclude specific methods
+     * Takes precedence over include
+     */
+    exclude?: Array<ProxyServiceMethods<TService>>;
+};
+/**
+ * Auto-generate proxy service methods from service interface and Zod schemas
+ * Returns the proxy instance cast to the service type for type safety
+ *
+ * @example
+ * ```typescript
+ * export class TagProxyService extends BaseProxyService2<ITagModel> {
+ *     protected logger: CdmLogger.ILogger;
+ *     protected topic = MoleculerTopics.Tag;
+ *
+ *     constructor(
+ *         @inject(SERVER_TYPES.ITagRepository) protected tagRepository: ITagRepository,
+ *         @inject(CommonType.MOLECULER_BROKER) broker: ServiceBroker,
+ *         @inject('Logger') logger: CdmLogger.ILogger,
+ *     ) {
+ *         super(broker, logger);
+ *         this.logger = logger.child({ className: 'TagProxyService' });
+ *
+ *         // 🎉 Auto-generate all proxy methods - just pass interface type and schemas!
+ *         return generateProxyMethods<ITagService>(this, TagServiceSchemas);
+ *     }
+ * }
+ * ```
+ */
+export declare function generateProxyMethods<TService>(proxyInstance: any, schemasOrConfig: Partial<{
+    [K in ProxyServiceMethods<TService>]: z.ZodObject<any>;
+}> | AutoProxyServiceConfig<TService>, broker: ServiceBroker, logger: CdmLogger.ILogger): asserts proxyInstance is TService;
+/**
+ * Namespace for proxy service utilities
+ */
+export declare namespace ProxyService {
+    /**
+     * Generate proxy methods from service interface and Zod schemas
+     */
+    const generate: typeof generateProxyMethods;
+    /**
+     * Debug utility: List all methods that would be generated
+     */
+    function debugProxyMethods<TService>(servicePrototype: any, config: AutoProxyServiceConfig<TService>): {
+        methodName: string;
+        hasSchema: boolean;
+        paramNames: string[];
+        isIncluded: boolean;
+        isExcluded: boolean;
+    }[];
+    /**
+     * Print debug information about proxy methods
+     */
+    function printProxyMethods<TService>(servicePrototype: any, config: AutoProxyServiceConfig<TService>, options?: {
+        onlyMissingSchemas?: boolean;
+        onlyIncluded?: boolean;
+    }): void;
+}
+/**
+ * Helper type to create a fully typed proxy service class
+ * This ensures the proxy implements all methods from the service interface
+ */
+export type TypedProxyService<TService> = TService & {
+    broker: ServiceBroker;
+    logger: CdmLogger.ILogger;
+    topic: string;
+    callAction<T, P = unknown>(command: string, params?: P): Promise<T>;
+};
+export {};

package/lib/moleculer-generation/typedProxyService.js

@@ -0,0 +1,205 @@
+import {isExcludedMethod,getAllMethodNames,getActionName,buildActionPath}from'./serviceGenerationUtils.js';// from package: store-mongo
+/**
+ * @file typed-proxy-service.ts
+ * @description Provides utilities for auto-generating proxy service methods
+ * with type-safe Zod schema validation from service interfaces.
+ *
+ * This allows proxy services to be lightweight and automatically stay in sync
+ * with their corresponding Moleculer services.
+ */
+/**
+ * Extract parameter names from a Zod schema object
+ */
+function extractParamNamesFromZodSchema(schema) {
+    try {
+        const { shape } = schema;
+        return Object.keys(shape);
+    }
+    catch (error) {
+        return [];
+    }
+}
+/**
+ * Add base proxy functionality to an instance
+ * Provides the callAction method that all proxy services need
+ */
+function addProxyBase(proxyInstance, broker, logger) {
+    // Add broker and logger
+    Object.defineProperty(proxyInstance, 'broker', {
+        value: broker,
+        writable: false,
+        enumerable: false,
+        configurable: false,
+    });
+    Object.defineProperty(proxyInstance, 'logger', {
+        value: logger,
+        writable: true,
+        enumerable: false,
+        configurable: false,
+    });
+    // Add callAction method
+    // eslint-disable-next-line no-param-reassign
+    proxyInstance.callAction = function callAction(command, params) {
+        const { topic } = this;
+        // Use shared utility for consistent action path building
+        const actionPath = buildActionPath(topic, command);
+        this.logger?.trace?.(`[ProxyService] Calling action: ${actionPath}`, { params });
+        return broker.call(actionPath, params);
+    };
+}
+/**
+ * Auto-generate proxy service methods from service interface and Zod schemas
+ * Returns the proxy instance cast to the service type for type safety
+ *
+ * @example
+ * ```typescript
+ * export class TagProxyService extends BaseProxyService2<ITagModel> {
+ *     protected logger: CdmLogger.ILogger;
+ *     protected topic = MoleculerTopics.Tag;
+ *
+ *     constructor(
+ *         @inject(SERVER_TYPES.ITagRepository) protected tagRepository: ITagRepository,
+ *         @inject(CommonType.MOLECULER_BROKER) broker: ServiceBroker,
+ *         @inject('Logger') logger: CdmLogger.ILogger,
+ *     ) {
+ *         super(broker, logger);
+ *         this.logger = logger.child({ className: 'TagProxyService' });
+ *
+ *         // 🎉 Auto-generate all proxy methods - just pass interface type and schemas!
+ *         return generateProxyMethods<ITagService>(this, TagServiceSchemas);
+ *     }
+ * }
+ * ```
+ */
+function generateProxyMethods(proxyInstance, schemasOrConfig, broker, logger) {
+    // Normalize input - support both schemas object directly or config object
+    const config = 'schemas' in schemasOrConfig
+        ? schemasOrConfig
+        : { schemas: schemasOrConfig };
+    const { schemas, include, exclude, actionNameOverrides } = config;
+    // Add base proxy functionality (broker, logger, callAction)
+    addProxyBase(proxyInstance, broker, logger);
+    // Get all method names from the schemas object (primary source of truth)
+    // This ensures ALL schema-defined methods are generated
+    const schemaMethodNames = Object.keys(schemas);
+    // Filter methods
+    const methodsToGenerate = schemaMethodNames.filter((methodName) => {
+        // Skip excluded base methods
+        if (isExcludedMethod(methodName)) {
+            return false;
+        }
+        // Skip if explicitly excluded
+        if (exclude && exclude.includes(methodName)) {
+            return false;
+        }
+        // If include list is provided, only include those
+        if (include && !include.includes(methodName)) {
+            return false;
+        }
+        return true;
+    });
+    // Generate methods
+    for (const methodName of methodsToGenerate) {
+        const schema = schemas[methodName];
+        if (!schema) {
+            // eslint-disable-next-line no-continue
+            continue;
+        }
+        // Determine action name using shared utility for consistency
+        // Convention: Use camelCase (method name as-is) to match Moleculer service actions
+        let actionName;
+        if (actionNameOverrides && actionNameOverrides[methodName]) {
+            actionName = actionNameOverrides[methodName];
+        }
+        else {
+            // Use shared utility to ensure consistency with Moleculer service
+            actionName = getActionName(methodName);
+        }
+        // Extract parameter names from Zod schema
+        const paramNames = extractParamNamesFromZodSchema(schema);
+        // Generate the proxy method
+        // eslint-disable-next-line no-param-reassign, func-names
+        proxyInstance[methodName] = function proxyMethod(...args) {
+            // Build params object from arguments
+            const params = {};
+            if (paramNames.length === 1 && args.length === 1 && typeof args[0] === 'object') {
+                // If single param and single object argument, use it directly
+                Object.assign(params, args[0]);
+            }
+            else {
+                // Map positional arguments to parameter names
+                paramNames.forEach((paramName, index) => {
+                    if (index < args.length) {
+                        params[paramName] = args[index];
+                    }
+                });
+            }
+            // Validate with Zod schema (optional - can be skipped for performance)
+            try {
+                schema.parse(params);
+            }
+            catch (error) {
+                console.warn(`[ProxyService] Zod validation failed for ${methodName}:`, error);
+                // Continue anyway - let Moleculer service handle validation
+            }
+            // Call the Moleculer action
+            return this.callAction(actionName, params);
+        };
+    }
+}
+/**
+ * Namespace for proxy service utilities
+ */
+var ProxyService;
+(function (ProxyService) {
+    /**
+     * Generate proxy methods from service interface and Zod schemas
+     */
+    ProxyService.generate = generateProxyMethods;
+    /**
+     * Debug utility: List all methods that would be generated
+     */
+    function debugProxyMethods(servicePrototype, config) {
+        const { schemas, include, exclude } = config;
+        const allMethods = getAllMethodNames(servicePrototype);
+        return allMethods
+            .filter((methodName) => !isExcludedMethod(methodName))
+            .map((methodName) => {
+            const schema = schemas[methodName];
+            const paramNames = schema ? extractParamNamesFromZodSchema(schema) : [];
+            return {
+                methodName,
+                hasSchema: !!schema,
+                paramNames,
+                isIncluded: !include || include.includes(methodName),
+                isExcluded: !!exclude && exclude.includes(methodName),
+            };
+        });
+    }
+    ProxyService.debugProxyMethods = debugProxyMethods;
+    /**
+     * Print debug information about proxy methods
+     */
+    function printProxyMethods(servicePrototype, config, options) {
+        const methods = debugProxyMethods(servicePrototype, config);
+        const filtered = methods.filter((m) => {
+            if (options?.onlyMissingSchemas && m.hasSchema)
+                return false;
+            if (options?.onlyIncluded && !m.isIncluded)
+                return false;
+            return true;
+        });
+        console.log('\n=== Proxy Service Methods Debug ===\n');
+        filtered.forEach((m) => {
+            console.log(`${m.methodName}:`);
+            console.log(`  - Has Schema: ${m.hasSchema}`);
+            console.log(`  - Included: ${m.isIncluded}`);
+            console.log(`  - Excluded: ${m.isExcluded}`);
+            if (m.paramNames.length > 0) {
+                console.log(`  - Params: ${m.paramNames.join(', ')}`);
+            }
+            console.log('');
+        });
+    }
+    ProxyService.printProxyMethods = printProxyMethods;
+})(ProxyService || (ProxyService = {}));export{ProxyService,generateProxyMethods};//# sourceMappingURL=typedProxyService.js.map

package/lib/moleculer-generation/typedProxyService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedProxyService.js","sources":["../../src/moleculer-generation/typedProxyService.ts"],"sourcesContent":[null],"names":[],"mappings":"2GAAA;AACA;;;;;;;AAOG;AAgEH;;AAEG;AACH,SAAS,8BAA8B,CAAC,MAAwB,EAAA;AAC5D,IAAA,IAAI;AACA,QAAA,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;AACzB,QAAA,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAC7B;IAAC,OAAO,KAAK,EAAE;AACZ,QAAA,OAAO,EAAE,CAAC;KACb;AACL,CAAC;AAED;;;AAGG;AACH,SAAS,YAAY,CAAC,aAAkB,EAAE,MAAqB,EAAE,MAAyB,EAAA;;AAEtF,IAAA,MAAM,CAAC,cAAc,CAAC,aAAa,EAAE,QAAQ,EAAE;AAC3C,QAAA,KAAK,EAAE,MAAM;AACb,QAAA,QAAQ,EAAE,KAAK;AACf,QAAA,UAAU,EAAE,KAAK;AACjB,QAAA,YAAY,EAAE,KAAK;AACtB,KAAA,CAAC,CAAC;AAEH,IAAA,MAAM,CAAC,cAAc,CAAC,aAAa,EAAE,QAAQ,EAAE;AAC3C,QAAA,KAAK,EAAE,MAAM;AACb,QAAA,QAAQ,EAAE,IAAI;AACd,QAAA,UAAU,EAAE,KAAK;AACjB,QAAA,YAAY,EAAE,KAAK;AACtB,KAAA,CAAC,CAAC;;;IAIH,aAAa,CAAC,UAAU,GAAG,SAAS,UAAU,CAA4B,OAAe,EAAE,MAAU,EAAA;AACjG,QAAA,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;;QAEvB,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAEnD,QAAA,IAAI,CAAC,MAAM,EAAE,KAAK,GAAG,CAAA,+BAAA,EAAkC,UAAU,CAAA,CAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAEjF,OAAO,MAAM,CAAC,IAAI,CAAO,UAAU,EAAE,MAAW,CAAC,CAAC;AACtD,KAAC,CAAC;AACN,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;AAuBG;AACG,SAAU,oBAAoB,CAChC,aAAkB,EAClB,eAEsC,EACtC,MAAqB,EACrB,MAAyB,EAAA;;AAGzB,IAAA,MAAM,MAAM,GACR,SAAS,IAAI,eAAe;AACxB,UAAG,eAAoD;AACvD,UAAE,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;IAEvC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;;AAGlE,IAAA,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;;;IAO5C,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;;IAG/C,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,UAAU,KAAI;;AAE9D,QAAA,IAAI,gBAAgB,CAAC,UAAU,CAAC,EAAE;AAC9B,YAAA,OAAO,KAAK,CAAC;SAChB;;QAGD,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,UAAiB,CAAC,EAAE;AAChD,YAAA,OAAO,KAAK,CAAC;SAChB;;QAGD,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAiB,CAAC,EAAE;AACjD,YAAA,OAAO,KAAK,CAAC;SAChB;AAED,QAAA,OAAO,IAAI,CAAC;AAChB,KAAC,CAAC,CAAC;;AAGH,IAAA,KAAK,MAAM,UAAU,IAAI,iBAAiB,EAAE;AACxC,QAAA,MAAM,MAAM,GAAG,OAAO,CAAC,UAAkC,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,EAAE;;YAET,SAAS;SACZ;;;AAID,QAAA,IAAI,UAAkB,CAAC;AACvB,QAAA,IAAI,mBAAmB,IAAI,mBAAmB,CAAC,UAA8C,CAAC,EAAE;AAC5F,YAAA,UAAU,GAAG,mBAAmB,CAAC,UAA8C,CAAW,CAAC;SAC9F;aAIM;;AAEH,YAAA,UAAU,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC;SAC1C;;AAGD,QAAA,MAAM,UAAU,GAAG,8BAA8B,CAAC,MAA0B,CAAC,CAAC;;;QAI9E,aAAa,CAAC,UAAU,CAAC,GAAG,SAAS,WAAW,CAAY,GAAG,IAAW,EAAA;;YAEtE,MAAM,MAAM,GAAwB,EAAE,CAAC;YAEvC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;;gBAE7E,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;aAClC;iBAAM;;gBAEH,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,KAAK,KAAI;AACpC,oBAAA,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE;wBACrB,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;qBACnC;AACL,iBAAC,CAAC,CAAC;aACN;;AAGD,YAAA,IAAI;AACC,gBAAA,MAA2B,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;aAC9C;YAAC,OAAO,KAAK,EAAE;gBACZ,OAAO,CAAC,IAAI,CAAC,CAAA,yCAAA,EAA4C,UAAU,CAAG,CAAA,CAAA,EAAE,KAAK,CAAC,CAAC;;aAElF;;YAGD,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAC/C,SAAC,CAAC;KACL;AACL,CAAC;AAED;;AAEG;AACG,IAAW,aAoEhB;AApED,CAAA,UAAiB,YAAY,EAAA;AACzB;;AAEG;IACU,YAAQ,CAAA,QAAA,GAAG,oBAAoB,CAAC;AAE7C;;AAEG;AACH,IAAA,SAAgB,iBAAiB,CAC7B,gBAAqB,EACrB,MAAwC,EAAA;QAQxC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;AAC7C,QAAA,MAAM,UAAU,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;AAEvD,QAAA,OAAO,UAAU;aACZ,MAAM,CAAC,CAAC,UAAU,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;AACrD,aAAA,GAAG,CAAC,CAAC,UAAU,KAAI;AAChB,YAAA,MAAM,MAAM,GAAG,OAAO,CAAC,UAAkC,CAAC,CAAC;AAC3D,YAAA,MAAM,UAAU,GAAG,MAAM,GAAG,8BAA8B,CAAC,MAA0B,CAAC,GAAG,EAAE,CAAC;YAE5F,OAAO;gBACH,UAAU;gBACV,SAAS,EAAE,CAAC,CAAC,MAAM;gBACnB,UAAU;gBACV,UAAU,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,UAAiB,CAAC;gBAC3D,UAAU,EAAE,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,UAAiB,CAAC;aAC/D,CAAC;AACN,SAAC,CAAC,CAAC;KACV;AA3Be,IAAA,YAAA,CAAA,iBAAiB,oBA2BhC,CAAA;AAED;;AAEG;AACH,IAAA,SAAgB,iBAAiB,CAC7B,gBAAqB,EACrB,MAAwC,EACxC,OAGC,EAAA;QAED,MAAM,OAAO,GAAG,iBAAiB,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAI;AAClC,YAAA,IAAI,OAAO,EAAE,kBAAkB,IAAI,CAAC,CAAC,SAAS;AAAE,gBAAA,OAAO,KAAK,CAAC;AAC7D,YAAA,IAAI,OAAO,EAAE,YAAY,IAAI,CAAC,CAAC,CAAC,UAAU;AAAE,gBAAA,OAAO,KAAK,CAAC;AACzD,YAAA,OAAO,IAAI,CAAC;AAChB,SAAC,CAAC,CAAC;AAEH,QAAA,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;AACvD,QAAA,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,KAAI;YACnB,OAAO,CAAC,GAAG,CAAC,CAAA,EAAG,CAAC,CAAC,UAAU,CAAG,CAAA,CAAA,CAAC,CAAC;YAChC,OAAO,CAAC,GAAG,CAAC,CAAA,gBAAA,EAAmB,CAAC,CAAC,SAAS,CAAE,CAAA,CAAC,CAAC;YAC9C,OAAO,CAAC,GAAG,CAAC,CAAA,cAAA,EAAiB,CAAC,CAAC,UAAU,CAAE,CAAA,CAAC,CAAC;YAC7C,OAAO,CAAC,GAAG,CAAC,CAAA,cAAA,EAAiB,CAAC,CAAC,UAAU,CAAE,CAAA,CAAC,CAAC;YAC7C,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;AACzB,gBAAA,OAAO,CAAC,GAAG,CAAC,CAAA,YAAA,EAAe,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,CAAE,CAAC,CAAC;aACzD;AACD,YAAA,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AACpB,SAAC,CAAC,CAAC;KACN;AA1Be,IAAA,YAAA,CAAA,iBAAiB,oBA0BhC,CAAA;AACL,CAAC,EApEgB,YAAY,KAAZ,YAAY,GAoE5B,EAAA,CAAA,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@common-stack/server-core",
-    "version": "7.2.1-alpha.31",
+    "version": "7.2.1-alpha.32",
     "description": "common core for higher packages to depend on",
     "license": "ISC",
     "author": "CDMBase LLC",
@@ -33,7 +33,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "5067fc1b656efe968ae646df72bfa3dbc9fff7f9",
+    "gitHead": "6585d3213eab8f5db2bb43f8c15768b070404f21",
     "typescript": {
         "definition": "lib/index.d.ts"
     }