magic-structure 1.0.6 → 1.1.0

package/index.ts

@@ -1,2 +1,3 @@
-export { field, fieldName, schema, mapper, value, skip, skipIf } from './lib/decorators'
-export { fromJson, toJson } from './lib/mappers'
+export { field, fieldName, schema, from, to, value, skip, skipIf } from './lib/decorators'
+export { fromJson, toJson } from './lib/mappers'
+export { type FieldOptions, type Mapper, type SkipMapper } from './lib/types'

package/lib/decorators.ts

@@ -1,5 +1,5 @@
-import type { FieldOptions, Mapper, SkipMapper } from './types.ts'
 import Meta from './meta'
+import type { FieldOptions, Mapper, SkipMapper } from './types'
 
 function field(options: FieldOptions) {
     return <Target extends object>(target: Target, property: keyof Target) => {
@@ -11,22 +11,26 @@ function fieldName(fieldName: string, reconstruct = false) {
     return field({ fieldName, reconstruct })
 }
 
-function mapper<Record extends object>(mapper: Mapper<Record>) {
-    return field({ mapper })
+function from<Value, Record extends object>(from: Mapper<Value, Record>) {
+    return field({ from })
+}
+
+function to<Value, Record extends object>(to: Mapper<Value, Record>) {
+    return field({ to })
 }
 
 function schema(schema: FieldOptions['schema'], isArray: FieldOptions['isArray'] = false) {
     return field({ schema, isArray })
 }
 
-function value(value: any) {
-    return field({ value })
+function value(value: any, excludeNull = false) {
+    return field({ value, excludeNull })
 }
 
-function skipIf(skipMapper: SkipMapper) {
+function skipIf<Value, Record extends object>(skipMapper: SkipMapper<Value, Record>) {
     return field({ skip: skipMapper })
 }
 
 const skip = field({ skip: true })
 
-export { field, fieldName, mapper, schema, value, skipIf, skip }
+export { field, fieldName, from, to, schema, value, skipIf, skip }

package/lib/mappers.ts

@@ -1,5 +1,5 @@
-import type { FieldOptions } from './types.ts'
 import Meta from './meta'
+import type { FieldOptions } from './types'
 
 export function fromJson<Schema extends object, Json extends object>(
     schema: new () => Schema,
@@ -22,7 +22,7 @@ export function fromJson<Schema extends object, Json extends object>(
             continue
         }
 
-        const { fieldName, value, mapper, schema, isArray } = options as FieldOptions
+        const { fieldName, value, from, excludeNull, schema, isArray } = options as FieldOptions
         const dataKey = fieldName !== undefined ? fieldName : key
         const data = json[dataKey as keyof Json]
 
@@ -31,10 +31,11 @@ export function fromJson<Schema extends object, Json extends object>(
             continue
         }
 
-        if (mapper?.from) {
-            result[key] = mapper.from(data, json)
+        if (from) {
+            result[key] = from(data, json)
         } else {
-            result[key] = data === undefined ? value : data
+            const isNullish = excludeNull ? data == null : data === undefined
+            result[key] = isNullish ? value : data
         }
     }
 
@@ -57,7 +58,7 @@ export function toJson<Json extends object>(json: Json): Json {
             continue
         }
 
-        const { mapper, schema, isArray, fieldName, reconstruct, skip } = options as FieldOptions
+        const { to, schema, isArray, fieldName, reconstruct, skip } = options as FieldOptions
         const data = json[key as keyof Json]
 
         if (skip !== undefined) {
@@ -72,8 +73,8 @@ export function toJson<Json extends object>(json: Json): Json {
             continue
         }
 
-        if (mapper?.to) {
-            result[resultKey] = mapper.to(data, json)
+        if (to) {
+            result[resultKey] = to(data, json)
         } else {
             result[resultKey] = data
         }

package/lib/meta.ts

@@ -1,4 +1,4 @@
-import type { FieldOptions, MetaInfo } from './types.ts'
+import type { FieldOptions, MetaInfo } from './types'
 
 const META_KEY = Symbol('meta')
 

package/lib/types.ts

@@ -1,20 +1,22 @@
-export interface Mapper<Record extends object = any> {
-    from?: (field: any, record: Record) => any
-    to?: (field: any, record: Record) => any
+export interface Mapper<Value, Record extends object = any> {
+    (value: Value, record: Record): any
+    (value: Value, record: Record): any
 }
 
-export interface SkipMapper {
-    <Record>(field: any, record: Record): boolean
+export interface SkipMapper<Value, Record> {
+    (value: Value, record: Record): boolean
 }
 
-export interface FieldOptions<Record extends object = any> {
-    skip?: boolean | SkipMapper
+export interface FieldOptions<Value = any, Record extends object = any> {
+    skip?: boolean | SkipMapper<Value, Record>
     value?: any
-    mapper?: Mapper<Record>
+    excludeNull?: boolean
+    from?: Mapper<Value, Record>
+    to?: Mapper<Value, Record>
     fieldName?: string
-    isArray?: boolean
     reconstruct?: boolean
     schema?: new () => object
+    isArray?: boolean
 }
 
 export interface MetaInfo {

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "magic-structure",
-  "version": "1.0.6",
+  "version": "1.1.0",
   "author": "Vlad Kramarukha",
   "description": "TS lib for mapping data",
   "keywords": ["TS", "mapper", "structure", "json", "magic"],
   "private": false,
-  "module": "dist/index.js",
+  "module": "index.ts",
   "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/lib/types.d.ts",
-  "files": ["README.md", "LICENSE", "lib/*", "dist/*", "index.ts"],
+  "main": "index.ts",
+  "types": "./lib/types.ts",
+  "files": ["README.md", "LICENSE", "lib/*", "index.ts"],
   "license": "Apache-2.0",
   "exports": {
     ".": {
-      "default": "./dist/index.js",
-      "types": "./dist/lib/types.d.ts"
+      "default": "./index.ts",
+      "types": "./lib/types.ts"
     }
   },
   "devDependencies": {

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-export { field, fieldName, schema, mapper, value, skip, skipIf } from './lib/decorators';
-export { fromJson, toJson } from './lib/mappers';

package/dist/index.js

@@ -1,2 +0,0 @@
-export { field, fieldName, schema, mapper, value, skip, skipIf } from './lib/decorators';
-export { fromJson, toJson } from './lib/mappers';

package/dist/lib/decorators.d.ts

@@ -1,9 +0,0 @@
-import type { FieldOptions, Mapper, SkipMapper } from './types.ts';
-declare function field(options: FieldOptions): <Target extends object>(target: Target, property: keyof Target) => void;
-declare function fieldName(fieldName: string, reconstruct?: boolean): <Target extends object>(target: Target, property: keyof Target) => void;
-declare function mapper<Record extends object>(mapper: Mapper<Record>): <Target extends object>(target: Target, property: keyof Target) => void;
-declare function schema(schema: FieldOptions['schema'], isArray?: FieldOptions['isArray']): <Target extends object>(target: Target, property: keyof Target) => void;
-declare function value(value: any): <Target extends object>(target: Target, property: keyof Target) => void;
-declare function skipIf(skipMapper: SkipMapper): <Target extends object>(target: Target, property: keyof Target) => void;
-declare const skip: <Target extends object>(target: Target, property: keyof Target) => void;
-export { field, fieldName, mapper, schema, value, skipIf, skip };

package/dist/lib/decorators.js

@@ -1,23 +0,0 @@
-import Meta from './meta';
-function field(options) {
-    return (target, property) => {
-        Meta.addMeta(target, property, options);
-    };
-}
-function fieldName(fieldName, reconstruct = false) {
-    return field({ fieldName, reconstruct });
-}
-function mapper(mapper) {
-    return field({ mapper });
-}
-function schema(schema, isArray = false) {
-    return field({ schema, isArray });
-}
-function value(value) {
-    return field({ value });
-}
-function skipIf(skipMapper) {
-    return field({ skip: skipMapper });
-}
-const skip = field({ skip: true });
-export { field, fieldName, mapper, schema, value, skipIf, skip };

package/dist/lib/mappers.d.ts

@@ -1,2 +0,0 @@
-export declare function fromJson<Schema extends object, Json extends object>(schema: new () => Schema, json: Json): Schema;
-export declare function toJson<Json extends object>(json: Json): Json;

package/dist/lib/mappers.js

@@ -1,63 +0,0 @@
-import Meta from './meta';
-export function fromJson(schema, json) {
-    if (json && typeof json !== 'object') {
-        return json;
-    }
-    const result = {};
-    const instance = new schema();
-    const metaInfo = Meta.getMeta(instance);
-    for (const key of [...Object.keys(metaInfo), ...Object.keys(instance)]) {
-        const options = metaInfo[key];
-        if (!options) {
-            result[key] = json[key];
-            continue;
-        }
-        const { fieldName, value, mapper, schema, isArray } = options;
-        const dataKey = fieldName !== undefined ? fieldName : key;
-        const data = json[dataKey];
-        if (schema && data && typeof data === 'object') {
-            result[key] = isArray ? data.map((v) => fromJson(schema, v)) : fromJson(schema, data);
-            continue;
-        }
-        if (mapper?.from) {
-            result[key] = mapper.from(data, json);
-        }
-        else {
-            result[key] = data === undefined ? value : data;
-        }
-    }
-    return Object.assign(instance, result);
-}
-export function toJson(json) {
-    if (json && typeof json !== 'object') {
-        return json;
-    }
-    const result = {};
-    const metaInfo = Meta.getMeta(json);
-    for (const key of [...Object.keys(metaInfo), ...Object.keys(json)]) {
-        const options = metaInfo[key];
-        if (!options) {
-            result[key] = json[key];
-            continue;
-        }
-        const { mapper, schema, isArray, fieldName, reconstruct, skip } = options;
-        const data = json[key];
-        if (skip !== undefined) {
-            const skipped = typeof skip === 'function' ? skip(data, json) : skip;
-            if (skipped)
-                continue;
-        }
-        const resultKey = fieldName && reconstruct ? fieldName : key;
-        if (schema && data && typeof data === 'object') {
-            result[resultKey] = isArray ? data.map(toJson) : toJson(data);
-            continue;
-        }
-        if (mapper?.to) {
-            result[resultKey] = mapper.to(data, json);
-        }
-        else {
-            result[resultKey] = data;
-        }
-    }
-    return result;
-}

package/dist/lib/meta.d.ts

@@ -1,6 +0,0 @@
-import type { FieldOptions, MetaInfo } from './types.ts';
-export default class Meta {
-    static isMeta<Target extends object>(target: Target | (Target & MetaInfo)): target is Target & MetaInfo;
-    static addMeta<Target extends object>(target: Target, property: keyof Target, info: FieldOptions): void;
-    static getMeta<Target extends object>(target: Target | Target & MetaInfo): MetaInfo;
-}

package/dist/lib/meta.js

@@ -1,20 +0,0 @@
-const META_KEY = Symbol('meta');
-const pt = (target) => target.constructor.prototype;
-const meta = (target) => pt(target)[META_KEY] || {};
-export default class Meta {
-    static isMeta(target) {
-        return META_KEY in pt(target);
-    }
-    static addMeta(target, property, info) {
-        if (!Meta.isMeta(target)) {
-            pt(target)[META_KEY] = {};
-        }
-        if (!meta(target)[property]) {
-            meta(target)[property] = {};
-        }
-        Object.assign(meta(target)[property], info);
-    }
-    static getMeta(target) {
-        return meta(target);
-    }
-}

package/dist/lib/types.d.ts

@@ -1,19 +0,0 @@
-export interface Mapper<Record extends object = any> {
-    from?: (field: any, record: Record) => any;
-    to?: (field: any, record: Record) => any;
-}
-export interface SkipMapper {
-    <Record>(field: any, record: Record): boolean;
-}
-export interface FieldOptions<Record extends object = any> {
-    skip?: boolean | SkipMapper;
-    value?: any;
-    mapper?: Mapper<Record>;
-    fieldName?: string;
-    isArray?: boolean;
-    reconstruct?: boolean;
-    schema?: new () => object;
-}
-export interface MetaInfo {
-    [p: string]: FieldOptions;
-}