@dipscope/type-manager 5.0.0-beta.1 → 6.0.0

package/type-manager.d.ts

@@ -1,331 +0,0 @@
-import { Alias } from './alias';
-import { TypeFn } from './type-fn';
-import { TypeLike } from './type-like';
-import { TypeManagerOptions } from './type-manager-options';
-import { TypeMetadata } from './type-metadata';
-import { TypeOptions } from './type-options';
-import { TypeOptionsBase } from './type-options-base';
-/**
- * Type manager class for external usage.
- *
- * @type {TypeManager<TType>}
- */
-export declare class TypeManager<TType> {
-    /**
-     * 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>;
-    /**
-     * 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 {Map<Alias, TypeFn<any>>}
-     */
-    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.
-     *
-     * 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(typeFn: TypeFn<TType>, typeManagerOptions?: TypeManagerOptions);
-    /**
-     * Declares type metadata for provided type function based on general configuration.
-     *
-     * @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.
-     *
-     * @type {TypeMetadata<any>} Type metadata for provided type argument.
-     */
-    private static resolveTypeMetadata;
-    /**
-     * Configures static global type options.
-     *
-     * @param {Partial<TypeOptionsBase<TType>>} typeOptionsBase Type options base.
-     *
-     * @returns {typeof TypeManager} Static instance of type manager.
-     */
-    static configureTypeOptionsBase<TType>(typeOptionsBase: Partial<TypeOptionsBase<TType>>): typeof TypeManager;
-    /**
-     * Configures static type options.
-     *
-     * @param {TypeFn<TType>} typeFn Type function.
-     * @param {TypeOptions<TType>} typeOptions Type options.
-     *
-     * @returns {typeof TypeManager} Static instance of type manager.
-     */
-    static configureTypeOptions<TType>(typeFn: TypeFn<TType>, typeOptions: TypeOptions<TType>): typeof TypeManager;
-    /**
-     * 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 {typeof TypeManager} Static instance of type manager.
-     */
-    static configure(typeManagerOptions: TypeManagerOptions): typeof TypeManager;
-    /**
-     * Defines serializer context for x in static context.
-     *
-     * @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>(typeFn: TypeFn<TType>, x: undefined): any;
-    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 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>(typeFn: TypeFn<TType>, x: undefined): any;
-    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 {TypeFn<TType>} typeFn Type function.
-     * @param {any} x Input value, usually an object or array, to be converted.
-     * @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>(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 {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>(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 {Array<GenericArgument<any>>} genericArguments Generic arguments.
-     *
-     * @returns {SerializerContext<any>} Serializer context.
-     */
-    private defineSerializerContext;
-    /**
-     * Serializes provided value.
-     *
-     *  @param {TypeLike<TType>} x Input value.
-     *
-     * @returns {TypeLike<any>} Object created from provided input value or undefined.
-     */
-    serialize(x: undefined): any;
-    serialize(x: null): null;
-    serialize(x: Array<TType>): Array<any>;
-    serialize(x: TType): any;
-    /**
-     * Deserializes provided value.
-     *
-     * @param {TypeLike<any>} x Input value.
-     *
-     * @returns {TypeLike<TType>} Type created from provided input value or undefined.
-     */
-    deserialize(x: undefined): any;
-    deserialize(x: null): null;
-    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|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 | Array<number> | Array<string> | null, space?: string | number): string;
-    /**
-     * Converts a JavaScript Object Notation (JSON) string into a type.
-     *
-     * @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.
-     */
-    parse(x: string, reviver?: (this: any, key: string, value: any) => any): TypeLike<TType>;
-}