@tsed/json-mapper 6.87.1 → 6.89.0

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

@@ -0,0 +1,23 @@
+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/domain/JsonMapperContext.d.ts

@@ -0,0 +1,20 @@
+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/types/domain/JsonMapperTypesContainer.d.ts

@@ -0,0 +1,10 @@
+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/types/hooks/alterAfterDeserialize.d.ts

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

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

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

package/lib/types/index.d.ts

@@ -0,0 +1,11 @@
+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/types/interfaces/JsonMapperMethods.d.ts

@@ -0,0 +1,25 @@
+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/types/utils/deserialize.d.ts

@@ -0,0 +1,41 @@
+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/types/utils/serialize.d.ts

@@ -0,0 +1,16 @@
+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;

package/package.json

@@ -1,14 +1,21 @@
 {
   "name": "@tsed/json-mapper",
-  "version": "6.87.1",
+  "version": "6.89.0",
   "description": "Json mapper module for Ts.ED Framework",
   "private": false,
   "source": "./src/index.ts",
-  "main": "./lib/index.js",
-  "typings": "./lib/index.d.ts",
+  "main": "./lib/cjs/index.js",
+  "typings": "./lib/types/index.d.ts",
   "exports": {
-    "require": "./lib/index.js",
-    "default": "./lib/index.modern.js"
+    "types": "./lib/types/index.d.ts",
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
+  },
+  "scripts": {
+    "build": "yarn run build:esm && yarn run build:cjs",
+    "build:cjs": "tsc --build tsconfig.compile.json",
+    "build:esm": "tsc --build tsconfig.compile.esm.json"
   },
   "keywords": [
     "TypeScript",
@@ -22,21 +29,18 @@
     "classes",
     "tsed"
   ],
-  "scripts": {
-    "build": "microbundle --target node --no-compress --format modern,cjs --tsconfig ./tsconfig.compile.json"
-  },
   "dependencies": {
     "tslib": "2.2.0"
   },
   "devDependencies": {
-    "@tsed/core": "6.87.1",
-    "@tsed/exceptions": "6.87.1",
-    "@tsed/schema": "6.87.1"
+    "@tsed/core": "6.89.0",
+    "@tsed/exceptions": "6.89.0",
+    "@tsed/schema": "6.89.0"
   },
   "peerDependencies": {
-    "@tsed/core": "^6.87.1",
-    "@tsed/exceptions": "^6.87.1",
-    "@tsed/schema": "^6.87.1"
+    "@tsed/core": "^6.89.0",
+    "@tsed/exceptions": "^6.89.0",
+    "@tsed/schema": "^6.89.0"
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {

package/tsconfig.compile.esm.json

@@ -0,0 +1,23 @@
+{
+  "extends": "./tsconfig.compile.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ES2020",
+    "rootDir": "src",
+    "outDir": "./lib/esm",
+    "declaration": true,
+    "declarationDir": "./lib/types"
+  },
+  "exclude": [
+    "node_modules",
+    "test",
+    "lib",
+    "benchmark",
+    "coverage",
+    "spec",
+    "**/*.benchmark.ts",
+    "**/*.spec.ts",
+    "keys",
+    "jest.config.js"
+  ]
+}