feat: allow registering Proxy providers globally

Papooch · Oct 18, 2023 · 92d00f7 · 92d00f7
1 parent bb755f9
commit 92d00f7
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 18 deletions.
diff --git a/packages/core/src/lib/cls.module.ts b/packages/core/src/lib/cls.module.ts
@@ -85,6 +85,11 @@ export class ClsModule implements NestModule {
         }
     }
 
+    /**
+     * Configures the CLS module in the root.
+     *
+     * Provides the `ClsService` for injection.
+     */
     static forRoot(options?: ClsModuleOptions): DynamicModule {
         options = { ...new ClsModuleOptions(), ...options };
         const { providers, exports } = this.getProviders();
@@ -107,6 +112,11 @@ export class ClsModule implements NestModule {
         };
     }
 
+    /**
+     * Configures the CLS module in the root with asynchronously provided configuration.
+     *
+     * Provides the `ClsService` for injection.
+     */
     static forRootAsync(asyncOptions: ClsModuleAsyncOptions): DynamicModule {
         const { providers, exports } = this.getProviders();
         const proxyProviders = this.createProxyClassProviders(
@@ -134,6 +144,9 @@ export class ClsModule implements NestModule {
      * Registers the `ClsService` provider in the module
      */
     static forFeature(): DynamicModule;
+    /**
+     * Registers the given Class proxy providers in the module along with `ClsService`.
+     */
     static forFeature(...proxyProviderClasses: Array<Type>): DynamicModule;
     static forFeature(...proxyProviderClasses: Array<Type>): DynamicModule {
         const proxyProviders =
@@ -146,6 +159,11 @@ export class ClsModule implements NestModule {
         };
     }
 
+    /**
+     * Registers the given Class or Factory proxy providers in the module along with `ClsService`.
+     *
+     * If used with `global: true`, makes the proxy provider available globally.
+     */
     static forFeatureAsync(
         options: ClsModuleProxyProviderOptions,
     ): DynamicModule {
@@ -159,6 +177,7 @@ export class ClsModule implements NestModule {
             imports: options.imports ?? [],
             providers: [...providers, proxyProvider],
             exports: [...commonProviders, proxyProvider.provide],
+            global: options.global,
         };
     }
 

diff --git a/packages/core/src/lib/proxy-provider/proxy-provider.interfaces.ts b/packages/core/src/lib/proxy-provider/proxy-provider.interfaces.ts
@@ -1,14 +1,7 @@
 import { Provider, Type } from '@nestjs/common';
 import { ModuleRef } from '@nestjs/core';
 
-export interface ClsModuleProxyClassProviderOptions {
-    /**
-     * Custom injection token to use for the provider. In case of a class provider,
-     * this parameter is optional, as the class reference passed to `useClass` will
-     * be used by default.
-     */
-    provide?: any;
-
+interface ClsModuleProxyProviderCommonOptions {
     /**
      * Optional list of imported modules that export the providers which are required for the provider.
      */
@@ -21,28 +14,33 @@ export interface ClsModuleProxyClassProviderOptions {
     extraProviders?: Provider[];
 
     /**
-     * The target class that will be used by this Proxy Provider. Make sure it is decorated with `@InjectableProxy`.
+     * Whether to make this proxy provider available globally or just in this module.
      */
-    useClass: Type;
+    global?: boolean;
 }
-export interface ClsModuleProxyFactoryProviderOptions {
+
+export interface ClsModuleProxyClassProviderOptions
+    extends ClsModuleProxyProviderCommonOptions {
     /**
      * Custom injection token to use for the provider. In case of a class provider,
      * this parameter is optional, as the class reference passed to `useClass` will
      * be used by default.
      */
-    provide: any;
+    provide?: any;
 
     /**
-     * Optional list of imported modules that export the providers which are required for the provider.
+     * The target class that will be used by this Proxy Provider. Make sure it is decorated with `@InjectableProxy`.
      */
-    imports?: any[];
-
+    useClass: Type;
+}
+export interface ClsModuleProxyFactoryProviderOptions
+    extends ClsModuleProxyProviderCommonOptions {
     /**
-     * Optional list of additional providers that should be available to the Proxy.
-     * Useful for passing configuration from a parent dynamic module.
+     * Custom injection token to use for the provider. In case of a class provider,
+     * this parameter is optional, as the class reference passed to `useClass` will
+     * be used by default.
      */
-    extraProviders?: Provider[];
+    provide: any;
 
     /**
      * An array of injection tokens for providers used in the `useFactory`.