@vlad_kramarukha/json-statham 1.0.0

package/README.md

@@ -0,0 +1,2 @@
+# @json-statham
+

package/index.ts

@@ -0,0 +1,13 @@
+/* Decorators */
+import field from '@decorators/field.ts'
+import skip from '@decorators/skip.ts'
+import skipIf from '@decorators/skipIf.ts'
+import schema from '@decorators/schema.ts'
+import value from '@decorators/value.ts'
+import mapper from '@decorators/mapper.ts'
+import fieldName from '@decorators/fieldName.ts'
+
+/* Mappers */
+import { fromJson, toJson } from '@mappers'
+
+export default { field, skip, skipIf, schema, value, mapper, fieldName, fromJson, toJson }

package/lib/decorators/field.ts

@@ -0,0 +1,7 @@
+import Meta from '@meta'
+
+export default function field(options: FieldOptions) {
+    return <Target extends object>(target: Target, property: keyof Target) => {
+        Meta.addMeta(target, property, options)
+    }
+}

package/lib/decorators/fieldName.ts

@@ -0,0 +1,5 @@
+import field from '@decorators/field.ts'
+
+export default function fieldName(fieldName: string, reconstruct = false) {
+    return field({ fieldName, reconstruct })
+}

package/lib/decorators/mapper.ts

@@ -0,0 +1,5 @@
+import field from '@decorators/field.ts'
+
+export default function mapper<Record extends object>(mapper: Mapper<Record>) {
+    return field({ mapper })
+}

package/lib/decorators/schema.ts

@@ -0,0 +1,5 @@
+import field from '@decorators/field.ts'
+
+export default function schema(schema: FieldOptions['schema'], isArray: FieldOptions['isArray'] = false) {
+    return field({ schema, isArray })
+}

package/lib/decorators/skip.ts

@@ -0,0 +1,4 @@
+import field from '@decorators/field.ts'
+
+const skip = field({ skip: true })
+export default skip

package/lib/decorators/skipIf.ts

@@ -0,0 +1,5 @@
+import field from '@decorators/field.ts'
+
+export default function skipIf(skipMapper: SkipMapper) {
+    return field({ skip: skipMapper })
+}

package/lib/decorators/value.ts

@@ -0,0 +1,5 @@
+import field from '@decorators/field.ts'
+
+export default function value(value: any) {
+    return field({ value })
+}

package/lib/index.d.ts

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

package/lib/mappers.ts

@@ -0,0 +1,74 @@
+import Meta from '@meta'
+
+export function fromJson<Schema, Json extends object>(
+    schema: new () => Schema & MetaInfo,
+    json: Json
+): (Schema & MetaInfo) | Schema {
+    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) {
+            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 {
+    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) {
+            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,30 @@
+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/package.json

@@ -0,0 +1,22 @@
+{
+    "name": "@vlad_kramarukha/json-statham",
+    "version": "1.0.0",
+    "author": "vlad_kramarukha",
+    "private": false,
+    "description": "Mapper for convenient work with data",
+    "module": "index.ts",
+    "type": "module",
+    "license": "Apache-2.0",
+    "files": [
+        "index.ts",
+        "lib/*",
+        "README.md"
+    ],
+    "devDependencies": {
+        "@types/bun": "latest",
+        "prettier": "^3.8.1"
+    },
+    "peerDependencies": {
+        "typescript": "^5"
+    }
+}