typeshi 2.1.2 → 2.1.4

package/dist/utils/object.d.ts

@@ -23,8 +23,25 @@ export declare class Restrict {
      */
     static toPicked: typeof picked;
 }
+/**
+ * define a `TransformationSchema<T>` to use in `sanitizeAndMap` to convert
+ * an initial object `any` to `T`. the `"initial"` object is assumed to share props with `T`
+ * (hence the need to transform its values)
+ *
+ * values are either:
+ * 1. a `function` where only need to pass in `initial[K]` to get the transformed value `T[K]`
+ * 2. an `object` with props:
+ * - `transform (function, optional)` - function that uses `initial[K]` & `args` to compute `T[K]`
+ * - `args (any[], optional)` - the array of arguments passed into `transform` using the spread operator.
+ * - `defaultValue (T[K], optional)` - assign this value to `K` when `transform` is `undefined`
+ * and `initial[K]` is `undefined`
+ */
 export type TransformationSchema<T> = {
-    [K in keyof T]?: (val: any) => T[K];
+    [K in keyof T]?: ((val: any) => T[K]) | {
+        transform?: (val: any, ...args: any[]) => T[K];
+        args?: any[];
+        defaultValue?: T[K];
+    };
 };
 /**
  * @param obj `any` - source object (e.g., Request Body)

package/dist/utils/object.js

@@ -9,6 +9,7 @@ exports.hasValidKeysOnly = hasValidKeysOnly;
 exports.picked = picked;
 exports.sanitizeAndMap = sanitizeAndMap;
 exports.hasDefinedEntry = hasDefinedEntry;
+const typeValidation_1 = require("./typeValidation");
 /**
  * @returns `boolean`
  * - `true` if all keys in obj are also in validKeys
@@ -50,8 +51,19 @@ function sanitizeAndMap(obj, schema, passThroughKeys = []) {
     const data = {};
     // 1. Handle explicit transformations
     for (const key in schema) {
-        if (schema[key] && hasDefinedEntry(obj, key)) {
-            data[key] = schema[key](obj[key]);
+        const schemaValue = schema[key];
+        if (!schemaValue)
+            continue;
+        if (hasDefinedEntry(obj, key)) {
+            if ((0, typeValidation_1.isFunction)(schemaValue)) {
+                data[key] = schemaValue(obj[key]);
+            }
+            else if ((0, typeValidation_1.isFunction)(schemaValue.transform)) {
+                data[key] = schemaValue.transform(obj[key], ...(schemaValue.args ?? []));
+            }
+        }
+        else if (!(0, typeValidation_1.isFunction)(schemaValue) && 'defaultValue' in schemaValue) { // can apply defaultValue
+            data[key] = schemaValue.defaultValue;
         }
     }
     // 2. Handle simple pass-throughs (Identity mapping)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "typeshi",
-    "version": "2.1.2",
+    "version": "2.1.4",
     "description": "TypeScript utility modules",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",