magic-structure 1.0.7 → 1.1.0

package/index.ts

@@ -1,3 +1,3 @@
-export { field, fieldName, schema, mapper, value, skip, skipIf } from './lib/decorators'
+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

@@ -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

@@ -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/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,6 +1,6 @@
 {
   "name": "magic-structure",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "author": "Vlad Kramarukha",
   "description": "TS lib for mapping data",
   "keywords": ["TS", "mapper", "structure", "json", "magic"],