@themainstack/communication 1.0.2 → 1.1.0

package/README.md

@@ -182,6 +182,7 @@ See `examples/full-grpc-demo.ts` in the repository for a complete working exampl
 ### Proto Generation
 - `generateProtoFromMethods(methods, options)` - Generate proto with service definition
 - `generateProtoFromFunction(fn, name)` - Generate proto for a single message
+- `AnyType` - Marker symbol for `google.protobuf.Any` dynamic fields
 
 ### Server
 - `GrpcServerFactory.createServer(options, handlers)` - Create a gRPC server

package/dist/index.d.ts

@@ -9,7 +9,7 @@
  * 3. Client Factory - Call gRPC services from other services
  * 4. Error Handling - Standardized error translation
  */
-export { generateProtoFromMethods, generateProtoFromFunction } from './proto-generator';
+export { generateProtoFromMethods, generateProtoFromFunction, AnyType } from './proto-generator';
 export type { MethodDefinition, GenerateProtoOptions } from './proto-generator';
 export { GrpcServerFactory, exposeAsGrpc } from './grpc/server-factory';
 export type { GrpcServerOptions, ServerMethodHandler } from './grpc/server-factory';

package/dist/index.js

@@ -11,12 +11,13 @@
  * 4. Error Handling - Standardized error translation
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GrpcError = exports.handleGrpcError = exports.GrpcClientFactory = exports.exposeAsGrpc = exports.GrpcServerFactory = exports.generateProtoFromFunction = exports.generateProtoFromMethods = void 0;
+exports.GrpcError = exports.handleGrpcError = exports.GrpcClientFactory = exports.exposeAsGrpc = exports.GrpcServerFactory = exports.AnyType = exports.generateProtoFromFunction = exports.generateProtoFromMethods = void 0;
 // Proto Generation
 // Auto-generate .proto files from TypeScript types
 var proto_generator_1 = require("./proto-generator");
 Object.defineProperty(exports, "generateProtoFromMethods", { enumerable: true, get: function () { return proto_generator_1.generateProtoFromMethods; } });
 Object.defineProperty(exports, "generateProtoFromFunction", { enumerable: true, get: function () { return proto_generator_1.generateProtoFromFunction; } });
+Object.defineProperty(exports, "AnyType", { enumerable: true, get: function () { return proto_generator_1.AnyType; } });
 // Server Factory
 // Expose existing functions as gRPC endpoints
 var server_factory_1 = require("./grpc/server-factory");

package/dist/proto-generator/index.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Marker symbol to indicate a field should use google.protobuf.Any type.
+ * Use this in your sample objects to mark dynamic/generic fields.
+ *
+ * @example
+ * requestSample: () => ({ id: '', data: AnyType })
+ */
+export declare const AnyType: unique symbol;
 /**
  * Options for generating a proto file
  */
@@ -10,6 +18,8 @@ export interface GenerateProtoOptions {
     outputDir?: string;
     /** Output filename (default: derived from serviceName or 'generated.proto') */
     outputFilename?: string;
+    /** Enable google.protobuf.Any for dynamic types marked with AnyType symbol (default: true) */
+    enableAnyType?: boolean;
 }
 /**
  * Definition of a gRPC method with request and response generators

package/dist/proto-generator/index.js

@@ -33,10 +33,19 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnyType = void 0;
 exports.generateProtoFromMethods = generateProtoFromMethods;
 exports.generateProtoFromFunction = generateProtoFromFunction;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
+/**
+ * Marker symbol to indicate a field should use google.protobuf.Any type.
+ * Use this in your sample objects to mark dynamic/generic fields.
+ *
+ * @example
+ * requestSample: () => ({ id: '', data: AnyType })
+ */
+exports.AnyType = Symbol('google.protobuf.Any');
 /**
  * Generate a complete .proto file from method definitions
  *
@@ -45,10 +54,11 @@ const path = __importStar(require("path"));
  * @returns The generated proto string
  */
 function generateProtoFromMethods(methods, options = {}) {
-    const { packageName, serviceName = 'GeneratedService', outputDir, outputFilename } = options;
+    const { packageName, serviceName = 'GeneratedService', outputDir, outputFilename, enableAnyType = true } = options;
     const messages = [];
     const protoMethods = [];
     const processedObjects = new Set();
+    let usesAnyType = false;
     // Helper: Capitalize string
     function capitalize(s) {
         return s.charAt(0).toUpperCase() + s.slice(1);
@@ -72,7 +82,12 @@ function generateProtoFromMethods(methods, options = {}) {
             let type = "string";
             let rule = undefined;
             const valueType = typeof value;
-            if (value === null || value === undefined) {
+            // Check for AnyType marker symbol
+            if (enableAnyType && (value === exports.AnyType || (typeof value === 'symbol' && value.description === 'google.protobuf.Any'))) {
+                type = "google.protobuf.Any";
+                usesAnyType = true;
+            }
+            else if (value === null || value === undefined) {
                 type = "string";
             }
             else if (valueType === "string") {
@@ -140,6 +155,10 @@ function generateProtoFromMethods(methods, options = {}) {
     if (packageName) {
         lines.push(`package ${packageName};`, '');
     }
+    // Add google.protobuf.Any import if needed
+    if (usesAnyType) {
+        lines.push('import "google/protobuf/any.proto";', '');
+    }
     // Service definition
     lines.push(`// ${serviceName} - Auto-generated gRPC service`);
     lines.push(`service ${serviceName} {`);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@themainstack/communication",
-    "version": "1.0.2",
+    "version": "1.1.0",
     "private": false,
     "description": "Unified gRPC framework for inter-service communication - auto-generates protos, creates servers, and provides type-safe clients",
     "main": "dist/index.js",
@@ -23,4 +23,4 @@
         "@grpc/grpc-js": "^1.14.3",
         "@grpc/proto-loader": "^0.8.0"
     }
-}
+}

package/src/index.ts

@@ -14,7 +14,8 @@
 // Auto-generate .proto files from TypeScript types
 export {
     generateProtoFromMethods,
-    generateProtoFromFunction
+    generateProtoFromFunction,
+    AnyType
 } from './proto-generator';
 export type {
     MethodDefinition,

package/src/proto-generator/index.ts

@@ -1,10 +1,19 @@
 import * as fs from 'fs';
 import * as path from 'path';
 
+/**
+ * Marker symbol to indicate a field should use google.protobuf.Any type.
+ * Use this in your sample objects to mark dynamic/generic fields.
+ * 
+ * @example
+ * requestSample: () => ({ id: '', data: AnyType })
+ */
+export const AnyType = Symbol('google.protobuf.Any');
+
 /**
  * Maps JavaScript/TypeScript runtime types to Protobuf types.
  */
-type ProtoType = "double" | "float" | "int32" | "int64" | "bool" | "string" | "bytes" | string;
+type ProtoType = "double" | "float" | "int32" | "int64" | "bool" | "string" | "bytes" | "google.protobuf.Any" | string;
 
 interface ProtoField {
     name: string;
@@ -36,6 +45,8 @@ export interface GenerateProtoOptions {
     outputDir?: string;
     /** Output filename (default: derived from serviceName or 'generated.proto') */
     outputFilename?: string;
+    /** Enable google.protobuf.Any for dynamic types marked with AnyType symbol (default: true) */
+    enableAnyType?: boolean;
 }
 
 /**
@@ -61,11 +72,12 @@ export function generateProtoFromMethods(
     methods: MethodDefinition<any, any>[],
     options: GenerateProtoOptions = {}
 ): string {
-    const { packageName, serviceName = 'GeneratedService', outputDir, outputFilename } = options;
+    const { packageName, serviceName = 'GeneratedService', outputDir, outputFilename, enableAnyType = true } = options;
 
     const messages: ProtoMessage[] = [];
     const protoMethods: ProtoMethod[] = [];
     const processedObjects = new Set<object>();
+    let usesAnyType = false;
 
     // Helper: Capitalize string
     function capitalize(s: string): string {
@@ -96,7 +108,11 @@ export function generateProtoFromMethods(
 
             const valueType = typeof value;
 
-            if (value === null || value === undefined) {
+            // Check for AnyType marker symbol
+            if (enableAnyType && (value === AnyType || (typeof value === 'symbol' && value.description === 'google.protobuf.Any'))) {
+                type = "google.protobuf.Any";
+                usesAnyType = true;
+            } else if (value === null || value === undefined) {
                 type = "string";
             } else if (valueType === "string") {
                 type = "string";
@@ -167,6 +183,11 @@ export function generateProtoFromMethods(
         lines.push(`package ${packageName};`, '');
     }
 
+    // Add google.protobuf.Any import if needed
+    if (usesAnyType) {
+        lines.push('import "google/protobuf/any.proto";', '');
+    }
+
     // Service definition
     lines.push(`// ${serviceName} - Auto-generated gRPC service`);
     lines.push(`service ${serviceName} {`);

package/tests/any-type.spec.ts

@@ -0,0 +1,100 @@
+import { describe, it, expect } from 'vitest';
+import { generateProtoFromMethods, AnyType } from '../src/index';
+
+describe('google.protobuf.Any support', () => {
+    it('should export AnyType symbol', () => {
+        expect(AnyType).toBeDefined();
+        expect(typeof AnyType).toBe('symbol');
+        expect(AnyType.description).toBe('google.protobuf.Any');
+    });
+
+    it('should generate proto with google.protobuf.Any for marked fields', () => {
+        const proto = generateProtoFromMethods([
+            {
+                name: 'ProcessGenericData',
+                requestSample: () => ({
+                    id: '',
+                    data: AnyType,
+                }),
+                responseSample: () => ({
+                    success: true,
+                    result: AnyType,
+                }),
+            }
+        ], {
+            packageName: 'generic.v1',
+            serviceName: 'GenericService',
+        });
+
+        // Should include the import statement
+        expect(proto).toContain('import "google/protobuf/any.proto";');
+
+        // Should use google.protobuf.Any type
+        expect(proto).toContain('google.protobuf.Any data = 2;');
+        expect(proto).toContain('google.protobuf.Any result = 2;');
+    });
+
+    it('should not include import if no Any types are used', () => {
+        const proto = generateProtoFromMethods([
+            {
+                name: 'SimpleMethod',
+                requestSample: () => ({ id: '', amount: 0 }),
+                responseSample: () => ({ success: true }),
+            }
+        ], {
+            packageName: 'simple.v1',
+            serviceName: 'SimpleService',
+        });
+
+        expect(proto).not.toContain('import "google/protobuf/any.proto";');
+        expect(proto).not.toContain('google.protobuf.Any');
+    });
+
+    it('should handle mixed fields with some Any types', () => {
+        const proto = generateProtoFromMethods([
+            {
+                name: 'MixedMethod',
+                requestSample: () => ({
+                    id: '',
+                    name: 'test',
+                    metadata: AnyType,
+                    count: 0,
+                }),
+                responseSample: () => ({
+                    status: 'ok',
+                    payload: AnyType,
+                }),
+            }
+        ], {
+            packageName: 'mixed.v1',
+            serviceName: 'MixedService',
+        });
+
+        expect(proto).toContain('import "google/protobuf/any.proto";');
+        expect(proto).toContain('string id = 1;');
+        expect(proto).toContain('string name = 2;');
+        expect(proto).toContain('google.protobuf.Any metadata = 3;');
+        expect(proto).toContain('int32 count = 4;');
+    });
+
+    it('should respect enableAnyType: false option', () => {
+        const proto = generateProtoFromMethods([
+            {
+                name: 'DisabledAny',
+                requestSample: () => ({
+                    id: '',
+                    data: AnyType,
+                }),
+                responseSample: () => ({ success: true }),
+            }
+        ], {
+            packageName: 'test.v1',
+            serviceName: 'TestService',
+            enableAnyType: false,
+        });
+
+        // When disabled, AnyType should be treated as a regular value (string fallback)
+        expect(proto).not.toContain('import "google/protobuf/any.proto";');
+        expect(proto).not.toContain('google.protobuf.Any');
+    });
+});

package/publish-config.npmrc

@@ -1 +0,0 @@
-//registry.npmjs.org/:_authToken=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