npm - @rsdk/core - Versions diffs - 2.1.0 → 2.4.0 - Mend

@rsdk/core 2.1.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/CHANGELOG.md +10 -0
package/dist/logging/logging.module.d.ts +31 -1
package/dist/logging/logging.module.js +37 -4
package/dist/logging/logging.module.js.map +1 -1
package/package.json +6 -6
package/src/logging/logging.module.ts +50 -13

package/CHANGELOG.md CHANGED Viewed

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+# [2.4.0](https://github.com/R-Vision/rsdk/compare/v2.3.1...v2.4.0) (2023-06-15)
+**Note:** Version bump only for package @rsdk/core
+## [2.3.1](https://github.com/R-Vision/rsdk/compare/v2.3.0...v2.3.1) (2023-06-08)
+### Bug Fixes
+* testing correct work with metadata ([d1734fa](https://github.com/R-Vision/rsdk/commit/d1734fa093a5bd905cc81a8c480f5ca4e88e0029))
 # [2.1.0](https://github.com/R-Vision/rsdk/compare/v2.0.0...v2.1.0) (2023-06-06)
 **Note:** Version bump only for package @rsdk/core

package/dist/logging/logging.module.d.ts CHANGED Viewed

@@ -8,5 +8,35 @@ export declare class LoggingModule {
      * Возвращает модуль которые нужны для логгирования в любом случае, например его конфиг
      */
     static pureRoot(): DynamicModule;
-    static register(target: object, context: string | Constructor, token: string): void;
+    static register(target: object, context: string | Constructor, token?: string): void;
+    /**
+     * Дополнительная возможность добавить в DI контейнер логгер в случаях когда нужен инлайн вызов например через `useFactory`
+     * @example
+     * const moduleDef = {
+     *   imports: [LoggerModule.forFeature(MyService)],
+     *   module: MyModule,
+     *   providers: [
+     *      {
+     *        inject: [getLoggerToken(MyService)],
+     *        provide: MyService,
+     *        useFactory(logger: ILogger)
+     *      }
+     *   ]
+     * }
+     * // Но по возможности
+     * const moduleDef = {
+     *   module: MyModule,
+     *   providers: [
+     *      {
+     *        inject: [getLoggerToken(MyService)],
+     *        provide: MyService,
+     *        useFactory(logger: ILogger)
+     *      }
+     *   ]
+     * }
+     * LoggerModule.register(moduleDef, MyService)
+     * @param context в обычном случае это или класс или строка по которой вы его инжектите например для `getLoggerToken(MyService)`/`@InjectLogger(MyService)`, необходимо будет сделать LoggerModule.forFeature(MyService)
+     * @param token если по какой-то причине вы хотите подменить логгер `@InjectLogger(MyService)` на логгер `@InjectLogger(NotMyService)`, используйте `getLoggerToken(MyService)` в качестве второго аргумента
+     */
+    static forFeature(context: string | Constructor, token?: string): DynamicModule;
 }

package/dist/logging/logging.module.js CHANGED Viewed

@@ -18,6 +18,7 @@ const metadata_1 = require("@rsdk/metadata");
 const config_1 = require("../config");
 const constants_1 = require("../rsdk-metadata/constants");
 const constants_2 = require("./metadata/constants");
+const helpers_1 = require("./helpers");
 const logging_config_1 = require("./logging.config");
 let LoggingModule = LoggingModule_1 = class LoggingModule {
     static logger = logging_1.LoggerFactory.create('LoggingModule');
@@ -42,8 +43,41 @@ let LoggingModule = LoggingModule_1 = class LoggingModule {
             exports: [config_1.PlatformConfigModule],
         };
     }
-    static register(target, context, token) {
-        metadata_1.RsdkMetadata.add(target, {
+    static register(target, context, token = (0, helpers_1.getLoggerToken)(context)) {
+        metadata_1.RsdkMetadata.add(target, this.forFeature(context, token), constants_1.PLATFORM_RAW_GLOBAL_METADATA_SCOPE);
+        metadata_1.RsdkMetadata.add(target, { context, token, target }, constants_2.LOGGING_RSDK_METADATA_SCOPE);
+    }
+    /**
+     * Дополнительная возможность добавить в DI контейнер логгер в случаях когда нужен инлайн вызов например через `useFactory`
+     * @example
+     * const moduleDef = {
+     *   imports: [LoggerModule.forFeature(MyService)],
+     *   module: MyModule,
+     *   providers: [
+     *      {
+     *        inject: [getLoggerToken(MyService)],
+     *        provide: MyService,
+     *        useFactory(logger: ILogger)
+     *      }
+     *   ]
+     * }
+     * // Но по возможности
+     * const moduleDef = {
+     *   module: MyModule,
+     *   providers: [
+     *      {
+     *        inject: [getLoggerToken(MyService)],
+     *        provide: MyService,
+     *        useFactory(logger: ILogger)
+     *      }
+     *   ]
+     * }
+     * LoggerModule.register(moduleDef, MyService)
+     * @param context в обычном случае это или класс или строка по которой вы его инжектите например для `getLoggerToken(MyService)`/`@InjectLogger(MyService)`, необходимо будет сделать LoggerModule.forFeature(MyService)
+     * @param token если по какой-то причине вы хотите подменить логгер `@InjectLogger(MyService)` на логгер `@InjectLogger(NotMyService)`, используйте `getLoggerToken(MyService)` в качестве второго аргумента
+     */
+    static forFeature(context, token = (0, helpers_1.getLoggerToken)(context)) {
+        return {
             global: true,
             imports: [config_1.PlatformConfigModule.forFeature(logging_config_1.LoggingConfig)],
             module: LoggingModule_1,
@@ -54,8 +88,7 @@ let LoggingModule = LoggingModule_1 = class LoggingModule {
                 },
             ],
             exports: [token],
-        }, constants_1.PLATFORM_RAW_GLOBAL_METADATA_SCOPE);
-        metadata_1.RsdkMetadata.add(target, { context, token, target }, constants_2.LOGGING_RSDK_METADATA_SCOPE);
+        };
     }
 };
 LoggingModule = LoggingModule_1 = __decorate([

package/dist/logging/logging.module.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"logging.module.js","sourceRoot":"","sources":["../../src/logging/logging.module.ts"],"names":[],"mappings":";AAAA,8BAA8B;;;;;;;;;;;;;AAG9B,2CAAwC;AAExC,2CAA8C;AAC9C,6CAA8C;AAE9C,sCAAiD;AAEjD,0DAAgF;AAEhF,oDAAmE;AACnE,qDAAiD;AAGjD,IACa,aAAa,qBAD1B,MACa,aAAa;IAChB,MAAM,CAAC,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAE9D,YAAY,MAAqB;QAC/B,MAAM,GAAG,GAAG,GAAS,EAAE;YACrB,eAAa,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,MAAM,CAAC,KAAK,GAAG,EAAE;gBAChE,QAAQ,EAAE,MAAM,CAAC,KAAK;aACvB,CAAC,CAAC;YAEH,uBAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrB,GAAG,EAAE,CAAC;IACR,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,OAAO;YACL,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,CAAC,6BAAoB,CAAC,UAAU,CAAC,8BAAa,CAAC,CAAC;YACzD,MAAM,EAAE,eAAa;YACrB,OAAO,EAAE,CAAC,6BAAoB,CAAC;SAChC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,MAAc,EACd,OAA6B,EAC7B,~~KAAa~~;~~QAEb~~,uBAAY,CAAC,GAAG,CACd,MAAM,EACN;~~YACE~~,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,CAAC,6BAAoB,CAAC,UAAU,CAAC,8BAAa,CAAC,CAAC;YACzD,MAAM,EAAE,eAAa;YACrB,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,KAAK;oBACd,QAAQ,EAAE,uBAAa,CAAC,MAAM,CAAC,OAAO,CAAC;iBACxC;aACF;YACD,OAAO,EAAE,CAAC,KAAK,CAAC;SACjB,~~EACD,8CAAkC,CACnC,~~CAAC;~~QAEF,uBAAY,CAAC,GAAG,CACd,MAAM,EACN,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAC1B,uCAA2B,CAC5B,CAAC;~~IACJ,CAAC;;~~AAvDU~~,aAAa;IADzB,IAAA,eAAM,EAAC,EAAE,CAAC;qCAIW,8BAAa;GAHtB,aAAa,~~CAwDzB~~;~~AAxDY~~,sCAAa"}
1	+ {"version":3,"file":"logging.module.js","sourceRoot":"","sources":["../../src/logging/logging.module.ts"],"names":[],"mappings":";AAAA,8BAA8B;;;;;;;;;;;;;AAG9B,2CAAwC;AAExC,2CAA8C;AAC9C,6CAA8C;AAE9C,sCAAiD;AAEjD,0DAAgF;AAEhF,oDAAmE;AACnE,uCAA2C;AAC3C,qDAAiD;AAGjD,IACa,aAAa,qBAD1B,MACa,aAAa;IAChB,MAAM,CAAC,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAE9D,YAAY,MAAqB;QAC/B,MAAM,GAAG,GAAG,GAAS,EAAE;YACrB,eAAa,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,MAAM,CAAC,KAAK,GAAG,EAAE;gBAChE,QAAQ,EAAE,MAAM,CAAC,KAAK;aACvB,CAAC,CAAC;YAEH,uBAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrB,GAAG,EAAE,CAAC;IACR,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,OAAO;YACL,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,CAAC,6BAAoB,CAAC,UAAU,CAAC,8BAAa,CAAC,CAAC;YACzD,MAAM,EAAE,eAAa;YACrB,OAAO,EAAE,CAAC,6BAAoB,CAAC;SAChC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,MAAc,EACd,OAA6B,EAC7B,KAAK,GAAG,IAAA,wBAAc,EAAC,OAAO,CAAC;QAE/B,uBAAY,CAAC,GAAG,CACd,MAAM,EACN,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,EAC/B,8CAAkC,CACnC,CAAC;QAEF,uBAAY,CAAC,GAAG,CACd,MAAM,EACN,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAC1B,uCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,UAAU,CACf,OAA6B,EAC7B,KAAK,GAAG,IAAA,wBAAc,EAAC,OAAO,CAAC;QAE/B,OAAO;YACL,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,CAAC,6BAAoB,CAAC,UAAU,CAAC,8BAAa,CAAC,CAAC;YACzD,MAAM,EAAE,eAAa;YACrB,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,KAAK;oBACd,QAAQ,EAAE,uBAAa,CAAC,MAAM,CAAC,OAAO,CAAC;iBACxC;aACF;YACD,OAAO,EAAE,CAAC,KAAK,CAAC;SACjB,CAAC;IACJ,CAAC;;AA3FU,aAAa;IADzB,IAAA,eAAM,EAAC,EAAE,CAAC;qCAIW,8BAAa;GAHtB,aAAa,CA4FzB;AA5FY,sCAAa"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/core",
-  "version": "2.1.0",
+  "version": "2.4.0",
   "description": "Nestjs based microservice chassis",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -29,14 +29,14 @@
     "@nestjs/core": "^9.0.0",
     "@nestjs/microservices": "^9.0.0",
     "@rsdk/autodoc.protocol": "^2.0.0",
-    "@rsdk/common": "^2.0.0",
-    "@rsdk/decorators": "^2.0.0",
-    "@rsdk/logging": "^2.0.0",
-    "@rsdk/metadata": "^2.0.0",
+    "@rsdk/common": "^2.4.0",
+    "@rsdk/decorators": "^2.4.0",
+    "@rsdk/logging": "^2.4.0",
+    "@rsdk/metadata": "^2.4.0",
     "@rsdk/nest-tools": "^2.0.0",
     "axios": "^1.1.3",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.0.0"
   },
-  "gitHead": "b98d43696f973cf6e21c6299bdddae9b1d8b8d4d"
+  "gitHead": "2c2c1eac3027955838c0883ca1cb76b051a541ed"
 }

package/src/logging/logging.module.ts CHANGED Viewed

@@ -11,6 +11,7 @@ import type { PlatformRawGlobalMetadata } from '../rsdk-metadata/constants';
 import { PLATFORM_RAW_GLOBAL_METADATA_SCOPE } from '../rsdk-metadata/constants';
 import { LOGGING_RSDK_METADATA_SCOPE } from './metadata/constants';
+import { getLoggerToken } from './helpers';
 import { LoggingConfig } from './logging.config';
 import type { LoggingRsdkMetadata } from './types';
@@ -46,22 +47,11 @@ export class LoggingModule {
   static register(
     target: object,
     context: string | Constructor,
-    token: string,
+    token = getLoggerToken(context),
   ): void {
     RsdkMetadata.add<PlatformRawGlobalMetadata>(
       target,
-      {
-        global: true,
-        imports: [PlatformConfigModule.forFeature(LoggingConfig)],
-        module: LoggingModule,
-        providers: [
-          {
-            provide: token,
-            useValue: LoggerFactory.create(context),
-          },
-        ],
-        exports: [token],
-      },
+      this.forFeature(context, token),
       PLATFORM_RAW_GLOBAL_METADATA_SCOPE,
     );
@@ -71,4 +61,51 @@ export class LoggingModule {
       LOGGING_RSDK_METADATA_SCOPE,
     );
   }
+  /**
+   * Дополнительная возможность добавить в DI контейнер логгер в случаях когда нужен инлайн вызов например через `useFactory`
+   * @example
+   * const moduleDef = {
+   *   imports: [LoggerModule.forFeature(MyService)],
+   *   module: MyModule,
+   *   providers: [
+   *      {
+   *        inject: [getLoggerToken(MyService)],
+   *        provide: MyService,
+   *        useFactory(logger: ILogger)
+   *      }
+   *   ]
+   * }
+   * // Но по возможности
+   * const moduleDef = {
+   *   module: MyModule,
+   *   providers: [
+   *      {
+   *        inject: [getLoggerToken(MyService)],
+   *        provide: MyService,
+   *        useFactory(logger: ILogger)
+   *      }
+   *   ]
+   * }
+   * LoggerModule.register(moduleDef, MyService)
+   * @param context в обычном случае это или класс или строка по которой вы его инжектите например для `getLoggerToken(MyService)`/`@InjectLogger(MyService)`, необходимо будет сделать LoggerModule.forFeature(MyService)
+   * @param token если по какой-то причине вы хотите подменить логгер `@InjectLogger(MyService)` на логгер `@InjectLogger(NotMyService)`, используйте `getLoggerToken(MyService)` в качестве второго аргумента
+   */
+  static forFeature(
+    context: string | Constructor,
+    token = getLoggerToken(context),
+  ): DynamicModule {
+    return {
+      global: true,
+      imports: [PlatformConfigModule.forFeature(LoggingConfig)],
+      module: LoggingModule,
+      providers: [
+        {
+          provide: token,
+          useValue: LoggerFactory.create(context),
+        },
+      ],
+      exports: [token],
+    };
+  }
 }