@dipscope/type-manager 4.1.1 → 5.0.0

package/serializers/string-serializer.d.ts

@@ -1,6 +1,6 @@
-import { Serializer } from '../core/serializer';
-import { SerializerContext } from '../core/serializer-context';
-import { TypeLike } from '../core/type-like';
+import { Serializer } from '../serializer';
+import { SerializerContext } from '../serializer-context';
+import { TypeLike } from '../type-like';
 /**
  * String serializer.
  *

package/serializers/type-serializer.d.ts

@@ -1,6 +1,6 @@
-import { Serializer } from '../core/serializer';
-import { SerializerContext } from '../core/serializer-context';
-import { TypeLike } from '../core/type-like';
+import { Serializer } from '../serializer';
+import { SerializerContext } from '../serializer-context';
+import { TypeLike } from '../type-like';
 /**
  * Type serializer.
  *

package/serializers/uint-16-array-serializer.d.ts

@@ -1,6 +1,6 @@
-import { Serializer } from '../core/serializer';
-import { SerializerContext } from '../core/serializer-context';
-import { TypeLike } from '../core/type-like';
+import { Serializer } from '../serializer';
+import { SerializerContext } from '../serializer-context';
+import { TypeLike } from '../type-like';
 /**
  * Uint 16 array serializer.
  *

package/serializers/uint-32-array-serializer.d.ts

@@ -1,6 +1,6 @@
-import { Serializer } from '../core/serializer';
-import { SerializerContext } from '../core/serializer-context';
-import { TypeLike } from '../core/type-like';
+import { Serializer } from '../serializer';
+import { SerializerContext } from '../serializer-context';
+import { TypeLike } from '../type-like';
 /**
  * Uint 32 array serializer.
  *

package/serializers/uint-8-array-serializer.d.ts

@@ -1,6 +1,6 @@
-import { Serializer } from '../core/serializer';
-import { SerializerContext } from '../core/serializer-context';
-import { TypeLike } from '../core/type-like';
+import { Serializer } from '../serializer';
+import { SerializerContext } from '../serializer-context';
+import { TypeLike } from '../type-like';
 /**
  * Uint 8 array serializer.
  *

package/serializers/uint-8-clamped-array-serializer.d.ts

@@ -1,6 +1,6 @@
-import { Serializer } from '../core/serializer';
-import { SerializerContext } from '../core/serializer-context';
-import { TypeLike } from '../core/type-like';
+import { Serializer } from '../serializer';
+import { SerializerContext } from '../serializer-context';
+import { TypeLike } from '../type-like';
 /**
  * Uint 8 clamped array serializer.
  *

package/type-manager-options.d.ts

@@ -1,12 +1,12 @@
-import { TypeFn } from './core';
-import { TypeOptions } from './core/type-options';
-import { TypeOptionsBase } from './core/type-options-base';
+import { TypeFn } from './type-fn';
+import { TypeOptions } from './type-options';
+import { TypeOptionsBase } from './type-options-base';
 /**
  * Type manager options.
  *
  * @type {TypeManagerOptions}
  */
-export interface TypeManagerOptions {
+export declare type TypeManagerOptions = {
     /**
      * Global type options shared among all types.
      *
@@ -21,4 +21,4 @@ export interface TypeManagerOptions {
      * @type {Map<TypeFn<any>, TypeOptions<any>>}
      */
     typeOptionsMap?: Map<TypeFn<any>, TypeOptions<any>>;
-}
+};

package/type-manager.d.ts

@@ -1,10 +1,10 @@
-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';
-import { TypeOptionsBase } from './core/type-options-base';
+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.
  *
@@ -165,7 +165,7 @@ export declare class TypeManager<TType> {
      *
      * @returns {TypeLike<any>} Object created from provided input value or undefined.
      */
-    static serialize<TType>(typeFn: TypeFn<TType>, x: undefined): 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;
@@ -177,7 +177,7 @@ export declare class TypeManager<TType> {
      *
      * @returns {TypeLike<TType>} Type created from provided input value or undefined.
      */
-    static deserialize<TType>(typeFn: TypeFn<TType>, x: undefined): 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;
@@ -294,7 +294,7 @@ export declare class TypeManager<TType> {
      *
      * @returns {TypeLike<any>} Object created from provided input value or undefined.
      */
-    serialize(x: undefined): undefined;
+    serialize(x: undefined): any;
     serialize(x: null): null;
     serialize(x: Array<TType>): Array<any>;
     serialize(x: TType): any;
@@ -305,7 +305,7 @@ export declare class TypeManager<TType> {
      *
      * @returns {TypeLike<TType>} Type created from provided input value or undefined.
      */
-    deserialize(x: undefined): undefined;
+    deserialize(x: undefined): any;
     deserialize(x: null): null;
     deserialize(x: Array<any>): Array<TType>;
     deserialize(x: any): TType;

package/{core/type-metadata.d.ts → type-metadata.d.ts}

@@ -1,5 +1,6 @@
 import { Alias } from './alias';
 import { CustomData } from './custom-data';
+import { DefaultValue } from './default-value';
 import { Discriminant } from './discriminant';
 import { Discriminator } from './discriminator';
 import { Factory } from './factory';
@@ -28,12 +29,6 @@ import { TypeOptionsBase } from './type-options-base';
  * @type {TypeMetadata<TType>}
  */
 export declare class TypeMetadata<TType> extends Metadata {
-    /**
-     * Parent type metadata.
-     *
-     * @type {TypeMetadata<any>}
-     */
-    readonly parentTypeMetadata?: TypeMetadata<any>;
     /**
      * Type name.
      *
@@ -48,6 +43,12 @@ export declare class TypeMetadata<TType> extends Metadata {
      * @type {TypeFn<TType>}
      */
     readonly typeFn: TypeFn<TType>;
+    /**
+     * Type function map for types with aliases.
+     *
+     * @type {Map<Alias, TypeFn<any>>}
+     */
+    readonly typeFnMap: Map<Alias, TypeFn<any>>;
     /**
      * Type options used by default.
      *
@@ -61,11 +62,11 @@ export declare class TypeMetadata<TType> extends Metadata {
      */
     readonly typeOptions: TypeOptions<TType>;
     /**
-     * Children type metadatas.
+     * Children type metadata map.
      *
      * @type {Map<TypeFn<TType>, TypeMetadata<any>>}
      */
-    readonly childrenTypeMetadatas: Map<TypeFn<any>, TypeMetadata<any>>;
+    readonly childrenTypeMetadataMap: Map<TypeFn<any>, TypeMetadata<any>>;
     /**
      * Discriminant map.
      *
@@ -84,16 +85,23 @@ export declare class TypeMetadata<TType> extends Metadata {
      * @type {Map<InjectIndex, InjectMetadata<TType, any>>}
      */
     readonly injectMetadataMap: Map<InjectIndex, InjectMetadata<TType, any>>;
+    /**
+     * Parent type metadata.
+     *
+     * @type {TypeMetadata<any>}
+     */
+    readonly parentTypeMetadata?: TypeMetadata<any>;
     /**
      * Constructor.
      *
      * @param {TypeMetadataResolver<any>} typeMetadataResolver Type metadata resolver.
      * @param {TypeFn<any>} typeFn Type function.
+     * @param {Map<Alias, TypeFn<any>>} typeFnMap Type function map.
      * @param {TypeOptionsBase<TType>} typeOptionsBase Type options used by default.
      * @param {TypeOptions<TType>} typeOptions Type options.
      * @param {TypeMetadata<any>} parentTypeMetadata Parent type metadata.
      */
-    constructor(typeMetadataResolver: TypeMetadataResolver<any>, typeFn: TypeFn<TType>, typeOptionsBase: TypeOptionsBase<TType>, typeOptions: TypeOptions<TType>, parentTypeMetadata?: TypeMetadata<any>);
+    constructor(typeMetadataResolver: TypeMetadataResolver<any>, typeFn: TypeFn<TType>, typeFnMap: Map<Alias, TypeFn<any>>, typeOptionsBase: TypeOptionsBase<TType>, typeOptions: TypeOptions<TType>, parentTypeMetadata?: TypeMetadata<any>);
     /**
      * Gets alias.
      *
@@ -106,12 +114,24 @@ export declare class TypeMetadata<TType> extends Metadata {
      * @returns {CustomData} Custom data.
      */
     get customData(): CustomData;
+    /**
+     * Gets serialized null value.
+     *
+     * @returns {any|undefined} Resolved serialized null value or undefined.
+     */
+    get serializedNullValue(): any | undefined;
     /**
      * Gets serialized default value.
      *
      * @returns {any|undefined} Resolved serialized default value or undefined.
      */
     get serializedDefaultValue(): any | undefined;
+    /**
+     * Gets deserialized null value.
+     *
+     * @returns {any|undefined} Resolved deserialized null value or undefined.
+     */
+    get deserializedNullValue(): any | undefined;
     /**
      * Gets deserialized default value.
      *
@@ -196,6 +216,12 @@ export declare class TypeMetadata<TType> extends Metadata {
      * @returns {Serializer<TType>} Serializer.
      */
     get serializer(): Serializer<TType>;
+    /**
+     * Gets indicator if null value should be preserved.
+     *
+     * @returns {boolean} True when null value should be preserved. False otherwise.
+     */
+    get preserveNull(): boolean;
     /**
      * Gets indicator if default value should be used.
      *
@@ -234,6 +260,68 @@ export declare class TypeMetadata<TType> extends Metadata {
      * @returns {TypeMetadata<TType>} Current instance of type metadata.
      */
     reflectInjectMetadata(): TypeMetadata<TType>;
+    /**
+     * Configures alias.
+     *
+     * @param {Alias} alias Alias.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureAlias(alias: Alias): TypeMetadata<TType>;
+    /**
+     * Releases alias.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    private releaseAlias;
+    /**
+     * Configures custom data.
+     *
+     * @param {CustomData} customData Custom data.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureCustomData(customData: CustomData): TypeMetadata<TType>;
+    /**
+     * Configures default value.
+     *
+     * @param {DefaultValue} defaultValue Default value.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureDefaultValue(defaultValue: DefaultValue): TypeMetadata<TType>;
+    /**
+     * Configures serialized default value.
+     *
+     * @param {DefaultValue} serializedDefaultValue Serialized default value.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureSerializedDefaultValue(serializedDefaultValue: DefaultValue): TypeMetadata<TType>;
+    /**
+     * Configures deserialized default value.
+     *
+     * @param {DefaultValue} deserializedDefaultValue Deserialized default value.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureDeserializedDefaultValue(deserializedDefaultValue: DefaultValue): TypeMetadata<TType>;
+    /**
+     * Configures discriminator.
+     *
+     * @param {Discriminator} discriminator Discriminator.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureDiscriminator(discriminator: Discriminator): TypeMetadata<TType>;
+    /**
+     * Configures discriminant.
+     *
+     * @param {Discriminant} discriminant Discriminant.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureDiscriminant(discriminant: Discriminant): TypeMetadata<TType>;
     /**
      * Provides discriminant.
      *
@@ -244,21 +332,101 @@ export declare class TypeMetadata<TType> extends Metadata {
      */
     private provideDiscriminant;
     /**
-     * Configures discriminant.
+     * Configures factory.
      *
-     * @param {Discriminant} discriminant Discriminant.
+     * @param {Factory} factory Factory.
      *
      * @returns {TypeMetadata<TType>} Current instance of type metadata.
      */
-    private configureDiscriminant;
+    configureFactory(factory: Factory): TypeMetadata<TType>;
     /**
-     * Configures custom data.
+     * Configures generic arguments.
      *
-     * @param {CustomData} customData Custom data.
+     * @param {Array<GenericArgument<any>>|undefined} genericArguments Generic arguments.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureGenericArguments(genericArguments: Array<GenericArgument<any>> | undefined): TypeMetadata<TType>;
+    /**
+     * Configures injectable.
+     *
+     * @param {boolean} injectable Injectable.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureInjectable(injectable: boolean): TypeMetadata<TType>;
+    /**
+     * Configures injector.
+     *
+     * @param {Injector} injector Injector.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureInjector(injector: Injector): TypeMetadata<TType>;
+    /**
+     * Configures log.
+     *
+     * @param {Log} log Log.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureLog(log: Log): TypeMetadata<TType>;
+    /**
+     * Configures naming convention.
+     *
+     * @param {NamingConvention} namingConvention Naming convention.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureNamingConvention(namingConvention: NamingConvention): TypeMetadata<TType>;
+    /**
+     * Configures preserve discriminator.
+     *
+     * @param {boolean} preserveDiscriminator Preserve discriminator.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configurePreserveDiscriminator(preserveDiscriminator: boolean): TypeMetadata<TType>;
+    /**
+     * Configures reference handler.
+     *
+     * @param {ReferenceHandler} referenceHandler Reference handler.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureReferenceHandler(referenceHandler: ReferenceHandler): TypeMetadata<TType>;
+    /**
+     * Configures serializer.
+     *
+     * @param {Serializer<TType>} serializer Serializer.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureSerializer(serializer: Serializer<TType>): TypeMetadata<TType>;
+    /**
+     * Configures preserve null.
+     *
+     * @param {boolean} preserveNull Preserve null.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configurePreserveNull(preserveNull: boolean): TypeMetadata<TType>;
+    /**
+     * Configures use default value.
+     *
+     * @param {boolean} useDefaultValue Use default value.
+     *
+     * @returns {TypeMetadata<TType>} Current instance of type metadata.
+     */
+    configureUseDefaultValue(useDefaultValue: boolean): TypeMetadata<TType>;
+    /**
+     * Configures use implicit convertion.
+     *
+     * @param {boolean} useImplicitConversion Use implicit convertion.
      *
      * @returns {TypeMetadata<TType>} Current instance of type metadata.
      */
-    private configureCustomData;
+    configureUseImplicitConversion(useImplicitConversion: boolean): TypeMetadata<TType>;
     /**
      * Configures certain property metadata.
      *

package/{core/type-options-base.d.ts → type-options-base.d.ts}

@@ -1,5 +1,4 @@
 import { CustomData } from './custom-data';
-import { DefaultValue } from './default-value';
 import { Discriminator } from './discriminator';
 import { Factory } from './factory';
 import { Injector } from './injector';
@@ -12,7 +11,7 @@ import { Serializer } from './serializer';
  *
  * @type {TypeOptionsBase<TType>}
  */
-export interface TypeOptionsBase<TType> {
+export declare type TypeOptionsBase<TType> = {
     /**
      * Custom developer data.
      *
@@ -25,22 +24,6 @@ export interface TypeOptionsBase<TType> {
      * @type {Discriminator}
      */
     discriminator: Discriminator;
-    /**
-     * Serialized default value for undefined ones.
-     *
-     * Used only when use default value option is true.
-     *
-     * @type {DefaultValue}
-     */
-    serializedDefaultValue?: DefaultValue;
-    /**
-     * Deserialized default value for undefined ones.
-     *
-     * Used only when use default value option is true.
-     *
-     * @type {DefaultValue}
-     */
-    deserializedDefaultValue?: DefaultValue;
     /**
      * Factory used to build instances of type.
      *
@@ -84,6 +67,13 @@ export interface TypeOptionsBase<TType> {
      * @type {Serializer<TType>}
      */
     serializer: Serializer<TType>;
+    /**
+     * If set to true then null values are preserved. Otherwise they will be
+     * treated as undefined.
+     *
+     * @type {boolean}
+     */
+    preserveNull: boolean;
     /**
      * Use default value assignment for undefined values?
      *
@@ -97,4 +87,4 @@ export interface TypeOptionsBase<TType> {
      * @type {boolean}
      */
     useImplicitConversion: boolean;
-}
+};

package/{core/type-options.d.ts → type-options.d.ts}

@@ -1,4 +1,5 @@
 import { Alias } from './alias';
+import { DefaultValue } from './default-value';
 import { Discriminant } from './discriminant';
 import { GenericArgument } from './generic-argument';
 import { InjectIndex } from './inject-index';
@@ -11,7 +12,7 @@ import { TypeOptionsBase } from './type-options-base';
  *
  * @type {TypeOptions<TType>}
  */
-export interface TypeOptions<TType> extends Partial<TypeOptionsBase<TType>> {
+export declare type TypeOptions<TType> = Partial<TypeOptionsBase<TType>> & {
     /**
      * Type alias.
      *
@@ -20,6 +21,31 @@ export interface TypeOptions<TType> extends Partial<TypeOptionsBase<TType>> {
      * @type {Alias}
      */
     alias?: Alias;
+    /**
+     * Default value for undefined ones.
+     *
+     * Used to set both serialized and deserialized default values and
+     * only when use default value option is true.
+     *
+     * @type {DefaultValue}
+     */
+    defaultValue?: DefaultValue;
+    /**
+     * Serialized default value for undefined ones.
+     *
+     * Used only when use default value option is true.
+     *
+     * @type {DefaultValue}
+     */
+    serializedDefaultValue?: DefaultValue;
+    /**
+     * Deserialized default value for undefined ones.
+     *
+     * Used only when use default value option is true.
+     *
+     * @type {DefaultValue}
+     */
+    deserializedDefaultValue?: DefaultValue;
     /**
      * Discriminant.
      *
@@ -50,4 +76,4 @@ export interface TypeOptions<TType> extends Partial<TypeOptionsBase<TType>> {
      * @type {Map<PropertyName, PropertyOptions<any>>}
      */
     propertyOptionsMap?: Map<PropertyName, PropertyOptions<any>>;
-}
+};

package/type.d.ts

@@ -1,4 +1,4 @@
-import { TypeOptions } from './core/type-options';
+import { TypeOptions } from './type-options';
 /**
  * Type decorator.
  *

package/core/alias.d.ts

@@ -1,6 +0,0 @@
-/**
- * Type to explicitly define an alias within a source code.
- *
- * @type {Alias}
- */
-export declare type Alias = string;

package/core/custom-data.d.ts

@@ -1,6 +0,0 @@
-/**
- * Custom data which can be defined by developer.
- *
- * @type {CustomData}
- */
-export declare type CustomData = Record<string, any>;

package/core/default-value.d.ts

@@ -1,7 +0,0 @@
-import { DefaultValueResolver } from './default-value-resolver';
-/**
- * Default value which can be defined by developer.
- *
- * @type {DefaultValue}
- */
-export declare type DefaultValue = any | DefaultValueResolver;

package/core/discriminant.d.ts

@@ -1,8 +0,0 @@
-import { TypeName } from './type-name';
-/**
- * Discriminant intends to describe a unique key for a polymorphic type which will be
- * used during serialization and deserialization. Can be a type name, any string or number.
- *
- * @type {Discriminant}
- */
-export declare type Discriminant = TypeName | string | number;

package/core/discriminator.d.ts

@@ -1,6 +0,0 @@
-/**
- * Discriminator intends to indicate the property used to identify the type of an object.
- *
- * @type {Discriminator}
- */
-export declare type Discriminator = string;

package/core/factory.d.ts

@@ -1,18 +0,0 @@
-import { Injector } from './injector';
-import { TypeContext } from './type-context';
-/**
- * Factory for building types.
- *
- * @type {Factory}
- */
-export interface Factory {
-    /**
-     * Builds type described by provided type context.
-     *
-     * @param {TypeContext<TType>} typeContext Type context.
-     * @param {Injector} injector Injector.
-     *
-     * @returns {TType} Type instance described by provided type context.
-     */
-    build<TType>(typeContext: TypeContext<TType>, injector: Injector): TType;
-}