ts-ioc-container 31.8.0 → 31.9.0

package/README.md

@@ -34,7 +34,9 @@
     - [Arguments](#arguments) `args`
     - [Visibility](#visibility) `visible`
     - [Alias](#alias) `alias`
-- [Registration](#registration) `@register(key('someKey'))`
+    - [Lazy](#lazy) `lazy`
+- [Registration](#registration) `@register`
+    - [Key](#key) `key`
     - [Scope](#scope) `scope`
 - [Module](#module)
 - [Hook](#hook) `@hook`
@@ -806,6 +808,95 @@ describe('alias', () => {
 
 ```
 
+### Lazy
+Sometimes you want to create dependency only when somebody want to invoke it's method or property. This is what `LazyProvider` is for.
+- `@provider(lazy)`
+
+```typescript
+import { lazy, Container, inject, MetadataInjector, provider, Registration as R, singleton, by } from 'ts-ioc-container';
+
+describe('lazy provider', () => {
+  @provider(singleton())
+  class Flag {
+    isSet = false;
+
+    set() {
+      this.isSet = true;
+    }
+  }
+
+  @provider(lazy)
+  class Service {
+    name = 'Service';
+
+    constructor(@inject(by.key('Flag')) private flag: Flag) {
+      this.flag.set();
+    }
+
+    greet() {
+      return 'Hello';
+    }
+  }
+
+  function createContainer() {
+    const container = new Container(new MetadataInjector());
+    container.add(R.fromClass(Flag)).add(R.fromClass(Service));
+    return container;
+  }
+
+  it('should not create an instance until method is not invoked', () => {
+    // Arrange
+    const container = createContainer();
+
+    // Act
+    const service = container.resolve<Service>('Service');
+    const flag = container.resolve<Flag>('Flag');
+
+    // Assert
+    expect(service.greet()).toBe('Hello');
+    expect(flag.isSet).toBe(true);
+  });
+
+  it('should create an instance only when some method/property is invoked', () => {
+    // Arrange
+    const container = createContainer();
+
+    // Act
+    const service = container.resolve<Service>('Service');
+    const flag = container.resolve<Flag>('Flag');
+
+    // Assert
+    expect(flag.isSet).toBe(false);
+  });
+
+  it('should not create instance on every method invoked', () => {
+    // Arrange
+    const container = createContainer();
+
+    // Act
+    const service = container.resolve<Service>('Service');
+
+    // Assert
+    expect(service.greet()).toBe('Hello');
+    expect(service.greet()).toBe('Hello');
+    expect(container.getInstances().filter((x) => x instanceof Service).length).toBe(1);
+  });
+
+  it('should create instance when property is invoked', () => {
+    // Arrange
+    const container = createContainer();
+
+    // Act
+    const service = container.resolve<Service>('Service');
+    const flag = container.resolve<Flag>('Flag');
+
+    // Assert
+    expect(service.name).toBe('Service');
+    expect(flag.isSet).toBe(true);
+  });
+});
+
+```
 
 ## Registration
 Registration is provider factory which registers provider in container.
@@ -815,6 +906,12 @@ Registration is provider factory which registers provider in container.
 - `Registration.fromValue(Logger)`
 - `Registration.fromFn((container, ...args) => container.resolve(Logger, {args}))`
 
+### Key
+Sometimes you want to register provider with certain key. This is what `key` is for.
+
+- by default, key is class name
+- you can assign the same key to different registrations
+
 ```typescript
 import 'reflect-metadata';
 import { Container, key, MetadataInjector, provider, register, Registration as R, scope, singleton } from 'ts-ioc-container';

package/cjm/index.js

@@ -1,18 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getParameterMetadata = exports.getMethodMetadata = exports.setMethodMetadata = exports.setParameterMetadata = exports.getMetadata = exports.setMetadata = exports.IMemoKey = exports.by = exports.hasHooks = exports.hook = exports.getHooks = exports.ProxyInjector = exports.SimpleInjector = exports.inject = exports.MetadataInjector = exports.Registration = exports.register = exports.scope = exports.key = exports.AutoMockedContainer = exports.multiCache = exports.MultiCache = exports.SingletonProvider = exports.singleton = exports.Provider = exports.ProviderDecorator = exports.args = exports.argsFn = exports.alias = exports.visible = exports.provider = exports.ContainerDisposedError = exports.MethodNotImplementedError = exports.DependencyNotFoundError = exports.EmptyContainer = exports.Container = exports.isDependencyKey = void 0;
+exports.getParameterMetadata = exports.getMethodMetadata = exports.setMethodMetadata = exports.setParameterMetadata = exports.getMetadata = exports.setMetadata = exports.IMemoKey = exports.by = exports.hasHooks = exports.hook = exports.getHooks = exports.ContainerDisposedError = exports.MethodNotImplementedError = exports.DependencyNotFoundError = exports.Registration = exports.register = exports.scope = exports.key = exports.lazy = exports.LazyProvider = exports.multiCache = exports.MultiCache = exports.SingletonProvider = exports.singleton = exports.Provider = exports.ProviderDecorator = exports.args = exports.argsFn = exports.alias = exports.visible = exports.provider = exports.ProxyInjector = exports.SimpleInjector = exports.inject = exports.MetadataInjector = exports.AutoMockedContainer = exports.EmptyContainer = exports.Container = exports.isDependencyKey = void 0;
+// Containers
 var IContainer_1 = require("./container/IContainer");
 Object.defineProperty(exports, "isDependencyKey", { enumerable: true, get: function () { return IContainer_1.isDependencyKey; } });
 var Container_1 = require("./container/Container");
 Object.defineProperty(exports, "Container", { enumerable: true, get: function () { return Container_1.Container; } });
 var EmptyContainer_1 = require("./container/EmptyContainer");
 Object.defineProperty(exports, "EmptyContainer", { enumerable: true, get: function () { return EmptyContainer_1.EmptyContainer; } });
-var DependencyNotFoundError_1 = require("./errors/DependencyNotFoundError");
-Object.defineProperty(exports, "DependencyNotFoundError", { enumerable: true, get: function () { return DependencyNotFoundError_1.DependencyNotFoundError; } });
-var MethodNotImplementedError_1 = require("./errors/MethodNotImplementedError");
-Object.defineProperty(exports, "MethodNotImplementedError", { enumerable: true, get: function () { return MethodNotImplementedError_1.MethodNotImplementedError; } });
-var ContainerDisposedError_1 = require("./errors/ContainerDisposedError");
-Object.defineProperty(exports, "ContainerDisposedError", { enumerable: true, get: function () { return ContainerDisposedError_1.ContainerDisposedError; } });
+var AutoMockedContainer_1 = require("./container/AutoMockedContainer");
+Object.defineProperty(exports, "AutoMockedContainer", { enumerable: true, get: function () { return AutoMockedContainer_1.AutoMockedContainer; } });
+var MetadataInjector_1 = require("./injector/MetadataInjector");
+Object.defineProperty(exports, "MetadataInjector", { enumerable: true, get: function () { return MetadataInjector_1.MetadataInjector; } });
+Object.defineProperty(exports, "inject", { enumerable: true, get: function () { return MetadataInjector_1.inject; } });
+var SimpleInjector_1 = require("./injector/SimpleInjector");
+Object.defineProperty(exports, "SimpleInjector", { enumerable: true, get: function () { return SimpleInjector_1.SimpleInjector; } });
+var ProxyInjector_1 = require("./injector/ProxyInjector");
+Object.defineProperty(exports, "ProxyInjector", { enumerable: true, get: function () { return ProxyInjector_1.ProxyInjector; } });
+// Providers
 var IProvider_1 = require("./provider/IProvider");
 Object.defineProperty(exports, "provider", { enumerable: true, get: function () { return IProvider_1.provider; } });
 Object.defineProperty(exports, "visible", { enumerable: true, get: function () { return IProvider_1.visible; } });
@@ -28,21 +33,24 @@ Object.defineProperty(exports, "SingletonProvider", { enumerable: true, get: fun
 var MultiCache_1 = require("./provider/singleton/MultiCache");
 Object.defineProperty(exports, "MultiCache", { enumerable: true, get: function () { return MultiCache_1.MultiCache; } });
 Object.defineProperty(exports, "multiCache", { enumerable: true, get: function () { return MultiCache_1.multiCache; } });
-var AutoMockedContainer_1 = require("./container/AutoMockedContainer");
-Object.defineProperty(exports, "AutoMockedContainer", { enumerable: true, get: function () { return AutoMockedContainer_1.AutoMockedContainer; } });
+var LazyProvider_1 = require("./provider/LazyProvider");
+Object.defineProperty(exports, "LazyProvider", { enumerable: true, get: function () { return LazyProvider_1.LazyProvider; } });
+Object.defineProperty(exports, "lazy", { enumerable: true, get: function () { return LazyProvider_1.lazy; } });
+// Registrations
 var IRegistration_1 = require("./registration/IRegistration");
 Object.defineProperty(exports, "key", { enumerable: true, get: function () { return IRegistration_1.key; } });
 Object.defineProperty(exports, "scope", { enumerable: true, get: function () { return IRegistration_1.scope; } });
 Object.defineProperty(exports, "register", { enumerable: true, get: function () { return IRegistration_1.register; } });
 var Registration_1 = require("./registration/Registration");
 Object.defineProperty(exports, "Registration", { enumerable: true, get: function () { return Registration_1.Registration; } });
-var MetadataInjector_1 = require("./injector/MetadataInjector");
-Object.defineProperty(exports, "MetadataInjector", { enumerable: true, get: function () { return MetadataInjector_1.MetadataInjector; } });
-Object.defineProperty(exports, "inject", { enumerable: true, get: function () { return MetadataInjector_1.inject; } });
-var SimpleInjector_1 = require("./injector/SimpleInjector");
-Object.defineProperty(exports, "SimpleInjector", { enumerable: true, get: function () { return SimpleInjector_1.SimpleInjector; } });
-var ProxyInjector_1 = require("./injector/ProxyInjector");
-Object.defineProperty(exports, "ProxyInjector", { enumerable: true, get: function () { return ProxyInjector_1.ProxyInjector; } });
+// Errors
+var DependencyNotFoundError_1 = require("./errors/DependencyNotFoundError");
+Object.defineProperty(exports, "DependencyNotFoundError", { enumerable: true, get: function () { return DependencyNotFoundError_1.DependencyNotFoundError; } });
+var MethodNotImplementedError_1 = require("./errors/MethodNotImplementedError");
+Object.defineProperty(exports, "MethodNotImplementedError", { enumerable: true, get: function () { return MethodNotImplementedError_1.MethodNotImplementedError; } });
+var ContainerDisposedError_1 = require("./errors/ContainerDisposedError");
+Object.defineProperty(exports, "ContainerDisposedError", { enumerable: true, get: function () { return ContainerDisposedError_1.ContainerDisposedError; } });
+// Others
 var hook_1 = require("./hook");
 Object.defineProperty(exports, "getHooks", { enumerable: true, get: function () { return hook_1.getHooks; } });
 Object.defineProperty(exports, "hook", { enumerable: true, get: function () { return hook_1.hook; } });

package/cjm/provider/LazyProvider.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lazy = exports.LazyProvider = void 0;
+const IProvider_1 = require("./IProvider");
+class LazyProvider extends IProvider_1.ProviderDecorator {
+    constructor(provider) {
+        super(provider);
+        this.provider = provider;
+    }
+    resolve(container, ...args) {
+        let instance;
+        return new Proxy({}, {
+            get: (_, prop) => {
+                instance = instance ?? this.provider.resolve(container, ...args);
+                // @ts-ignore
+                return instance[prop];
+            },
+        });
+    }
+}
+exports.LazyProvider = LazyProvider;
+const lazy = (provider) => new LazyProvider(provider);
+exports.lazy = lazy;

package/esm/index.js

@@ -1,19 +1,25 @@
+// Containers
 export { isDependencyKey, } from './container/IContainer';
 export { Container } from './container/Container';
 export { EmptyContainer } from './container/EmptyContainer';
-export { DependencyNotFoundError } from './errors/DependencyNotFoundError';
-export { MethodNotImplementedError } from './errors/MethodNotImplementedError';
-export { ContainerDisposedError } from './errors/ContainerDisposedError';
+export { AutoMockedContainer } from './container/AutoMockedContainer';
+export { MetadataInjector, inject } from './injector/MetadataInjector';
+export { SimpleInjector } from './injector/SimpleInjector';
+export { ProxyInjector } from './injector/ProxyInjector';
+// Providers
 export { provider, visible, alias, argsFn, args, ProviderDecorator, } from './provider/IProvider';
 export { Provider } from './provider/Provider';
 export { singleton, SingletonProvider } from './provider/singleton/SingletonProvider';
 export { MultiCache, multiCache } from './provider/singleton/MultiCache';
-export { AutoMockedContainer } from './container/AutoMockedContainer';
+export { LazyProvider, lazy } from './provider/LazyProvider';
+// Registrations
 export { key, scope, register } from './registration/IRegistration';
 export { Registration } from './registration/Registration';
-export { MetadataInjector, inject } from './injector/MetadataInjector';
-export { SimpleInjector } from './injector/SimpleInjector';
-export { ProxyInjector } from './injector/ProxyInjector';
+// Errors
+export { DependencyNotFoundError } from './errors/DependencyNotFoundError';
+export { MethodNotImplementedError } from './errors/MethodNotImplementedError';
+export { ContainerDisposedError } from './errors/ContainerDisposedError';
+// Others
 export { getHooks, hook, hasHooks } from './hook';
 export { by, IMemoKey } from './by';
 export { setMetadata, getMetadata, setParameterMetadata, setMethodMetadata, getMethodMetadata, getParameterMetadata, } from './metadata';

package/esm/provider/LazyProvider.js

@@ -0,0 +1,18 @@
+import { ProviderDecorator } from './IProvider';
+export class LazyProvider extends ProviderDecorator {
+    constructor(provider) {
+        super(provider);
+        this.provider = provider;
+    }
+    resolve(container, ...args) {
+        let instance;
+        return new Proxy({}, {
+            get: (_, prop) => {
+                instance = instance ?? this.provider.resolve(container, ...args);
+                // @ts-ignore
+                return instance[prop];
+            },
+        });
+    }
+}
+export const lazy = (provider) => new LazyProvider(provider);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-ioc-container",
-  "version": "31.8.0",
+  "version": "31.9.0",
   "description": "Typescript IoC container",
   "publishConfig": {
     "access": "public",
@@ -59,5 +59,5 @@
     "ts-node": "^10.9.1",
     "typescript": "5.4.3"
   },
-  "gitHead": "fa737f07d8b3f1bf9ab0bd33bbdd00cdcc823293"
+  "gitHead": "c0874ed0eb277f524b3aa96ed2a39d626af2ba8b"
 }

package/typings/index.d.ts

@@ -1,22 +1,23 @@
 export { IContainer, Resolvable, IContainerModule, isDependencyKey, DependencyKey, InjectionToken, Tag, Tagged, } from './container/IContainer';
-export { constructor } from './utils';
 export { Container } from './container/Container';
 export { EmptyContainer } from './container/EmptyContainer';
+export { AutoMockedContainer } from './container/AutoMockedContainer';
 export { IInjector } from './injector/IInjector';
-export { DependencyNotFoundError } from './errors/DependencyNotFoundError';
-export { MethodNotImplementedError } from './errors/MethodNotImplementedError';
-export { ContainerDisposedError } from './errors/ContainerDisposedError';
+export { MetadataInjector, inject } from './injector/MetadataInjector';
+export { SimpleInjector } from './injector/SimpleInjector';
+export { ProxyInjector } from './injector/ProxyInjector';
 export { ResolveDependency, IProvider, provider, visible, alias, argsFn, args, ArgsFn, ProviderDecorator, } from './provider/IProvider';
 export { Provider } from './provider/Provider';
 export { singleton, SingletonProvider } from './provider/singleton/SingletonProvider';
 export { MultiCache, multiCache } from './provider/singleton/MultiCache';
 export { Cache } from './provider/singleton/Cache';
-export { AutoMockedContainer } from './container/AutoMockedContainer';
+export { LazyProvider, lazy } from './provider/LazyProvider';
 export { key, IRegistration, scope, register } from './registration/IRegistration';
 export { Registration } from './registration/Registration';
-export { MetadataInjector, inject } from './injector/MetadataInjector';
-export { SimpleInjector } from './injector/SimpleInjector';
-export { ProxyInjector } from './injector/ProxyInjector';
+export { DependencyNotFoundError } from './errors/DependencyNotFoundError';
+export { MethodNotImplementedError } from './errors/MethodNotImplementedError';
+export { ContainerDisposedError } from './errors/ContainerDisposedError';
 export { getHooks, hook, hasHooks } from './hook';
 export { by, InstancePredicate, IMemo, IMemoKey } from './by';
+export { constructor } from './utils';
 export { setMetadata, getMetadata, setParameterMetadata, setMethodMetadata, getMethodMetadata, getParameterMetadata, } from './metadata';

package/typings/provider/LazyProvider.d.ts

@@ -0,0 +1,8 @@
+import { IProvider, ProviderDecorator } from './IProvider';
+import { IContainer } from '../container/IContainer';
+export declare class LazyProvider<Instance> extends ProviderDecorator<Instance> {
+    private provider;
+    constructor(provider: IProvider<Instance>);
+    resolve(container: IContainer, ...args: unknown[]): Instance;
+}
+export declare const lazy: <Instance>(provider: IProvider<Instance>) => LazyProvider<Instance>;