magic-structure 1.0.0 → 1.0.1

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import * as decorators from './lib/decorators';
+import * as mappers from './lib/mappers';
+export { decorators, mappers };

package/dist/lib/decorators.d.ts

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

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

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

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

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

@@ -0,0 +1,20 @@
+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/lib/decorators.ts

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

package/lib/mappers.ts

@@ -0,0 +1,83 @@
+import type { FieldOptions } from './types.ts'
+import Meta from './meta'
+
+export function fromJson<Schema extends object, Json extends object>(
+    schema: new () => Schema,
+    json: Json
+): Schema {
+    if (json && typeof json !== 'object') {
+        return json
+    }
+
+    const result = {} as Record<string, any>
+    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 as keyof Json]
+            continue
+        }
+
+        const { fieldName, value, mapper, schema, isArray } = options as FieldOptions
+        const dataKey = fieldName !== undefined ? fieldName : key
+        const data = json[dataKey as keyof Json]
+
+        if (schema && data && typeof data === 'object') {
+            result[key] = isArray ? (data as object[]).map((v: object) => 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 extends object>(json: Json): Json {
+    if (json && typeof json !== 'object') {
+        return json
+    }
+
+    const result = {} as Record<string, any>
+    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 as keyof Json]
+            continue
+        }
+
+        const { mapper, schema, isArray, fieldName, reconstruct, skip } = options as FieldOptions
+        const data = json[key as keyof Json]
+
+        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 as object[]).map(toJson) : toJson(data)
+            continue
+        }
+
+        if (mapper?.to) {
+            result[resultKey] = mapper.to(data, json)
+        } else {
+            result[resultKey] = data
+        }
+    }
+
+    return result as Json
+}

package/lib/meta.ts

@@ -0,0 +1,32 @@
+import type { FieldOptions, MetaInfo } from './types.ts'
+
+const META_KEY = Symbol('meta')
+
+const pt = (target: object) => target.constructor.prototype
+const meta = (target: object) => pt(target)[META_KEY] || {}
+
+export default class Meta {
+    static isMeta<Target extends object>(target: Target | (Target & MetaInfo)): target is Target & MetaInfo {
+        return META_KEY in pt(target)
+    }
+
+    static addMeta<Target extends object>(
+        target: Target,
+        property: keyof Target,
+        info: FieldOptions
+    ) {
+        if (!Meta.isMeta(target)) {
+            pt(target)[META_KEY] = {}
+        }
+
+        if (!meta(target)[property]) {
+            meta(target)[property] = {}
+        }
+
+        Object.assign(meta(target)[property], info)
+    }
+
+    static getMeta<Target extends object>(target: Target | Target & MetaInfo): MetaInfo {
+        return meta(target)
+    }
+}

package/lib/types.d.ts

@@ -0,0 +1,22 @@
+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
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "magic-structure",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "Vlad Kramarukha",
   "description": "TS lib for mapping data",
   "keywords": ["TS", "mapper", "structure", "json", "magic"],
@@ -9,7 +9,7 @@
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": ["README.md", "LICENSE", "./lib/*", "./dist/*", "index.ts"],
+  "files": ["README.md", "LICENSE", "lib/*", "dist/*", "index.ts"],
   "license": "Apache-2.0",
   "devDependencies": {
     "@types/bun": "latest"