@hodfords/nestjs-grpc-helper 11.4.0-rc.2 → 11.4.0-rc.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hodfords/nestjs-grpc-helper",
-  "version": "11.4.0-rc.2",
+  "version": "11.4.0-rc.3",
   "description": "A utility for simplifying gRPC integration and communication in NestJS applications",
   "author": "",
   "license": "UNLICENSED",
@@ -43,10 +43,11 @@
     "@grpc/grpc-js": "*",
     "@grpc/proto-loader": "*",
     "@hodfords/nestjs-cls-translation": "*",
-    "shelljs": "*",
-    "chalk": "*"
+    "chalk": "*",
+    "shelljs": "*"
   },
   "devDependencies": {
+    "@hodfords/nestjs-exception": "^11.0.2",
     "@hodfords/nestjs-cls-translation": "11.0.2",
     "@hodfords/nestjs-command": "11.0.6",
     "@hodfords/nestjs-eslint-config": "11.0.2",

package/templates/body-method-template.hbs

@@ -0,0 +1,28 @@
+{{#hasItems directParams}}
+    const param = {
+    {{#each directParams}}
+        {{this.name}},
+    {{/each}}
+    };
+{{/hasItems}}
+{{#if response}}
+    {{#if response.isArray}}
+        return await GrpcHelper.with(this.client, {{{response.responseClass.name}}}, this.options)
+            .service('{{{serviceName}}}')
+            .method('{{{method}}}')
+            .data({{#if parameterName}}param{{else}}{}{{/if}}{{#if parameterType}}, {{{parameterType}}}{{/if}})
+            .getMany() as any;
+    {{else}}
+        return await GrpcHelper.with(this.client, {{{response.responseClass.name}}}, this.options)
+            .service('{{{serviceName}}}')
+            .method('{{{method}}}')
+            .data({{#if parameterName}}param{{else}}{}{{/if}}{{#if parameterType}}, {{{parameterType}}}{{/if}})
+            .getOne() as any;
+    {{/if}}
+{{else}}
+    await GrpcHelper.with(this.client, null as any, this.options)
+        .service('{{{serviceName}}}')
+        .method('{{{method}}}')
+        .data({{#if parameterName}}param{{else}}{}{{/if}}{{#if parameterType}}, {{{parameterType}}}{{/if}})
+        .getMany();
+{{/if}}

package/templates/grpc-service-template.hbs

@@ -0,0 +1,5 @@
+service {{name}} {
+{{#each rpcMethods}}
+    {{this}}
+{{/each}}
+}

package/templates/index-template.hbs

@@ -0,0 +1,5 @@
+export * from './helpers/grpc.helper'
+export * from './{{{ fileName }}}.module'
+export * from './{{{ fileName }}}.mock.module'
+export * from './services/{{{ fileName }}}.service';
+export * from './types/microservice-option.type';

package/templates/method-template.hbs

@@ -0,0 +1,19 @@
+{{#hasItems directParams}}
+    async {{method}}(
+    {{#each directParams}}
+        {{this.name}}{{#unless this.required}}?{{/unless}}: {{this.type}}{{#if this.isArray}}[]{{/if}}{{#unless @last}}, {{/unless}}
+    {{/each}}
+    ): Promise<{{returnType}}> {
+        {{{body}}}
+    }
+{{else}}
+    {{#if params}}
+        async {{method}}(param: {{params}}): Promise<{{returnType}}> {
+            {{{body}}}
+        }
+    {{else}}
+        async {{method}}(): Promise<{{returnType}}> {
+            {{{body}}}
+        }
+    {{/if}}
+{{/hasItems}}

package/templates/mock-method-template.hbs

@@ -0,0 +1,19 @@
+{{#hasItems directParams}}
+    async {{method}}(
+    {{#each directParams}}
+        {{this.name}}{{#unless this.required}}?{{/unless}}: {{this.type}}{{#if this.isArray}}[]{{/if}}{{#unless @last}}, {{/unless}}
+    {{/each}}
+    ): Promise<{{returnType}}> {
+        {{{body}}}
+    }
+{{else}}
+    {{#if params}}
+        async {{method}}(param: {{params}}): Promise<{{returnType}}> {
+            {{{body}}}
+        }
+    {{else}}
+        async {{method}}(): Promise<{{returnType}}> {
+            {{{body}}}
+        }
+    {{/if}}
+{{/hasItems}}

package/templates/mock-module-template.hbs

@@ -0,0 +1,12 @@
+import { Module, Global } from '@nestjs/common';
+import { {{#each importServices}}{{this}}{{#unless @last}},{{/unless}}{{/each}} } from './services/{{fileName}}.service';
+
+@Global()
+@Module({
+    providers: [
+        {{providers}}
+    ],
+    exports: [{{#each services}}{{this}}{{#unless @last}},{{/unless}}{{/each}}]
+})
+export class Mock{{moduleName}}Module {
+}

package/templates/mock-providers-template.hbs

@@ -0,0 +1,6 @@
+{{#each services}}
+{
+    provide: {{this}},
+    useClass: Mock{{this}}
+}{{#unless @last}},{{/unless}}
+{{/each}}

package/templates/module-template.hbs

@@ -0,0 +1,44 @@
+import { DynamicModule, Module, Global } from '@nestjs/common';
+import { ClientsModule } from '@nestjs/microservices';
+import path from 'path';
+import { MicroserviceModuleOptionType } from './types/microservice-option.type';
+import { {{#each services}}{{this}}{{#unless @last}},{{/unless}}{{/each}} } from './services/{{fileName}}.service';
+import { CustomGrpcClient } from '@hodfords/nestjs-grpc-helper';
+import * as grpc from '@grpc/grpc-js';
+
+
+@Global()
+@Module({})
+export class {{moduleName}}Module {
+    static register(options: MicroserviceModuleOptionType): DynamicModule {
+        return {
+            module: {{moduleName}}Module,
+            providers: [
+                {{#each services}}{{this}}{{#unless @last}},{{/unless}}{{/each}},
+                {
+                    provide: '{{packageName}}_OPTIONS',
+                    useValue: options
+                }
+            ],
+            exports: [{{#each services}}{{this}}{{#unless @last}},{{/unless}}{{/each}}],
+            imports: [
+                ClientsModule.register([
+                    {
+                        name: '{{packageName}}_PACKAGE',
+                        customClass: CustomGrpcClient as any,
+                        options: {
+                            url: options.url,
+                            package: '{{packageName}}',
+                            protoPath: path.join(__dirname, 'microservice.proto'),
+                            credentials: options.ssl ? grpc.credentials.createSsl() : undefined,
+                            maxReceiveMessageLength: options.maxReceiveMessageLength ?? 4 * 1024 * 1024,
+                            loader: {
+                                arrays: options.shouldLoadEmptyArray ?? false
+                            }
+                        }
+                    }
+                ])
+            ]
+        };
+    }
+}

package/templates/proto-native-list.hbs

@@ -0,0 +1,4 @@
+message Proto{{{name}}}List {
+    repeated {{{type}}} items = 1;
+    bool grpcArray = 2;
+}

package/templates/proto-service-definition.hbs

@@ -0,0 +1,6 @@
+syntax = "proto3";
+import "google/protobuf/empty.proto";
+package {{packageName}};
+
+{{{ microserviceContent}}}
+{{{ modelContent }}}

package/templates/service-interface.hbs

@@ -0,0 +1,7 @@
+message {{{name}}} {
+    {{{propertyContent}}}
+}
+message Proto{{{name}}}List {
+    repeated {{{name}}} items = 1;
+    bool grpcArray = 2;
+}

package/templates/service-template.hbs

@@ -0,0 +1,49 @@
+import { GrpcHelper } from '../helpers/grpc.helper';
+import { Inject, Injectable } from '@nestjs/common';
+import { ClientGrpc } from '@nestjs/microservices';
+import { MicroserviceModuleOptionType } from '../types/microservice-option.type';
+import { Type } from 'class-transformer';
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import { Property, AnyType, sample, sampleMethod } from '@hodfords/nestjs-grpc-helper';
+{{#if addAllowDecorator}}
+import { Allow } from 'class-validator';
+{{/if}}
+
+{{#each serviceContent}}
+  {{#if isMock}}
+  export class Mock{{ serviceName }} {
+    {{#each methods}}
+      {{{this}}}
+    {{/each}}
+  }
+  {{else}}
+  @Injectable()
+  export class {{ serviceName }} {
+    constructor(
+      @Inject('{{ ../packageName }}_PACKAGE') private client: ClientGrpc,
+      @Inject('{{ ../packageName }}_OPTIONS') private options: MicroserviceModuleOptionType
+    ) {}
+
+    {{#each methods}}
+        {{{this}}}
+    {{/each}}
+  }
+  {{/if}} 
+{{/each}}
+
+{{#each modelContent}}
+export class {{ name }} {
+   {{#each properties}}
+        {{{this}}}
+    {{/each}}
+}
+{{/each}}
+
+
+{{#each enumContent}}
+export enum {{ enumName }} {
+  {{#each keys}}
+    {{{this}}},
+  {{/each}}
+}
+{{/each}}

package/templates/usage-doc-template.hbs

@@ -0,0 +1,17 @@
+// Import module
+
+{{moduleName}}Module.register({
+    timeout: 5000,
+    url: 'localhost:50051'
+})
+
+// Use in service
+export class ExampleService {
+    constructor(private {{packageName}}Microservice: {{moduleName}}Microservice) {
+        
+    }
+    
+    findOne() {
+        return this.{{packageName}}Microservice.findOne({ id: 1 });
+    }
+}