@tsed/json-mapper 6.95.9 → 6.96.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/json-mapper",
-  "version": "6.95.9",
+  "version": "6.96.2",
   "description": "Json mapper module for Ts.ED Framework",
   "private": false,
   "source": "./src/index.ts",
@@ -33,14 +33,14 @@
     "tslib": "2.2.0"
   },
   "devDependencies": {
-    "@tsed/core": "6.95.9",
-    "@tsed/exceptions": "6.95.9",
-    "@tsed/schema": "6.95.9"
+    "@tsed/core": "6.96.2",
+    "@tsed/exceptions": "6.96.2",
+    "@tsed/schema": "6.96.2"
   },
   "peerDependencies": {
-    "@tsed/core": "^6.95.9",
-    "@tsed/exceptions": "^6.95.9",
-    "@tsed/schema": "^6.95.9"
+    "@tsed/core": "^6.96.2",
+    "@tsed/exceptions": "^6.96.2",
+    "@tsed/schema": "^6.96.2"
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {

package/lib/cjs/components/ArrayMapper.d.ts

@@ -1,10 +0,0 @@
-import { JsonMapperCtx, JsonMapperMethods } from "../interfaces/JsonMapperMethods";
-/**
- * Mapper for `Array` type.
- * @jsonmapper
- * @component
- */
-export declare class ArrayMapper implements JsonMapperMethods {
-    deserialize<T = any>(data: any, options: JsonMapperCtx): T[];
-    serialize(data: any[], options: JsonMapperCtx): any;
-}

package/lib/cjs/components/DateMapper.d.ts

@@ -1,11 +0,0 @@
-import { JsonMapperMethods } from "../interfaces/JsonMapperMethods";
-/**
- * Mapper for `Date` type.
- * @jsonmapper
- * @component
- */
-export declare class DateMapper implements JsonMapperMethods {
-    deserialize(data: string | number): Date;
-    deserialize(data: boolean | null | undefined): boolean | null | undefined;
-    serialize(object: Date): any;
-}

package/lib/cjs/components/MapMapper.d.ts

@@ -1,12 +0,0 @@
-import { JsonMapperCtx, JsonMapperMethods } from "../interfaces/JsonMapperMethods";
-/**
- * Mapper for `Map` type.
- * @jsonmapper
- * @component
- */
-export declare class MapMapper implements JsonMapperMethods {
-    deserialize<T = any, C = Map<string, T>>(data: {
-        [key: string]: any;
-    }, ctx: JsonMapperCtx<T, C>): Map<string, T>;
-    serialize<T>(data: Map<string, T>, ctx: JsonMapperCtx): any;
-}

package/lib/cjs/components/PrimitiveMapper.d.ts

@@ -1,10 +0,0 @@
-import { JsonMapperCtx, JsonMapperMethods } from "../interfaces/JsonMapperMethods";
-/**
- * Mapper for the `String`, `Number` and `Boolean` types.
- * @jsonmapper
- * @component
- */
-export declare class PrimitiveMapper implements JsonMapperMethods {
-    deserialize<T>(data: any, ctx: JsonMapperCtx): string | number | boolean | void | null;
-    serialize(object: string | number | boolean): string | number | boolean;
-}

package/lib/cjs/components/SetMapper.d.ts

@@ -1,10 +0,0 @@
-import { JsonMapperCtx, JsonMapperMethods } from "../interfaces/JsonMapperMethods";
-/**
- * Mapper for the `Set` Type.
- * @jsonmapper
- * @component
- */
-export declare class SetMapper implements JsonMapperMethods {
-    deserialize<T>(data: any, ctx: JsonMapperCtx): Set<T>;
-    serialize<T>(data: Set<T>, ctx: JsonMapperCtx): any[];
-}

package/lib/cjs/components/SymbolMapper.d.ts

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

package/lib/cjs/components/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./ArrayMapper";
-export * from "./DateMapper";
-export * from "./MapMapper";
-export * from "./PrimitiveMapper";
-export * from "./SetMapper";
-export * from "./SymbolMapper";

package/lib/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/domain/JsonMapperContext.d.ts

@@ -1,20 +0,0 @@
-import { Type } from "@tsed/core";
-import { JsonMapperCtx } from "../interfaces/JsonMapperMethods";
-/**
- * @ignore
- */
-export interface JsonMapperContextProps extends Partial<Omit<JsonMapperCtx, "next">> {
-    next: (data: any, options: any) => void;
-    options: any;
-}
-/**
- * @ignore
- */
-export declare class JsonMapperContext implements JsonMapperCtx {
-    readonly collectionType: Type<any> | undefined;
-    readonly type: Type<any> | any;
-    readonly options: any;
-    private _next;
-    constructor({ type, collectionType, next, options }: JsonMapperContextProps);
-    next(data: any): void;
-}

package/lib/cjs/domain/JsonMapperTypesContainer.d.ts

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

package/lib/cjs/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/cjs/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/cjs/index.d.ts

@@ -1,11 +0,0 @@
-export * from "./components";
-export * from "./decorators/jsonMapper";
-export * from "./decorators/onDeserialize";
-export * from "./decorators/onSerialize";
-export * from "./decorators/afterDeserialize";
-export * from "./decorators/beforeDeserialize";
-export * from "./domain/JsonMapperContext";
-export * from "./domain/JsonMapperTypesContainer";
-export * from "./interfaces/JsonMapperMethods";
-export * from "./utils/deserialize";
-export * from "./utils/serialize";

package/lib/cjs/interfaces/JsonMapperMethods.d.ts

@@ -1,25 +0,0 @@
-import { Type } from "@tsed/core";
-export interface JsonMapperCtx<T = any, C = any> {
-    collectionType: Type<C> | undefined;
-    type: Type<T> | T;
-    next: JsonMapperNext;
-}
-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/cjs/utils/deserialize.d.ts

@@ -1,41 +0,0 @@
-import { MetadataTypes, Type } from "@tsed/core";
-import { JsonEntityStore } from "@tsed/schema";
-import "../components";
-import { JsonMapperMethods } from "../interfaces/JsonMapperMethods";
-export interface JsonDeserializerOptions<T = any, C = any> extends MetadataTypes<T, C> {
-    /**
-     * Types used to map complex types (Symbol, Array, Set, Map)
-     */
-    types?: WeakMap<Type<any>, JsonMapperMethods>;
-    /**
-     * useAlias mapping
-     */
-    useAlias?: boolean;
-    /**
-     * Accept additionalProperties or ignore it
-     */
-    additionalProperties?: 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;
-    [key: string]: any;
-}
-/**
- * Transform given plain object to class.
- * @param src
- * @param options
- */
-export declare function plainObjectToClass<T = any>(src: any, options: JsonDeserializerOptions): T;
-/**
- * Transform given source to class base on the given `options.type`.
- *
- * @param src
- * @param options
- */
-export declare function deserialize<T = any>(src: any, options?: JsonDeserializerOptions): T;

package/lib/cjs/utils/serialize.d.ts

@@ -1,16 +0,0 @@
-import { MetadataTypes, Type } from "@tsed/core";
-import "../components";
-import { JsonMapperMethods } from "../interfaces/JsonMapperMethods";
-export interface JsonSerializerOptions<T = any, C = any> extends MetadataTypes<T, C> {
-    /**
-     * Types used to map complex types (Symbol, Array, Set, Map)
-     */
-    types?: Map<Type<any>, JsonMapperMethods>;
-    /**
-     * useAlias mapping
-     */
-    useAlias?: boolean;
-    [key: string]: any;
-}
-export declare function classToPlainObject(obj: any, options: JsonSerializerOptions<any, any>): {};
-export declare function serialize(obj: any, { type, collectionType, groups, ...options }?: JsonSerializerOptions): any;