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

package/{core/serializer-context.d.ts → serializer-context.d.ts}

@@ -13,8 +13,8 @@ import { ReferenceCallback } from './reference-callback';
 import { ReferenceHandler } from './reference-handler';
 import { ReferenceKey } from './reference-key';
 import { ReferenceValue } from './reference-value';
-import { ReferenceValueInitializer } from './reference-value-initializer';
-import { ReferenceValueResolver } from './reference-value-resolver';
+import { ReferenceValueGetter } from './reference-value-getter';
+import { ReferenceValueSetter } from './reference-value-setter';
 import { Serializer } from './serializer';
 import { SerializerContextOptions } from './serializer-context-options';
 import { TypeFn } from './type-fn';
@@ -26,42 +26,102 @@ import { TypeMetadata } from './type-metadata';
  * @type {SerializerContext<TType>}
  */
 export declare class SerializerContext<TType> extends Metadata {
+    /**
+     * Serializer context root.
+     *
+     * This is a value passed to the root serializer.
+     *
+     * @type {any}
+     */
+    readonly $: any;
+    /**
+     * Reference map.
+     *
+     * Used to preserve object references.
+     *
+     * @type {WeakMap<ReferenceKey, ReferenceValue>}
+     */
+    readonly referenceMap: WeakMap<ReferenceKey, ReferenceValue>;
+    /**
+     * Reference callback map.
+     *
+     * Used to assign object references in a later time due to circular dependency.
+     *
+     * @type {WeakMap<ReferenceKey, Array<ReferenceCallback>>}
+     */
+    readonly referenceCallbackMap: WeakMap<ReferenceKey, Array<ReferenceCallback>>;
     /**
      * Serializer context options.
      *
      * @type {SerializerContext<TType>}
      */
     readonly serializerContextOptions: SerializerContextOptions<TType>;
+    /**
+     * Parent serializer context.
+     *
+     * Present when any serializer defines child context.
+     *
+     * @type {SerializerContext<any>}
+     */
+    readonly parentSerializerContext?: SerializerContext<any>;
     /**
      * Constructor.
      *
+     * @param {any} $ Serializer context root.
+     * @param {WeakMap<ReferenceKey, ReferenceValue>} referenceMap Reference map.
+     * @param {WeakMap<ReferenceKey, Array<ReferenceCallback>>} referenceCallbackMap Reference callback map.
      * @param {SerializerContextOptions<TType>} serializerContextOptions Serializer context options.
+     * @param {SerializerContext<any>} parentSerializerContext Parent serializer context.
+     */
+    constructor($: any, referenceMap: WeakMap<ReferenceKey, ReferenceValue>, referenceCallbackMap: WeakMap<ReferenceKey, Array<ReferenceCallback>>, serializerContextOptions: SerializerContextOptions<TType>, parentSerializerContext?: SerializerContext<any>);
+    /**
+     * Gets json path key.
+     *
+     * @returns {string|number} Json path key.
      */
-    constructor(serializerContextOptions: SerializerContextOptions<TType>);
+    get jsonPathKey(): any;
     /**
-     * Gets serializer context root.
+     * Gets reference value setter.
      *
-     * @returns {any} Serializer context root.
+     * @returns {ReferenceValueSetter|undefined} Reference value setter or undefined if not present.
      */
-    get $(): any;
+    get referenceValueSetter(): ReferenceValueSetter | undefined;
     /**
      * Gets custom data.
      *
      * @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.
      *
      * @returns {any|undefined} Resolved deserialized default value or undefined.
      */
     get deserializedDefaultValue(): any | undefined;
+    /**
+     * Gets json path from serializer context root.
+     *
+     * @returns {string} Json path.
+     */
+    get jsonPath(): string;
     /**
      * Gets discriminant.
      *
@@ -122,12 +182,6 @@ export declare class SerializerContext<TType> extends Metadata {
      * @returns {NamingConvention|undefined} Naming convention or undefined.
      */
     get namingConvention(): NamingConvention | undefined;
-    /**
-     * Gets JSONPath from serializer context root.
-     *
-     * @returns {string} Path.
-     */
-    get path(): string;
     /**
      * Gets indicator if context is polymorphic.
      *
@@ -152,18 +206,6 @@ export declare class SerializerContext<TType> extends Metadata {
      * @returns {ReferenceHandler} Reference handler.
      */
     get referenceHandler(): ReferenceHandler;
-    /**
-     * Gets reference callback map.
-     *
-     * @returns {WeakMap<ReferenceKey, Array<ReferenceCallback>>} Reference callback map.
-     */
-    get referenceCallbackMap(): WeakMap<ReferenceKey, Array<ReferenceCallback>>;
-    /**
-     * Gets reference map.
-     *
-     * @returns {WeakMap<ReferenceKey, ReferenceValue>} Reference map.
-     */
-    get referenceMap(): WeakMap<ReferenceKey, ReferenceValue>;
     /**
      * Gets serializer.
      *
@@ -176,6 +218,12 @@ export declare class SerializerContext<TType> extends Metadata {
      * @returns {TypeMetadata<TType>} Type metadata.
      */
     get typeMetadata(): TypeMetadata<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.
      *
@@ -210,26 +258,36 @@ export declare class SerializerContext<TType> extends Metadata {
      * May be called during serialization to define reference.
      *
      * @param {ReferenceKey} referenceKey Reference key.
-     * @param {ReferenceValueInitializer} referenceValueInitializer Reference value initializer.
+     * @param {ReferenceValueGetter} referenceValueGetter Reference value getter.
      *
-     * @returns {ReferenceValue|ReferenceValueResolver} Reference value or reference value resolver when circular dependency is detected.
+     * @returns {ReferenceValue} Reference value.
      */
-    defineReference(referenceKey: ReferenceKey, referenceValueInitializer: ReferenceValueInitializer): ReferenceValue | ReferenceValueResolver;
+    defineReference(referenceKey: ReferenceKey, referenceValueGetter: ReferenceValueGetter): ReferenceValue;
     /**
      * Restores reference.
      *
      * May be called during deserialization to restore reference.
      *
      * @param {ReferenceKey} referenceKey Reference key.
-     * @param {ReferenceValueInitializer} referenceValueInitializer Reference value initializer.
+     * @param {ReferenceValueGetter} referenceValueGetter Reference value getter.
+     *
+     * @returns {ReferenceValue} Reference value.
+     */
+    restoreReference(referenceKey: ReferenceKey, referenceValueGetter: ReferenceValueGetter): ReferenceValue;
+    /**
+     * Registers callback for provided reference key.
+     *
+     * May be called by reference handlers to register a callback resolver for a circular reference.
+     *
+     * @param {ReferenceKey} referenceKey Reference key.
      *
-     * @returns {ReferenceValue|ReferenceValueResolver} Reference value or reference value resolver when circular dependency is detected.
+     * @returns {void}
      */
-    restoreReference(referenceKey: ReferenceKey, referenceValueInitializer: ReferenceValueInitializer): ReferenceValue | ReferenceValueResolver;
+    registerReferenceCallback(referenceKey: ReferenceKey): void;
     /**
      * Pushes callback for provided reference key.
      *
-     * Called by serializers during handling of circular references.
+     * Called by reference handlers during handling of circular references.
      *
      * @param {ReferenceKey} referenceKey Reference key.
      * @param {ReferenceCallback} referenceCallback Reference callback.
@@ -240,19 +298,27 @@ export declare class SerializerContext<TType> extends Metadata {
     /**
      * Resolves callbacks for provided reference key.
      *
-     * Called by reference handlers when circular references can be resolved.
+     * May be called by reference handlers when circular references can be resolved.
      *
      * @param {ReferenceKey} referenceKey Reference key.
      *
      * @returns {void}
      */
     resolveReferenceCallbacks(referenceKey: ReferenceKey): void;
+    /**
+     * Defines serializer context options based on partial.
+     *
+     * @param {Partial<SerializerContextOptions<any>>} serializerContextOptions Partial serializer context options.
+     *
+     * @returns {SerializerContextOptions<any>} Complete serializer context options.
+     */
+    private defineSerializerContextOptions;
     /**
      * Defines child serializer context.
      *
-     * Called by serializers on context change.
+     * Called by serializers on drill down.
      *
-     * @param {Partial<SerializerContextOptions<any>>} childSerializerContextOptions Partial of serializer context options to override.
+     * @param {Partial<SerializerContextOptions<any>>} childSerializerContextOptions Child serializer context options.
      *
      * @returns {SerializerContext<any>} Child serializer context.
      */
@@ -267,6 +333,16 @@ export declare class SerializerContext<TType> extends Metadata {
      * @returns {SerializerContext<any>} Generic serializer context.
      */
     defineGenericSerializerContext(genericIndex: number): SerializerContext<any>;
+    /**
+     * Defines polymorphic serializer context.
+     *
+     * Called by serializers which work with polymorphic types.
+     *
+     * @param {TypeFn<any>|Record<string, any>} x Type function or record.
+     *
+     * @returns {SerializerContext<any>} Polymorphic serializer context.
+     */
+    definePolymorphicSerializerContext(x: TypeFn<any> | Record<string, any>): SerializerContext<any>;
     /**
      * Defines polymorphic serializer context by type function.
      *
@@ -283,14 +359,4 @@ export declare class SerializerContext<TType> extends Metadata {
      * @returns {SerializerContext<any>} Polymorphic serializer context.
      */
     private definePolymorphicSerializerContextByDiscriminant;
-    /**
-     * Defines polymorphic serializer context.
-     *
-     * Called by serializers which work with polymorphic types.
-     *
-     * @param {TypeFn<any>|Record<string, any>} x Type function or record.
-     *
-     * @returns {SerializerContext<any>} Polymorphic serializer context.
-     */
-    definePolymorphicSerializerContext(x: TypeFn<any> | Record<string, any>): SerializerContext<any>;
 }

package/serializer.d.ts

@@ -1,11 +1,27 @@
-import { Serializer } from './core/serializer';
+import { SerializerContext } from './serializer-context';
+import { TypeLike } from './type-like';
 /**
- * Serializer decorator.
+ * Serializer.
  *
- * Used to define custom serializer for type and property.
- *
- * @param {Serializer<TType>} serializer Serializer.
- *
- * @returns {ClassDecorator&PropertyDecorator} Class and property decorator.
+ * @type {Serializer<TType>}
  */
-export declare function Serializer<TType>(serializer: Serializer<TType>): ClassDecorator & PropertyDecorator;
+export interface Serializer<TType> {
+    /**
+     * Serializes provided value.
+     *
+     * @param {TypeLike<TType>} x Some value.
+     * @param {SerializerContext<TType>} serializerContext Serializer context.
+     *
+     * @returns {TypeLike<any>} Serialized value.
+     */
+    serialize(x: TypeLike<TType>, serializerContext: SerializerContext<TType>): TypeLike<any>;
+    /**
+     * Deserializes provided value.
+     *
+     * @param {TypeLike<any>} x Some value.
+     * @param {SerializerContext<TType>} serializerContext Serializer context.
+     *
+     * @returns {TypeLike<TType>} Deserialized value.
+     */
+    deserialize(x: TypeLike<any>, serializerContext: SerializerContext<TType>): TypeLike<TType>;
+}

package/serializers/array-buffer-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';
 /**
  * Array buffer serializer.
  *

package/serializers/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';
 /**
  * Array serializer.
  *

package/serializers/boolean-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';
 /**
  * Boolean serializer.
  *

package/serializers/data-view-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';
 /**
  * Data view serializer.
  *

package/serializers/date-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';
 /**
  * Date serializer.
  *

package/serializers/float-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';
 /**
  * Float 32 array serializer.
  *

package/serializers/float-64-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';
 /**
  * Float 64 array serializer.
  *

package/serializers/int-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';
 /**
  * Int 16 array serializer.
  *

package/serializers/int-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';
 /**
  * Int 32 array serializer.
  *

package/serializers/int-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';
 /**
  * Int 8 array serializer.
  *

package/serializers/map-serializer.d.ts

@@ -1,12 +1,24 @@
-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';
 /**
  * Map serializer.
  *
  * @type {MapSerializer}
  */
 export declare class MapSerializer implements Serializer<Map<any, any>> {
+    /**
+     * Map serializer key.
+     *
+     * @type {string}
+     */
+    static readonly key: string;
+    /**
+     * Map serializer value.
+     *
+     * @type {string}
+     */
+    static readonly value: string;
     /**
      * Serializes provided value.
      *

package/serializers/number-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';
 /**
  * Number serializer.
  *

package/serializers/set-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';
 /**
  * Set serializer.
  *

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;