@tsed/json-mapper 7.83.3 → 8.0.0-alpha.10

package/lib/types-esm/components/SymbolMapper.d.ts

@@ -1,11 +0,0 @@
-import { JsonMapperMethods } from "../interfaces/JsonMapperMethods.js";
-/**
- * Mapper for the `Symbol` type.
- *
- * @jsonmapper
- * @component
- */
-export declare class SymbolMapper implements JsonMapperMethods {
-    deserialize(data: string): symbol;
-    serialize(object: Symbol): any;
-}

package/lib/types-esm/decorators/afterDeserialize.d.ts

@@ -1,33 +0,0 @@
-import { JsonHookContext } from "@tsed/schema";
-export interface AfterDeserializeCallback {
-    (value: any, ctx: JsonHookContext): any;
-}
-/**
- * Call the function after JsonMapper.
- *
- * ## Example
- *
- * ```typescript
- * @AfterDeserialize((data: Model) => { // After deserialize get the instance class
- *    if (data.prop1 === 'VALUE' && data.prop2 !== 'VALUE2') {
- *      throw BadRequest('MyMessage'); // or throw a ValidationError
- *    } else {
- *      data.prop2 = 'VALUE2';
- *      return data;
- *    }
- * })
- * class Model {
- *    @Property()
- *    prop1: string;
- *    @Property()
- *    prop2: string;
- * }
- * ```
- *
- * @returns {Function}
- * @decorator
- * @schema
- * @property
- * @param cb
- */
-export declare function AfterDeserialize(cb: AfterDeserializeCallback): ClassDecorator;

package/lib/types-esm/decorators/beforeDeserialize.d.ts

@@ -1,33 +0,0 @@
-import { JsonHookContext } from "@tsed/schema";
-export interface BeforeDeserializeCallback {
-    (value: any, ctx: JsonHookContext): any;
-}
-/**
- * Call the function before JsonMapper.
- *
- * ## Example
- *
- * ```typescript
- * @BeforeDeserialize((data: Record<string, unknown>) => { // Before deserialize get the data
- *    if (data.prop1 === 'VALUE' && data.prop2 !== 'VALUE2') {
- *      throw BadRequest('MyMessage'); // or throw a ValidationError
- *    } else {
- *      data.prop2 = 'VALUE2';
- *      return data;
- *    }
- * })
- * class Model {
- *    @Property()
- *    prop1: string;
- *    @Property()
- *    prop2: string;
- * }
- * ```
- *
- * @returns {Function}
- * @decorator
- * @schema
- * @property
- * @param cb
- */
-export declare function BeforeDeserialize(cb: BeforeDeserializeCallback): ClassDecorator;

package/lib/types-esm/decorators/jsonMapper.d.ts

@@ -1,7 +0,0 @@
-import { Type } from "@tsed/core";
-/**
- * Register a new JsonMapper Type
- * @param types
- * @constructor
- */
-export declare function JsonMapper(...types: (any | Type)[]): ClassDecorator;

package/lib/types-esm/decorators/onDeserialize.d.ts

@@ -1,23 +0,0 @@
-import { JsonHookContext } from "@tsed/schema";
-export interface OnDeserializeCallback {
-    (value: any, ctx: JsonHookContext): any;
-}
-/**
- * Call the function before property deserialization.
- *
- * ## Example
- *
- * ```typescript
- * class Model {
- *    @OnDeserialize(v => v + 1)
- *    property: string;
- * }
- * ```
- *
- * @returns {Function}
- * @decorator
- * @schema
- * @property
- * @param cb
- */
-export declare function OnDeserialize(cb: OnDeserializeCallback): PropertyDecorator;

package/lib/types-esm/decorators/onSerialize.d.ts

@@ -1,23 +0,0 @@
-import { JsonHookContext } from "@tsed/schema";
-export interface OnSerializeCallback {
-    (value: any, ctx: JsonHookContext): any;
-}
-/**
- * Call the function before property serialization.
- *
- * ## Example
- *
- * ```typescript
- * class Model {
- *    @OnSerialize(v => v + 1)
- *    property: string;
- * }
- * ```
- *
- * @returns {Function}
- * @decorator
- * @schema
- * @property
- * @param cb
- */
-export declare function OnSerialize(cb: OnSerializeCallback): PropertyDecorator;

package/lib/types-esm/domain/JsonDeserializer.d.ts

@@ -1,33 +0,0 @@
-import { Type } from "@tsed/core";
-import { JsonDeserializerOptions } from "./JsonDeserializerOptions.js";
-import { CachedJsonMapper, JsonMapperCompiler } from "./JsonMapperCompiler.js";
-export declare class JsonDeserializer extends JsonMapperCompiler<JsonDeserializerOptions> {
-    /**
-     * Cached classes by his id
-     * @protected
-     */
-    protected constructors: Record<string, Type<any>>;
-    constructor();
-    map<Model = any>(input: any, options?: JsonDeserializerOptions): Model;
-    compile(model: Type<any>, groups: false | string[]): CachedJsonMapper<JsonDeserializerOptions>;
-    eval(mapper: string, { id, groupsId, model }: {
-        id: string;
-        model: Type<any>;
-        groupsId: string;
-    }): CachedJsonMapper<JsonDeserializerOptions>;
-    protected newInstanceOf(id: string, obj: any, options: any): any;
-    protected createMapper(model: Type<any>, id: string, groups: false | string[]): string;
-    protected alterValue(schemaId: string, value: any, options: JsonDeserializerOptions): any;
-    private mapDiscriminator;
-    private mapProperty;
-    private getPropertyFiller;
-    private mapOptions;
-    private mapAdditionalProperties;
-    private mapObject;
-    private mapSet;
-    private mapArray;
-    private mapMap;
-    private mapItem;
-    private alterBeforeDeserialize;
-    private alterAfterDeserialize;
-}

package/lib/types-esm/domain/JsonDeserializerOptions.d.ts

@@ -1,28 +0,0 @@
-import { MetadataTypes, Type } from "@tsed/core";
-import { JsonEntityStore } from "@tsed/schema";
-import { JsonMapperMethods } from "../interfaces/JsonMapperMethods.js";
-import { JsonMapperGlobalOptions } from "./JsonMapperGlobalOptions.js";
-export interface JsonDeserializerOptions<T = any, C = any> extends MetadataTypes<T, C>, JsonMapperGlobalOptions {
-    /**
-     * Types used to map complex types (Symbol, Array, Set, Map)
-     */
-    types?: Map<Type | Symbol | string, JsonMapperMethods>;
-    /**
-     * useAlias mapping
-     */
-    useAlias?: boolean;
-    /**
-     * Use the store which have all metadata to deserialize correctly the model. This
-     * property is useful when you deal with metadata parameters.
-     */
-    store?: JsonEntityStore;
-    /**
-     *
-     */
-    groups?: string[] | false;
-    /**
-     * Add types to deserialize a module using generics feature.
-     */
-    generics?: Type[][];
-    [key: string]: any;
-}

package/lib/types-esm/domain/JsonMapperCompiler.d.ts

@@ -1,60 +0,0 @@
-import { Type } from "@tsed/core";
-import { JsonSchema } from "@tsed/schema";
-export type JsonMapperCallback<Options> = (input: any, options?: Options) => any;
-export type CachedJsonMapper<Options> = {
-    id: string;
-    fn: JsonMapperCallback<Options>;
-};
-export type CachedGroupsJsonMapper<Options> = Map<string, CachedJsonMapper<Options>>;
-export declare abstract class JsonMapperCompiler<Options extends Record<string, any> = any> {
-    /**
-     * Cached mappers metadata
-     * @protected
-     */
-    protected cache: Map<string | Type<any>, CachedGroupsJsonMapper<Options>>;
-    /**
-     * Cached executable mappers by his id
-     * @protected
-     */
-    protected mappers: Record<string, JsonMapperCallback<Options>>;
-    /**
-     * Cached schemas
-     * @protected
-     */
-    protected schemes: Record<string, any>;
-    /**
-     * Cached classes by his id
-     * @protected
-     */
-    protected constructors: Record<string, Type<any>>;
-    /**
-     * Global variables available in the mapper
-     * @protected
-     */
-    protected globals: Record<string, any>;
-    constructor();
-    addTypeMapper(model: Type<any> | string, fn: any): this;
-    removeTypeMapper(model: Type<any> | string): void;
-    addGlobal(key: string, value: any): this;
-    eval(mapper: string, { id, groupsId, model }: {
-        id: string;
-        model: Type<any> | string;
-        groupsId: string;
-    }): CachedJsonMapper<Options>;
-    createContext(options: Options): Options & {
-        cache: Map<string | Type<any>, CachedGroupsJsonMapper<Options>>;
-    };
-    compile(model: Type<any> | string, groups: false | string[], opts?: {
-        mapper?: any;
-    }): CachedJsonMapper<Options>;
-    protected execMapper(id: string, value: any, options: Options): any;
-    protected abstract map(input: any, options: Options): any;
-    protected abstract alterValue(schemaId: string, value: any, options: Options): any;
-    protected abstract createMapper(model: Type<any>, id: string, groups: false | string[]): string;
-    protected getType(model: Type<any>): Type<any> | MapConstructor | ObjectConstructor | ArrayConstructor | SetConstructor;
-    protected alterIgnore(id: string, options: Options): any;
-    protected alterGroups(schema: JsonSchema, groups: false | string[]): boolean;
-    protected getGroupsId(groups: false | string[]): string;
-    protected getId(model: Type<any> | string, groupsId: string): string;
-    protected getSchemaId(id: string, propertyKey: string): string;
-}

package/lib/types-esm/domain/JsonMapperGlobalOptions.d.ts

@@ -1,14 +0,0 @@
-export interface JsonMapperGlobalOptions {
-    /**
-     * JsonMapper additional property policy. (see [JsonMapper](/docs/json-mapper.md))
-     */
-    additionalProperties?: boolean;
-    /**
-     * Disable the unsecure constructor injection when the deserialize function is used (by default: false)
-     */
-    disableUnsecureConstructor?: boolean;
-    /**
-     * Enable strict Groups configuration when the `options.groups` is undefined. (by default: false)
-     */
-    strictGroups?: boolean;
-}

package/lib/types-esm/domain/JsonMapperSettings.d.ts

@@ -1,2 +0,0 @@
-import type { JsonMapperGlobalOptions } from "./JsonMapperGlobalOptions.js";
-export declare const JsonMapperSettings: JsonMapperGlobalOptions;

package/lib/types-esm/domain/JsonMapperTypesContainer.d.ts

@@ -1,10 +0,0 @@
-import { Type } from "@tsed/core";
-import { JsonMapperMethods } from "../interfaces/JsonMapperMethods.js";
-/**
- * @ignore
- */
-export declare function registerJsonTypeMapper(type: Type<any> | Symbol | string, token: Type<JsonMapperMethods>): void;
-/**
- * @ignore
- */
-export declare function getJsonMapperTypes(): Map<Type<any> | Symbol | string, JsonMapperMethods>;

package/lib/types-esm/domain/JsonSerializer.d.ts

@@ -1,22 +0,0 @@
-import { Type } from "@tsed/core";
-import { JsonMapperCompiler } from "./JsonMapperCompiler.js";
-import { JsonSerializerOptions } from "./JsonSerializerOptions.js";
-export declare class JsonSerializer extends JsonMapperCompiler<JsonSerializerOptions> {
-    constructor();
-    map(input: any, options?: JsonSerializerOptions): any;
-    protected alterValue(schemaId: string, value: any, options: JsonSerializerOptions): any;
-    protected createMapper(model: Type<any>, id: string, groups: false | string[]): string;
-    private mapOptions;
-    private mapProperty;
-    private getPropertyFiller;
-    private createDiscriminatorMapper;
-    private mapPrecondition;
-    private mapDiscriminatorKeyValue;
-    private mapAdditionalProperties;
-    private mapObject;
-    private mapSet;
-    private mapArray;
-    private mapMap;
-    private mapItem;
-    private mapJSON;
-}

package/lib/types-esm/domain/JsonSerializerOptions.d.ts

@@ -1,14 +0,0 @@
-import { MetadataTypes, Type } from "@tsed/core";
-import { JsonMapperMethods } from "../interfaces/JsonMapperMethods.js";
-import { JsonMapperGlobalOptions } from "./JsonMapperGlobalOptions.js";
-export interface JsonSerializerOptions<T = any, C = any> extends MetadataTypes<T, C>, Pick<JsonMapperGlobalOptions, "strictGroups"> {
-    /**
-     * Types used to map complex types (Symbol, Number, String, etc...)
-     */
-    types?: Map<Type<any> | Symbol | string, JsonMapperMethods>;
-    /**
-     * useAlias mapping
-     */
-    useAlias?: boolean;
-    [key: string]: any;
-}

package/lib/types-esm/domain/Writer.d.ts

@@ -1,43 +0,0 @@
-export declare class Writer {
-    static object: {
-        assign(...args: string[]): string;
-    };
-    protected _root?: Writer;
-    protected body: (string | Writer)[];
-    private _indent;
-    constructor(root?: Writer);
-    static indent(lines: string[]): string[];
-    static mapper(mapperId: string, key: string, options: string): string;
-    static mapperFrom(key: string, options: string): string;
-    static options(...args: string[]): string;
-    add(...lines: (undefined | string | Writer)[]): this;
-    arrow(...args: string[]): Writer;
-    build(): string[];
-    callMapper(id: string, key: string, ...options: string[]): this;
-    returnCallMapper(id: string, key: string, ...options: string[]): Writer;
-    const(name: string, line: string): this;
-    each(iterable: string, args?: string[]): Writer;
-    if(condition: string): IfWriter;
-    switch(input: string): SwitchWriter;
-    indent(indent: boolean): this;
-    new(indent?: boolean): Writer;
-    return(line: string): Writer;
-    root(): Writer;
-    set(left: string, right: string): this;
-    toString(): string;
-}
-declare class IfWriter extends Writer {
-    protected condition: string;
-    protected elseWriter?: Writer;
-    constructor(condition: string, root: Writer);
-    else(): Writer;
-    build(): string[];
-}
-declare class SwitchWriter extends Writer {
-    #private;
-    private input;
-    constructor(input: string);
-    case(condition: string): Writer;
-    build(): string[];
-}
-export {};

package/lib/types-esm/hooks/alterAfterDeserialize.d.ts

@@ -1,4 +0,0 @@
-import { Hooks } from "@tsed/core";
-export declare function alterAfterDeserialize(data: any, schema: {
-    $hooks: Hooks;
-}, options: any): any;

package/lib/types-esm/hooks/alterBeforeDeserialize.d.ts

@@ -1,4 +0,0 @@
-import { Hooks } from "@tsed/core";
-export declare function alterBeforeDeserialize(data: any, schema: {
-    $hooks: Hooks;
-}, options: any): any;

package/lib/types-esm/hooks/alterOnDeserialize.d.ts

@@ -1,2 +0,0 @@
-import { JsonHookContext, JsonSchema } from "@tsed/schema";
-export declare function alterOnDeserialize(schema: JsonSchema, value: any, options: JsonHookContext): any;

package/lib/types-esm/hooks/alterOnSerialize.d.ts

@@ -1,2 +0,0 @@
-import { JsonHookContext, JsonSchema } from "@tsed/schema";
-export declare function alterOnSerialize(schema: JsonSchema, value: any, options: JsonHookContext): any;

package/lib/types-esm/index.d.ts

@@ -1,28 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./components/DateMapper.js";
-export * from "./components/PrimitiveMapper.js";
-export * from "./components/SymbolMapper.js";
-export * from "./decorators/afterDeserialize.js";
-export * from "./decorators/beforeDeserialize.js";
-export * from "./decorators/jsonMapper.js";
-export * from "./decorators/onDeserialize.js";
-export * from "./decorators/onSerialize.js";
-export * from "./domain/JsonDeserializer.js";
-export * from "./domain/JsonDeserializerOptions.js";
-export * from "./domain/JsonMapperCompiler.js";
-export * from "./domain/JsonMapperGlobalOptions.js";
-export * from "./domain/JsonMapperSettings.js";
-export * from "./domain/JsonMapperTypesContainer.js";
-export * from "./domain/JsonSerializer.js";
-export * from "./domain/JsonSerializerOptions.js";
-export * from "./domain/Writer.js";
-export * from "./hooks/alterAfterDeserialize.js";
-export * from "./hooks/alterBeforeDeserialize.js";
-export * from "./hooks/alterOnDeserialize.js";
-export * from "./hooks/alterOnSerialize.js";
-export * from "./interfaces/JsonMapperMethods.js";
-export * from "./utils/deserialize.js";
-export * from "./utils/getObjectProperties.js";
-export * from "./utils/serialize.js";

package/lib/types-esm/interfaces/JsonMapperMethods.d.ts

@@ -1,28 +0,0 @@
-import { Type } from "@tsed/core";
-export interface JsonMapperCtx<T = any, C = any> {
-    collectionType: Type<C> | undefined;
-    type: Type<T> | T;
-    next: JsonMapperNext;
-    options: {
-        format?: string;
-    };
-}
-export interface JsonMapperNext {
-    (obj: any): any;
-}
-export interface JsonMapperMethods {
-    /**
-     *
-     * @param obj
-     * @param {JsonMapperNext} ctx
-     * @returns {any}
-     */
-    deserialize<T = any, C = any>(obj: any, ctx: JsonMapperCtx<T, C>): any;
-    /**
-     *
-     * @param obj
-     * @param ctx
-     * @returns {any}
-     */
-    serialize(obj: any, ctx: JsonMapperCtx<any>): any;
-}

package/lib/types-esm/utils/deserialize.d.ts

@@ -1,5 +0,0 @@
-import "../components/DateMapper";
-import "../components/PrimitiveMapper";
-import "../components/SymbolMapper";
-import { JsonDeserializerOptions } from "../domain/JsonDeserializerOptions.js";
-export declare function deserialize<Model = any>(input: any, options?: JsonDeserializerOptions): Model;

package/lib/types-esm/utils/getObjectProperties.d.ts

@@ -1 +0,0 @@
-export declare function getObjectProperties(obj: any): [string, any][];

package/lib/types-esm/utils/serialize.d.ts

@@ -1,5 +0,0 @@
-import "../components/DateMapper";
-import "../components/PrimitiveMapper";
-import "../components/SymbolMapper";
-import { JsonSerializerOptions } from "../domain/JsonSerializerOptions.js";
-export declare function serialize(input: any, options?: JsonSerializerOptions): any;