typeshi 2.1.6 → 2.1.8

package/dist/utils/object.d.ts

@@ -2,27 +2,6 @@
  * @file src/utils/object.ts
  * @TODO just use zod instead
  */
-/**
- * @returns `boolean`
- * - `true` if all keys in obj are also in validKeys
- * - `false` if there exists a key in obj that is not in validKeys
- */
-export declare function hasValidKeysOnly<T extends object>(obj: object, validKeys: readonly (keyof T)[]): obj is T;
-/**
- * @returns a new object containing only the specified keys.
- */
-export declare function picked<T extends object, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
-export declare class Restrict {
-    /**
-     * `hasValidKeysOnly`
-     * @returns `boolean` - `true` if `obj` contains ONLY keys found in `validKeys`
-     */
-    static keys: typeof hasValidKeysOnly;
-    /**
-     * @returns a new object containing only the specified keys.
-     */
-    static toPicked: typeof picked;
-}
 /**
  * define a `TransformationSchema<T, S>` to use in `sanitizeAndMap`, where entries from
  * a `source` object `S` are mapped to a new object `T`
@@ -38,10 +17,10 @@ export declare class Restrict {
  * and `source[sourceKey]` is `undefined`
  */
 export type TransformationSchema<T extends object, S extends object = any> = {
-    [K in keyof T]?: ((val: S[keyof S]) => T[K]) | TransformOptions<T, K, S>;
+    [K in keyof T]?: ((val: any) => T[K]) | TransformOptions<T, K, S>;
 };
 export type TransformOptions<T extends object, K extends keyof T, S extends object = any> = {
-    transform?: (val: S[keyof S], ...args: any[]) => T[K];
+    transform?: (val: any, ...args: any[]) => T[K];
     args?: any[];
     defaultValue?: T[K];
     sourceKey?: keyof S;
@@ -57,3 +36,24 @@ export declare function sanitizeAndMap<T extends object, S extends object = any>
  * @returns `Object.prototype.hasOwnProperty.call(obj, key) && obj[key] !== undefined;`
  */
 export declare function hasDefinedEntry<T extends object>(obj: any, key: keyof T | keyof any): boolean;
+/**
+ * @returns `boolean`
+ * - `true` if all keys in obj are also in validKeys
+ * - `false` if there exists a key in obj that is not in validKeys
+ */
+export declare function hasValidKeysOnly<T extends object>(obj: object, validKeys: readonly (keyof T)[]): obj is T;
+/**
+ * @returns a new object containing only the specified keys.
+ */
+export declare function picked<T extends object, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
+export declare class Restrict {
+    /**
+     * `hasValidKeysOnly`
+     * @returns `boolean` - `true` if `obj` contains ONLY keys found in `validKeys`
+     */
+    static keys: typeof hasValidKeysOnly;
+    /**
+     * @returns a new object containing only the specified keys.
+     */
+    static toPicked: typeof picked;
+}

package/dist/utils/object.js

@@ -5,42 +5,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Restrict = void 0;
-exports.hasValidKeysOnly = hasValidKeysOnly;
-exports.picked = picked;
 exports.sanitizeAndMap = sanitizeAndMap;
 exports.hasDefinedEntry = hasDefinedEntry;
+exports.hasValidKeysOnly = hasValidKeysOnly;
+exports.picked = picked;
 const typeValidation_1 = require("./typeValidation");
-/**
- * @returns `boolean`
- * - `true` if all keys in obj are also in validKeys
- * - `false` if there exists a key in obj that is not in validKeys
- */
-function hasValidKeysOnly(obj, validKeys) {
-    return Object.keys(obj).every(key => validKeys.includes(key));
-}
-/**
- * @returns a new object containing only the specified keys.
- */
-function picked(obj, keys) {
-    const result = {};
-    for (const key of keys) {
-        if (key in obj && obj[key] !== undefined)
-            result[key] = obj[key];
-    }
-    return result;
-}
-class Restrict {
-}
-exports.Restrict = Restrict;
-/**
- * `hasValidKeysOnly`
- * @returns `boolean` - `true` if `obj` contains ONLY keys found in `validKeys`
- */
-Restrict.keys = hasValidKeysOnly;
-/**
- * @returns a new object containing only the specified keys.
- */
-Restrict.toPicked = picked;
 /**
  * @param obj `S` - source object (e.g., Request Body)
  * @param schema {@link TransformationSchema}`<T, S>` - map of keys to transformation functions.
@@ -58,10 +27,10 @@ function sanitizeAndMap(obj, schema, passThroughKeys = []) {
             ? schemaValue.sourceKey
             : key);
         if (hasDefinedEntry(obj, sourceKey)) {
-            if ((0, typeValidation_1.isFunction)(schemaValue)) { // schemaValue is ((val: S[keyof S]) => T[K])
+            if ((0, typeValidation_1.isFunction)(schemaValue)) { // schemaValue is ((val: any) => T[K])
                 data[key] = schemaValue(obj[sourceKey]);
             }
-            else if ((0, typeValidation_1.isFunction)(schemaValue.transform)) { // schemaValue is { transform?: (val: S[keyof S], ...args: any[]) => T[K]; args?: any[]; sourceKey?: keyof S}
+            else if ((0, typeValidation_1.isFunction)(schemaValue.transform)) { // schemaValue is { transform?: (val: any, ...args: any[]) => T[K]; args?: any[]; sourceKey?: keyof S}
                 data[key] = schemaValue.transform(obj[sourceKey], ...(schemaValue.args ?? []));
             }
         }
@@ -72,9 +41,17 @@ function sanitizeAndMap(obj, schema, passThroughKeys = []) {
     }
     // 2. Handle simple pass-throughs (Identity mapping)
     for (const key of passThroughKeys) {
-        if (!data[key] && hasDefinedEntry(obj, key)) {
+        if (key in data)
+            continue; // already handled
+        if (hasDefinedEntry(obj, key)) {
             data[key] = obj[key];
         }
+        else if (key in schema && schema[key]) { // no value available to pass through, but can assign defaultValue
+            const schemaValue = schema[key];
+            if (!(0, typeValidation_1.isFunction)(schemaValue) && 'defaultValue' in schemaValue) {
+                data[key] = schemaValue.defaultValue;
+            }
+        }
     }
     return data;
 }
@@ -84,3 +61,34 @@ function sanitizeAndMap(obj, schema, passThroughKeys = []) {
 function hasDefinedEntry(obj, key) {
     return Object.prototype.hasOwnProperty.call(obj, key) && obj[key] !== undefined;
 }
+/**
+ * @returns `boolean`
+ * - `true` if all keys in obj are also in validKeys
+ * - `false` if there exists a key in obj that is not in validKeys
+ */
+function hasValidKeysOnly(obj, validKeys) {
+    return Object.keys(obj).every(key => validKeys.includes(key));
+}
+/**
+ * @returns a new object containing only the specified keys.
+ */
+function picked(obj, keys) {
+    const result = {};
+    for (const key of keys) {
+        if (key in obj && obj[key] !== undefined)
+            result[key] = obj[key];
+    }
+    return result;
+}
+class Restrict {
+}
+exports.Restrict = Restrict;
+/**
+ * `hasValidKeysOnly`
+ * @returns `boolean` - `true` if `obj` contains ONLY keys found in `validKeys`
+ */
+Restrict.keys = hasValidKeysOnly;
+/**
+ * @returns a new object containing only the specified keys.
+ */
+Restrict.toPicked = picked;

package/package.json

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