@tsed/di 8.0.0-alpha.4 → 8.0.0-alpha.6

package/lib/types-esm/common/interfaces/DIConfigurationOptions.d.ts

@@ -1,29 +0,0 @@
-import type { ProviderScope } from "../domain/ProviderScope.js";
-import type { DIResolver } from "./DIResolver.js";
-import type { ImportTokenProviderOpts } from "./ImportTokenProviderOpts.js";
-import type { TokenProvider } from "./TokenProvider.js";
-declare global {
-    namespace TsED {
-        interface Context {
-        }
-        interface Configuration extends Record<string, any> {
-            scopes: {
-                [key: string]: ProviderScope;
-            };
-            /**
-             * Define a list of resolvers (it can be an external DI).
-             */
-            resolvers: DIResolver[];
-            /**
-             * Define dependencies to build the provider
-             */
-            imports: (TokenProvider | ImportTokenProviderOpts)[];
-            /**
-             * Mount controllers
-             */
-            mount: Record<string, TokenProvider[]>;
-        }
-    }
-}
-export interface DIConfigurationOptions extends TsED.Configuration {
-}

package/lib/types-esm/common/interfaces/DILogger.d.ts

@@ -1,8 +0,0 @@
-export interface DILogger {
-    info(...args: any[]): void | any;
-    warn(...args: any[]): void | any;
-    debug(...args: any[]): void | any;
-    error(...args: any[]): void | any;
-    trace(...args: any[]): void | any;
-    [key: string]: any;
-}

package/lib/types-esm/common/interfaces/DILoggerOptions.d.ts

@@ -1,53 +0,0 @@
-export interface DILoggerOptions {
-    /**
-     * Enable debug mode. By default debug is false.
-     */
-    debug?: boolean;
-    /**
-     * Enable info mode. By default debug is false.
-     */
-    level?: "debug" | "info" | "warn" | "error" | "off";
-    /**
-     * Enable log performance tracker and disable log server.
-     */
-    perf?: boolean;
-    /**
-     * List of regexp to ignore log.
-     */
-    ignoreUrlPatterns?: (string | RegExp)[];
-    /**
-     * The number of space characters to use as white space in JSON output. Default is 2 (0 in production).
-     */
-    jsonIndentation?: number;
-    /**
-     * A function called for each incoming request to create a request id.
-     * @returns {number}
-     */
-    reqIdBuilder?: (req: any) => string;
-    /**
-     * Disable routes table displayed in the logger. By default debug is `false`.
-     */
-    disableRoutesSummary?: boolean;
-    /**
-     * Disable bootstrap log displayed in the logger. By default debug is `false`.
-     */
-    disableBootstrapLog?: boolean;
-    /**
-     * Specify log format. Example: `%[%d{[yyyy-MM-dd hh:mm:ss,SSS}] %p%] %m`. See [@tsed/logger configuration](https://tsedio.github.io/logger/).
-     */
-    format?: string;
-    /**
-     * Specify the log stack size for the context.logger. When the stack.length is reach, the logger is flushed during the request.
-     * Default size is set to 30.
-     */
-    maxStackSize?: number;
-}
-declare global {
-    namespace TsED {
-        interface LoggerConfiguration extends DILoggerOptions {
-        }
-        interface Configuration extends Record<string, any> {
-            logger?: LoggerConfiguration;
-        }
-    }
-}

package/lib/types-esm/common/interfaces/DIResolver.d.ts

@@ -1,5 +0,0 @@
-import type { TokenProvider } from "./TokenProvider.js";
-export interface DIResolver {
-    deps?: TokenProvider[];
-    get<T = any>(type: TokenProvider, options: any): T | undefined;
-}

package/lib/types-esm/common/interfaces/ImportTokenProviderOpts.d.ts

@@ -1,19 +0,0 @@
-import type { AbstractType, Type } from "@tsed/core";
-import type { TokenProvider } from "./TokenProvider.js";
-export type UseImportTokenProviderOpts = {
-    token: TokenProvider;
-    use: unknown;
-};
-export type UseClassImportTokenProviderOpts = {
-    token: TokenProvider;
-    useClass: Type | AbstractType<any>;
-};
-export type UseFactoryImportTokenProviderOpts = {
-    token: TokenProvider;
-    useFactory: (...args: unknown[]) => unknown;
-};
-export type UseAsyncFactoryImportTokenProviderOpts = {
-    token: TokenProvider;
-    useAsyncFactory: (...args: unknown[]) => Promise<unknown>;
-};
-export type ImportTokenProviderOpts = UseImportTokenProviderOpts | UseClassImportTokenProviderOpts | UseFactoryImportTokenProviderOpts | UseAsyncFactoryImportTokenProviderOpts;

package/lib/types-esm/common/interfaces/InterceptorContext.d.ts

@@ -1,11 +0,0 @@
-import type { Type } from "@tsed/core";
-export interface InterceptorNext {
-    <T>(err?: Error): T;
-}
-export interface InterceptorContext<Klass = Type, Opts = any> {
-    target: Klass;
-    propertyKey: string | symbol;
-    args: any[];
-    next: InterceptorNext;
-    options?: Opts;
-}

package/lib/types-esm/common/interfaces/InterceptorMethods.d.ts

@@ -1,4 +0,0 @@
-import type { InterceptorContext, InterceptorNext } from "./InterceptorContext.js";
-export interface InterceptorMethods {
-    intercept(context: InterceptorContext, next?: InterceptorNext): any;
-}

package/lib/types-esm/common/interfaces/InvokeOptions.d.ts

@@ -1,30 +0,0 @@
-import type { LocalsContainer } from "../domain/LocalsContainer.js";
-import { ProviderScope } from "../domain/ProviderScope.js";
-import { TokenProvider } from "./TokenProvider.js";
-export interface InvokeOptions {
-    /**
-     * Define dependencies to build the provider and inject them in the constructor.
-     */
-    deps: TokenProvider[];
-    /**
-     * List of imports to be created before the provider. Imports list aren't injected directly in the provider constructor.
-     */
-    imports: TokenProvider[];
-    /**
-     * Parent provider.
-     */
-    parent?: TokenProvider;
-    /**
-     * Scope used by the injector to build the provider.
-     */
-    scope: ProviderScope;
-    /**
-     * If true, the injector will rebuild the instance.
-     */
-    rebuild?: boolean;
-    /**
-     * Option given to injectable props or parameter constructor (UseOpts).
-     */
-    useOpts?: Record<string, unknown>;
-    locals?: LocalsContainer;
-}

package/lib/types-esm/common/interfaces/OnDestroy.d.ts

@@ -1,3 +0,0 @@
-export interface OnDestroy {
-    $onDestroy(): Promise<any> | void;
-}

package/lib/types-esm/common/interfaces/OnInit.d.ts

@@ -1,3 +0,0 @@
-export interface OnInit {
-    $onInit(): Promise<any> | void;
-}

package/lib/types-esm/common/interfaces/ProviderOpts.d.ts

@@ -1,59 +0,0 @@
-import type { Type } from "@tsed/core";
-import type { ProviderType } from "../domain/ProviderType.js";
-import type { DIResolver } from "./DIResolver.js";
-import type { ProviderScope } from "../domain/ProviderScope.js";
-import type { TokenProvider } from "./TokenProvider.js";
-export interface ProviderOpts<T = any> {
-    /**
-     * An injection token. (Typically an instance of `Type` or `InjectionToken`, but can be `any`).
-     */
-    provide: TokenProvider<T>;
-    /**
-     * Create alias token to retrieve the instance provider.
-     */
-    alias?: TokenProvider;
-    /**
-     * Provider type
-     */
-    type?: TokenProvider | ProviderType;
-    /**
-     * Instance build by the injector
-     */
-    instance?: T;
-    /**
-     * Define dependencies to build the provider
-     */
-    deps?: TokenProvider[];
-    /**
-     * Class to instantiate for the `token`.
-     */
-    useClass?: Type<T>;
-    /**
-     * Provide a function to build the provider
-     */
-    useFactory?: Function;
-    /**
-     * Provide an async function to build the provider
-     */
-    useAsyncFactory?: Function;
-    /**
-     * Provide predefined value
-     */
-    useValue?: any;
-    /**
-     * Scope used by the injector to build the provider.
-     */
-    scope?: ProviderScope;
-    /**
-     * A list of resolvers which will be used to resolve missing Symbol/Class when injector invoke a Class. This property allow external DI usage.
-     */
-    resolvers?: DIResolver[];
-    /**
-     * hooks to intercept custom events
-     */
-    hooks?: Record<string, (instance: T, ...args: any[]) => Promise<any> | any>;
-    /**
-     *
-     */
-    [key: string]: any;
-}

package/lib/types-esm/common/interfaces/RegistrySettings.d.ts

@@ -1,21 +0,0 @@
-import { Type } from "@tsed/core";
-import type { LocalsContainer } from "../domain/LocalsContainer.js";
-import type { Provider } from "../domain/Provider.js";
-import type { InjectorService } from "../services/InjectorService.js";
-import type { ResolvedInvokeOptions } from "./ResolvedInvokeOptions.js";
-/**
- * @ignore
- */
-export interface RegistrySettings {
-    injectable?: boolean;
-    model?: Type<Provider>;
-    /**
-     *
-     * @param provider
-     * @param {Map<string | Function, any>} locals
-     * @param options
-     */
-    onInvoke?(provider: Provider, locals: LocalsContainer, options: ResolvedInvokeOptions & {
-        injector: InjectorService;
-    }): void;
-}

package/lib/types-esm/common/interfaces/ResolvedInvokeOptions.d.ts

@@ -1,12 +0,0 @@
-import type { Provider } from "../domain/Provider.js";
-import type { ProviderScope } from "../domain/ProviderScope.js";
-import type { TokenProvider } from "./TokenProvider.js";
-export interface ResolvedInvokeOptions {
-    token: TokenProvider;
-    parent?: TokenProvider;
-    scope: ProviderScope;
-    deps: TokenProvider[];
-    imports: (TokenProvider | [TokenProvider])[];
-    provider: Provider;
-    construct(deps: TokenProvider[]): any;
-}

package/lib/types-esm/common/interfaces/TokenProvider.d.ts

@@ -1,2 +0,0 @@
-import type { Type, AbstractType } from "@tsed/core";
-export type TokenProvider<T = any> = string | symbol | Type<T> | AbstractType<T> | Function;

package/lib/types-esm/common/interfaces/TokenRoute.d.ts

@@ -1,5 +0,0 @@
-import { TokenProvider } from "./TokenProvider.js";
-export interface TokenRoute {
-    token: TokenProvider;
-    route: string;
-}

package/lib/types-esm/common/registries/GlobalProviders.d.ts

@@ -1,58 +0,0 @@
-import { Type } from "@tsed/core";
-import type { LocalsContainer } from "../domain/LocalsContainer.js";
-import { Provider } from "../domain/Provider.js";
-import { ProviderOpts } from "../interfaces/ProviderOpts.js";
-import { RegistrySettings } from "../interfaces/RegistrySettings.js";
-import { ResolvedInvokeOptions } from "../interfaces/ResolvedInvokeOptions.js";
-import { TokenProvider } from "../interfaces/TokenProvider.js";
-import type { InjectorService } from "../services/InjectorService.js";
-export declare class GlobalProviderRegistry extends Map<TokenProvider, Provider> {
-    #private;
-    /**
-     * The get() method returns a specified element from a Map object.
-     * @param key Required. The key of the element to return from the Map object.
-     * @returns {T} Returns the element associated with the specified key or undefined if the key can't be found in the Map object.
-     */
-    get(key: TokenProvider): Provider | undefined;
-    /**
-     * The has() method returns a boolean indicating whether an element with the specified key exists or not.
-     * @param key
-     * @returns {boolean}
-     */
-    has(key: TokenProvider): boolean;
-    /**
-     * The set() method adds or updates an element with a specified key and value to a Map object.
-     * @param key Required. The key of the element to add to the Map object.
-     * @param metadata Required. The value of the element to add to the Map object.
-     */
-    set(key: TokenProvider, metadata: Provider): this;
-    /**
-     *
-     * @param target
-     * @param options
-     */
-    merge(target: TokenProvider, options: Partial<ProviderOpts>): Provider<any>;
-    /**
-     * The delete() method removes the specified element from a Map object.
-     * @param key Required. The key of the element to remove from the Map object.
-     * @returns {boolean} Returns true if an element in the Map object existed and has been removed, or false if the element does not exist.
-     */
-    delete(key: TokenProvider): boolean;
-    createRegistry(type: string | symbol, model: Type<Provider>, options?: Partial<RegistrySettings>): this;
-    onInvoke(provider: Provider, locals: LocalsContainer, options: ResolvedInvokeOptions & {
-        injector: InjectorService;
-    }): void;
-    getRegistrySettings(target: TokenProvider): RegistrySettings;
-    createRegisterFn(type: string): (provider: any | ProviderOpts, instance?: any) => void;
-    /**
-     *
-     * @param key
-     * @param options
-     */
-    protected createIfNotExists(key: TokenProvider, options: Partial<ProviderOpts>): Provider;
-}
-/**
- *
- * @type {GlobalProviders}
- */
-export declare const GlobalProviders: GlobalProviderRegistry;

package/lib/types-esm/common/registries/ProviderRegistry.d.ts

@@ -1,58 +0,0 @@
-import { Provider } from "../domain/Provider.js";
-import type { ProviderOpts } from "../interfaces/ProviderOpts.js";
-/**
- * Register a provider configuration.
- * @param {ProviderOpts<any>} provider
- */
-export declare function registerProvider<Type = any>(provider: Partial<ProviderOpts<Type>>): Provider<any>;
-/**
- * Add a new value in the `ProviderRegistry`.
- *
- * #### Example with symbol definition
- *
- *
- * ```typescript
- * import {registerValue, InjectorService} from "@tsed/di";
- *
- * const MyValue = Symbol.from("MyValue")
- *
- * registerValue({token: MyValue, useValue: "myValue"});
- *
- * @Service()
- * export class OtherService {
- *      constructor(@Inject(MyValue) myValue: string){
- *          console.log(myValue); /// "myValue"
- *      }
- * }
- * ```
- */
-export declare const registerValue: (provider: any | ProviderOpts<any>, value?: any) => void;
-/**
- * Add a new controller in the `ProviderRegistry`. This controller will be built when `InjectorService` will be loaded.
- *
- * #### Example
- *
- * ```typescript
- * import {registerController, InjectorService} from "@tsed/di";
- *
- * export default class MyController {
- *     constructor(){}
- *     transform() {
- *         return "test";
- *     }
- * }
- *
- * registerController({provide: MyController});
- * // or
- * registerController(MyController);
- *
- * const injector = new InjectorService();
- * injector.load();
- *
- * const myController = injector.get<MyController>(MyController);
- * myController.getFoo(); // test
- * ```
- *
- * @param provider Provider configuration.
- */
-export declare const registerController: (provider: any, instance?: any) => void;

package/lib/types-esm/common/services/DIConfiguration.d.ts

@@ -1,57 +0,0 @@
-import { Env } from "@tsed/core";
-import type { ProviderScope } from "../domain/ProviderScope.js";
-import type { DILoggerOptions } from "../interfaces/DILoggerOptions.js";
-import type { DIResolver } from "../interfaces/DIResolver.js";
-import type { ImportTokenProviderOpts } from "../interfaces/ImportTokenProviderOpts.js";
-import type { TokenProvider } from "../interfaces/TokenProvider.js";
-import type { TokenRoute } from "../interfaces/TokenRoute.js";
-export declare class DIConfiguration {
-    readonly default: Map<string, any>;
-    protected map: Map<string, any>;
-    constructor(initialProps?: {});
-    get version(): string;
-    set version(v: string);
-    get rootDir(): string;
-    set rootDir(value: string);
-    get env(): Env;
-    set env(value: Env);
-    get scopes(): Record<string, ProviderScope>;
-    set scopes(value: Record<string, ProviderScope>);
-    get resolvers(): DIResolver[];
-    set resolvers(resolvers: DIResolver[]);
-    get imports(): (TokenProvider | ImportTokenProviderOpts)[];
-    set imports(imports: (TokenProvider | ImportTokenProviderOpts)[]);
-    get routes(): TokenRoute[];
-    set routes(routes: TokenRoute[]);
-    get logger(): Partial<DILoggerOptions>;
-    set logger(value: Partial<DILoggerOptions>);
-    get debug(): boolean;
-    set debug(debug: boolean);
-    /**
-     *
-     * @param callbackfn
-     * @param thisArg
-     */
-    forEach(callbackfn: (value: any, index: string, map: Map<string, any>) => void, thisArg?: any): void;
-    /**
-     *
-     * @param propertyKey
-     * @param value
-     */
-    set(propertyKey: string | Partial<TsED.Configuration>, value?: any): this;
-    setRaw(propertyKey: string, value: any): this;
-    /**
-     *
-     * @param propertyKey
-     * @param defaultValue
-     * @returns {undefined|any}
-     */
-    get<T = any>(propertyKey: string, defaultValue?: T): T;
-    /**
-     *
-     * @param value
-     * @returns {any}
-     */
-    resolve(value: any): any;
-    protected getRaw(propertyKey: string, defaultValue?: any): any;
-}

package/lib/types-esm/common/services/DILogger.d.ts

@@ -1,3 +0,0 @@
-import { DILogger } from "../interfaces/DILogger.js";
-export declare const LOGGER: unique symbol;
-export type LOGGER = DILogger;

package/lib/types-esm/common/services/InjectorService.d.ts

@@ -1,203 +0,0 @@
-import { Container } from "../domain/Container.js";
-import { LocalsContainer } from "../domain/LocalsContainer.js";
-import { Provider } from "../domain/Provider.js";
-import { ProviderScope } from "../domain/ProviderScope.js";
-import type { DILogger } from "../interfaces/DILogger.js";
-import type { InvokeOptions } from "../interfaces/InvokeOptions.js";
-import type { TokenProvider } from "../interfaces/TokenProvider.js";
-import { DIConfiguration } from "./DIConfiguration.js";
-/**
- * This service contain all services collected by `@Service` or services declared manually with `InjectorService.factory()` or `InjectorService.service()`.
- *
- * ### Example:
- *
- * ```typescript
- * import {InjectorService} from "@tsed/di";
- *
- * // Import the services (all services are decorated with @Service()";
- * import MyService1 from "./services/service1.js";
- * import MyService2 from "./services/service2.js";
- * import MyService3 from "./services/service3.js";
- *
- * // When all services are imported, you can load InjectorService.
- * const injector = new InjectorService()
- *
- * await injector.load();
- *
- * const myService1 = injector.get<MyService1>(MyServcice1);
- * ```
- */
-export declare class InjectorService extends Container {
-    #private;
-    settings: DIConfiguration;
-    logger: DILogger;
-    private resolvedConfiguration;
-    constructor();
-    get resolvers(): import("../index.js").DIResolver[];
-    get scopes(): Record<string, ProviderScope>;
-    /**
-     * Return the current injector service.
-     */
-    static getInstance(): InjectorService;
-    /**
-     * Get the locals container initiated by DITest or .bootstrap() method.
-     */
-    static getLocals(): LocalsContainer;
-    /**
-     * Reset the locals container.
-     */
-    static unsetLocals(): void;
-    /**
-     * Retrieve default scope for a given provider.
-     * @param provider
-     */
-    scopeOf(provider: Provider): ProviderScope;
-    /**
-     * Return a list of instance build by the injector.
-     */
-    toArray(): any[];
-    /**
-     * Get a service or factory already constructed from his symbol or class.
-     *
-     * #### Example
-     *
-     * ```typescript
-     * import {InjectorService} from "@tsed/di";
-     * import MyService from "./services.js";
-     *
-     * class OtherService {
-     *      constructor(injectorService: InjectorService) {
-     *          const myService = injectorService.get<MyService>(MyService);
-     *      }
-     * }
-     * ```
-     *
-     * @param token The class or symbol registered in InjectorService.
-     * @param options
-     */
-    get<T = any>(token: TokenProvider<T>, options?: Record<string, unknown>): T | undefined;
-    /**
-     * Return all instance of the same provider type
-     */
-    getMany<Type = any>(type: any, locals?: LocalsContainer, options?: Partial<InvokeOptions>): Type[];
-    /**
-     * The has() method returns a boolean indicating whether an element with the specified key exists or not.
-     */
-    has(token: TokenProvider): boolean;
-    /**
-     * Declare an alias for a given token.
-     */
-    alias(token: TokenProvider, alias: TokenProvider): this;
-    /**
-     * Invoke the class and inject all services that required by the class constructor.
-     *
-     * #### Example
-     *
-     * ```typescript
-     * import {InjectorService} from "@tsed/di";
-     * import MyService from "./services.js";
-     *
-     * class OtherService {
-     *     constructor(injectorService: InjectorService) {
-     *          const myService = injectorService.invoke<MyService>(MyService);
-     *      }
-     *  }
-     * ```
-     *
-     * @param token The injectable class to invoke. Class parameters are injected according constructor signature.
-     * @param locals  Optional object. If preset then any argument Class are read from this object first, before the `InjectorService` is consulted.
-     * @param options
-     * @returns {Type} The class constructed.
-     */
-    invoke<Type = any>(token: TokenProvider<Type>, locals?: LocalsContainer, options?: Partial<InvokeOptions>): Type;
-    /**
-     * Build only providers which are asynchronous.
-     */
-    loadAsync(): Promise<void>;
-    /**
-     * Build only providers which are synchronous.
-     */
-    loadSync(): void;
-    /**
-     * Boostrap injector from container and resolve configuration.
-     *
-     * @param container
-     */
-    bootstrap(container?: Container): this;
-    /**
-     * Load injector from a given module
-     * @param rootModule
-     */
-    loadModule(rootModule: TokenProvider): Promise<void>;
-    /**
-     * Build all providers from given container (or GlobalProviders) and emit `$onInit` event.
-     *
-     * @param container
-     */
-    load(container?: Container): Promise<void>;
-    /**
-     * Load all configurations registered on providers
-     */
-    resolveConfiguration(): void;
-    lazyInvoke<T = any>(token: TokenProvider): Promise<any>;
-    /**
-     * Emit an event to all service. See service [lifecycle hooks](/docs/services.md#lifecycle-hooks).
-     * @param eventName The event name to emit at all services.
-     * @param args List of the parameters to give to each service.
-     * @returns A list of promises.
-     */
-    emit(eventName: string, ...args: any[]): Promise<void>;
-    /**
-     * Alter value attached to an event.
-     * @param eventName
-     * @param value
-     * @param args
-     */
-    alter<T = any>(eventName: string, value: any, ...args: any[]): T;
-    /**
-     * Alter value attached to an event asynchronously.
-     * @param eventName
-     * @param value
-     * @param args
-     */
-    alterAsync<T = any>(eventName: string, value: any, ...args: any[]): Promise<T>;
-    /**
-     * Destroy the injector and all services.
-     */
-    destroy(): Promise<void>;
-    /**
-     * Ensure that a provider is added to the container.
-     * @protected
-     */
-    protected ensureProvider(token: TokenProvider, force: true): Provider;
-    protected ensureProvider(token: TokenProvider, force: false): Provider | undefined;
-    protected ensureProvider(token: TokenProvider): Provider | undefined;
-    protected getInstance(token: any): any;
-    /**
-     * Invoke a class method and inject service.
-     *
-     * #### IInjectableMethod options
-     *
-     * * **target**: Optional. The class instance.
-     * * **methodName**: `string` Optional. The method name.
-     * * **designParamTypes**: `any[]` Optional. List of injectable types.
-     * * **locals**: `Map<Function, any>` Optional. If preset then any argument Class are read from this object first, before the `InjectorService` is consulted.
-     *
-     * #### Example
-     *
-     * @param target
-     * @param locals
-     * @param options
-     * @private
-     */
-    protected resolve<T>(target: TokenProvider, locals?: LocalsContainer, options?: Partial<InvokeOptions>): T | Promise<T>;
-    private resolveImportsProviders;
-    /**
-     * Create options to invoke a provider or class.
-     * @param token
-     * @param locals
-     * @param options
-     */
-    private mapInvokeOptions;
-    private registerHooks;
-}

package/lib/types-esm/common/utils/colors.d.ts

@@ -1,5 +0,0 @@
-export declare const colors: {
-    red: (text: string) => string;
-    yellow: (text: string) => string;
-    green: (text: string) => string;
-};