@vnodes/boot-grpc 0.0.23

package/README.md

@@ -0,0 +1,35 @@
+![Npm version](https://img.shields.io/npm/v/@vnodes/boot-grpc)
+![Npm downloads](https://img.shields.io/npm/dm/@vnodes/boot-grpc)
+![Build Status](https://img.shields.io/github/actions/workflow/status/vnodes/vnodes/ci.yml)
+![Doc Status](https://img.shields.io/github/actions/workflow/status/vnodes/vnodes/doc.yml)
+![Bundle size](https://img.shields.io/bundlephobia/min/@vnodes/boot-grpc)
+
+<p align="center">
+  <img   srcset="./assets/favicon.png, https://vnodes.github.io/vnodes/libs/boot-grpc/assets/favicon.png" alt="Logo"  width="200" height="200" style="border-radius: 100%"/>
+</p>
+
+## @vnodes/boot-grpc
+
+@vnodes/boot-grpc
+
+## Installation
+
+```bash
+pnpm add @vnodes/boot-grpc
+```
+
+## 💖 Support My Work
+
+If you find my open-source contributions or the **@vnodes/boot-grpc** project helpful, consider supporting my work. Your sponsorship helps me maintain these projects and explore new enterprise patterns.
+
+[![CashApp](https://img.shields.io/badge/Sponsor%20me-%23EA4AAA.svg?style=for-the-badge&logo=github-sponsors&logoColor=white)](https://cash.app/$puqlib)
+
+---
+
+## 🤝 Connect with Me
+
+<p align="left">
+<a href="mailto:robert.brightline+vnodes-boot-grpc@gmail.com">
+<img src="https://img.shields.io/badge/Email-D14836?style=for-the-badge&logo=gmail&logoColor=white" />
+</a>
+</p>

package/bin/version.mjs

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+
+import { readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const packageJsonPath = join(__dirname, '..', 'package.json');
+const packageJson = readFileSync(packageJsonPath, { encoding: 'utf-8' });
+const version = JSON.parse(packageJson).version;
+console.log(version);

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/boot.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from './lib/boot.js';
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './lib/boot.js';\n"],"names":[],"mappings":"AAAA,cAAc,gBAAgB"}

package/dist/lib/boot.d.ts

@@ -0,0 +1,26 @@
+import { type Type } from '@vnodes/nestjs/common';
+export type BootGRpcOptions = {
+    appModule: Type;
+};
+export declare function configs(): Promise<{
+    APP_ID: any;
+    PROTO_DIR: any;
+    PROTO_FILE_PATH: any;
+    PORT: any;
+    GRPC_URL: string;
+}>;
+/**
+ * Sample env
+ *
+ * ````env
+ * APP_ID="sample"
+ * APP_DESC="sample app"
+ * DB_URL="postgres://admin:password@localhost:5432/vnodes?schema=sample"
+ * DB_SCHEMA="sample"
+ * PROTO_DIR=apps/sample-service/proto
+ * PROTO_FILE_PATH=sample-service.proto
+ * ````
+ * @param options
+ */
+export declare function boot(options: BootGRpcOptions): Promise<void>;
+//# sourceMappingURL=boot.d.ts.map

package/dist/lib/boot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boot.d.ts","sourceRoot":"","sources":["../../src/lib/boot.ts"],"names":[],"mappings":"AACA,OAAO,EAAsC,KAAK,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAMtF,MAAM,MAAM,eAAe,GAAG;IAC1B,SAAS,EAAE,IAAI,CAAC;CACnB,CAAC;AAEF,wBAAsB,OAAO;;;;;;GAkB5B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,IAAI,CAAC,OAAO,EAAE,eAAe,iBA2ClD"}

package/dist/lib/boot.js

@@ -0,0 +1,80 @@
+import { Env } from '@vnodes/env';
+import { ClassSerializerInterceptor, Logger } from '@vnodes/nestjs/common';
+import { ConfigModule, ConfigService } from '@vnodes/nestjs/config';
+import { NestFactory, Reflector } from '@vnodes/nestjs/core';
+import { Transport } from '@vnodes/nestjs/microservices';
+import { CommonGRpcValidationPipe } from '@vnodes/prop';
+export async function configs() {
+    const context = await NestFactory.createApplicationContext(ConfigModule);
+    const config = context.get(ConfigService);
+    const APP_ID = config.getOrThrow(Env.APP_ID);
+    const PROTO_DIR = config.getOrThrow(Env.PROTO_DIR);
+    const PROTO_FILE_PATH = config.getOrThrow(Env.PROTO_FILE_PATH);
+    const PORT = config.getOrThrow(Env.PORT, 50051);
+    const GRPC_URL = `0.0.0.0:${PORT}`;
+    await context.close();
+    return {
+        APP_ID,
+        PROTO_DIR,
+        PROTO_FILE_PATH,
+        PORT,
+        GRPC_URL
+    };
+}
+/**
+ * Sample env
+ *
+ * ````env
+ * APP_ID="sample"
+ * APP_DESC="sample app"
+ * DB_URL="postgres://admin:password@localhost:5432/vnodes?schema=sample"
+ * DB_SCHEMA="sample"
+ * PROTO_DIR=apps/sample-service/proto
+ * PROTO_FILE_PATH=sample-service.proto
+ * ````
+ * @param options
+ */ export async function boot(options) {
+    const NODE_ENV = process.env[Env.NODE_ENV];
+    const IS_PROD = NODE_ENV === 'production';
+    const { APP_ID, GRPC_URL, PROTO_DIR, PROTO_FILE_PATH } = await configs();
+    const logger = new Logger(APP_ID);
+    const app = await NestFactory.createMicroservice(options.appModule, {
+        transport: Transport.GRPC,
+        logger: IS_PROD ? [
+            'fatal',
+            'error'
+        ] : undefined,
+        bufferLogs: true,
+        options: {
+            package: APP_ID,
+            url: GRPC_URL,
+            protoPath: PROTO_FILE_PATH,
+            loader: {
+                keepCase: true,
+                longs: String,
+                enums: String,
+                defaults: true,
+                oneofs: true,
+                includeDirs: [
+                    PROTO_DIR
+                ]
+            },
+            channelOptions: {
+                // Keep-alive: Helps prevent load balancers from dropping idle connections
+                'grpc.keepalive_time_ms': 10000,
+                'grpc.keepalive_timeout_ms': 5000,
+                'grpc.keepalive_permit_without_calls': 1,
+                // Maximum message size (standard is 4MB; increase if sending large CRM/HR reports)
+                'grpc.max_receive_message_length': 1024 * 1024 * 10,
+                'grpc.max_send_message_length': 1024 * 1024 * 10
+            }
+        }
+    });
+    app.enableShutdownHooks();
+    app.useGlobalInterceptors(new ClassSerializerInterceptor(app.get(Reflector)));
+    app.useGlobalPipes(CommonGRpcValidationPipe);
+    await app.listen();
+    logger.log(`${NODE_ENV}| gRpc Microservice | Running at ${GRPC_URL}`);
+}
+
+//# sourceMappingURL=boot.js.map

package/dist/lib/boot.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/lib/boot.ts"],"sourcesContent":["import { Env } from '@vnodes/env';\nimport { ClassSerializerInterceptor, Logger, type Type } from '@vnodes/nestjs/common';\nimport { ConfigModule, ConfigService } from '@vnodes/nestjs/config';\nimport { NestFactory, Reflector } from '@vnodes/nestjs/core';\nimport { type GrpcOptions, Transport } from '@vnodes/nestjs/microservices';\nimport { CommonGRpcValidationPipe } from '@vnodes/prop';\n\nexport type BootGRpcOptions = {\n    appModule: Type;\n};\n\nexport async function configs() {\n    const context = await NestFactory.createApplicationContext(ConfigModule);\n    const config = context.get(ConfigService);\n    const APP_ID = config.getOrThrow(Env.APP_ID);\n    const PROTO_DIR = config.getOrThrow(Env.PROTO_DIR);\n    const PROTO_FILE_PATH = config.getOrThrow(Env.PROTO_FILE_PATH);\n    const PORT = config.getOrThrow(Env.PORT, 50051);\n    const GRPC_URL = `0.0.0.0:${PORT}`;\n\n    await context.close();\n\n    return {\n        APP_ID,\n        PROTO_DIR,\n        PROTO_FILE_PATH,\n        PORT,\n        GRPC_URL,\n    };\n}\n\n/**\n * Sample env\n *\n * ````env\n * APP_ID=\"sample\"\n * APP_DESC=\"sample app\"\n * DB_URL=\"postgres://admin:password@localhost:5432/vnodes?schema=sample\"\n * DB_SCHEMA=\"sample\"\n * PROTO_DIR=apps/sample-service/proto\n * PROTO_FILE_PATH=sample-service.proto\n * ````\n * @param options\n */\nexport async function boot(options: BootGRpcOptions) {\n    const NODE_ENV = process.env[Env.NODE_ENV];\n    const IS_PROD = NODE_ENV === 'production';\n\n    const { APP_ID, GRPC_URL, PROTO_DIR, PROTO_FILE_PATH } = await configs();\n\n    const logger = new Logger(APP_ID);\n\n    const app = await NestFactory.createMicroservice<GrpcOptions>(options.appModule, {\n        transport: Transport.GRPC,\n        logger: IS_PROD ? ['fatal', 'error'] : undefined,\n        bufferLogs: true,\n        options: {\n            package: APP_ID,\n            url: GRPC_URL,\n            protoPath: PROTO_FILE_PATH,\n            loader: {\n                keepCase: true, // Preserves field_names from .proto (important for some clients)\n                longs: String, // Handles large SQL IDs/Numbers safely in JS\n                enums: String, // Returns string names of enums for easier debugging\n                defaults: true, // Ensures default values are populated in responses\n                oneofs: true,\n                includeDirs: [PROTO_DIR],\n            },\n            channelOptions: {\n                // Keep-alive: Helps prevent load balancers from dropping idle connections\n                'grpc.keepalive_time_ms': 10000,\n                'grpc.keepalive_timeout_ms': 5000,\n                'grpc.keepalive_permit_without_calls': 1,\n                // Maximum message size (standard is 4MB; increase if sending large CRM/HR reports)\n                'grpc.max_receive_message_length': 1024 * 1024 * 10, // 10MB\n                'grpc.max_send_message_length': 1024 * 1024 * 10, // 10MB\n            },\n        },\n    });\n\n    app.enableShutdownHooks();\n    app.useGlobalInterceptors(new ClassSerializerInterceptor(app.get(Reflector)));\n    app.useGlobalPipes(CommonGRpcValidationPipe);\n\n    await app.listen();\n\n    logger.log(`${NODE_ENV}| gRpc Microservice | Running at ${GRPC_URL}`);\n}\n"],"names":["Env","ClassSerializerInterceptor","Logger","ConfigModule","ConfigService","NestFactory","Reflector","Transport","CommonGRpcValidationPipe","configs","context","createApplicationContext","config","get","APP_ID","getOrThrow","PROTO_DIR","PROTO_FILE_PATH","PORT","GRPC_URL","close","boot","options","NODE_ENV","process","env","IS_PROD","logger","app","createMicroservice","appModule","transport","GRPC","undefined","bufferLogs","package","url","protoPath","loader","keepCase","longs","String","enums","defaults","oneofs","includeDirs","channelOptions","enableShutdownHooks","useGlobalInterceptors","useGlobalPipes","listen","log"],"mappings":"AAAA,SAASA,GAAG,QAAQ,cAAc;AAClC,SAASC,0BAA0B,EAAEC,MAAM,QAAmB,wBAAwB;AACtF,SAASC,YAAY,EAAEC,aAAa,QAAQ,wBAAwB;AACpE,SAASC,WAAW,EAAEC,SAAS,QAAQ,sBAAsB;AAC7D,SAA2BC,SAAS,QAAQ,+BAA+B;AAC3E,SAASC,wBAAwB,QAAQ,eAAe;AAMxD,OAAO,eAAeC;IAClB,MAAMC,UAAU,MAAML,YAAYM,wBAAwB,CAACR;IAC3D,MAAMS,SAASF,QAAQG,GAAG,CAACT;IAC3B,MAAMU,SAASF,OAAOG,UAAU,CAACf,IAAIc,MAAM;IAC3C,MAAME,YAAYJ,OAAOG,UAAU,CAACf,IAAIgB,SAAS;IACjD,MAAMC,kBAAkBL,OAAOG,UAAU,CAACf,IAAIiB,eAAe;IAC7D,MAAMC,OAAON,OAAOG,UAAU,CAACf,IAAIkB,IAAI,EAAE;IACzC,MAAMC,WAAW,CAAC,QAAQ,EAAED,MAAM;IAElC,MAAMR,QAAQU,KAAK;IAEnB,OAAO;QACHN;QACAE;QACAC;QACAC;QACAC;IACJ;AACJ;AAEA;;;;;;;;;;;;CAYC,GACD,OAAO,eAAeE,KAAKC,OAAwB;IAC/C,MAAMC,WAAWC,QAAQC,GAAG,CAACzB,IAAIuB,QAAQ,CAAC;IAC1C,MAAMG,UAAUH,aAAa;IAE7B,MAAM,EAAET,MAAM,EAAEK,QAAQ,EAAEH,SAAS,EAAEC,eAAe,EAAE,GAAG,MAAMR;IAE/D,MAAMkB,SAAS,IAAIzB,OAAOY;IAE1B,MAAMc,MAAM,MAAMvB,YAAYwB,kBAAkB,CAAcP,QAAQQ,SAAS,EAAE;QAC7EC,WAAWxB,UAAUyB,IAAI;QACzBL,QAAQD,UAAU;YAAC;YAAS;SAAQ,GAAGO;QACvCC,YAAY;QACZZ,SAAS;YACLa,SAASrB;YACTsB,KAAKjB;YACLkB,WAAWpB;YACXqB,QAAQ;gBACJC,UAAU;gBACVC,OAAOC;gBACPC,OAAOD;gBACPE,UAAU;gBACVC,QAAQ;gBACRC,aAAa;oBAAC7B;iBAAU;YAC5B;YACA8B,gBAAgB;gBACZ,0EAA0E;gBAC1E,0BAA0B;gBAC1B,6BAA6B;gBAC7B,uCAAuC;gBACvC,mFAAmF;gBACnF,mCAAmC,OAAO,OAAO;gBACjD,gCAAgC,OAAO,OAAO;YAClD;QACJ;IACJ;IAEAlB,IAAImB,mBAAmB;IACvBnB,IAAIoB,qBAAqB,CAAC,IAAI/C,2BAA2B2B,IAAIf,GAAG,CAACP;IACjEsB,IAAIqB,cAAc,CAACzC;IAEnB,MAAMoB,IAAIsB,MAAM;IAEhBvB,OAAOwB,GAAG,CAAC,GAAG5B,SAAS,iCAAiC,EAAEJ,UAAU;AACxE"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@vnodes/boot-grpc",
+  "version": "0.0.23",
+  "description": "@vnodes/boot-grpc",
+  "keywords": [
+    "boot-grpc"
+  ],
+  "author": {
+    "name": "Robert Brightline",
+    "email": "robert.brightline+vnodes-boot-grpc@gmail.com",
+    "url": "https://vnodes.github.io/vnodes"
+  },
+  "homepage": "https://vnodes.github.io/vnodes/libs/boot-grpc",
+  "icon": "https://vnodes.github.io/vnodes/libs/boot-grpc/assets/favicon.png",
+  "funding": [
+    "https://cash.app/$puqlib"
+  ],
+  "bin": {
+    "version": "./bin/version.mjs"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "@vnodes/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "bin",
+    "!**/*.tsbuildinfo"
+  ],
+  "nx": {
+    "sourceRoot": "libs/boot-grpc/src",
+    "tags": [
+      "lib"
+    ],
+    "targets": {
+      "build": {},
+      "doc": {},
+      "lint": {}
+    }
+  },
+  "dependencies": {
+    "@swc/helpers": "~0.5.18"
+  },
+  "devDependencies": {
+    "@vnodes/nestjs": "0.0.23",
+    "@vnodes/prop": "0.0.23",
+    "@vnodes/env": "0.0.23"
+  },
+  "peerDependencies": {
+    "@vnodes/env": "0.0.23",
+    "@vnodes/nestjs": "0.0.23",
+    "@vnodes/prop": "0.0.23"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  }
+}