@zdavison/nestjs-rpc-toolkit 0.0.11 → 0.0.13

package/dist/decorators/rpc-method.decorator.js

@@ -1,33 +1,83 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RpcMethod = RpcMethod;
-const microservices_1 = require("@nestjs/microservices");
-const rpc_registry_1 = require("../rpc/rpc-registry");
 require("reflect-metadata");
+/**
+ * RPC Method decorator with compile-time serialization validation.
+ * Ensures all parameters and return types are JSON-serializable for TCP transport.
+ * Pattern is automatically generated from the class name or @Controller decorator.
+ *
+ * @example
+ * ```typescript
+ * @RpcMethod()
+ * async findUser(id: string): Promise<User> {
+ *   // ✅ Valid: string param, User return type are serializable
+ *   // Pattern: auto-generated as 'user.findUser' or 'controllerName.findUser'
+ *   return this.userRepo.findById(id);
+ * }
+ *
+ * @RpcMethod()
+ * async invalidMethod(callback: (data: string) => void): Promise<HTMLElement> {
+ *   // ❌ Error: callback and HTMLElement are not serializable
+ * }
+ * ```
+ */
 function RpcMethod() {
     return function (target, propertyKey, descriptor) {
         const originalMethod = descriptor.value;
-        const module = Reflect.getMetadata('rpc:module', target.constructor);
-        if (!module) {
-            throw new Error(`@RpcMethod can only be used in classes decorated with @RpcController. Class: ${target.constructor.name}`);
-        }
-        const methodName = propertyKey;
-        const actualPattern = `${module}.${methodName}`;
-        const metadata = {
-            pattern: actualPattern,
-            module,
-            methodName,
-            target: target.constructor,
-            propertyKey,
+        // Defer the module lookup and pattern registration until runtime
+        // This is necessary because method decorators execute before class decorators
+        const getModuleAndPattern = () => {
+            const module = Reflect.getMetadata('rpc:module', target.constructor);
+            if (!module) {
+                throw new Error(`@RpcMethod can only be used in classes decorated with @RpcController. Class: ${target.constructor.name}`);
+            }
+            return {
+                module,
+                pattern: `${module}.${propertyKey}`
+            };
         };
-        rpc_registry_1.rpcRegistry.registerMethod(metadata);
-        descriptor.value = function (args) {
-            if (Array.isArray(args)) {
-                return originalMethod.apply(this, args);
+        // Create wrapper method that handles RPC parameter unwrapping
+        descriptor.value = function (...args) {
+            // Defer the module check until the method is actually called
+            // This allows the class decorator to run first
+            getModuleAndPattern();
+            // NestJS microservices sends parameters as a single object: { paramName: value }
+            // We need to unwrap this and pass the actual values to the method
+            let unwrappedArgs = args;
+            if (args.length === 1 && typeof args[0] === 'object' && args[0] !== null) {
+                // Extract parameter names from the original method
+                const methodStr = originalMethod.toString();
+                const paramMatch = methodStr.match(/^(?:async\s+)?(?:function\s*)?\w*\s*\(([^)]*)\)/);
+                if (paramMatch) {
+                    const paramNames = paramMatch[1]
+                        .split(',')
+                        .map(p => p.trim().split(/[:\s=]/)[0])
+                        .filter(p => p.length > 0);
+                    // If the incoming object has exactly the parameter names as keys, unwrap them
+                    const incomingKeys = Object.keys(args[0]);
+                    if (paramNames.length > 0 && incomingKeys.length === paramNames.length) {
+                        const allMatch = paramNames.every(name => incomingKeys.includes(name));
+                        if (allMatch) {
+                            unwrappedArgs = paramNames.map(name => args[0][name]);
+                        }
+                    }
+                }
             }
-            return originalMethod.call(this, args);
+            // Call the original method with the unwrapped arguments
+            return originalMethod.apply(this, unwrappedArgs);
         };
-        (0, microservices_1.MessagePattern)(actualPattern)(target, propertyKey, descriptor);
+        // Store the method for lazy pattern registration
+        // We'll register it when @RpcController is applied
+        if (!Reflect.hasMetadata('rpc:pending-methods', target.constructor)) {
+            Reflect.defineMetadata('rpc:pending-methods', [], target.constructor);
+        }
+        const pendingMethods = Reflect.getMetadata('rpc:pending-methods', target.constructor);
+        pendingMethods.push({
+            propertyKey,
+            originalMethod,
+            descriptor,
+        });
     };
 }
 //# sourceMappingURL=rpc-method.decorator.js.map

package/dist/decorators/rpc-method.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"rpc-method.decorator.js","sourceRoot":"","sources":["../../src/decorators/rpc-method.decorator.ts"],"names":[],"mappings":";;AAyBA,8BA6CC;AAtED,yDAA6E;AAC7E,sDAAqE;AAErE,4BAA0B;AAsB1B,SAAgB,SAAS;IAKvB,OAAO,UACL,MAAW,EACX,WAAmB,EACnB,UAAsC;QAEtC,MAAM,cAAc,GAAG,UAAU,CAAC,KAAM,CAAC;QAGzC,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QAErE,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,gFAAgF,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7H,CAAC;QAGD,MAAM,UAAU,GAAG,WAAW,CAAC;QAC/B,MAAM,aAAa,GAAG,GAAG,MAAM,IAAI,UAAU,EAAE,CAAC;QAGhD,MAAM,QAAQ,GAAsB;YAClC,OAAO,EAAE,aAAa;YACtB,MAAM;YACN,UAAU;YACV,MAAM,EAAE,MAAM,CAAC,WAAW;YAC1B,WAAW;SACZ,CAAC;QACF,0BAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAGrC,UAAU,CAAC,KAAK,GAAG,UAAqB,IAAW;YAEjD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxB,OAAO,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1C,CAAC;YACD,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACzC,CAAQ,CAAC;QAGT,IAAA,8BAAkB,EAAC,aAAa,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"rpc-method.decorator.js","sourceRoot":"","sources":["../../src/decorators/rpc-method.decorator.ts"],"names":[],"mappings":";;AAuBA,8BAqEC;AA3FD,4BAA0B;AAE1B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,SAAS;IACvB,OAAO,UACL,MAAW,EACX,WAAmB,EACnB,UAA+D;QAE/D,MAAM,cAAc,GAAG,UAAU,CAAC,KAAM,CAAC;QAEzC,iEAAiE;QACjE,8EAA8E;QAC9E,MAAM,mBAAmB,GAAG,GAAG,EAAE;YAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;YACrE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,gFAAgF,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;YAC7H,CAAC;YACD,OAAO;gBACL,MAAM;gBACN,OAAO,EAAE,GAAG,MAAM,IAAI,WAAW,EAAE;aACpC,CAAC;QACJ,CAAC,CAAC;QAEF,8DAA8D;QAC9D,UAAU,CAAC,KAAK,GAAG,UAAqB,GAAG,IAAW;YACpD,6DAA6D;YAC7D,+CAA+C;YAC/C,mBAAmB,EAAE,CAAC;YAEtB,iFAAiF;YACjF,kEAAkE;YAClE,IAAI,aAAa,GAAG,IAAI,CAAC;YAEzB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBACzE,mDAAmD;gBACnD,MAAM,SAAS,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAC;gBAC5C,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;gBAEtF,IAAI,UAAU,EAAE,CAAC;oBACf,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC;yBAC7B,KAAK,CAAC,GAAG,CAAC;yBACV,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;yBACrC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBAE7B,8EAA8E;oBAC9E,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1C,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,YAAY,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;wBACvE,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;wBACvE,IAAI,QAAQ,EAAE,CAAC;4BACb,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;wBACxD,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAED,wDAAwD;YACxD,OAAO,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,aAAoB,CAAC,CAAC;QAC1D,CAAQ,CAAC;QAET,iDAAiD;QACjD,mDAAmD;QACnD,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;YACpE,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,EAAE,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QACxE,CAAC;QACD,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QACtF,cAAc,CAAC,IAAI,CAAC;YAClB,WAAW;YACX,cAAc;YACd,UAAU;SACX,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}

package/dist/generators/rpc-types-generator.d.ts

@@ -1,4 +1,5 @@
 export interface RpcGenerationConfig {
+    /** Package paths to scan for RPC methods. Supports glob patterns like 'packages/modules/*' */
     packages: string[];
     outputDir: string;
 }
@@ -25,11 +26,12 @@ export declare class RpcTypesGenerator {
     private extractTypesFromFile;
     private extractInterface;
     private extractClassAsInterface;
+    private extractTypeAlias;
     private isRelevantInterface;
     private getModuleForFile;
     private isInternalType;
     private processMethod;
-    private extractPattern;
+    private extractJsDoc;
     private generateTypesFile;
     private generateModuleTypesFile;
     private generateMainTypesFile;

package/dist/generators/rpc-types-generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rpc-types-generator.d.ts","sourceRoot":"","sources":["../../src/generators/rpc-types-generator.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,mBAAmB;IAElC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB;AAiBD,qBAAa,iBAAiB;IAShB,OAAO,CAAC,OAAO;IAR3B,OAAO,CAAC,QAAQ,CAAmC;IACnD,OAAO,CAAC,UAAU,CAAuB;IACzC,OAAO,CAAC,UAAU,CAA+C;IACjE,OAAO,CAAC,MAAM,CAAsB;IACpC,OAAO,CAAC,YAAY,CAAoC;IACxD,OAAO,CAAC,gBAAgB,CAAgB;IACxC,OAAO,CAAC,eAAe,CAAkC;gBAErC,OAAO,EAAE,gBAAgB;IAa7C,OAAO,CAAC,kBAAkB;IA+B1B,OAAO,CAAC,wBAAwB;IA2BhC,OAAO,CAAC,sBAAsB;IA6B9B,OAAO,CAAC,UAAU;IAOlB,QAAQ,IAAI,IAAI;IAqChB,OAAO,CAAC,iBAAiB;IAsBzB,OAAO,CAAC,oBAAoB;IAU5B,OAAO,CAAC,gBAAgB;IAcxB,OAAO,CAAC,uBAAuB;IAmC/B,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,gBAAgB;IAqBxB,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,aAAa;IA8ErB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,iBAAiB;IA4BzB,OAAO,CAAC,uBAAuB;IAiE/B,OAAO,CAAC,qBAAqB;IAqH7B,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,eAAe;IAcvB,OAAO,CAAC,eAAe;IAavB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,gBAAgB;IAoBxB,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,yBAAyB;CA0ClC"}
+{"version":3,"file":"rpc-types-generator.d.ts","sourceRoot":"","sources":["../../src/generators/rpc-types-generator.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,mBAAmB;IAClC,8FAA8F;IAC9F,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB;AAoBD,qBAAa,iBAAiB;IAShB,OAAO,CAAC,OAAO;IAR3B,OAAO,CAAC,QAAQ,CAAmC;IACnD,OAAO,CAAC,UAAU,CAAuB;IACzC,OAAO,CAAC,UAAU,CAA+C;IACjE,OAAO,CAAC,MAAM,CAAsB;IACpC,OAAO,CAAC,YAAY,CAAoC;IACxD,OAAO,CAAC,gBAAgB,CAAgB;IACxC,OAAO,CAAC,eAAe,CAAkC;gBAErC,OAAO,EAAE,gBAAgB;IAa7C,OAAO,CAAC,kBAAkB;IA+B1B,OAAO,CAAC,wBAAwB;IA2BhC,OAAO,CAAC,sBAAsB;IA6B9B,OAAO,CAAC,UAAU;IAOlB,QAAQ,IAAI,IAAI;IAqChB,OAAO,CAAC,iBAAiB;IAsBzB,OAAO,CAAC,oBAAoB;IAY5B,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,uBAAuB;IA4D/B,OAAO,CAAC,gBAAgB;IA0BxB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,gBAAgB;IAqBxB,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,aAAa;IA6FrB,OAAO,CAAC,YAAY;IASpB,OAAO,CAAC,iBAAiB;IA4BzB,OAAO,CAAC,uBAAuB;IA8F/B,OAAO,CAAC,qBAAqB;IAyK7B,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,eAAe;IAcvB,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,gBAAgB;IAoBxB,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,yBAAyB;CAqElC"}