@rsdk/nest-tools 1.0.12 → 2.4.1-next.0

package/CHANGELOG.md

@@ -3,6 +3,49 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.4.1-next.0](https://github.com/R-Vision/rsdk/compare/v2.4.0...v2.4.1-next.0) (2023-06-15)
+
+**Note:** Version bump only for package @rsdk/nest-tools
+
+# [2.0.0](https://github.com/R-Vision/rsdk/compare/v1.0.12...v2.0.0) (2023-06-06)
+
+### Draft
+
+* Pfm 303 static to meta migration ([#45](https://github.com/R-Vision/rsdk/issues/45)) ([d98e303](https://github.com/R-Vision/rsdk/commit/d98e3032f9b10446b478427d841b9209ed68fa2d))
+
+### BREAKING CHANGES
+
+* GrpcClientModule removed
+new way for declaration with `GrpcServers.define()` and `@InjectGrpcClient`
+
+* fix: rework interaction with metadata and generating modules from metadata
+
+* refactor: destructring added
+
+* docs: added docs for autodoc pre-commit hook
+
+* chore: spell fix
+
+* chore: some improves declaration
+
+* chore: laconic naming for constants
+
+* chore: remove useless
+
+* chore: move file to suitable place
+
+* chore: remove useless imports
+
+* chore!: remove boostrap tasks from Makefile
+
+* chore: rework test tasks
+
+* feat: grpc client plugin useless
+
+* chore: verbosed naming
+
+* docs: improve verbosity
+
 ## 1.0.12 (2023-05-23)
 
 ### Bug Fixes

package/dist/constants.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NestDefinitionType = void 0;
 var NestDefinitionType;
 (function (NestDefinitionType) {
+    // eslint-disable-next-line unicorn/prefer-math-trunc
     NestDefinitionType[NestDefinitionType["Module"] = 1] = "Module";
     NestDefinitionType[NestDefinitionType["Controllers"] = 2] = "Controllers";
     NestDefinitionType[NestDefinitionType["Providers"] = 4] = "Providers";

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { NestDefinitionType } from './constants';
-export { NestDefinitionMediator } from './nest-definition.mediator';
+export { NestDefinitionIterator } from './nest-definition.iterator';
 export { NestDefinition } from './nest-definition';

package/dist/index.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NestDefinition = exports.NestDefinitionMediator = exports.NestDefinitionType = void 0;
+exports.NestDefinition = exports.NestDefinitionIterator = exports.NestDefinitionType = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "NestDefinitionType", { enumerable: true, get: function () { return constants_1.NestDefinitionType; } });
-var nest_definition_mediator_1 = require("./nest-definition.mediator");
-Object.defineProperty(exports, "NestDefinitionMediator", { enumerable: true, get: function () { return nest_definition_mediator_1.NestDefinitionMediator; } });
+var nest_definition_iterator_1 = require("./nest-definition.iterator");
+Object.defineProperty(exports, "NestDefinitionIterator", { enumerable: true, get: function () { return nest_definition_iterator_1.NestDefinitionIterator; } });
 var nest_definition_1 = require("./nest-definition");
 Object.defineProperty(exports, "NestDefinition", { enumerable: true, get: function () { return nest_definition_1.NestDefinition; } });

package/dist/nest-definition.d.ts

@@ -3,8 +3,6 @@ export type NestModuleDefinition = DynamicModule | Type;
 /**
  * Хелпер для работы с объявлением модуля nest.
  * Получения провайдеров и импортов
- *
- * TODO: Объяснить что это за нафиг?
  */
 export declare class NestDefinition {
     private definition;

package/dist/{nest-definition.mediator.d.ts → nest-definition.iterator.d.ts}

@@ -1,8 +1,13 @@
 import type { Provider } from '@nestjs/common';
+import type { Promisable } from 'type-fest';
 import { NestDefinitionType } from './constants';
 import type { NestModuleDefinition } from './nest-definition';
-export declare class NestDefinitionMediator {
+export declare class NestDefinitionIterator {
     private nestModuleDefinition;
-    constructor(nestModuleDefinition: NestModuleDefinition);
+    constructor(nestModuleDefinition: Promisable<NestModuleDefinition>);
+    /**
+     * By default dont iterate by exports
+     * @param type
+     */
     iterate(type?: NestDefinitionType): AsyncIterableIterator<NestModuleDefinition | Provider>;
 }

package/dist/{nest-definition.mediator.js → nest-definition.iterator.js}

@@ -1,20 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NestDefinitionMediator = void 0;
+exports.NestDefinitionIterator = void 0;
 const constants_1 = require("./constants");
 const nest_definition_1 = require("./nest-definition");
-class NestDefinitionMediator {
+class NestDefinitionIterator {
     nestModuleDefinition;
     constructor(nestModuleDefinition) {
         this.nestModuleDefinition = nestModuleDefinition;
     }
+    /**
+     * By default dont iterate by exports
+     * @param type
+     */
     async *iterate(type) {
-        const iterateAll = typeof type === 'undefined';
+        const iterateAll = type === undefined;
         const iterateModule = iterateAll || type & constants_1.NestDefinitionType.Module;
+        const awaitedNestModuleDefinition = await this.nestModuleDefinition;
         if (iterateModule) {
-            yield this.nestModuleDefinition;
+            yield awaitedNestModuleDefinition;
+            if ('module' in awaitedNestModuleDefinition) {
+                yield awaitedNestModuleDefinition.module;
+            }
         }
-        const nestDefinition = new nest_definition_1.NestDefinition(this.nestModuleDefinition);
+        const nestDefinition = new nest_definition_1.NestDefinition(awaitedNestModuleDefinition);
         const nestImports = await nestDefinition.getImports();
         const iterateProviders = iterateAll || type & constants_1.NestDefinitionType.Providers;
         if (iterateProviders) {
@@ -23,7 +31,7 @@ class NestDefinitionMediator {
                 yield provider;
             }
         }
-        const iterateExports = iterateAll || type & constants_1.NestDefinitionType.Exports;
+        const iterateExports = type !== undefined && type & constants_1.NestDefinitionType.Exports;
         if (iterateExports) {
             const exports = nestDefinition.getExports();
             for (const nestExport of exports ?? []) {
@@ -38,8 +46,8 @@ class NestDefinitionMediator {
             }
         }
         for (const nestImport of nestImports ?? []) {
-            yield* new NestDefinitionMediator(nestImport).iterate(type);
+            yield* new NestDefinitionIterator(nestImport).iterate(type);
         }
     }
 }
-exports.NestDefinitionMediator = NestDefinitionMediator;
+exports.NestDefinitionIterator = NestDefinitionIterator;

package/dist/nest-definition.js

@@ -6,8 +6,6 @@ const scanner_1 = require("@nestjs/core/scanner");
 /**
  * Хелпер для работы с объявлением модуля nest.
  * Получения провайдеров и импортов
- *
- * TODO: Объяснить что это за нафиг?
  */
 class NestDefinition {
     definition;
@@ -15,36 +13,36 @@ class NestDefinition {
         this.definition = definition;
     }
     getProviders() {
-        return !scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
-            ? this.reflectMetadata(constants_1.MODULE_METADATA.PROVIDERS, this.definition)
-            : [
+        return scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
+            ? [
                 ...this.reflectMetadata(constants_1.MODULE_METADATA.PROVIDERS, this.definition.module),
                 ...(this.definition.providers || []),
-            ];
+            ]
+            : this.reflectMetadata(constants_1.MODULE_METADATA.PROVIDERS, this.definition);
     }
     getImports() {
-        return !scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
-            ? this.reflectMetadata(constants_1.MODULE_METADATA.IMPORTS, this.definition)
-            : [
+        return scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
+            ? [
                 ...this.reflectMetadata(constants_1.MODULE_METADATA.IMPORTS, this.definition.module),
                 ...(this.definition.imports || []),
-            ];
+            ]
+            : this.reflectMetadata(constants_1.MODULE_METADATA.IMPORTS, this.definition);
     }
     getControllers() {
-        return !scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
-            ? this.reflectMetadata(constants_1.MODULE_METADATA.CONTROLLERS, this.definition)
-            : [
+        return scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
+            ? [
                 ...this.reflectMetadata(constants_1.MODULE_METADATA.CONTROLLERS, this.definition.module),
                 ...(this.definition.controllers || []),
-            ];
+            ]
+            : this.reflectMetadata(constants_1.MODULE_METADATA.CONTROLLERS, this.definition);
     }
     getExports() {
-        return !scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
-            ? this.reflectMetadata(constants_1.MODULE_METADATA.EXPORTS, this.definition)
-            : [
+        return scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
+            ? [
                 ...this.reflectMetadata(constants_1.MODULE_METADATA.EXPORTS, this.definition.module),
                 ...(this.definition.exports || []),
-            ];
+            ]
+            : this.reflectMetadata(constants_1.MODULE_METADATA.EXPORTS, this.definition);
     }
     reflectMetadata(metadataKey, metatype) {
         return Reflect.getMetadata(metadataKey, metatype) || [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/nest-tools",
-  "version": "1.0.12",
+  "version": "2.4.1-next.0",
   "license": "Apache License 2.0",
   "publishConfig": {
     "access": "public"
@@ -10,5 +10,5 @@
     "@nestjs/common": "^9.0.0",
     "@nestjs/core": "^9.0.0"
   },
-  "gitHead": "e2741fe798655b87946330f8db0705e0f7ba2fb2"
+  "gitHead": "02cbc6be59dcf7d7784b316b315eb746c6d5ac4a"
 }

package/src/constants.ts

@@ -1,4 +1,5 @@
 export enum NestDefinitionType {
+  // eslint-disable-next-line unicorn/prefer-math-trunc
   Module = 1 << 0,
   Controllers = 1 << 1,
   Providers = 1 << 2,

package/src/index.ts

@@ -1,5 +1,5 @@
 export { NestDefinitionType } from './constants';
 
-export { NestDefinitionMediator } from './nest-definition.mediator';
+export { NestDefinitionIterator } from './nest-definition.iterator';
 
 export { NestDefinition } from './nest-definition';

package/src/{nest-definition.mediator.ts → nest-definition.iterator.ts}

@@ -1,21 +1,30 @@
 import type { Provider } from '@nestjs/common';
+import type { Promisable } from 'type-fest';
 
 import { NestDefinitionType } from './constants';
 import type { NestModuleDefinition } from './nest-definition';
 import { NestDefinition } from './nest-definition';
 
-export class NestDefinitionMediator {
-  constructor(private nestModuleDefinition: NestModuleDefinition) {}
+export class NestDefinitionIterator {
+  constructor(private nestModuleDefinition: Promisable<NestModuleDefinition>) {}
 
+  /**
+   * By default dont iterate by exports
+   * @param type
+   */
   async *iterate(
     type?: NestDefinitionType,
   ): AsyncIterableIterator<NestModuleDefinition | Provider> {
-    const iterateAll = typeof type === 'undefined';
+    const iterateAll = type === undefined;
     const iterateModule = iterateAll || type & NestDefinitionType.Module;
+    const awaitedNestModuleDefinition = await this.nestModuleDefinition;
     if (iterateModule) {
-      yield this.nestModuleDefinition;
+      yield awaitedNestModuleDefinition;
+      if ('module' in awaitedNestModuleDefinition) {
+        yield awaitedNestModuleDefinition.module;
+      }
     }
-    const nestDefinition = new NestDefinition(this.nestModuleDefinition);
+    const nestDefinition = new NestDefinition(awaitedNestModuleDefinition);
 
     const nestImports = await nestDefinition.getImports();
 
@@ -28,7 +37,8 @@ export class NestDefinitionMediator {
       }
     }
 
-    const iterateExports = iterateAll || type & NestDefinitionType.Exports;
+    const iterateExports =
+      type !== undefined && type & NestDefinitionType.Exports;
 
     if (iterateExports) {
       const exports = nestDefinition.getExports();
@@ -50,7 +60,7 @@ export class NestDefinitionMediator {
     }
 
     for (const nestImport of nestImports ?? []) {
-      yield* new NestDefinitionMediator(nestImport).iterate(type);
+      yield* new NestDefinitionIterator(nestImport).iterate(type);
     }
   }
 }

package/src/nest-definition.ts

@@ -7,58 +7,56 @@ export type NestModuleDefinition = DynamicModule | Type;
 /**
  * Хелпер для работы с объявлением модуля nest.
  * Получения провайдеров и импортов
- *
- * TODO: Объяснить что это за нафиг?
  */
 export class NestDefinition {
   constructor(private definition: NestModuleDefinition) {}
 
   getProviders(): Provider[] | undefined {
-    return !DependenciesScanner.prototype.isDynamicModule(this.definition)
-      ? this.reflectMetadata(MODULE_METADATA.PROVIDERS, this.definition)
-      : [
+    return DependenciesScanner.prototype.isDynamicModule(this.definition)
+      ? [
           ...this.reflectMetadata(
             MODULE_METADATA.PROVIDERS,
             this.definition.module,
           ),
           ...(this.definition.providers || []),
-        ];
+        ]
+      : this.reflectMetadata(MODULE_METADATA.PROVIDERS, this.definition);
   }
 
   getImports(): NestModuleDefinition[] | undefined {
-    return !DependenciesScanner.prototype.isDynamicModule(this.definition)
-      ? this.reflectMetadata(MODULE_METADATA.IMPORTS, this.definition)
-      : [
+    return DependenciesScanner.prototype.isDynamicModule(this.definition)
+      ? [
           ...this.reflectMetadata(
             MODULE_METADATA.IMPORTS,
             this.definition.module,
           ),
           ...(this.definition.imports || []),
-        ];
+        ]
+      : this.reflectMetadata(MODULE_METADATA.IMPORTS, this.definition);
   }
 
   getControllers(): Type[] | undefined {
-    return !DependenciesScanner.prototype.isDynamicModule(this.definition)
-      ? this.reflectMetadata(MODULE_METADATA.CONTROLLERS, this.definition)
-      : [
+    return DependenciesScanner.prototype.isDynamicModule(this.definition)
+      ? [
           ...this.reflectMetadata(
             MODULE_METADATA.CONTROLLERS,
             this.definition.module,
           ),
           ...(this.definition.controllers || []),
-        ];
+        ]
+      : this.reflectMetadata(MODULE_METADATA.CONTROLLERS, this.definition);
   }
 
   getExports(): Type[] | undefined {
-    return !DependenciesScanner.prototype.isDynamicModule(this.definition)
-      ? this.reflectMetadata(MODULE_METADATA.EXPORTS, this.definition)
-      : [
+    return DependenciesScanner.prototype.isDynamicModule(this.definition)
+      ? [
           ...this.reflectMetadata(
             MODULE_METADATA.EXPORTS,
             this.definition.module,
           ),
           ...(this.definition.exports || []),
-        ];
+        ]
+      : this.reflectMetadata(MODULE_METADATA.EXPORTS, this.definition);
   }
 
   private reflectMetadata<T = any>(metadataKey: string, metatype: Type): T[] {