@rsdk/grpc.loader 1.0.13

package/CHANGELOG.md

@@ -0,0 +1,62 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.13 (2023-06-06)
+
+**Note:** Version bump only for package @rsdk/grpc.loader
+
+## 1.0.12 (2023-05-23)
+
+### Bug Fixes
+
+* remove private dependencies from `peerDependencies` section ([0bce6ff](https://github.com/R-Vision/rsdk/commit/0bce6ffb5b699e2ed1dc9aca77cbdbf085267ff7))
+
+## 1.0.11 (2023-05-23)
+
+**Note:** Version bump only for package @rsdk/grpc.loader
+
+## 1.0.10 (2023-05-22)
+
+### Bug Fixes
+
+* add "access: public" to new packages ([04d5983](https://github.com/R-Vision/rsdk/commit/04d5983cfa3e97c5d8219e07208a0499a8c6bc83))
+
+## 1.0.9 (2023-05-21)
+
+**Note:** Version bump only for package @rsdk/grpc.loader
+
+## 1.0.8 (2023-05-17)
+
+**Note:** Version bump only for package @rsdk/grpc.loader
+
+## 1.0.7 (2023-05-11)
+
+**Note:** Version bump only for package @rsdk/grpc.loader
+
+## 1.0.6 (2023-05-11)
+
+**Note:** Version bump only for package @rsdk/grpc.loader
+
+## 1.0.5 (2023-05-10)
+
+**Note:** Version bump only for package @rsdk/grpc.loader
+
+## 1.0.4 (2023-05-10)
+
+**Note:** Version bump only for package @rsdk/grpc.loader
+
+## 1.0.3 (2023-05-10)
+
+### Bug Fixes
+
+* builtin make not private in npm ([50c83b6](https://github.com/R-Vision/rsdk/commit/50c83b6454f9a89f1e99d3b33a497ce2c029d8c6))
+
+## 1.0.2 (2023-05-10)
+
+**Note:** Version bump only for package @rsdk/grpc.loader
+
+## 1.0.1 (2023-05-07)
+
+**Note:** Version bump only for package @rsdk/grpc.loader

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './loader';
+export * from './options';

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./loader"), exports);
+__exportStar(require("./options"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,4CAA0B"}

package/dist/loader.d.ts

@@ -0,0 +1,50 @@
+/**
+ * CUSTOM PROTO "LOADER"
+ *
+ * Стандартный loader, который использует нест (@grpc/proto-loader) требует для работы
+ * исходных .proto-файлов. Нам это не подходит, т.к. контракты мы храним в отдельных
+ * репозиториях.
+ *
+ * Данный модуль, подсовывается несту, вместо @grpc/proto-loader.
+ *
+ * Как это работает:
+ *
+ * Для работы gRPC-транспорту неста нужны "определения"/"дефинишены" - они же definitions.
+ * Определения представляют собой объект такого вида:
+ *
+  {
+    'package1.v1.SomeService': {
+      something: {
+        path: '/package1.v1.SomeService/Something',
+        requestStream: false,
+        responseStream: false,
+        requestSerialize: ...,
+        requestDeserialize: ...,
+        responseSerialize: ...,
+        responseDeserialize: ...
+      },
+    },
+    ...
+  }
+ *
+ * Первый уровень ключей - <имя grpc-пакета>.<имя grpc-сервиса>.
+ * Второй уровень - название gRPC метода (приведённое к camelCase)
+ *
+ * Подобные объекты генерируется из .proto-файлов при помощи библиотеки
+ * @grpc/grpc-js, которую мы используем в нашем генераторе.
+ * TODO: ссылку на репозиторий генератора
+ *
+ * Функция loadSync не предназначена для пробрасывания этих дефинишенов напрямую.
+ * Но объект передаваемый в поле loader попадёт в функцию без изменений.
+ * Этим фактом мы и пользуемся для проброса массива объектов классы Package,
+ * которые содержат всю необходимую информацию.
+ *
+ * Остётся только смержить данные по всем пакетам в один объект и сделать правильные
+ * ключи.
+ *
+ * NOTE: В первом аргументе, соотвественно, будет undefined, поскольку поле protoPath
+ * мы не передаём
+ */
+export declare function loadSync(_file: string | string[], loader: {
+    packages: Record<string, any>[];
+}): object;

package/dist/loader.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadSync = void 0;
+/**
+ * CUSTOM PROTO "LOADER"
+ *
+ * Стандартный loader, который использует нест (@grpc/proto-loader) требует для работы
+ * исходных .proto-файлов. Нам это не подходит, т.к. контракты мы храним в отдельных
+ * репозиториях.
+ *
+ * Данный модуль, подсовывается несту, вместо @grpc/proto-loader.
+ *
+ * Как это работает:
+ *
+ * Для работы gRPC-транспорту неста нужны "определения"/"дефинишены" - они же definitions.
+ * Определения представляют собой объект такого вида:
+ *
+  {
+    'package1.v1.SomeService': {
+      something: {
+        path: '/package1.v1.SomeService/Something',
+        requestStream: false,
+        responseStream: false,
+        requestSerialize: ...,
+        requestDeserialize: ...,
+        responseSerialize: ...,
+        responseDeserialize: ...
+      },
+    },
+    ...
+  }
+ *
+ * Первый уровень ключей - <имя grpc-пакета>.<имя grpc-сервиса>.
+ * Второй уровень - название gRPC метода (приведённое к camelCase)
+ *
+ * Подобные объекты генерируется из .proto-файлов при помощи библиотеки
+ * @grpc/grpc-js, которую мы используем в нашем генераторе.
+ * TODO: ссылку на репозиторий генератора
+ *
+ * Функция loadSync не предназначена для пробрасывания этих дефинишенов напрямую.
+ * Но объект передаваемый в поле loader попадёт в функцию без изменений.
+ * Этим фактом мы и пользуемся для проброса массива объектов классы Package,
+ * которые содержат всю необходимую информацию.
+ *
+ * Остётся только смержить данные по всем пакетам в один объект и сделать правильные
+ * ключи.
+ *
+ * NOTE: В первом аргументе, соотвественно, будет undefined, поскольку поле protoPath
+ * мы не передаём
+ */
+function loadSync(_file, loader) {
+    const result = {};
+    for (const pkg of loader.packages) {
+        // Берём именно definitions['grpc-js']
+        // Есть ещёdefinitions['generic'] - они для другого
+        const definitions = pkg.definitions['grpc-js'];
+        for (const [service, definition] of Object.entries(definitions)) {
+            result[`${pkg.name}.${service}`] = definition;
+        }
+    }
+    return result;
+}
+exports.loadSync = loadSync;
+//# sourceMappingURL=loader.js.map

package/dist/loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,SAAgB,QAAQ,CACtB,KAAwB,EACxB,MAA2C;IAE3C,MAAM,MAAM,GAA4B,EAAE,CAAC;IAE3C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,QAAQ,EAAE;QACjC,sCAAsC;QACtC,mDAAmD;QACnD,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAE/C,KAAK,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YAC/D,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC,GAAG,UAAU,CAAC;SAC/C;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAjBD,4BAiBC"}

package/dist/options.d.ts

@@ -0,0 +1,14 @@
+import type { MicroserviceOptions } from '@nestjs/microservices';
+export interface Package {
+    readonly name: string;
+    readonly definitions: {
+        'grpc-js': object;
+        generic: object;
+    };
+}
+export interface GrpcServerOptions {
+    address: string;
+    maxRecv?: number;
+    maxSend?: number;
+}
+export declare const createGrpcOptions: (packages: Package[], options: GrpcServerOptions) => MicroserviceOptions;

package/dist/options.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createGrpcOptions = void 0;
+const microservices_1 = require("@nestjs/microservices");
+const createGrpcOptions = (packages, options) => {
+    return {
+        transport: microservices_1.Transport.GRPC,
+        options: {
+            loader: {
+                packages,
+            },
+            /**
+             * Подменяем дефолтный @grpc/proto-loader реализацией,
+             * не требующей исходных .proto-файлов
+             */
+            protoLoader: '@rsdk/grpc.loader',
+            // Actually package'S'
+            package: packages.map((x) => x.name),
+            url: options.address,
+            channelOptions: {
+                'grpc.max_receive_message_length': options.maxRecv,
+                'grpc.max_send_message_length': options.maxSend,
+            },
+        },
+    };
+};
+exports.createGrpcOptions = createGrpcOptions;
+//# sourceMappingURL=options.js.map

package/dist/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":";;;AACA,yDAAkD;AAsB3C,MAAM,iBAAiB,GAAG,CAC/B,QAAmB,EACnB,OAA0B,EACL,EAAE;IACvB,OAAO;QACL,SAAS,EAAE,yBAAS,CAAC,IAAI;QAEzB,OAAO,EAAE;YACP,MAAM,EAAE;gBACN,QAAQ;aACT;YAED;;;eAGG;YACH,WAAW,EAAE,mBAAmB;YAEhC,sBAAsB;YACtB,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YACpC,GAAG,EAAE,OAAO,CAAC,OAAO;YAEpB,cAAc,EAAE;gBACd,iCAAiC,EAAE,OAAO,CAAC,OAAO;gBAClD,8BAA8B,EAAE,OAAO,CAAC,OAAO;aAChD;SACK;KACT,CAAC;AACJ,CAAC,CAAC;AA5BW,QAAA,iBAAiB,qBA4B5B"}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@rsdk/grpc.loader",
+  "version": "1.0.13",
+  "description": "Load generated ts code to nestjs and initialize microservice",
+  "license": "Apache License 2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "url": "https://github.com/R-Vision/rsdk"
+  },
+  "main": "dist/index.js",
+  "peerDependencies": {
+    "@nestjs/microservices": "^9.0.0"
+  },
+  "gitHead": "1f40e539993d341b239f78bf2f8b29b44fae9c1e"
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './loader';
+export * from './options';

package/src/loader.ts

@@ -0,0 +1,65 @@
+/**
+ * CUSTOM PROTO "LOADER"
+ * 
+ * Стандартный loader, который использует нест (@grpc/proto-loader) требует для работы
+ * исходных .proto-файлов. Нам это не подходит, т.к. контракты мы храним в отдельных
+ * репозиториях.
+ * 
+ * Данный модуль, подсовывается несту, вместо @grpc/proto-loader.
+ * 
+ * Как это работает:
+ * 
+ * Для работы gRPC-транспорту неста нужны "определения"/"дефинишены" - они же definitions.
+ * Определения представляют собой объект такого вида:
+ * 
+  {
+    'package1.v1.SomeService': {
+      something: {
+        path: '/package1.v1.SomeService/Something',
+        requestStream: false,
+        responseStream: false,
+        requestSerialize: ...,
+        requestDeserialize: ...,
+        responseSerialize: ...,
+        responseDeserialize: ...
+      },
+    },
+    ...
+  }
+ * 
+ * Первый уровень ключей - <имя grpc-пакета>.<имя grpc-сервиса>.
+ * Второй уровень - название gRPC метода (приведённое к camelCase)
+ * 
+ * Подобные объекты генерируется из .proto-файлов при помощи библиотеки
+ * @grpc/grpc-js, которую мы используем в нашем генераторе.
+ * TODO: ссылку на репозиторий генератора
+ * 
+ * Функция loadSync не предназначена для пробрасывания этих дефинишенов напрямую.
+ * Но объект передаваемый в поле loader попадёт в функцию без изменений.
+ * Этим фактом мы и пользуемся для проброса массива объектов классы Package,
+ * которые содержат всю необходимую информацию.
+ * 
+ * Остётся только смержить данные по всем пакетам в один объект и сделать правильные
+ * ключи.
+ * 
+ * NOTE: В первом аргументе, соотвественно, будет undefined, поскольку поле protoPath
+ * мы не передаём
+ */
+export function loadSync(
+  _file: string | string[],
+  loader: { packages: Record<string, any>[] },
+): object {
+  const result: Record<string, unknown> = {};
+
+  for (const pkg of loader.packages) {
+    // Берём именно definitions['grpc-js']
+    // Есть ещёdefinitions['generic'] - они для другого
+    const definitions = pkg.definitions['grpc-js'];
+
+    for (const [service, definition] of Object.entries(definitions)) {
+      result[`${pkg.name}.${service}`] = definition;
+    }
+  }
+
+  return result;
+}

package/src/options.ts

@@ -0,0 +1,52 @@
+import type { MicroserviceOptions } from '@nestjs/microservices';
+import { Transport } from '@nestjs/microservices';
+
+// Represents GRPC package
+export interface Package {
+  readonly name: string;
+  readonly definitions: {
+    'grpc-js': object;
+    generic: object;
+  };
+}
+
+export interface GrpcServerOptions {
+  // Grpc server address (host:port)
+  address: string;
+
+  // Max gRPC message size (receive)
+  maxRecv?: number;
+
+  // Max gRPC message size (send)
+  maxSend?: number;
+}
+
+export const createGrpcOptions = (
+  packages: Package[],
+  options: GrpcServerOptions,
+): MicroserviceOptions => {
+  return {
+    transport: Transport.GRPC,
+
+    options: {
+      loader: {
+        packages,
+      },
+
+      /**
+       * Подменяем дефолтный @grpc/proto-loader реализацией,
+       * не требующей исходных .proto-файлов
+       */
+      protoLoader: '@rsdk/grpc.loader',
+
+      // Actually package'S'
+      package: packages.map((x) => x.name),
+      url: options.address,
+
+      channelOptions: {
+        'grpc.max_receive_message_length': options.maxRecv,
+        'grpc.max_send_message_length': options.maxSend,
+      },
+    } as any,
+  };
+};

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+
+  "extends": "@rsdk/tsconfig/base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}