@adimm/x-injection 2.1.2 → 3.0.1

package/dist/index.d.cts

@@ -140,8 +140,6 @@ declare enum DefinitionEventType {
 /** See {@link https://inversify.io/docs/api/decorator/#injectable} for more details. */
 declare function Injectable(scope?: InjectionScope): ClassDecorator;
 
-type AsyncMethod<T = void> = () => Promise<T>;
-
 type ProviderToken<T = any> = ProviderIdentifier<T> | DependencyProvider<T>;
 type DependencyProvider<T = any> = Class<T> | Function | ProviderClassToken<T> | ProviderValueToken<T> | ProviderFactoryToken<T>;
 type ProviderClassToken<T> = (ProviderOptions<T> & ProviderScopeOption) & {
@@ -274,19 +272,6 @@ interface IDynamicModuleDefinition {
      * @param addToExports When set to `true` it'll also `export` the {@link moduleOrBlueprint}. _(defaults to `false`)_
      */
     addImport(moduleOrBlueprint: ModuleOrBlueprint, addToExports?: boolean): void;
-    /**
-     * Can be used to _lazily_ `import` a new {@link module} into the current {@link IProviderModule | Module}.
-     *
-     * **Note:** _This is useful when you want to lazy import a module from within another file._
-     *
-     * ```ts
-     * addImportLazy(async () => import('./lazy.module'));
-     * ```
-     *
-     * @param lazyCb An `async` callback which will resolve the {@link IProviderModule | Module} to be imported.
-     * @param addToExports When set to `true` it'll also `export` the {@link module}. _(defaults to `false`)_
-     */
-    addImportLazy(lazyCb: AsyncMethod<IProviderModule>, addToExports?: boolean): Promise<void>;
     /**
      * Can be used to `bind` a new {@link provider} to the {@link IProviderModule | Module}'s `container`.
      *
@@ -294,24 +279,11 @@ interface IDynamicModuleDefinition {
      * @param addToExports When set to `true` it'll also `export` the {@link module}. _(defaults to `false`)_
      */
     addProvider<T>(provider: DependencyProvider<T>, addToExports?: boolean): void;
-    /**
-     * Can be used to _lazily_ `bind` a new {@link provider} to the {@link IProviderModule | Module}'s `container`.
-     *
-     * **Note:** _This is useful when you want to lazy import a provider from within another file._
-     *
-     * ```ts
-     * addImportLazy(async () => import('./lazy.provider'));
-     * ```
-     *
-     * @param lazyCb An `async` callback which will resolve the {@link DependencyProvider | Provider} to add.
-     * @param addToExports When set to `true` it'll also `export` the {@link module}. _(defaults to `false`)_
-     */
-    addProviderLazy<T>(lazyCb: AsyncMethod<DependencyProvider<T>>, addToExports?: boolean): Promise<void>;
     /**
      * Can be used to remove an `import` from the _current_ {@link IProviderModule | Module}.
      * It'll also automatically remove it from the `exports` definition.
      *
-     * **Note:** _You can always add it back with the {@link addImport} or {@link addImportLazy} methods._
+     * **Note:** _You can always add it back with the {@link addImport} method._
      *
      * @param moduleOrId Either the `module` reference itself or its `id`.
      */
@@ -320,7 +292,7 @@ interface IDynamicModuleDefinition {
      * Can be used to remove a `provider` from the _current_ {@link IProviderModule | Module}'s `container`.
      * It'll also automatically remove it from the `exports` definition.
      *
-     * **Note:** _You can always add it back with the {@link addProvider} or {@link addProviderLazy} methods._
+     * **Note:** _You can always add it back with the {@link addProvider} method._
      *
      * @param providerOrIdentifier Either the `provider` reference itself or its `{ provide }` property value.
      */
@@ -352,9 +324,7 @@ declare class DynamicModuleDefinition implements IDynamicModuleDefinition {
     private importedModuleSubscriptions;
     constructor(providerModule: ProviderModule);
     addImport(moduleOrBlueprint: ModuleOrBlueprint, addToExports?: boolean): void;
-    addImportLazy(lazyCb: AsyncMethod<ProviderModule>, addToExports?: boolean): Promise<void>;
     addProvider<T>(provider: DependencyProvider<T>, addToExports?: boolean): void;
-    addProviderLazy<T>(lazyCb: AsyncMethod<DependencyProvider<T>>, addToExports?: boolean): Promise<void>;
     removeImport(moduleOrId: IProviderModule | ModuleIdentifier): boolean;
     removeProvider<T>(providerOrIdentifier: DependencyProvider<T> | ProviderIdentifier<T>): boolean;
     removeFromExports(exportDefinition: ExportDefinition): boolean;
@@ -366,6 +336,7 @@ declare class DynamicModuleDefinition implements IDynamicModuleDefinition {
     private createImportedModuleContainer;
     private subscribeToImportedModuleEvents;
     private unsubscribeFromImportedModuleEvents;
+    private applyMiddlewareGuard;
 }
 
 interface IMiddlewaresManager {
@@ -380,6 +351,9 @@ declare class MiddlewaresManager implements IMiddlewaresManager {
     constructor(providerModule: ProviderModule);
     add<T extends MiddlewareType>(type: MiddlewareType, cb: AddMiddlewareCallbackType<T>): void;
     applyMiddlewares<T>(type: MiddlewareType, ...args: any[]): T;
+    private applyChainMiddleware;
+    private applyReduceMiddleware;
+    private applyBooleanMiddleware;
     clear(): void;
     dispose(): void;
 }
@@ -686,6 +660,52 @@ declare class ProviderModule implements IProviderModule {
     private throwIfDisposed;
 }
 
+/**
+ * Base class for creating OOP-style modules with composition pattern.
+ *
+ * Provides a clean separation between your custom module logic and the `DI` container
+ * by exposing all {@link ProviderModule} functionality through the `module` property.
+ *
+ * This avoids naming conflicts between your methods and {@link ProviderModule} methods.
+ *
+ * ```ts
+ * Injectable()
+ * class UserService {
+ *   get(id: string) {
+ *     // ... get logic
+ *   }
+ * }
+ *
+ * class AuthModule extends ProviderModuleClass {
+ *   constructor() {
+ *     super({
+ *       id: 'AuthModule',
+ *       providers: [UserService],
+ *       exports: [UserService],
+ *     });
+ *   }
+ *
+ *   // Your custom methods - no conflicts with the `ProviderModule` class methods
+ *   authenticateUser(userId: string) {
+ *     const userService = this.module.get(UserService);
+ *
+ *     return userService.get(userId);
+ *   }
+ * }
+ *
+ * const authModule = new AuthModule();
+ * authModule.authenticateUser('123');
+ * ```
+ */
+declare class ProviderModuleClass {
+    /**
+     * The underlying {@link ProviderModule} instance.
+     * Access all `DI` container methods through this property.
+     */
+    readonly module: IProviderModule;
+    constructor(options: ProviderModuleOptions);
+}
+
 /**
  * The `root` {@link IProviderModule} of your application.
  *
@@ -717,16 +737,12 @@ declare function MultiInject(provider: ProviderToken): MethodDecorator & Paramet
 
 /** See {@link https://inversify.io/docs/api/decorator/#injectfrombase} for more details. */
 declare function InjectFromBase(options?: Parameters<typeof injectFromBase>[0]): ClassDecorator;
-
 /** See {@link https://inversify.io/docs/api/decorator/#named} for more details. */
 declare function Named(name: MetadataName): MethodDecorator & ParameterDecorator & PropertyDecorator;
-
 /** See {@link https://inversify.io/docs/api/decorator/#optional} for more details. */
 declare function Optional(): MethodDecorator & ParameterDecorator & PropertyDecorator;
-
 /** See {@link https://inversify.io/docs/api/decorator/#tagged} for more details. */
 declare function Tagged(key: MetadataTag, value: unknown): MethodDecorator & ParameterDecorator & PropertyDecorator;
-
 /** See {@link https://inversify.io/docs/api/decorator/#unmanaged} for more details. */
 declare function Unmanaged(): MethodDecorator & ParameterDecorator & PropertyDecorator;
 
@@ -792,7 +808,6 @@ declare namespace ProviderTokenHelpers {
     function tryGetScopeFromProvider(provider: ProviderToken): InjectionScope | undefined;
     function tryGetDecoratorScopeFromClass<T = any>(provider: ProviderToken<T>): InjectionScope | undefined;
 }
-
 declare namespace ProviderModuleHelpers {
     function isModule(value: any): value is IProviderModule;
     function isBlueprint(value: any): value is ProviderModuleBlueprint;
@@ -802,13 +817,9 @@ declare namespace ProviderModuleHelpers {
 }
 
 declare function isPlainObject(o: any): o is object;
-
 declare function isClass(v: any): boolean;
-
-declare function isFunction(v: any): boolean;
-
 declare function isClassOrFunction(value: any): value is Function | Class<any>;
 
 declare function deepClone<T>(obj: T): T;
 
-export { AppModule, DefinitionEventType, type DependencyProvider, type ExportDefinition, type ExportsDefinition, type ExportsDefinitionOptimized, IProviderModule, Inject, InjectFromBase, Injectable, InjectionError, InjectionProviderModuleDisposedError, InjectionProviderModuleError, InjectionProviderModuleMissingIdentifierError, InjectionProviderModuleMissingProviderError, InjectionProviderModuleUnknownProviderError, InjectionScope, MiddlewareType, type ModuleOrBlueprint, MultiInject, Named, Optional, type ProviderClassToken, type ProviderFactoryToken, type ProviderIdentifier, ProviderModule, ProviderModuleBlueprint, type ProviderModuleGetManyParam, type ProviderModuleGetManyReturn, type ProviderModuleGetReturn, ProviderModuleHelpers, type ProviderModuleOptions, type ProviderModuleOptionsInternal, type ProviderOptions, type ProviderScopeOption, type ProviderToken, ProviderTokenHelpers, type ProviderValueToken, Tagged, Unmanaged, bindingScopeToInjectionScope, deepClone, injectionScopeToBindingScope, isClass, isClassOrFunction, isFunction, isPlainObject };
+export { AppModule, DefinitionEventType, type DependencyProvider, type ExportDefinition, type ExportsDefinition, type ExportsDefinitionOptimized, IProviderModule, Inject, InjectFromBase, Injectable, InjectionError, InjectionProviderModuleDisposedError, InjectionProviderModuleError, InjectionProviderModuleMissingIdentifierError, InjectionProviderModuleMissingProviderError, InjectionProviderModuleUnknownProviderError, InjectionScope, MiddlewareType, type ModuleOrBlueprint, MultiInject, Named, Optional, type ProviderClassToken, type ProviderFactoryToken, type ProviderIdentifier, ProviderModule, ProviderModuleBlueprint, ProviderModuleClass, type ProviderModuleGetManyParam, type ProviderModuleGetManyReturn, type ProviderModuleGetReturn, ProviderModuleHelpers, type ProviderModuleOptions, type ProviderModuleOptionsInternal, type ProviderOptions, type ProviderScopeOption, type ProviderToken, ProviderTokenHelpers, type ProviderValueToken, Tagged, Unmanaged, bindingScopeToInjectionScope, deepClone, injectionScopeToBindingScope, isClass, isClassOrFunction, isPlainObject };

package/dist/index.d.ts

@@ -140,8 +140,6 @@ declare enum DefinitionEventType {
 /** See {@link https://inversify.io/docs/api/decorator/#injectable} for more details. */
 declare function Injectable(scope?: InjectionScope): ClassDecorator;
 
-type AsyncMethod<T = void> = () => Promise<T>;
-
 type ProviderToken<T = any> = ProviderIdentifier<T> | DependencyProvider<T>;
 type DependencyProvider<T = any> = Class<T> | Function | ProviderClassToken<T> | ProviderValueToken<T> | ProviderFactoryToken<T>;
 type ProviderClassToken<T> = (ProviderOptions<T> & ProviderScopeOption) & {
@@ -274,19 +272,6 @@ interface IDynamicModuleDefinition {
      * @param addToExports When set to `true` it'll also `export` the {@link moduleOrBlueprint}. _(defaults to `false`)_
      */
     addImport(moduleOrBlueprint: ModuleOrBlueprint, addToExports?: boolean): void;
-    /**
-     * Can be used to _lazily_ `import` a new {@link module} into the current {@link IProviderModule | Module}.
-     *
-     * **Note:** _This is useful when you want to lazy import a module from within another file._
-     *
-     * ```ts
-     * addImportLazy(async () => import('./lazy.module'));
-     * ```
-     *
-     * @param lazyCb An `async` callback which will resolve the {@link IProviderModule | Module} to be imported.
-     * @param addToExports When set to `true` it'll also `export` the {@link module}. _(defaults to `false`)_
-     */
-    addImportLazy(lazyCb: AsyncMethod<IProviderModule>, addToExports?: boolean): Promise<void>;
     /**
      * Can be used to `bind` a new {@link provider} to the {@link IProviderModule | Module}'s `container`.
      *
@@ -294,24 +279,11 @@ interface IDynamicModuleDefinition {
      * @param addToExports When set to `true` it'll also `export` the {@link module}. _(defaults to `false`)_
      */
     addProvider<T>(provider: DependencyProvider<T>, addToExports?: boolean): void;
-    /**
-     * Can be used to _lazily_ `bind` a new {@link provider} to the {@link IProviderModule | Module}'s `container`.
-     *
-     * **Note:** _This is useful when you want to lazy import a provider from within another file._
-     *
-     * ```ts
-     * addImportLazy(async () => import('./lazy.provider'));
-     * ```
-     *
-     * @param lazyCb An `async` callback which will resolve the {@link DependencyProvider | Provider} to add.
-     * @param addToExports When set to `true` it'll also `export` the {@link module}. _(defaults to `false`)_
-     */
-    addProviderLazy<T>(lazyCb: AsyncMethod<DependencyProvider<T>>, addToExports?: boolean): Promise<void>;
     /**
      * Can be used to remove an `import` from the _current_ {@link IProviderModule | Module}.
      * It'll also automatically remove it from the `exports` definition.
      *
-     * **Note:** _You can always add it back with the {@link addImport} or {@link addImportLazy} methods._
+     * **Note:** _You can always add it back with the {@link addImport} method._
      *
      * @param moduleOrId Either the `module` reference itself or its `id`.
      */
@@ -320,7 +292,7 @@ interface IDynamicModuleDefinition {
      * Can be used to remove a `provider` from the _current_ {@link IProviderModule | Module}'s `container`.
      * It'll also automatically remove it from the `exports` definition.
      *
-     * **Note:** _You can always add it back with the {@link addProvider} or {@link addProviderLazy} methods._
+     * **Note:** _You can always add it back with the {@link addProvider} method._
      *
      * @param providerOrIdentifier Either the `provider` reference itself or its `{ provide }` property value.
      */
@@ -352,9 +324,7 @@ declare class DynamicModuleDefinition implements IDynamicModuleDefinition {
     private importedModuleSubscriptions;
     constructor(providerModule: ProviderModule);
     addImport(moduleOrBlueprint: ModuleOrBlueprint, addToExports?: boolean): void;
-    addImportLazy(lazyCb: AsyncMethod<ProviderModule>, addToExports?: boolean): Promise<void>;
     addProvider<T>(provider: DependencyProvider<T>, addToExports?: boolean): void;
-    addProviderLazy<T>(lazyCb: AsyncMethod<DependencyProvider<T>>, addToExports?: boolean): Promise<void>;
     removeImport(moduleOrId: IProviderModule | ModuleIdentifier): boolean;
     removeProvider<T>(providerOrIdentifier: DependencyProvider<T> | ProviderIdentifier<T>): boolean;
     removeFromExports(exportDefinition: ExportDefinition): boolean;
@@ -366,6 +336,7 @@ declare class DynamicModuleDefinition implements IDynamicModuleDefinition {
     private createImportedModuleContainer;
     private subscribeToImportedModuleEvents;
     private unsubscribeFromImportedModuleEvents;
+    private applyMiddlewareGuard;
 }
 
 interface IMiddlewaresManager {
@@ -380,6 +351,9 @@ declare class MiddlewaresManager implements IMiddlewaresManager {
     constructor(providerModule: ProviderModule);
     add<T extends MiddlewareType>(type: MiddlewareType, cb: AddMiddlewareCallbackType<T>): void;
     applyMiddlewares<T>(type: MiddlewareType, ...args: any[]): T;
+    private applyChainMiddleware;
+    private applyReduceMiddleware;
+    private applyBooleanMiddleware;
     clear(): void;
     dispose(): void;
 }
@@ -686,6 +660,52 @@ declare class ProviderModule implements IProviderModule {
     private throwIfDisposed;
 }
 
+/**
+ * Base class for creating OOP-style modules with composition pattern.
+ *
+ * Provides a clean separation between your custom module logic and the `DI` container
+ * by exposing all {@link ProviderModule} functionality through the `module` property.
+ *
+ * This avoids naming conflicts between your methods and {@link ProviderModule} methods.
+ *
+ * ```ts
+ * Injectable()
+ * class UserService {
+ *   get(id: string) {
+ *     // ... get logic
+ *   }
+ * }
+ *
+ * class AuthModule extends ProviderModuleClass {
+ *   constructor() {
+ *     super({
+ *       id: 'AuthModule',
+ *       providers: [UserService],
+ *       exports: [UserService],
+ *     });
+ *   }
+ *
+ *   // Your custom methods - no conflicts with the `ProviderModule` class methods
+ *   authenticateUser(userId: string) {
+ *     const userService = this.module.get(UserService);
+ *
+ *     return userService.get(userId);
+ *   }
+ * }
+ *
+ * const authModule = new AuthModule();
+ * authModule.authenticateUser('123');
+ * ```
+ */
+declare class ProviderModuleClass {
+    /**
+     * The underlying {@link ProviderModule} instance.
+     * Access all `DI` container methods through this property.
+     */
+    readonly module: IProviderModule;
+    constructor(options: ProviderModuleOptions);
+}
+
 /**
  * The `root` {@link IProviderModule} of your application.
  *
@@ -717,16 +737,12 @@ declare function MultiInject(provider: ProviderToken): MethodDecorator & Paramet
 
 /** See {@link https://inversify.io/docs/api/decorator/#injectfrombase} for more details. */
 declare function InjectFromBase(options?: Parameters<typeof injectFromBase>[0]): ClassDecorator;
-
 /** See {@link https://inversify.io/docs/api/decorator/#named} for more details. */
 declare function Named(name: MetadataName): MethodDecorator & ParameterDecorator & PropertyDecorator;
-
 /** See {@link https://inversify.io/docs/api/decorator/#optional} for more details. */
 declare function Optional(): MethodDecorator & ParameterDecorator & PropertyDecorator;
-
 /** See {@link https://inversify.io/docs/api/decorator/#tagged} for more details. */
 declare function Tagged(key: MetadataTag, value: unknown): MethodDecorator & ParameterDecorator & PropertyDecorator;
-
 /** See {@link https://inversify.io/docs/api/decorator/#unmanaged} for more details. */
 declare function Unmanaged(): MethodDecorator & ParameterDecorator & PropertyDecorator;
 
@@ -792,7 +808,6 @@ declare namespace ProviderTokenHelpers {
     function tryGetScopeFromProvider(provider: ProviderToken): InjectionScope | undefined;
     function tryGetDecoratorScopeFromClass<T = any>(provider: ProviderToken<T>): InjectionScope | undefined;
 }
-
 declare namespace ProviderModuleHelpers {
     function isModule(value: any): value is IProviderModule;
     function isBlueprint(value: any): value is ProviderModuleBlueprint;
@@ -802,13 +817,9 @@ declare namespace ProviderModuleHelpers {
 }
 
 declare function isPlainObject(o: any): o is object;
-
 declare function isClass(v: any): boolean;
-
-declare function isFunction(v: any): boolean;
-
 declare function isClassOrFunction(value: any): value is Function | Class<any>;
 
 declare function deepClone<T>(obj: T): T;
 
-export { AppModule, DefinitionEventType, type DependencyProvider, type ExportDefinition, type ExportsDefinition, type ExportsDefinitionOptimized, IProviderModule, Inject, InjectFromBase, Injectable, InjectionError, InjectionProviderModuleDisposedError, InjectionProviderModuleError, InjectionProviderModuleMissingIdentifierError, InjectionProviderModuleMissingProviderError, InjectionProviderModuleUnknownProviderError, InjectionScope, MiddlewareType, type ModuleOrBlueprint, MultiInject, Named, Optional, type ProviderClassToken, type ProviderFactoryToken, type ProviderIdentifier, ProviderModule, ProviderModuleBlueprint, type ProviderModuleGetManyParam, type ProviderModuleGetManyReturn, type ProviderModuleGetReturn, ProviderModuleHelpers, type ProviderModuleOptions, type ProviderModuleOptionsInternal, type ProviderOptions, type ProviderScopeOption, type ProviderToken, ProviderTokenHelpers, type ProviderValueToken, Tagged, Unmanaged, bindingScopeToInjectionScope, deepClone, injectionScopeToBindingScope, isClass, isClassOrFunction, isFunction, isPlainObject };
+export { AppModule, DefinitionEventType, type DependencyProvider, type ExportDefinition, type ExportsDefinition, type ExportsDefinitionOptimized, IProviderModule, Inject, InjectFromBase, Injectable, InjectionError, InjectionProviderModuleDisposedError, InjectionProviderModuleError, InjectionProviderModuleMissingIdentifierError, InjectionProviderModuleMissingProviderError, InjectionProviderModuleUnknownProviderError, InjectionScope, MiddlewareType, type ModuleOrBlueprint, MultiInject, Named, Optional, type ProviderClassToken, type ProviderFactoryToken, type ProviderIdentifier, ProviderModule, ProviderModuleBlueprint, ProviderModuleClass, type ProviderModuleGetManyParam, type ProviderModuleGetManyReturn, type ProviderModuleGetReturn, ProviderModuleHelpers, type ProviderModuleOptions, type ProviderModuleOptionsInternal, type ProviderOptions, type ProviderScopeOption, type ProviderToken, ProviderTokenHelpers, type ProviderValueToken, Tagged, Unmanaged, bindingScopeToInjectionScope, deepClone, injectionScopeToBindingScope, isClass, isClassOrFunction, isPlainObject };