@lppedd/di-wise-neo 0.3.2 → 0.5.0

package/README.md

@@ -1,16 +1,15 @@
 <!--suppress HtmlDeprecatedAttribute -->
+<h1 align="center">di-wise-neo</h1>
+<p align="center">Lightweight, type-safe, flexible dependency injection library for TypeScript and JavaScript</p>
 <div align="center">
-  <h1>di-wise-neo</h1>
-  <p>Lightweight, type-safe, flexible dependency injection library for TypeScript and JavaScript</p>
 
 [![test](https://img.shields.io/github/actions/workflow/status/lppedd/di-wise-neo/test.yml.svg?branch=main)](https://github.com/lppedd/di-wise-neo/actions/workflows/test.yml)
 [![npm](https://img.shields.io/npm/v/@lppedd/di-wise-neo?color=%23de1f1f&logo=npm)](https://www.npmjs.com/package/@lppedd/di-wise-neo)
 [![npm gzipped size](https://img.shields.io/bundlejs/size/@lppedd/di-wise-neo)](https://bundlejs.com/?q=@lppedd/di-wise-neo)
 [![license](https://img.shields.io/github/license/lppedd/di-wise-neo?color=blue)](https://github.com/lppedd/di-wise-neo/blob/main/LICENSE)
 
-  <img src="./.github/images/neo-wall.jpg" alt="di-wise-neo" style="border: 3px solid black; border-radius: 15px;" />
-  <div><sub>yes, I like The Matrix</sub></div>
 </div>
+<img align="center" src="./.github/images/neo-wall.jpg" alt="di-wise-neo" style="border: 3px solid black; border-radius: 15px;" />
 
 > [!NOTE]
 >
@@ -23,7 +22,7 @@
 - [Why yet another library](#why-yet-another-library)
 - [Installation](#installation)
 - [API reference](#api-reference)
-- [Ergonomics](#ergonomics)
+- [Ergonomics & Requirements](#ergonomics)
 - [Quickstart](#quickstart)
 - [Container scopes](#container-scopes)
 - [Token registration](#token-registration)
@@ -93,9 +92,10 @@ pnpm add @lppedd/di-wise-neo
 ```sh
 yarn add @lppedd/di-wise-neo
 ```
+
 ## API reference
 
-You can find the complete API reference at https://lppedd.github.io/di-wise-neo
+You can find the complete API reference at [lppedd.github.io/di-wise-neo](https://lppedd.github.io/di-wise-neo)
 
 ## Ergonomics
 
@@ -103,6 +103,11 @@ You can find the complete API reference at https://lppedd.github.io/di-wise-neo
 - Does **not** use [reflect-metadata](https://www.npmjs.com/package/reflect-metadata) to drive decorators
 - **Can** be used from JavaScript with function-based injection
 
+### Requirements
+
+- When using decorator-based injection, `experimentalDecorators` must be enabled in your `tsconfig.json` file
+- The JavaScript environment must support features such as `Array.flat`, `WeakSet`, `WeakMap`, `Set`, and `Map`
+
 ## Quickstart
 
 ```ts
@@ -220,14 +225,14 @@ Alternatively, use an explicit `ClassProvider` object - useful when registering
 an interface or abstract type:
 
 ```ts
-const Store = createType<Store>("Store");
-container.register(Store, {
+const IStore = createType<Store>("Store");
+container.register(IStore, {
   useClass: SecretStore, // class SecretStore implements Store
 });
 ```
 
-Upon resolving `Store`, the container creates an instance of `SecretStore`,
-caching it according to the configured scope.
+Upon resolving `IStore` - which represents the `Store` interface - the container
+creates an instance of `SecretStore`, caching it according to the configured scope.
 
 ### FactoryProvider
 
@@ -245,7 +250,7 @@ according to the configured scope.
 
 ### ValueProvider
 
-A static value - always taken as-is and unaffected by scopes - can be registered using:
+A fixed value - always taken as-is and unaffected by scopes - can be registered using:
 
 ```ts
 const PID = createType<number>("PID");
@@ -310,7 +315,7 @@ never been registered in the container.
 
 ```ts
 export class ExtensionContext {
-  readonly stores /*: Store[] */ = injectAll(Store);
+  readonly stores /*: Store[] */ = injectAll(IStore);
 
   /* ... */
 
@@ -341,7 +346,7 @@ has never been registered in the container.
 ```ts
 export class ExtensionContext {
   // The type does not change compared to injectAll(T), but the call does not fail
-  readonly stores /*: Store[] */ = optionalAll(Store);
+  readonly stores /*: Store[] */ = optionalAll(IStore);
 
   /* ... */
 }
@@ -366,7 +371,7 @@ export class ProcessManager {
   /* ... */
 
   // The method is called immediately after instance construction
-  notifyListener(@Inject(ProcessListener) listeners: ProcessListener): void {
+  notifyListener(@Inject(ProcessListener) listener: ProcessListener): void {
     listener.processStarted(this.rootPID);
   }
 }
@@ -381,7 +386,7 @@ never been registered in the container.
 
 ```ts
 export class ExtensionContext {
-  constructor(@InjectAll(Store) readonly stores: Store[]) {}
+  constructor(@InjectAll(IStore) readonly stores: Store[]) {}
 
   /* ... */
 
@@ -412,7 +417,7 @@ has never been registered in the container.
 ```ts
 export class ExtensionContext {
   // The type does not change compared to @InjectAll, but construction does not fail
-  constructor(@OptionalAll(Store) readonly stores: Store[]) {}
+  constructor(@OptionalAll(IStore) readonly stores: Store[]) {}
 
   /* ... */
 }
@@ -423,13 +428,13 @@ export class ExtensionContext {
 Sometimes you may need to reference a token or class that is declared later in the file.  
 Normally, attempting to do that would result in a `ReferenceError`:
 
-> ReferenceError: Cannot access 'Store' before initialization
+> ReferenceError: Cannot access 'IStore' before initialization
 
 We can work around this problem by using the `forwardRef` helper function:
 
 ```ts
 export class ExtensionContext {
-  constructor(@OptionalAll(forwardRef(() => Store)) readonly stores: Store[]) {}
+  constructor(@OptionalAll(forwardRef(() => IStore)) readonly stores: Store[]) {}
 
   /* ... */
 }
@@ -471,7 +476,7 @@ In this example, `ExtensionContext` will be registered with **Resolution** scope
 Enables automatic registration of the decorated class if it has not been registered explicitly.
 
 ```ts
-@AutoRegister()
+@AutoRegister
 export class ExtensionContext {
   /* ... */
 }
@@ -480,6 +485,24 @@ export class ExtensionContext {
 container.resolve(ExtensionContext);
 ```
 
+### `@EagerInstantiate`
+
+Marks a class for eager instantiation when registered with **Container** scope.
+
+This causes the container to immediately create and cache the instance of the class
+at registration time, instead of deferring instantiation until the first resolution.
+
+```ts
+@EagerInstantiate
+@Scoped(Scope.Container)
+export class ExtensionContext {
+  /* ... */
+}
+
+// The container immediately creates and caches the instance
+container.register(ExtensionContext);
+```
+
 ## Testing support
 
 Testing is an important part of software development, and dependency injection is meant to make it easier.  

package/dist/cjs/index.d.ts

@@ -3,11 +3,11 @@
  */
 interface Type<A> {
     /**
-     * Name of the type.
+     * The name of the type.
      */
     readonly name: string;
     /**
-     * Create an intersection type from another type.
+     * Creates an intersection type from another type.
      *
      * @example
      * ```ts
@@ -19,7 +19,7 @@ interface Type<A> {
      */
     inter<B>(typeName: string, B: Type<B>): Type<A & B>;
     /**
-     * Create a union type from another type.
+     * Creates a union type from another type.
      *
      * @example
      * ```ts
@@ -37,7 +37,6 @@ interface Type<A> {
 interface Constructor<Instance extends object> {
     new (...args: any[]): Instance;
     readonly name: string;
-    readonly length: number;
 }
 /**
  * Token type.
@@ -48,11 +47,11 @@ type Token<Value = any> = [Value] extends [object] ? Type<Value> | Constructor<V
  */
 type Tokens<Value = any> = [Token<Value>, ...Token<Value>[]];
 /**
- * Create a type token.
+ * Creates a type token.
  *
  * @example
  * ```ts
- * const Spell = createType<Spell>("Spell");
+ * const ISpell = createType<Spell>("Spell");
  * ```
  *
  * @__NO_SIDE_EFFECTS__
@@ -65,31 +64,33 @@ declare function createType<T>(typeName: string): Type<T>;
 interface ClassProvider<Instance extends object> {
     readonly useClass: Constructor<Instance>;
 }
-/**
- * Provides a value for a token via another existing token.
- */
-interface ExistingProvider<Value> {
-    readonly useExisting: Token<Value>;
-}
 /**
  * Provides a value for a token via a factory function.
  *
- * The factory function runs inside the injection context
- * and can thus access dependencies via {@link inject}.
+ * The factory function runs inside the injection context and can
+ * thus access dependencies via {@link inject}-like functions.
  */
 interface FactoryProvider<Value> {
     readonly useFactory: (...args: []) => Value;
 }
 /**
- * Provides a direct - already constructed - value for a token.
+ * Provides a static - already constructed - value for a token.
  */
 interface ValueProvider<T> {
     readonly useValue: T;
 }
+/**
+ * Aliases another registered token.
+ *
+ * Resolving this token will return the value of the aliased one.
+ */
+interface ExistingProvider<Value> {
+    readonly useExisting: Token<Value>;
+}
 /**
  * A token provider.
  */
-type Provider<Value = any> = ClassProvider<Value & object> | ExistingProvider<Value> | FactoryProvider<Value> | ValueProvider<Value>;
+type Provider<Value = any> = ClassProvider<Value & object> | FactoryProvider<Value> | ValueProvider<Value> | ExistingProvider<Value>;
 
 declare const Scope: {
     readonly Inherited: "Inherited";
@@ -212,35 +213,87 @@ interface Container {
      * Returns whether the token is registered in this container or in parent containers, if any.
      */
     isRegistered(token: Token): boolean;
+    /**
+     * Registers a concrete class, where the class acts as its own token.
+     *
+     * Tokens provided via the {@link Injectable} decorator applied to the class
+     * are also registered as aliases.
+     *
+     * The default registration scope is determined by the {@link Scoped} decorator,
+     * if present.
+     */
+    registerClass<Instance extends object>(Class: Constructor<Instance>): void;
+    /**
+     * Registers a concrete class with a token.
+     *
+     * The default registration scope is determined by the {@link Scoped} decorator
+     * applied to the class, if present, but it can be overridden by passing explicit
+     * registration options.
+     */
+    registerClass<Instance extends object, ProvidedInstance extends Instance>(token: Token<Instance>, Class: Constructor<ProvidedInstance>, options?: RegistrationOptions): void;
+    /**
+     * Registers a token whose value is produced by a factory function.
+     *
+     * The factory function runs inside the injection context and can
+     * thus access dependencies via {@link inject}-like functions.
+     */
+    registerFactory<Value, ProvidedValue extends Value>(token: Token<Value>, factory: (...args: []) => ProvidedValue, options?: RegistrationOptions): void;
+    /**
+     * Registers a token with a fixed value.
+     *
+     * The provided value is returned as-is when the token is resolved (scopes do not apply).
+     */
+    registerValue<Value, ProvidedValue extends Value>(token: Token<Value>, value: ProvidedValue): void;
+    /**
+     * Registers one or more tokens as aliases for a target token.
+     *
+     * When an alias is resolved, the target token is resolved instead.
+     */
+    registerAlias<Value, ProvidedValue extends Value>(targetToken: Token<ProvidedValue>, aliasTokens: Tokens<Value>): void;
     /**
      * Registers a {@link ClassProvider}, using the class itself as its token.
      *
-     * Tokens provided to the {@link Injectable} decorator applied to the class
-     * are also registered as aliases. The scope is determined by the {@link Scoped}
-     * decorator, if present.
+     * Tokens provided via the {@link Injectable} decorator applied to the class
+     * are also registered as aliases.
+     *
+     * The scope is determined by the {@link Scoped} decorator, if present.
+     *
+     * @see registerClass
      */
-    register<Instance extends object>(Class: Constructor<Instance>): this;
+    register<Instance extends object>(Class: Constructor<Instance>): Container;
     /**
      * Registers a {@link ClassProvider} with a token.
+     *
+     * The default registration scope is determined by the {@link Scoped} decorator
+     * applied to the provided class, if present, but it can be overridden by
+     * passing explicit registration options.
+     *
+     * @see registerClass
      */
-    register<Instance extends object, ProviderInstance extends Instance>(token: Token<Instance>, provider: ClassProvider<ProviderInstance>, options?: RegistrationOptions): this;
+    register<Instance extends object, ProviderInstance extends Instance>(token: Token<Instance>, provider: ClassProvider<ProviderInstance>, options?: RegistrationOptions): Container;
     /**
      * Registers a {@link FactoryProvider} with a token.
+     *
+     * @see registerFactory
      */
-    register<Value, ProviderValue extends Value>(token: Token<Value>, provider: FactoryProvider<ProviderValue>, options?: RegistrationOptions): this;
+    register<Value, ProviderValue extends Value>(token: Token<Value>, provider: FactoryProvider<ProviderValue>, options?: RegistrationOptions): Container;
     /**
      * Registers an {@link ExistingProvider} with a token.
      *
      * The token will alias the one set in `useExisting`.
+     *
+     * @see registerAlias
      */
-    register<Value, ProviderValue extends Value>(token: Token<Value>, provider: ExistingProvider<ProviderValue>): this;
+    register<Value, ProviderValue extends Value>(token: Token<Value>, provider: ExistingProvider<ProviderValue>): Container;
     /**
      * Registers a {@link ValueProvider} with a token.
      *
      * Values provided via `useValue` are never cached (scopes do not apply)
      * and are simply returned as-is.
+     *
+     * @see registerValue
      */
-    register<Value, ProviderValue extends Value>(token: Token<Value>, provider: ValueProvider<ProviderValue>): this;
+    register<Value, ProviderValue extends Value>(token: Token<Value>, provider: ValueProvider<ProviderValue>): Container;
     /**
      * Removes all registrations for the given token from the container's internal registry.
      *
@@ -364,12 +417,12 @@ interface Container {
 declare function createContainer(options?: Partial<ContainerOptions>): Container;
 
 /**
- * Class decorator for enabling auto-registration of an unregistered class
- * when first resolving it from the container.
+ * Class decorator that enables auto-registration of an unregistered class,
+ * when the class is first resolved from the container.
  *
  * @example
  * ```ts
- * @AutoRegister()
+ * @AutoRegister
  * class Wizard {}
  *
  * const wizard = container.resolve(Wizard);
@@ -378,7 +431,28 @@ declare function createContainer(options?: Partial<ContainerOptions>): Container
  *
  * @__NO_SIDE_EFFECTS__
  */
-declare function AutoRegister(enable?: boolean): ClassDecorator;
+declare function AutoRegister<Ctor extends Constructor<any>>(Class: Ctor): void;
+
+/**
+ * Class decorator that enables eager instantiation of a class when it is registered
+ * in the container with `Scope.Container`.
+ *
+ * This causes the container to immediately create and cache the instance of the class,
+ * instead of deferring instantiation until the first resolution.
+ *
+ * @example
+ * ```ts
+ * @EagerInstantiate
+ * @Scoped(Scope.Container)
+ * class Wizard {}
+ *
+ * // A Wizard instance is immediately created and cached by the container
+ * const wizard = container.register(Wizard);
+ * ```
+ *
+ * @__NO_SIDE_EFFECTS__
+ */
+declare function EagerInstantiate<Ctor extends Constructor<any>>(Class: Ctor): void;
 
 interface TokensRef<Value = any> {
     readonly getRefTokens: () => Set<Token<Value>>;
@@ -387,9 +461,14 @@ interface TokenRef<Value = any> {
     readonly getRefToken: () => Token<Value>;
 }
 /**
- * Allows referencing a token that is declared later in the file by wrapping it in a function.
+ * Allows referencing tokens that are declared later in the file by wrapping them
+ * in a lazily evaluated function.
  */
 declare function forwardRef<Value>(token: () => Tokens<Value>): TokensRef<Value>;
+/**
+ * Allows referencing a token that is declared later in the file by wrapping it
+ * in a lazily evaluated function.
+ */
 declare function forwardRef<Value>(token: () => Token<Value>): TokenRef<Value>;
 
 /**
@@ -424,8 +503,8 @@ declare function Inject<Value>(token: Token<Value>): ParameterDecorator;
 declare function Inject<Value>(tokens: TokenRef<Value>): ParameterDecorator;
 
 /**
- * Class decorator for registering additional aliasing tokens for the decorated type
- * when registering it.
+ * Class decorator that registers additional aliasing tokens for the decorated type,
+ * when the type is first registered in the container.
  *
  * The container uses {@link ExistingProvider} under the hood.
  *
@@ -437,8 +516,8 @@ declare function Inject<Value>(tokens: TokenRef<Value>): ParameterDecorator;
  */
 declare function Injectable<This extends object, Value extends This>(...tokens: Tokens<Value>): ClassDecorator;
 /**
- * Class decorator for registering additional aliasing tokens for the decorated type
- * when registering it.
+ * Class decorator that registers additional aliasing tokens for the decorated type,
+ * when the type is first registered in the container.
  *
  * The container uses {@link ExistingProvider} under the hood.
  *
@@ -718,7 +797,7 @@ declare const Injector: Type<Injector>;
  */
 interface MiddlewareComposer {
     /**
-     * Add a middleware function to the composer.
+     * Adds a middleware function to the composer.
      */
     use<MethodKey extends keyof Container>(key: MethodKey, wrap: Container[MethodKey] extends Function ? (next: Container[MethodKey]) => Container[MethodKey] : never): MiddlewareComposer;
 }
@@ -744,7 +823,7 @@ interface Middleware {
     (composer: MiddlewareComposer, api: Readonly<Container>): void;
 }
 /**
- * Apply middleware functions to a container.
+ * Applies middleware functions to a container.
  *
  * Middlewares are applied in array order, but execute in reverse order.
  *
@@ -768,5 +847,5 @@ interface Middleware {
  */
 declare function applyMiddleware(container: Container, middlewares: Middleware[]): Container;
 
-export { AutoRegister, Inject, InjectAll, Injectable, Injector, Optional, OptionalAll, Scope, Scoped, applyMiddleware, build, createContainer, createType, forwardRef, inject, injectAll, injectBy };
+export { AutoRegister, EagerInstantiate, Inject, InjectAll, Injectable, Injector, Optional, OptionalAll, Scope, Scoped, applyMiddleware, build, createContainer, createType, forwardRef, inject, injectAll, injectBy };
 export type { ClassProvider, Constructor, Container, ContainerOptions, ExistingProvider, FactoryProvider, Middleware, MiddlewareComposer, Provider, RegistrationOptions, Token, TokenRef, Tokens, TokensRef, Type, ValueProvider };