@hazeljs/grpc 0.2.0-alpha.1

package/LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2024 HazelJS Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+---
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+   Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+   that You distribute, all copyright, patent, trademark, and
+   attribution notices from the Source form of the Work,
+   excluding those notices that do not pertain to any part of
+   the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not
+   pertain to any part of the Derivative Works, in at least one
+   of the following places: within a NOTICE text file distributed
+   as part of the Derivative Works; within the Source form or
+   documentation, if provided along with the Derivative Works; or,
+   within a display generated by the Derivative Works, if and
+   wherever such third-party notices normally appear. The contents
+   of the NOTICE file are for informational purposes only and
+   do not modify the License. You may add Your own attribution
+   notices within Derivative Works that You distribute, alongside
+   or as an addendum to the NOTICE text from the Work, provided
+   that such additional attribution notices cannot be construed
+   as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,161 @@
+# @hazeljs/grpc
+
+**gRPC Module for HazelJS**
+
+RPC server support with decorator-based handlers. Built on [@grpc/grpc-js](https://www.npmjs.com/package/@grpc/grpc-js) and [@grpc/proto-loader](https://www.npmjs.com/package/@grpc/proto-loader).
+
+[![npm version](https://img.shields.io/npm/v/@hazeljs/grpc.svg)](https://www.npmjs.com/package/@hazeljs/grpc)
+[![npm downloads](https://img.shields.io/npm/dm/@hazeljs/grpc)](https://www.npmjs.com/package/@hazeljs/grpc)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Features
+
+- **Decorator-Based API** - `@GrpcMethod()` for declarative RPC handlers
+- **DI Integration** - Controllers are resolved from the HazelJS container
+- **Proto Loading** - Load `.proto` files at runtime with configurable options
+- **Unary RPC** - Support for request-response RPC methods
+
+## Installation
+
+```bash
+npm install @hazeljs/grpc
+```
+
+## Quick Start
+
+### 1. Define your service in a .proto file
+
+```proto
+syntax = "proto3";
+package hero;
+
+service HeroService {
+  rpc FindOne (HeroById) returns (Hero);
+}
+
+message HeroById {
+  int32 id = 1;
+}
+
+message Hero {
+  int32 id = 1;
+  string name = 2;
+}
+```
+
+### 2. Import GrpcModule and create a controller
+
+```typescript
+import { Injectable } from '@hazeljs/core';
+import { GrpcMethod } from '@hazeljs/grpc';
+import { join } from 'path';
+import { HazelModule } from '@hazeljs/core';
+import { GrpcModule } from '@hazeljs/grpc';
+
+@Injectable()
+export class HeroGrpcController {
+  @GrpcMethod('HeroService', 'FindOne')
+  findOne(data: { id: number }) {
+    return { id: data.id, name: 'Hero' };
+  }
+}
+
+@HazelModule({
+  imports: [
+    GrpcModule.forRoot({
+      protoPath: join(__dirname, 'hero.proto'),
+      package: 'hero',
+      url: '0.0.0.0:50051',
+    }),
+  ],
+  providers: [HeroGrpcController],
+})
+export class AppModule {}
+```
+
+### 3. Register handlers and start the gRPC server
+
+```typescript
+import { HazelApp } from '@hazeljs/core';
+import { GrpcModule, GrpcServer } from '@hazeljs/grpc';
+import { Container } from '@hazeljs/core';
+import { AppModule } from './app.module';
+import { HeroGrpcController } from './hero.grpc-controller';
+
+async function bootstrap() {
+  const app = new HazelApp(AppModule);
+
+  // Register gRPC handlers from controllers
+  GrpcModule.registerHandlersFromProviders([HeroGrpcController]);
+
+  // Start HTTP server
+  await app.listen(3000);
+
+  // Start gRPC server (runs on separate port)
+  const grpcServer = Container.getInstance().resolve(GrpcServer);
+  await grpcServer.start();
+}
+
+bootstrap();
+```
+
+## Configuration
+
+```typescript
+GrpcModule.forRoot({
+  protoPath: join(__dirname, 'hero.proto'),  // or ['a.proto', 'b.proto']
+  package: 'hero',                             // package name from .proto
+  url: '0.0.0.0:50051',                       // bind address (default: 0.0.0.0:50051)
+  loader: {                                    // @grpc/proto-loader options
+    keepCase: true,
+    longs: String,
+    enums: String,
+    defaults: true,
+    oneofs: true,
+  },
+  isGlobal: true,                              // global module (default)
+});
+```
+
+## Async Configuration
+
+```typescript
+GrpcModule.forRootAsync({
+  useFactory: async (config: ConfigService) => ({
+    protoPath: config.get('GRPC_PROTO_PATH'),
+    package: config.get('GRPC_PACKAGE'),
+    url: config.get('GRPC_URL'),
+  }),
+  inject: [ConfigService],
+});
+```
+
+## @GrpcMethod Decorator
+
+```typescript
+// Explicit service and method name
+@GrpcMethod('HeroService', 'FindOne')
+findOne(data: { id: number }) {
+  return { id: data.id, name: 'Hero' };
+}
+
+// Method name defaults to the decorated method name
+@GrpcMethod('HeroService')
+findOne(data: { id: number }) {
+  return { id: data.id, name: 'Hero' };
+}
+
+// Async handlers are supported
+@GrpcMethod('HeroService', 'FindOne')
+async findOne(data: { id: number }) {
+  const hero = await this.heroRepository.findById(data.id);
+  return hero;
+}
+```
+
+## API
+
+- **GrpcModule** - Module with `forRoot(options)`, `forRootAsync(options)`, `registerHandlersFromProvider(provider)`, `registerHandlersFromProviders(providerClasses)`
+- **GrpcServer** - Injectable service with `configure(options)`, `start()`, `close()`, `registerHandlersFromProvider(provider)`, `registerHandlersFromProviders(providerClasses)`
+- **GrpcMethod(serviceName, methodName?)** - Decorator for RPC method handlers
+- **getGrpcMethodMetadata(target)** - Get @GrpcMethod metadata from a class

package/dist/decorators/grpc-method.decorator.d.ts

@@ -0,0 +1,32 @@
+import 'reflect-metadata';
+import type { GrpcMethodMetadata } from '../grpc.types';
+/**
+ * Metadata key for gRPC method handlers
+ */
+export declare const GRPC_METHOD_METADATA_KEY: unique symbol;
+/**
+ * Decorator to mark a method as a gRPC RPC handler
+ *
+ * @param serviceName - Service name as defined in the .proto file (e.g. 'HeroService')
+ * @param methodName - Method name as defined in the .proto file. Defaults to the decorated method name.
+ *
+ * @example
+ * ```typescript
+ * @GrpcMethod('HeroService', 'FindOne')
+ * findOne(data: { id: number }) {
+ *   return { id: data.id, name: 'Hero' };
+ * }
+ *
+ * // Method name defaults to decorated method name
+ * @GrpcMethod('HeroService')
+ * findOne(data: { id: number }) {
+ *   return { id: data.id, name: 'Hero' };
+ * }
+ * ```
+ */
+export declare function GrpcMethod(serviceName: string, methodName?: string): MethodDecorator;
+/**
+ * Get @GrpcMethod metadata from a class
+ */
+export declare function getGrpcMethodMetadata(target: object): GrpcMethodMetadata[];
+//# sourceMappingURL=grpc-method.decorator.d.ts.map

package/dist/decorators/grpc-method.decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grpc-method.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/grpc-method.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,wBAAwB,eAAwB,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,eAAe,CAapF;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,kBAAkB,EAAE,CAE1E"}

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

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GRPC_METHOD_METADATA_KEY = void 0;
+exports.GrpcMethod = GrpcMethod;
+exports.getGrpcMethodMetadata = getGrpcMethodMetadata;
+require("reflect-metadata");
+/**
+ * Metadata key for gRPC method handlers
+ */
+exports.GRPC_METHOD_METADATA_KEY = Symbol('grpc:method');
+/**
+ * Decorator to mark a method as a gRPC RPC handler
+ *
+ * @param serviceName - Service name as defined in the .proto file (e.g. 'HeroService')
+ * @param methodName - Method name as defined in the .proto file. Defaults to the decorated method name.
+ *
+ * @example
+ * ```typescript
+ * @GrpcMethod('HeroService', 'FindOne')
+ * findOne(data: { id: number }) {
+ *   return { id: data.id, name: 'Hero' };
+ * }
+ *
+ * // Method name defaults to decorated method name
+ * @GrpcMethod('HeroService')
+ * findOne(data: { id: number }) {
+ *   return { id: data.id, name: 'Hero' };
+ * }
+ * ```
+ */
+function GrpcMethod(serviceName, methodName) {
+    return (target, propertyKey, _descriptor) => {
+        const existing = Reflect.getMetadata(exports.GRPC_METHOD_METADATA_KEY, target.constructor) || [];
+        existing.push({
+            service: serviceName,
+            method: methodName ?? propertyKey.toString(),
+            methodName: propertyKey.toString(),
+        });
+        Reflect.defineMetadata(exports.GRPC_METHOD_METADATA_KEY, existing, target.constructor);
+    };
+}
+/**
+ * Get @GrpcMethod metadata from a class
+ */
+function getGrpcMethodMetadata(target) {
+    return Reflect.getMetadata(exports.GRPC_METHOD_METADATA_KEY, target.constructor) || [];
+}

package/dist/decorators/grpc-method.decorator.test.d.ts

@@ -0,0 +1,2 @@
+import 'reflect-metadata';
+//# sourceMappingURL=grpc-method.decorator.test.d.ts.map

package/dist/decorators/grpc-method.decorator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grpc-method.decorator.test.d.ts","sourceRoot":"","sources":["../../src/decorators/grpc-method.decorator.test.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC"}

package/dist/decorators/grpc-method.decorator.test.js

@@ -0,0 +1,130 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const grpc_method_decorator_1 = require("./grpc-method.decorator");
+describe('GrpcMethod decorator', () => {
+    it('should define GRPC_METHOD_METADATA_KEY', () => {
+        expect(typeof grpc_method_decorator_1.GRPC_METHOD_METADATA_KEY).toBe('symbol');
+    });
+    it('should add metadata for service and method', () => {
+        class TestController {
+            findOne(_data) {
+                return { id: 1, name: 'Hero' };
+            }
+        }
+        __decorate([
+            (0, grpc_method_decorator_1.GrpcMethod)('HeroService', 'FindOne'),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", [Object]),
+            __metadata("design:returntype", void 0)
+        ], TestController.prototype, "findOne", null);
+        const metadata = (0, grpc_method_decorator_1.getGrpcMethodMetadata)(new TestController());
+        expect(metadata).toHaveLength(1);
+        expect(metadata[0].service).toBe('HeroService');
+        expect(metadata[0].method).toBe('FindOne');
+        expect(metadata[0].methodName).toBe('findOne');
+    });
+    it('should default method name to property key when not provided', () => {
+        class TestController {
+            findOne(_data) {
+                return { id: 1, name: 'Hero' };
+            }
+        }
+        __decorate([
+            (0, grpc_method_decorator_1.GrpcMethod)('HeroService'),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", [Object]),
+            __metadata("design:returntype", void 0)
+        ], TestController.prototype, "findOne", null);
+        const metadata = (0, grpc_method_decorator_1.getGrpcMethodMetadata)(new TestController());
+        expect(metadata[0].method).toBe('findOne');
+        expect(metadata[0].methodName).toBe('findOne');
+    });
+    it('should add metadata for multiple methods on same class', () => {
+        class TestController {
+            findOne(_data) {
+                return { id: 1, name: 'Hero' };
+            }
+            findAll(_data) {
+                return [];
+            }
+        }
+        __decorate([
+            (0, grpc_method_decorator_1.GrpcMethod)('HeroService', 'FindOne'),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", [Object]),
+            __metadata("design:returntype", void 0)
+        ], TestController.prototype, "findOne", null);
+        __decorate([
+            (0, grpc_method_decorator_1.GrpcMethod)('HeroService', 'FindAll'),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", [Object]),
+            __metadata("design:returntype", void 0)
+        ], TestController.prototype, "findAll", null);
+        const metadata = (0, grpc_method_decorator_1.getGrpcMethodMetadata)(new TestController());
+        expect(metadata).toHaveLength(2);
+        expect(metadata[0].service).toBe('HeroService');
+        expect(metadata[0].method).toBe('FindOne');
+        expect(metadata[1].service).toBe('HeroService');
+        expect(metadata[1].method).toBe('FindAll');
+    });
+    it('should support different services on same class', () => {
+        class TestController {
+            findHero(_data) {
+                return { id: 1, name: 'Hero' };
+            }
+            getUser(_data) {
+                return { id: '1', name: 'User' };
+            }
+        }
+        __decorate([
+            (0, grpc_method_decorator_1.GrpcMethod)('HeroService', 'FindOne'),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", [Object]),
+            __metadata("design:returntype", void 0)
+        ], TestController.prototype, "findHero", null);
+        __decorate([
+            (0, grpc_method_decorator_1.GrpcMethod)('UserService', 'GetUser'),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", [Object]),
+            __metadata("design:returntype", void 0)
+        ], TestController.prototype, "getUser", null);
+        const metadata = (0, grpc_method_decorator_1.getGrpcMethodMetadata)(new TestController());
+        expect(metadata).toHaveLength(2);
+        expect(metadata[0].service).toBe('HeroService');
+        expect(metadata[1].service).toBe('UserService');
+    });
+});
+describe('getGrpcMethodMetadata', () => {
+    it('should return empty array for class without @GrpcMethod decorators', () => {
+        class PlainClass {
+        }
+        const metadata = (0, grpc_method_decorator_1.getGrpcMethodMetadata)(new PlainClass());
+        expect(metadata).toEqual([]);
+    });
+    it('should return metadata from class constructor', () => {
+        class TestController {
+            testMethod() { }
+        }
+        __decorate([
+            (0, grpc_method_decorator_1.GrpcMethod)('TestService', 'TestMethod'),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", []),
+            __metadata("design:returntype", void 0)
+        ], TestController.prototype, "testMethod", null);
+        const instance = new TestController();
+        const metadata = (0, grpc_method_decorator_1.getGrpcMethodMetadata)(instance);
+        expect(metadata).toHaveLength(1);
+        expect(metadata[0].service).toBe('TestService');
+        expect(metadata[0].method).toBe('TestMethod');
+    });
+});

package/dist/grpc.client.d.ts

@@ -0,0 +1,50 @@
+import type { GrpcClientOptions } from './grpc.client.types';
+type GrpcClientStub = Record<string, (req: unknown, cb: (err: Error | null, res: unknown) => void) => void>;
+/**
+ * gRPC Client service - creates and caches gRPC client stubs for calling remote gRPC services
+ */
+export declare class GrpcClientService {
+    private packageDefinition;
+    private protoDescriptor;
+    private options;
+    private stubCache;
+    /**
+     * Configure the client with proto path and options
+     */
+    configure(options: GrpcClientOptions): void;
+    /**
+     * Resolve URL from Discovery when configured
+     */
+    private resolveUrl;
+    /**
+     * Build filter for Discovery.
+     * Passes user filter; for protocol: 'grpc' use metadata: { protocol: 'grpc' }
+     * since ServiceFilter filters by metadata.
+     */
+    private buildDiscoveryFilter;
+    /**
+     * Get a gRPC client stub for the given service.
+     * When Discovery is configured and url is omitted, resolves URL from Discovery.
+     * Stubs are cached per (serviceName, url).
+     *
+     * @param serviceName - Service name as defined in proto (e.g. 'ProductService')
+     * @param url - Optional URL (e.g. 'localhost:50051'). Required if not using Discovery and no defaultUrl.
+     * @returns gRPC client stub with RPC methods
+     */
+    getClient(serviceName: string, url?: string): GrpcClientStub;
+    /**
+     * Get a gRPC client stub asynchronously.
+     * Use this when Discovery is configured, as URL resolution is async.
+     *
+     * @param serviceName - Service name as defined in proto (e.g. 'ProductService')
+     * @param url - Optional URL. When omitted and Discovery is configured, resolves from Discovery.
+     * @returns Promise resolving to gRPC client stub
+     */
+    getClientAsync(serviceName: string, url?: string): Promise<GrpcClientStub>;
+    /**
+     * Close all cached client channels (for graceful shutdown)
+     */
+    close(): void;
+}
+export {};
+//# sourceMappingURL=grpc.client.d.ts.map

package/dist/grpc.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grpc.client.d.ts","sourceRoot":"","sources":["../src/grpc.client.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,iBAAiB,EAGlB,MAAM,qBAAqB,CAAC;AAE7B,KAAK,cAAc,GAAG,MAAM,CAC1B,MAAM,EACN,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,OAAO,KAAK,IAAI,KAAK,IAAI,CACtE,CAAC;AAEF;;GAEG;AACH,qBACa,iBAAiB;IAC5B,OAAO,CAAC,iBAAiB,CAAkC;IAC3D,OAAO,CAAC,eAAe,CAAwC;IAC/D,OAAO,CAAC,OAAO,CAAkC;IACjD,OAAO,CAAC,SAAS,CAAkD;IAEnE;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAwB3C;;OAEG;YACW,UAAU;IA0BxB;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;;;;;OAQG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,cAAc;IA2D5D;;;;;;;OAOG;IACG,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAKhF;;OAEG;IACH,KAAK,IAAI,IAAI;CAOd"}