@rsdk/nest-tools 3.1.0 → 3.4.1-next.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.4.1-next.0](https://github.com/R-Vision/rsdk/compare/v3.4.0...v3.4.1-next.0) (2023-09-01)
+
+### Bug Fixes
+
+* added correctly exception and warn on incorrectly value in module tree ([2349782](https://github.com/R-Vision/rsdk/commit/234978226ff9a41a9781fc773d35f865e09ce371))
+
 ## [3.1.0](https://github.com/R-Vision/rsdk/compare/v3.1.0-next.3...v3.1.0) (2023-08-09)
 
 **Note:** Version bump only for package @rsdk/nest-tools

package/dist/exception.d.ts

@@ -0,0 +1,11 @@
+export declare abstract class Exception extends Error {
+    name: string;
+}
+export declare class FalsyValueInNestModuleTree extends Exception {
+    readonly moduleValue: unknown;
+    constructor(moduleValue: unknown);
+}
+export declare class UnexpectedNestModuleDefinitionValue extends Exception {
+    readonly moduleValue: unknown;
+    constructor(moduleValue: unknown);
+}

package/dist/exception.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnexpectedNestModuleDefinitionValue = exports.FalsyValueInNestModuleTree = exports.Exception = void 0;
+class Exception extends Error {
+    name = this.constructor.name;
+}
+exports.Exception = Exception;
+class FalsyValueInNestModuleTree extends Exception {
+    moduleValue;
+    constructor(moduleValue) {
+        const message = moduleValue === undefined
+            ? `Undefined was found in the tree of the test module, a cyclic dependence is possible`
+            : `Falsy value was found in nest module tree: ${moduleValue}`;
+        super(message);
+        this.moduleValue = moduleValue;
+    }
+}
+exports.FalsyValueInNestModuleTree = FalsyValueInNestModuleTree;
+class UnexpectedNestModuleDefinitionValue extends Exception {
+    moduleValue;
+    constructor(moduleValue) {
+        super();
+        this.moduleValue = moduleValue;
+    }
+}
+exports.UnexpectedNestModuleDefinitionValue = UnexpectedNestModuleDefinitionValue;

package/dist/nest-definition.d.ts

@@ -1,4 +1,4 @@
-import type { DynamicModule, Provider, Type } from '@nestjs/common';
+import type { DynamicModule, InjectionToken, Provider, Type } from '@nestjs/common';
 export type NestModuleDefinition = DynamicModule | Type;
 /**
  * Хелпер для работы с объявлением модуля nest.
@@ -10,6 +10,6 @@ export declare class NestDefinition {
     getProviders(): Provider[] | undefined;
     getImports(): NestModuleDefinition[] | undefined;
     getControllers(): Type[] | undefined;
-    getExports(): Type[] | undefined;
+    getExports(): (Type | InjectionToken)[] | undefined;
     private reflectMetadata;
 }

package/dist/nest-definition.iterator.d.ts

@@ -1,7 +1,11 @@
-import type { Provider } from '@nestjs/common';
+import type { Abstract, ClassProvider, DynamicModule, ExistingProvider, FactoryProvider, InjectionToken, Provider, Type, ValueProvider } from '@nestjs/common';
 import type { Promisable } from 'type-fest';
 import { NestDefinitionType } from './constants';
 import type { NestModuleDefinition } from './nest-definition';
+export declare class Assert {
+    static isObjectOrCtor(nestDefinition: DynamicModule | Type<any> | ClassProvider<any> | ValueProvider<any> | FactoryProvider<any> | ExistingProvider<any> | string | symbol | Abstract<any>): nestDefinition is DynamicModule | Type<any> | ClassProvider<any> | ValueProvider<any> | FactoryProvider<any> | ExistingProvider<any> | Abstract<any> | Function;
+    static isObject(v: unknown): v is object;
+}
 export declare class NestDefinitionIterator {
     private nestModuleDefinition;
     constructor(nestModuleDefinition: Promisable<NestModuleDefinition>);
@@ -9,6 +13,6 @@ export declare class NestDefinitionIterator {
      * By default dont iterate by exports
      * @param type
      */
-    iterate(type?: NestDefinitionType): AsyncIterableIterator<NestModuleDefinition | Provider>;
-    find<R extends NestModuleDefinition | Provider>(predicate: (definition: NestModuleDefinition | Provider) => boolean, type?: NestDefinitionType): Promise<R | null>;
+    iterate(type?: NestDefinitionType): AsyncIterableIterator<NestModuleDefinition | Provider | InjectionToken>;
+    find<R extends NestModuleDefinition | Provider>(predicate: (definition: NestModuleDefinition | Provider | Function) => boolean, type?: NestDefinitionType): Promise<R | null>;
 }

package/dist/nest-definition.iterator.js

@@ -1,8 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NestDefinitionIterator = void 0;
+exports.NestDefinitionIterator = exports.Assert = void 0;
 const constants_1 = require("./constants");
+const exception_1 = require("./exception");
 const nest_definition_1 = require("./nest-definition");
+class Assert {
+    static isObjectOrCtor(nestDefinition) {
+        return ['object', 'function'].includes(typeof nestDefinition);
+    }
+    static isObject(v) {
+        return typeof v === 'object';
+    }
+}
+exports.Assert = Assert;
 class NestDefinitionIterator {
     nestModuleDefinition;
     constructor(nestModuleDefinition) {
@@ -14,16 +24,19 @@ class NestDefinitionIterator {
      */
     async *iterate(type) {
         const iterateAll = type === undefined;
-        const iterateModule = iterateAll || type & constants_1.NestDefinitionType.Module;
+        const iterateByModule = iterateAll || type & constants_1.NestDefinitionType.Module;
         const awaitedNestModuleDefinition = await this.nestModuleDefinition;
-        if (iterateModule) {
+        if (!awaitedNestModuleDefinition) {
+            throw new exception_1.FalsyValueInNestModuleTree(awaitedNestModuleDefinition);
+        }
+        if (iterateByModule) {
             yield awaitedNestModuleDefinition;
             if ('module' in awaitedNestModuleDefinition) {
                 yield awaitedNestModuleDefinition.module;
             }
         }
         const nestDefinition = new nest_definition_1.NestDefinition(awaitedNestModuleDefinition);
-        const nestImports = await nestDefinition.getImports();
+        const nestImports = nestDefinition.getImports();
         const iterateProviders = iterateAll || type & constants_1.NestDefinitionType.Providers;
         if (iterateProviders) {
             const providers = nestDefinition.getProviders();
@@ -51,6 +64,9 @@ class NestDefinitionIterator {
     }
     async find(predicate, type) {
         for await (const definition of this.iterate(type)) {
+            if (!Assert.isObjectOrCtor(definition)) {
+                throw new exception_1.UnexpectedNestModuleDefinitionValue(definition);
+            }
             const isNeeded = predicate(definition);
             if (isNeeded) {
                 return definition;

package/dist/nest-definition.js

@@ -13,37 +13,30 @@ class NestDefinition {
         this.definition = definition;
     }
     getProviders() {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         return scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
             ? [
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
                 ...this.reflectMetadata(constants_1.MODULE_METADATA.PROVIDERS, this.definition.module),
                 ...(this.definition.providers || []),
             ]
             : this.reflectMetadata(constants_1.MODULE_METADATA.PROVIDERS, this.definition);
     }
     getImports() {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         return scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
             ? [
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
                 ...this.reflectMetadata(constants_1.MODULE_METADATA.IMPORTS, this.definition.module),
                 ...(this.definition.imports || []),
             ]
             : this.reflectMetadata(constants_1.MODULE_METADATA.IMPORTS, this.definition);
     }
     getControllers() {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         return scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
             ? [
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
                 ...this.reflectMetadata(constants_1.MODULE_METADATA.CONTROLLERS, this.definition.module),
                 ...(this.definition.controllers || []),
             ]
             : this.reflectMetadata(constants_1.MODULE_METADATA.CONTROLLERS, this.definition);
     }
     getExports() {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         return scanner_1.DependenciesScanner.prototype.isDynamicModule(this.definition)
             ? [
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
@@ -53,7 +46,6 @@ class NestDefinition {
             : this.reflectMetadata(constants_1.MODULE_METADATA.EXPORTS, this.definition);
     }
     reflectMetadata(metadataKey, metatype) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         return Reflect.getMetadata(metadataKey, metatype) || [];
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/nest-tools",
-  "version": "3.1.0",
+  "version": "3.4.1-next.0",
   "license": "Apache License 2.0",
   "publishConfig": {
     "access": "public"
@@ -10,5 +10,5 @@
     "@nestjs/common": "^10.1.3",
     "@nestjs/core": "^10.1.3"
   },
-  "gitHead": "428640441ec53822ea1c1be7b085bb9dad04689d"
+  "gitHead": "ea16db30e841625857ace62dff377e2c5a952980"
 }

package/src/exception.ts

@@ -0,0 +1,20 @@
+export abstract class Exception extends Error {
+  override name = this.constructor.name;
+}
+
+export class FalsyValueInNestModuleTree extends Exception {
+  constructor(readonly moduleValue: unknown) {
+    const message =
+      moduleValue === undefined
+        ? `Undefined was found in the tree of the test module, a cyclic dependence is possible`
+        : `Falsy value was found in nest module tree: ${moduleValue}`;
+
+    super(message);
+  }
+}
+
+export class UnexpectedNestModuleDefinitionValue extends Exception {
+  constructor(readonly moduleValue: unknown) {
+    super();
+  }
+}

package/src/nest-definition.iterator.ts

@@ -1,10 +1,54 @@
-import type { Provider } from '@nestjs/common';
+import type {
+  Abstract,
+  ClassProvider,
+  DynamicModule,
+  ExistingProvider,
+  FactoryProvider,
+  InjectionToken,
+  Provider,
+  Type,
+  ValueProvider,
+} from '@nestjs/common';
 import type { Promisable } from 'type-fest';
 
 import { NestDefinitionType } from './constants';
+import {
+  FalsyValueInNestModuleTree,
+  UnexpectedNestModuleDefinitionValue,
+} from './exception';
 import type { NestModuleDefinition } from './nest-definition';
 import { NestDefinition } from './nest-definition';
 
+export class Assert {
+  static isObjectOrCtor(
+    nestDefinition:
+      | DynamicModule
+      | Type<any>
+      | ClassProvider<any>
+      | ValueProvider<any>
+      | FactoryProvider<any>
+      | ExistingProvider<any>
+      | string
+      | symbol
+      | Abstract<any>,
+  ): nestDefinition is
+    | DynamicModule
+    | Type<any>
+    | ClassProvider<any>
+    | ValueProvider<any>
+    | FactoryProvider<any>
+    | ExistingProvider<any>
+    | Abstract<any>
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    | Function {
+    return ['object', 'function'].includes(typeof nestDefinition);
+  }
+
+  static isObject(v: unknown): v is object {
+    return typeof v === 'object';
+  }
+}
+
 export class NestDefinitionIterator {
   constructor(private nestModuleDefinition: Promisable<NestModuleDefinition>) {}
 
@@ -14,11 +58,14 @@ export class NestDefinitionIterator {
    */
   async *iterate(
     type?: NestDefinitionType,
-  ): AsyncIterableIterator<NestModuleDefinition | Provider> {
+  ): AsyncIterableIterator<NestModuleDefinition | Provider | InjectionToken> {
     const iterateAll = type === undefined;
-    const iterateModule = iterateAll || type & NestDefinitionType.Module;
+    const iterateByModule = iterateAll || type & NestDefinitionType.Module;
     const awaitedNestModuleDefinition = await this.nestModuleDefinition;
-    if (iterateModule) {
+    if (!awaitedNestModuleDefinition) {
+      throw new FalsyValueInNestModuleTree(awaitedNestModuleDefinition);
+    }
+    if (iterateByModule) {
       yield awaitedNestModuleDefinition;
       if ('module' in awaitedNestModuleDefinition) {
         yield awaitedNestModuleDefinition.module;
@@ -26,7 +73,7 @@ export class NestDefinitionIterator {
     }
     const nestDefinition = new NestDefinition(awaitedNestModuleDefinition);
 
-    const nestImports = await nestDefinition.getImports();
+    const nestImports = nestDefinition.getImports();
 
     const iterateProviders = iterateAll || type & NestDefinitionType.Providers;
     if (iterateProviders) {
@@ -65,10 +112,16 @@ export class NestDefinitionIterator {
   }
 
   async find<R extends NestModuleDefinition | Provider>(
-    predicate: (definition: NestModuleDefinition | Provider) => boolean,
+    predicate: (
+      // eslint-disable-next-line @typescript-eslint/ban-types
+      definition: NestModuleDefinition | Provider | Function,
+    ) => boolean,
     type?: NestDefinitionType,
   ): Promise<R | null> {
     for await (const definition of this.iterate(type)) {
+      if (!Assert.isObjectOrCtor(definition)) {
+        throw new UnexpectedNestModuleDefinitionValue(definition);
+      }
       const isNeeded = predicate(definition);
       if (isNeeded) {
         return definition as R;

package/src/nest-definition.ts

@@ -1,4 +1,9 @@
-import type { DynamicModule, Provider, Type } from '@nestjs/common';
+import type {
+  DynamicModule,
+  InjectionToken,
+  Provider,
+  Type,
+} from '@nestjs/common';
 import { MODULE_METADATA } from '@nestjs/common/constants';
 import { DependenciesScanner } from '@nestjs/core/scanner';
 
@@ -12,10 +17,8 @@ export class NestDefinition {
   constructor(private definition: NestModuleDefinition) {}
 
   getProviders(): Provider[] | undefined {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return DependenciesScanner.prototype.isDynamicModule(this.definition)
       ? [
-          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
           ...this.reflectMetadata(
             MODULE_METADATA.PROVIDERS,
             this.definition.module,
@@ -26,10 +29,8 @@ export class NestDefinition {
   }
 
   getImports(): NestModuleDefinition[] | undefined {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return DependenciesScanner.prototype.isDynamicModule(this.definition)
       ? [
-          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
           ...this.reflectMetadata(
             MODULE_METADATA.IMPORTS,
             this.definition.module,
@@ -40,10 +41,8 @@ export class NestDefinition {
   }
 
   getControllers(): Type[] | undefined {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return DependenciesScanner.prototype.isDynamicModule(this.definition)
       ? [
-          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
           ...this.reflectMetadata(
             MODULE_METADATA.CONTROLLERS,
             this.definition.module,
@@ -53,8 +52,7 @@ export class NestDefinition {
       : this.reflectMetadata(MODULE_METADATA.CONTROLLERS, this.definition);
   }
 
-  getExports(): Type[] | undefined {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+  getExports(): (Type | InjectionToken)[] | undefined {
     return DependenciesScanner.prototype.isDynamicModule(this.definition)
       ? [
           // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
@@ -68,7 +66,6 @@ export class NestDefinition {
   }
 
   private reflectMetadata<T = any>(metadataKey: string, metatype: Type): T[] {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return Reflect.getMetadata(metadataKey, metatype) || [];
   }
 }