@hodfords/nestjs-grpc-helper 10.1.0 → 10.1.1

package/README.md

@@ -1,33 +1,46 @@
-# nestjs-grpc-helper
+<p align="center">
+  <a href="http://opensource.hodfords.uk" target="blank"><img src="https://opensource.hodfords.uk/img/logo.svg" width="320" alt="Hodfords Logo" /></a>
+</p>
 
-## Preinstall
-https://docs.nestjs.com/microservices/grpc
+<p align="center">
+<b>nestjs-grpc-helper</b> simplifies gRPC integration in NestJS, allowing seamless communication between services. It enables easy setup of gRPC clients and servers, and supports building SDK packages that any service can import and use, ensuring consistent API interaction across your microservices architecture.
+</p>
 
-```
-npm i --save @grpc/grpc-js @grpc/proto-loader
+## Pre-Installation 🔧
+
+Before using nestjs-grpc-helper, you'll need to install the necessary gRPC dependencies. Follow
+[the official NestJS documentation](https://docs.nestjs.com/microservices/grpc) for gRPC setup by installing the required packages:
+
+```bash
+npm install @grpc/grpc-js @grpc/proto-loader --save
 ```
 
 ## Installation 🤖
 
-```
+Install the `nestjs-grpc-helper` package with:
+
+```bash
 npm install @hodfords/nestjs-grpc-helper --save
 ```
 
-Automatically generate proto file, add it to main.ts, before application starts.
+Next, automatically generate the proto file and include it in main.ts before starting the application:
+
 ```typescript
 import { generateProtoService } from '@hodfords/nestjs-grpc-helper';
 
 generateProtoService(camelCase(env.APP_NAME), env.ROOT_PATH + '/../');
 ```
 
-Create microservices, it works similar to Controller.
-Response must be defined according to the rules of nestjs-response.
+## Usage 🚀
+
+### Creating microservices
+
+Create microservices using the `@GrpcMicroservice` decorator, similar to how you would use a Controller. Ensure that the response adheres to the [nestjs-response](https://www.npmjs.com/package/@hodfords/nestjs-response) rules:
 
 ```typescript
 @GrpcMicroservice()
 export class UserMicroservice {
-    constructor(private userService: UserService) {
-    }
+    constructor(private userService: UserService) {}
 
     @GrpcAction('Get user by id')
     @ResponseModel(UserResponse)
@@ -37,9 +50,62 @@ export class UserMicroservice {
 }
 ```
 
+### Create SDK
+
+To generate a TypeScript SDK for your gRPC services, use the following command:
+
+```shell
+npm run wz-command make-sdk <package-name> <folder>
+```
+
+#### What this command does
+
+This command will:
+
+1. **Collect all request and response types**: It gathers all `@GrpcValue` request and response types from your project.
+2. **Generate proto file**: Automatically generates the necessary proto files based on the collected types.
+3. **Create JavaScript Package**: Packages the generated code into a JavaScript SDK. The SDK will be published using the name and version specified in your package.json, making it available for other services to import and use. The arguments, response structure, and method names remain consistent with the definitions in your gRPC service, ensuring seamless integration and functionality across services.
+
+### SDK usage
+
+After publishing the SDK, other services can easily integrate it. Here’s an example of how to use the generated SDK
+
+1. **Import the sdk package**
+
+2. **Register the microservice module**: Configure the microservice in `AppModule` with the appropriate gRPC URL and timeout settings.
+
+    ```typescript
+    UserModule.register({
+        url: env.GRPC_URL,
+        timeout: 5000
+    });
+    ```
+
+3. **Use the SDK in another service**: Import the SDK and use it to interact with your gRPC services.
+
+    ```typescript
+    export class OtherService {
+        constructor(private userMicroservice: UserMicroservice) {}
+
+        async doTask(userId: string): Promise<void> {
+            const user = await this.userMicroservice.findUserById({ id: userId });
+            // Process user information as needed
+        }
+    }
+    ```
+
+In this example, `OtherService` uses the `UserMicroservice` class from the SDK to call the `findUserById` method.
+
 ### Mock response
 
-Use faker as a method: `MockMethod`
+To effectively generate and handle mock data in your application, you can use the `@MockMethod`, `@MockSample`, and `@MockNested` decorators.
+
+##### Generate dynamic data with `@MockMethod`
+
+Use `@MockMethod` to apply Faker methods for generating random values.
+
+For example, to create a random string of 10 characters
+
 ```typescript
 @Property({ type: String, required: false })
 @MockMethod('faker.datatype.string', [10])
@@ -47,7 +113,12 @@ Use faker as a method: `MockMethod`
 name: string;
 ```
 
-Use fixed values: `MockSample`
+##### Set fixed values with `@MockSample`
+
+If you need to set a fixed value for a property, use the `@MockSample` decorator. This is useful for enumerations or other predefined values.
+
+For example, to set a fixed user type
+
 ```typescript
 @Property({
     type: String,
@@ -59,7 +130,12 @@ Use fixed values: `MockSample`
 type: UserTypeEnum;
 ```
 
-Specifies the number of elements to return: `MockNested`
+##### Generate nested data
+
+Use `@MockNested` to generate mock data for nested objects or arrays of nested objects.
+
+For example, to create an array of 5 nested objects
+
 ```typescript
 @Property({ type: UserResponse, isArray: true })
 @IsArray()
@@ -69,21 +145,19 @@ Specifies the number of elements to return: `MockNested`
 users: UserResponse[];
 ```
 
-## Create SDK
+### Document for GRPC
 
-Run this command to create the typescript sdk
-```shell
-npm run wz-command make-sdk <package-name> <folder>
-```
-
-## Document for GRPC
-You can go to `http://xyz/microservice-documents` to check and try to call the grpc method
+You can go to `http://xyz/microservice-documents` to check and try to call the gRPC method
 
 ```typescript
 MicroserviceDocumentModule.register({
     isEnable: true,
     prefix: <app-prefix>,
-    packageName: camelCase(<package-name>>),
+    packageName: camelCase(<package-name>),
     clientOptions: { ...microserviceGrpcConfig, customClass: CustomGrpcClient, transport: undefined }
 })
 ```
+
+## License 📝
+
+This project is licensed under the MIT License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hodfords/nestjs-grpc-helper",
-  "version": "10.1.0",
+  "version": "10.1.1",
   "description": "A utility for simplifying gRPC integration and communication in NestJS applications",
   "author": "",
   "license": "UNLICENSED",