@adimm/x-injection 1.1.6 → 1.2.1

package/dist/index.d.ts

@@ -164,8 +164,9 @@ declare const GlobalContainer: Container;
 declare class ProviderModule implements IProviderModule {
     isDisposed: boolean;
     readonly identifier: ModuleIdentifier;
-    isMarkedAsGlobal: boolean;
-    protected isAppModule: boolean;
+    isGlobal: boolean;
+    protected isAppModule: IProviderModuleNaked['isAppModule'];
+    protected instantiatedFromDefinition: IProviderModuleNaked['instantiatedFromDefinition'];
     protected container: Container;
     protected defaultScope: IProviderModuleNaked['defaultScope'];
     protected onReady: IProviderModuleNaked['onReady'];
@@ -323,8 +324,11 @@ declare class GlobalAppModule extends ProviderModule implements IAppModule {
     private isLoaded;
     constructor();
     register<AsNaked extends boolean = false>(options: AppModuleOptions): AsNaked extends false ? IAppModule : IAppModule & IProviderModuleNaked;
+    lazyImport(...modules: ProviderModuleOrDefinition[]): void;
     toNaked(): IAppModule & IProviderModuleNaked;
     dispose(): Promise<void>;
+    /** **Internally used, do not use!** */
+    _importWithoutSecondaryImportCheck(...modules: ProviderModuleOrDefinition[]): void;
     private checkIfRegisteredModulesHaveGlobalMark;
 }
 /**
@@ -377,12 +381,14 @@ declare class ProviderModuleDefinition implements IProviderModuleDefinition {
     providers: IProviderModuleDefinition['providers'];
     exports: IProviderModuleDefinition['exports'];
     defaultScope: IProviderModuleDefinition['defaultScope'];
-    markAsGlobal: IProviderModuleDefinition['markAsGlobal'];
+    isGlobal: IProviderModuleDefinition['isGlobal'];
     onReady: IProviderModuleDefinition['onReady'];
     onDispose: IProviderModuleDefinition['onDispose'];
     constructor(moduleOptions: ProviderModuleOptions);
     getDefinition(): ProviderModuleOptions;
+    clone(definition?: Partial<ProviderModuleOptions>): IProviderModuleDefinition;
     toString(): string;
+    private checkIfShouldBeAddedToTheGlobalRegister;
 }
 
 interface ProviderModuleOptions {
@@ -406,17 +412,17 @@ interface ProviderModuleOptions {
      */
     defaultScope?: InjectionScope;
     /**
-     * This option is only a _marker_, per se it doesn't do anything
-     * apart from marking this module as `global`.
      * When a module is marked as `global`, it means that it is expected to be _imported_ into the `AppModule`.
      *
+     * **Note:** _Importing a `global` module into a `scoped` module will automatically import it into the `AppModule` rather than the scoped module itself!_
+     *
      * Expect an exception to be thrown:
      * - If a `module` marked as global is **not** imported into the `AppModule`.
      * - If a `module` **not** marked as global _is_ imported into the `AppModule`
      *
      * Defaults to `false`.
      */
-    markAsGlobal?: boolean;
+    isGlobal?: boolean;
     /**
      * Callback which will be invoked once the module container has been initialized
      * and the providers resolved.
@@ -435,6 +441,7 @@ interface ProviderModuleOptions {
 }
 interface ProviderModuleOptionsInternal {
     isAppModule?: boolean;
+    instantiatedFromDefinition?: boolean;
     isDisposed?: boolean;
     /** Can be used to manually provide the {@link IAppModule} instance. */
     appModule?: () => GlobalAppModule;
@@ -466,6 +473,24 @@ type OnDisposeOptions = RequireAtLeastOne<{
 interface IProviderModuleDefinition extends ProviderModuleOptions {
     /** Returns the {@link ProviderModuleOptions | definition}. */
     getDefinition(): ProviderModuleOptions;
+    /**
+     * Can be used to _clone_ the instance of this {@link IProviderModuleDefinition | ModuleDefinition}.
+     *
+     * @param definition Optionally you can overwrite the definition of the clone before being returned.
+     *
+     * ```ts
+     * const CarModuleDefinition = new ProviderModuleDefinition({
+     *   identifier: 'CarModuleDefinition',
+     *   providers: [CarService],
+     * });
+     *
+     * const CarModuleDefinitionMocked = CarModuleDefinition.clone({
+     *   identifier: 'CarModuleDefinitionMocked',
+     *   providers: [{ provide: CarService, useClass: CarServiceMocked }]
+     * });
+     * ```
+     */
+    clone(definition?: Partial<ProviderModuleOptions>): IProviderModuleDefinition;
     /** Returns the {@link ProviderModuleOptions.identifier | identifier}. */
     toString(): string;
 }
@@ -478,10 +503,10 @@ interface IProviderModuleDefinition extends ProviderModuleOptions {
 declare class ProviderModuleUtils {
     /** The low-level InversifyJS {@link Container} owned by {@link ProviderModuleUtils.module | module}. */
     get container(): Container;
+    readonly appModule: GlobalAppModule;
     /** The parent {@link IProviderModule | ProviderModule} of `this` instance. */
     readonly module: IProviderModule;
     readonly moduleNaked: IProviderModuleNaked;
-    private readonly appModule;
     constructor(module: IProviderModule, internalOptions: ProviderModuleOptionsInternal);
     /**
      * Low-level method which can be used to manually register _(bind)_ a new {@link provider} into the {@link ProviderModuleUtils.module | module} container.
@@ -509,8 +534,10 @@ declare class ProviderModuleUtils {
 
 /** Can be used to publicly expose internal properties and methods of an {@link IProviderModule} instance. */
 interface IProviderModuleNaked extends IProviderModule {
-    /** It'll be true when the current module is the global `AppModule`. */
+    /** It'll be `true` when the current module is the global `AppModule`. */
     readonly isAppModule: boolean;
+    /** It'll be `true` when the `module` has been instantiated from a `ProviderModuleDefinition` instance. */
+    readonly instantiatedFromDefinition: boolean;
     /** The low-level `InversifyJS` {@link https://inversify.io/docs/api/container/ | container} instance. */
     readonly container: Container;
     /** The default injection scope of this module. */
@@ -704,8 +731,8 @@ type OnUnbindEffects = {
 interface IProviderModule {
     /** The module unique ID. */
     readonly identifier: ModuleIdentifier;
-    /** See {@link ProviderModuleOptions.markAsGlobal}. */
-    readonly isMarkedAsGlobal: ProviderModuleOptions['markAsGlobal'];
+    /** See {@link ProviderModuleOptions.isGlobal}. */
+    readonly isGlobal: ProviderModuleOptions['isGlobal'];
     readonly isDisposed: boolean;
     /**
      * Can be used to retrieve a resolved `dependency` from the module container.
@@ -770,13 +797,13 @@ type ProviderModuleGetManyParam<T> = {
     isOptional?: boolean;
 };
 
-interface IAppModule extends Except<IProviderModule, 'isMarkedAsGlobal'> {
+interface IAppModule extends Except<IProviderModule, 'isGlobal'> {
     readonly _strict: AppModuleOptions['_strict'];
     /** Must be invoked _(only once during the application lifecycle)_ in order to provide the {@link options} to the module. */
     register<AsNaked extends boolean = false>(options: AppModuleOptions): AsNaked extends false ? IAppModule : IAppModule & IProviderModuleNaked;
     toNaked(): IAppModule & IProviderModuleNaked;
 }
-interface AppModuleOptions extends Except<InternalInitOptions, 'appModule' | 'markAsGlobal' | 'exports' | 'isDisposed'> {
+interface AppModuleOptions extends Except<InternalInitOptions, 'appModule' | 'isGlobal' | 'exports' | 'isDisposed'> {
     /**
      * When set to `true` it'll enforce an opinionated set of rules
      * which _can help_ in avoiding common pitfalls which may otherwise produce
@@ -784,7 +811,7 @@ interface AppModuleOptions extends Except<InternalInitOptions, 'appModule' | 'ma
      *
      * **Note:** _Do not open an `issue` if a bug or edge-case is caused by having the `strict` property disabled!_
      *
-     * - `markAsGlobal`: Will not be enforced anymore.
+     * - `isGlobal`: Will not be enforced anymore.
      *
      * Defaults to `true`.
      */
@@ -820,25 +847,25 @@ declare class InjectionError extends Error {
 /** Exception which indicates that there is a generic error with an instance of {@link IProviderModule}. */
 declare class InjectionProviderModuleError extends Error {
     name: string;
-    constructor(module: IProviderModule, message: string);
+    constructor(module: ProviderModuleOrDefinition, message: string);
 }
 
 /** Exception which indicates an invokation of a disposed module.  */
 declare class InjectionProviderModuleDisposedError extends InjectionProviderModuleError {
     name: string;
-    constructor(module: IProviderModule);
+    constructor(module: ProviderModuleOrDefinition);
 }
 
 /** Exception which indicates that a module has been initialized without an `identifier`.  */
 declare class InjectionProviderModuleMissingIdentifierError extends InjectionProviderModuleError {
     name: string;
-    constructor(module: IProviderModule);
+    constructor(module: ProviderModuleOrDefinition);
 }
 
-/** Exception which indicates an error with regards to the `markAsGlobal` option.  */
+/** Exception which indicates an error with regards to the `isGlobal` option.  */
 declare class InjectionProviderModuleGlobalMarkError extends InjectionProviderModuleError {
     name: string;
-    constructor(module: IProviderModule, message: string);
+    constructor(module: ProviderModuleOrDefinition, message: string);
 }
 
 declare function injectionScopeToBindingScope(injectionScope: InjectionScope): BindingScope;