@dipscope/type-manager 3.0.0 → 4.0.2

package/type-manager.d.ts

@@ -1,4 +1,5 @@
-import { TypeCtor } from './core/type-ctor';
+import { Alias } from './core/alias';
+import { TypeFn } from './core/type-fn';
 import { TypeLike } from './core/type-like';
 import { TypeMetadata } from './core/type-metadata';
 import { TypeOptions } from './core/type-options';
@@ -11,107 +12,277 @@ import { TypeManagerOptions } from './type-manager-options';
  */
 export declare class TypeManager<TType> {
     /**
-     * Type metadata for provided type.
+     * Static global options of any type.
+     *
+     * @type {TypeOptionsBase<any>}
+     */
+    static readonly typeOptionsBase: TypeOptionsBase<any>;
+    /**
+     * Static type options per type.
+     *
+     * Overrides static global type options.
+     *
+     * @type {Map<TypeFn<any>, TypeOptions<any>>}
+     */
+    static readonly typeOptionsMap: Map<TypeFn<any>, TypeOptions<any>>;
+    /**
+     * Static type function map for types with aliases.
+     *
+     * @type {Map<Alias, TypeFn<any>>}
+     */
+    static readonly typeFnMap: Map<Alias, TypeFn<any>>;
+    /**
+     * Type function provided to the type manager.
+     *
+     * @type {TypeFn<TType>}
+     */
+    readonly typeFn: TypeFn<TType>;
+    /**
+     * Type metadata for provided type function.
      *
      * @type {TypeMetadata<TType>}
      */
     readonly typeMetadata: TypeMetadata<TType>;
     /**
-     * Array metadata for provided type.
+     * Type manager options.
+     *
+     * @type {TypeManagerOptions}
+     */
+    readonly typeManagerOptions: TypeManagerOptions;
+    /**
+     * Type options base of current instance.
+     *
+     * @type {TypeOptionsBase<any>}
+     */
+    readonly typeOptionsBase: TypeOptionsBase<any>;
+    /**
+     * Type options map of current instance.
+     *
+     * @type {Map<TypeFn<any>, TypeOptions<any>>}
+     */
+    readonly typeOptionsMap: Map<TypeFn<any>, TypeOptions<any>>;
+    /**
+     * Type function map for types with aliases of current instance.
      *
-     * @type {TypeMetadata<Array<any>>}
+     * @type {Map<Alias, TypeFn<any>>}
      */
-    private readonly arrayMetadata;
+    readonly typeFnMap: Map<Alias, TypeFn<any>>;
+    /**
+     * Type metadata map of current instance.
+     *
+     * @type {Map<TypeFn<any>, TypeMetadata<any>>}
+     */
+    readonly typeMetadataMap: Map<TypeFn<any>, TypeMetadata<any>>;
     /**
      * Constructor.
      *
-     * @param {TypeCtor<TType>} typeCtor Type constructor function.
+     * Creating an instance of type manager is a heavy operation as it preserves a configuration state.
+     * If you don't modify any of type manager options at runtime it is better to use static methods.
+     *
+     * @param {TypeFn<TType>} typeFn Type function.
+     * @param {TypeManagerOptions} typeManagerOptions Type manager options.
      */
-    constructor(typeCtor: TypeCtor<TType>);
+    constructor(typeFn: TypeFn<TType>, typeManagerOptions?: TypeManagerOptions);
     /**
-     * Configures global type options.
+     * Declares type metadata for provided type function based on general configuration.
      *
-     * @param {Partial<TypeOptionsBase<any>>} typeOptionsBase Type options base.
+     * @param {TypeFn<TType>} typeFn Type function.
+     *
+     * @returns {TypeMetadata<TType>} Type metadata.
+     */
+    private static declareTypeMetadata;
+    /**
+     * Defines type metadata for the type prototype.
+     *
+     * @param {TypeFn<TType>} typeFn Type function.
+     * @param {TypeOptions<TType>} typeOptions Type options.
+     *
+     * @returns {TypeMetadata<TType>} Type metadata for provided type function.
+     */
+    static defineTypeMetadata<TType>(typeFn: TypeFn<TType>, typeOptions?: TypeOptions<TType>): TypeMetadata<TType>;
+    /**
+     * Extracts type metadata from provided type function.
+     *
+     * @param {TypeFn<TType>} typeFn Type function.
+     *
+     * @returns {TypeMetadata<TType>} Type metadata for provided type function.
+     */
+    static extractTypeMetadata<TType>(typeFn: TypeFn<TType>): TypeMetadata<TType>;
+    /**
+     * Resolves type metadata by provided type argument.
      *
-     * @returns {void}
+     * @type {TypeMetadata<any>} Type metadata for provided type argument.
      */
-    static configureTypeOptionsBase(typeOptionsBase: Partial<TypeOptionsBase<any>>): void;
+    private static resolveTypeMetadata;
     /**
-     * Configures type options.
+     * Configures static global type options.
      *
-     * @param {TypeCtor<any>} typeCtor Type constructor function.
-     * @param {TypeOptions<any>} typeOptions Type options.
+     * @param {Partial<TypeOptionsBase<TType>>} typeOptionsBase Type options base.
      *
-     * @returns {void}
+     * @returns {typeof TypeManager} Static instance of type manager.
      */
-    static configureTypeOptions(typeCtor: TypeCtor<any>, typeOptions: TypeOptions<any>): void;
+    static configureTypeOptionsBase<TType>(typeOptionsBase: Partial<TypeOptionsBase<TType>>): typeof TypeManager;
     /**
-     * Configures type options per type.
+     * Configures static type options.
      *
-     * @param {Map<TypeCtor<any>, TypeOptions<any>>} typeOptionsMap Type options map.
+     * @param {TypeFn<TType>} typeFn Type function.
+     * @param {TypeOptions<TType>} typeOptions Type options.
      *
-     * @returns {void}
+     * @returns {typeof TypeManager} Static instance of type manager.
      */
-    static configureTypeOptionsMap(typeOptionsMap: Map<TypeCtor<any>, TypeOptions<any>>): void;
+    static configureTypeOptions<TType>(typeFn: TypeFn<TType>, typeOptions: TypeOptions<TType>): typeof TypeManager;
     /**
-     * Configures type manager in general.
+     * Configures static type options map.
+     *
+     * @param {Map<TypeFn<TType>, TypeOptions<TType>>} typeOptionsMap Type options map.
+     *
+     * @returns {typeof TypeManager} Static instance of type manager.
+     */
+    static configureTypeOptionsMap<TType>(typeOptionsMap: Map<TypeFn<TType>, TypeOptions<TType>>): typeof TypeManager;
+    /**
+     * Configures type manager in static context.
      *
      * @param {TypeManagerOptions} typeManagerOptions Type manager options.
      *
-     * @returns {void}
+     * @returns {typeof TypeManager} Static instance of type manager.
      */
-    static configure(typeManagerOptions: TypeManagerOptions): void;
+    static configure(typeManagerOptions: TypeManagerOptions): typeof TypeManager;
     /**
-     * Serializes provided value based on the type constructor function.
+     * Defines serializer context for x in static context.
      *
-     * @param {TypeCtor<TType>} typeCtor Type constructor function.
+     * @param {TypeFn<TType>} typeFn Type function.
+     * @param {any} x Some value.
+     * @param {Array<GenericArgument<any>>} genericArguments Generic arguments.
+     *
+     * @returns {SerializerContext<TType>} Serializer context.
+     */
+    private static defineSerializerContext;
+    /**
+     * Serializes provided value based on the type function.
+     *
+     * @param {TypeFn<TType>} typeFn Type function.
      * @param {TypeLike<TType>} x Input value.
      *
      * @returns {TypeLike<any>} Object created from provided input value or undefined.
      */
-    static serialize<TType>(typeCtor: TypeCtor<TType>, x: undefined): undefined;
-    static serialize<TType>(typeCtor: TypeCtor<TType>, x: null): null;
-    static serialize<TType>(typeCtor: TypeCtor<TType>, x: TType[]): any[];
-    static serialize<TType>(typeCtor: TypeCtor<TType>, x: TType): any;
+    static serialize<TType>(typeFn: TypeFn<TType>, x: undefined): undefined;
+    static serialize<TType>(typeFn: TypeFn<TType>, x: null): null;
+    static serialize<TType>(typeFn: TypeFn<TType>, x: Array<TType>): Array<any>;
+    static serialize<TType>(typeFn: TypeFn<TType>, x: TType): any;
     /**
-     * Deserializes provided value based on the type constructor function.
+     * Deserializes provided value based on the type function.
      *
-     * @param {TypeCtor<TType>} typeCtor Type constructor function.
+     * @param {TypeFn<TType>} typeFn Type function.
      * @param {TypeLike<any>} x Input value.
      *
      * @returns {TypeLike<TType>} Type created from provided input value or undefined.
      */
-    static deserialize<TType>(typeCtor: TypeCtor<TType>, x: undefined): undefined;
-    static deserialize<TType>(typeCtor: TypeCtor<TType>, x: null): null;
-    static deserialize<TType>(typeCtor: TypeCtor<TType>, x: any[]): TType[];
-    static deserialize<TType>(typeCtor: TypeCtor<TType>, x: any): TType;
+    static deserialize<TType>(typeFn: TypeFn<TType>, x: undefined): undefined;
+    static deserialize<TType>(typeFn: TypeFn<TType>, x: null): null;
+    static deserialize<TType>(typeFn: TypeFn<TType>, x: Array<any>): Array<TType>;
+    static deserialize<TType>(typeFn: TypeFn<TType>, x: any): TType;
     /**
      * Converts provided value to a JavaScript Object Notation (JSON) string.
      *
-     * @param {TypeCtor<TType>} typeCtor Type constructor function.
+     * @param {TypeFn<TType>} typeFn Type function.
      * @param {any} x Input value, usually an object or array, to be converted.
-     * @param {Function|number[]|string[]} replacer A function that transforms the results or an array of strings and numbers that acts as an approved list.
+     * @param {Function|Array<number>|Array<string>} replacer A function that transforms the results or an array of strings and numbers that acts as an approved list.
      * @param {string|number} space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
      *
      * @returns {string} JSON string.
      */
-    static stringify<TType>(typeCtor: TypeCtor<TType>, x: any, replacer?: (this: any, key: string, value: any) => any | number[] | string[] | null, space?: string | number): string;
+    static stringify<TType>(typeFn: TypeFn<TType>, x: any, replacer?: (this: any, key: string, value: any) => any | Array<number> | Array<string> | null, space?: string | number): string;
     /**
      * Converts a JavaScript Object Notation (JSON) string into a type.
      *
-     * @param {TypeCtor<TType>} typeCtor Type constructor function.
+     * @param {TypeFn<TType>} typeFn Type function.
      * @param {string} x A valid JSON string.
      * @param {Function} reviver A function that transforms the results. This function is called for each member of the object.
      *
      * @returns {TypeLike<TType>} Type created from provided input value or undefined.
      */
-    static parse<TType>(typeCtor: TypeCtor<TType>, x: string, reviver?: (this: any, key: string, value: any) => any): TypeLike<TType>;
+    static parse<TType>(typeFn: TypeFn<TType>, x: string, reviver?: (this: any, key: string, value: any) => any): TypeLike<TType>;
+    /**
+     * Declares type metadata for provided type function.
+     *
+     * @param {TypeFn<TType>} typeFn Type function.
+     *
+     * @returns {TypeMetadata<TType>} Type metadata.
+     */
+    private declareTypeMetadata;
+    /**
+     * Defines type metadata in the type metadata map.
+     *
+     * @param {TypeFn<TType>} typeFn Type function.
+     * @param {TypeOptions<TType>} typeOptions Type options.
+     *
+     * @returns {TypeMetadata<TType>} Type metadata for provided type function.
+     */
+    defineTypeMetadata<TType>(typeFn: TypeFn<TType>, typeOptions?: TypeOptions<TType>): TypeMetadata<TType>;
+    /**
+     * Extracts type metadata from provided type function.
+     *
+     * @param {TypeFn<TType>} typeFn Type function.
+     *
+     * @returns {TypeMetadata<TType>} Type metadata for provided type function.
+     */
+    extractTypeMetadata<TType>(typeFn: TypeFn<TType>): TypeMetadata<TType>;
+    /**
+     * Resolves type metadata by provided type argument.
+     *
+     * @type {TypeMetadata<any>} Type metadata for provided type argument.
+     */
+    private resolveTypeMetadata;
+    /**
+     * Configures instance global type options.
+     *
+     * @param {Partial<TypeOptionsBase<any>>} typeOptionsBase Type options base.
+     *
+     * @returns {TypeManager<TType>} Current instance of type manager.
+     */
+    configureTypeOptionsBase(typeOptionsBase: Partial<TypeOptionsBase<any>>): TypeManager<TType>;
+    /**
+     * Configures instance type options.
+     *
+     * @param {TypeFn<TType>} typeFn Type function.
+     * @param {TypeOptions<TType>} typeOptions Type options.
+     *
+     * @returns {TypeManager<TType>} Current instance of type manager.
+     */
+    configureTypeOptions(typeFn: TypeFn<any>, typeOptions: TypeOptions<any>): TypeManager<TType>;
+    /**
+     * Configures instance type options map.
+     *
+     * @param {Map<TypeFn<TType>, TypeOptions<TType>>} typeOptionsMap Type options map.
+     *
+     * @returns {TypeManager<TType>} Current instance of type manager.
+     */
+    configureTypeOptionsMap(typeOptionsMap: Map<TypeFn<any>, TypeOptions<any>>): TypeManager<TType>;
+    /**
+     * Configures type manager.
+     *
+     * @param {TypeManagerOptions} typeManagerOptions Type manager options.
+     *
+     * @returns {TypeManager<TType>} Current instance of type manager.
+     */
+    configure(typeManagerOptions: TypeManagerOptions): TypeManager<TType>;
+    /**
+     * Builds type options base for the current instance.
+     *
+     * @returns {TypeOptionsBase<any>} Type options base.
+     */
+    private buildTypeOptionsBase;
+    /**
+     * Builds type options map of the current instance.
+     *
+     * @returns {Map<TypeFn<any>, TypeOptions<any>>} Type options map.
+     */
+    private buildTypeOptionsMap;
     /**
      * Defines serializer context for x.
      *
      * @param {any} x Some value.
-     * @param {TypeMetadata<any>} typeMetadata Type metadata.
-     * @param {GenericArgument<any>[]} genericArguments Generic arguments.
+     * @param {Array<GenericArgument<any>>} genericArguments Generic arguments.
      *
      * @returns {SerializerContext<any>} Serializer context.
      */
@@ -125,7 +296,7 @@ export declare class TypeManager<TType> {
      */
     serialize(x: undefined): undefined;
     serialize(x: null): null;
-    serialize(x: TType[]): any[];
+    serialize(x: Array<TType>): Array<any>;
     serialize(x: TType): any;
     /**
      * Deserializes provided value.
@@ -136,18 +307,18 @@ export declare class TypeManager<TType> {
      */
     deserialize(x: undefined): undefined;
     deserialize(x: null): null;
-    deserialize(x: any[]): TType[];
+    deserialize(x: Array<any>): Array<TType>;
     deserialize(x: any): TType;
     /**
      * Converts provided value to a JavaScript Object Notation (JSON) string.
      *
      * @param {any} x Input value, usually an object or array, to be converted.
-     * @param {Function|number[]|string[]} replacer A function that transforms the results or an array of strings and numbers that acts as an approved list.
+     * @param {Function|Array<number>|Array<string>} replacer A function that transforms the results or an array of strings and numbers that acts as an approved list.
      * @param {string|number} space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
      *
      * @returns {string} JSON string.
      */
-    stringify(x: any, replacer?: (this: any, key: string, value: any) => any | number[] | string[] | null, space?: string | number): string;
+    stringify(x: any, replacer?: (this: any, key: string, value: any) => any | Array<number> | Array<string> | null, space?: string | number): string;
     /**
      * Converts a JavaScript Object Notation (JSON) string into a type.
      *

package/inject-artisan.d.ts

@@ -1,20 +0,0 @@
-import { InjectMetadata } from './core/inject-metadata';
-import { InjectOptions } from './core/inject-options';
-import { TypeCtor } from './core/type-ctor';
-/**
- * Inject artisan class to encapsulate injection manipulating functions.
- *
- * @type {InjectArtisan}
- */
-export declare class InjectArtisan {
-    /**
-     * Defines inject metadata for a certain type constructor.
-     *
-     * @param {TypeCtor<TDeclaringType>} declaringTypeCtor Declaring type constructor function.
-     * @param {number} injectIndex Inject index.
-     * @param {InjectOptions<TType>} injectOptions Inject options.
-     *
-     * @returns {InjectMetadata<TDeclaringType, TType>} Inject metadata for provided type constructor.
-     */
-    static defineInjectMetadata<TDeclaringType, TType>(declaringTypeCtor: TypeCtor<TDeclaringType>, injectIndex: number, injectOptions: InjectOptions<TType>): InjectMetadata<TDeclaringType, TType>;
-}

package/property-artisan.d.ts

@@ -1,20 +0,0 @@
-import { PropertyMetadata } from './core/property-metadata';
-import { PropertyOptions } from './core/property-options';
-import { TypeCtor } from './core/type-ctor';
-/**
- * Property artisan class to encapsulate property manipulating functions.
- *
- * @type {PropertyArtisan}
- */
-export declare class PropertyArtisan {
-    /**
-     * Defines property metadata for a certain type constructor.
-     *
-     * @param {TypeCtor<TDeclaringType>} declaringTypeCtor Declaring type constructor function.
-     * @param {string} propertyName Property name.
-     * @param {PropertyOptions<TType>} propertyOptions Property options.
-     *
-     * @returns {PropertyMetadata<TDeclaringType, TType>} Property metadata for provided type constructor.
-     */
-    static definePropertyMetadata<TDeclaringType, TType>(declaringTypeCtor: TypeCtor<TDeclaringType>, propertyName: string, propertyOptions: PropertyOptions<TType>): PropertyMetadata<TDeclaringType, TType>;
-}

package/type-artisan.d.ts

@@ -1,95 +0,0 @@
-import { Alias } from './core/alias';
-import { TypeArgument } from './core/type-argument';
-import { TypeCtor } from './core/type-ctor';
-import { TypeMetadata } from './core/type-metadata';
-import { TypeOptions } from './core/type-options';
-import { TypeOptionsBase } from './core/type-options-base';
-/**
- * Type artisan class to encapsulate type manipulating functions.
- *
- * @type {TypeArtisan}
- */
-export declare class TypeArtisan {
-    /**
-     * Type metadata key which is used to store data in prototypes.
-     *
-     * @type {string}
-     */
-    static readonly typeMetadataKey: string;
-    /**
-     * Global options of any type.
-     *
-     * @type {TypeOptionsBase<any>}
-     */
-    static readonly typeOptionsBase: TypeOptionsBase<any>;
-    /**
-     * Type options per type.
-     *
-     * Overrides global type options.
-     *
-     * @type {Map<TypeCtor<any>, TypeOptions<any>>}
-     */
-    static readonly typeOptionsMap: Map<TypeCtor<any>, TypeOptions<any>>;
-    /**
-     * Type constructor map for types with aliases.
-     *
-     * @type {Map<Alias, TypeCtor<any>>}
-     */
-    static readonly typeCtorMap: Map<Alias, TypeCtor<any>>;
-    /**
-     * Configures global type options.
-     *
-     * @param {Partial<TypeOptionsBase<TType>>} typeOptionsBase Type options base.
-     *
-     * @returns {void}
-     */
-    static configureTypeOptionsBase<TType>(typeOptionsBase: Partial<TypeOptionsBase<TType>>): void;
-    /**
-     * Configures type options.
-     *
-     * @param {TypeCtor<TType>} typeCtor Type constructor function.
-     * @param {TypeOptions<TType>} typeOptions Type options.
-     *
-     * @returns {void}
-     */
-    static configureTypeOptions<TType>(typeCtor: TypeCtor<TType>, typeOptions: TypeOptions<TType>): void;
-    /**
-     * Configures type options per type.
-     *
-     * @param {Map<TypeCtor<TType>, TypeOptions<TType>>} typeOptionsMap Type options map.
-     *
-     * @returns {void}
-     */
-    static configureTypeOptionsMap<TType>(typeOptionsMap: Map<TypeCtor<TType>, TypeOptions<TType>>): void;
-    /**
-     * Declares type metadata for provided type constructor based on general configuration.
-     *
-     * @param {TypeCtor<TType>} typeCtor Type constructor function.
-     *
-     * @returns {TypeMetadata<TType>} Type metadata.
-     */
-    static declareTypeMetadata<TType>(typeCtor: TypeCtor<TType>): TypeMetadata<TType>;
-    /**
-     * Defines type metadata for the type prototype.
-     *
-     * @param {TypeCtor<TType>} typeCtor Type constructor function.
-     * @param {TypeOptions<TType>} typeOptions Type options.
-     *
-     * @returns {TypeMetadata<TType>} Type metadata for provided type constructor.
-     */
-    static defineTypeMetadata<TType>(typeCtor: TypeCtor<TType>, typeOptions?: TypeOptions<TType>): TypeMetadata<TType>;
-    /**
-     * Extracts type metadata from provided type constructor.
-     *
-     * @param {TypeCtor<TType>} typeCtor Type constructor function.
-     *
-     * @returns {TypeMetadata<TType>} Type metadata for provided type constructor.
-     */
-    static extractTypeMetadata<TType>(typeCtor: TypeCtor<TType>): TypeMetadata<TType>;
-    /**
-     * Resolves type metadata by provided type argument.
-     *
-     * @type {TypeMetadata<any>} Type metadata for provided type argument.
-     */
-    static resolveTypeMetadata<TType>(typeArgument: TypeArgument<TType>): TypeMetadata<TType>;
-}