nhb-toolbox 2.3.9 → 2.4.0

package/dist/form/convert.d.ts

@@ -1,10 +1,11 @@
+import type { LooseObject } from '../object/types';
 /**
  * * Utility to convert object into FormData.
  *
  * @param data Data to convert into FormData.
  * @returns Converted FormData.
  */
-export declare const convertIntoFormData: <T extends object>(data: T) => FormData;
+export declare const convertIntoFormData: <T extends LooseObject>(data: T) => FormData;
 /**
  * * Check if a formdata object is empty.
  *

package/dist/form/convert.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../../src/form/convert.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,CAAC,SAAS,MAAM,QAAQ,CAAC,KAAG,QAY/D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,SAAU,QAAQ,KAAG,OAQhD,CAAC"}
+{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../../src/form/convert.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,CAAC,SAAS,WAAW,QAClD,CAAC,KACL,QAYF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,SAAU,QAAQ,KAAG,OAQhD,CAAC"}

package/dist/form/transform.d.ts

@@ -1,12 +1,12 @@
-import type { LooseObject } from '../object/types';
+import type { GenericObject } from '../object/types';
 import type { FormDataConfigs } from './types';
 /**
- * * Utility to  convert object into FormData in a controlled way.
+ * Utility to convert object into FormData in a controlled way.
  *
  * @param data - The source object to control and convert to FormData.
  * @param configs - Configuration options to control the formData.
  *
  * @returns FormData instance containing the sanitized and transformed data
  */
-export declare const createControlledFormData: <T extends LooseObject>(data: T, configs?: FormDataConfigs<T>) => FormData;
+export declare const createControlledFormData: <T extends GenericObject>(data: T, configs?: FormDataConfigs<T>) => FormData;
 //# sourceMappingURL=transform.d.ts.map

package/dist/form/transform.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../src/form/transform.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,GAAI,CAAC,SAAS,WAAW,QACvD,CAAC,YACG,eAAe,CAAC,CAAC,CAAC,KAC1B,QAkDF,CAAC"}
+{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../src/form/transform.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAEX,aAAa,EAEb,MAAM,iBAAiB,CAAC;AAEzB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,GAAI,CAAC,SAAS,aAAa,QACzD,CAAC,YACG,eAAe,CAAC,CAAC,CAAC,KAC1B,QAqFF,CAAC"}

package/dist/form/transform.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createControlledFormData = void 0;
-const basics_1 = require("../object/basics");
+const basics_1 = require("../array/basics");
+const basics_2 = require("../object/basics");
 /**
- * * Utility to  convert object into FormData in a controlled way.
+ * Utility to convert object into FormData in a controlled way.
  *
  * @param data - The source object to control and convert to FormData.
  * @param configs - Configuration options to control the formData.
@@ -13,49 +14,71 @@ const basics_1 = require("../object/basics");
 const createControlledFormData = (data, configs) => {
     const formData = new FormData();
     const addToFormData = (key, value) => {
-        if (value instanceof File) {
-            formData.append(key, value);
+        const transformedKey = (configs?.lowerCaseKeys === '*' ||
+            configs?.lowerCaseKeys?.includes(key)) ?
+            key.toLowerCase()
+            : key;
+        if (!(0, basics_1.isValidEmptyArray)(value) && value[0]?.originFileObj) {
+            formData.append(transformedKey, value[0].originFileObj);
         }
         else if (Array.isArray(value)) {
             value.forEach((item, index) => {
-                addToFormData(`${key}[${index}]`, item);
+                addToFormData(`${transformedKey}[${index}]`, item);
             });
         }
-        else if (typeof value === 'object' && !(0, basics_1.isEmptyObject)(value)) {
+        else if (typeof value === 'object' &&
+            value !== null &&
+            !(0, basics_2.isEmptyObject)(value)) {
+            // Handle nested object by converting it into a string representation like 'name.first'
             Object.entries(value).forEach(([nestedKey, nestedValue]) => {
                 addToFormData(`${key}.${nestedKey}`, nestedValue);
             });
         }
         else {
-            formData.append(key, value);
+            const isRequired = configs?.requiredKeys === '*' ||
+                configs?.requiredKeys?.includes(key);
+            const isNotNullish = value != null && value !== '';
+            if (isNotNullish || isRequired) {
+                formData.append(transformedKey, value);
+            }
         }
     };
-    const isPathPreserved = (key) => {
-        return configs?.preservePaths?.some((path) => key.startsWith(path));
+    // Helper function to check if a key matches a preserved path
+    const isPathPreserved = (fullKey) => {
+        if (Array.isArray(configs?.preservePaths))
+            return configs?.preservePaths?.some((path) => fullKey === path || fullKey.startsWith(`${path}.`));
+        return configs?.preservePaths === '*';
     };
-    Object.entries(data).forEach(([key, value]) => {
-        // 1. Skip keys that are in ignoreKeys
-        if (configs?.ignoreKeys?.includes(key))
-            return;
-        // 2. Trim string values if trimStrings is enabled
-        if (configs?.trimStrings && typeof value === 'string') {
-            value = value.trim();
-        }
-        // 3. Ensure requiredKeys are included even if falsy
-        if (configs?.requiredKeys?.includes(key) && value == null) {
-            value = ''; // Make sure it's an empty string for falsy values
-        }
-        // 4. Check preservePaths, if true, preserve values for nested paths
-        if (isPathPreserved(key)) {
-            addToFormData(key, value);
-        }
-        else {
-            const transformedKey = configs?.lowerCaseKeys?.includes(key) ?
-                key.toLowerCase()
-                : key;
-            addToFormData(transformedKey, value);
-        }
-    });
+    const processObject = (obj, parentKey = '') => {
+        Object.entries(obj).forEach(([key, value]) => {
+            const fullKey = (parentKey ?
+                `${parentKey}.${key}`
+                : key);
+            // Skip keys that are in ignoreKeys
+            if (configs?.ignoreKeys?.includes(fullKey))
+                return;
+            // Trim string values if trimStrings is enabled
+            if (configs?.trimStrings && typeof value === 'string') {
+                value = value.trim();
+            }
+            // Check if this key is preserved
+            if (isPathPreserved(fullKey)) {
+                // If it's a preserved path, we need to append the value directly as the key
+                addToFormData(fullKey, value);
+            }
+            else if (typeof value === 'object' &&
+                !Array.isArray(value) &&
+                value != null) {
+                // Process nested objects
+                processObject(value, key);
+            }
+            else {
+                // For other cases, just append as key-value
+                addToFormData(key, value);
+            }
+        });
+    };
+    processObject(data);
     return formData;
 };
 exports.createControlledFormData = createControlledFormData;

package/dist/form/types.d.ts

@@ -1,8 +1,14 @@
+import type { DotNotationKey } from '../object/types';
 export interface FormDataConfigs<T> {
-    ignoreKeys?: (keyof T)[];
-    requiredKeys?: (keyof T)[];
-    lowerCaseKeys?: (keyof T)[];
-    preservePaths?: string[];
+    /** - Keys to exclude from processing. Ignored keys are ignored even if they're in other options */
+    ignoreKeys?: DotNotationKey<T>[];
+    /** - Keys to preserve even if falsy. `*` to include all keys */
+    requiredKeys?: '*' | DotNotationKey<T>[];
+    /**  - Keys to convert to lowercase. `*` to include all keys */
+    lowerCaseKeys?: '*' | DotNotationKey<T>[];
+    /** - Dot-notation paths to preserve (e.g., 'user.settings.theme'). `*` to include all keys */
+    preservePaths?: '*' | DotNotationKey<T>[];
+    /** - Whether to trim string values */
     trimStrings?: boolean;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/form/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/form/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe,CAAC,CAAC;IAEjC,UAAU,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAEzB,YAAY,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAE3B,aAAa,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAE5B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/form/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEtD,MAAM,WAAW,eAAe,CAAC,CAAC;IACjC,mGAAmG;IACnG,UAAU,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IACjC,gEAAgE;IAChE,YAAY,CAAC,EAAE,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IACzC,+DAA+D;IAC/D,aAAa,CAAC,EAAE,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1C,8FAA8F;IAC9F,aAAa,CAAC,EAAE,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1C,sCAAsC;IACtC,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/dist/object/basics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"basics.d.ts","sourceRoot":"","sources":["../../src/object/basics.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE1D;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,mBAAmB,GAAI,CAAC,SAAS,WAAW,WAChD,CAAC,KACP,MAkCF,CAAC;AACF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,aAAa,OAAO,CAAC,KAAG,CAE7D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,aAAa,OAAO,CAAC,KAAG,OAE/D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,aAAa,OAAO,CAAC,KAAG,MAEnE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,SAAU,OAAO,KAAG,OAExC,CAAC"}
+{"version":3,"file":"basics.d.ts","sourceRoot":"","sources":["../../src/object/basics.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE1D;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,mBAAmB,GAAI,CAAC,SAAS,WAAW,WAChD,CAAC,KACP,MAkCF,CAAC;AACF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,aAAa,OAAO,CAAC,KAAG,CAE7D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,aAAa,OAAO,CAAC,KAAG,OAI/D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,aAAa,OAAO,CAAC,KAAG,MAInE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,SAAU,OAAO,KAAG,OAExC,CAAC"}

package/dist/object/basics.js

@@ -52,7 +52,9 @@ exports.cloneObject = cloneObject;
  * @returns Whether the object is empty.
  */
 const isEmptyObject = (obj) => {
-    return (0, exports.countObjectFields)(obj) === 0;
+    if (obj != null)
+        return (0, exports.countObjectFields)(obj) === 0;
+    return false;
 };
 exports.isEmptyObject = isEmptyObject;
 /**
@@ -62,7 +64,9 @@ exports.isEmptyObject = isEmptyObject;
  * @returns Number of fields in the object.
  */
 const countObjectFields = (obj) => {
-    return Object.keys(obj).length;
+    if (obj != null)
+        return Object.keys(obj).length;
+    return 0;
 };
 exports.countObjectFields = countObjectFields;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "2.3.9",
+  "version": "2.4.0",
   "description": "A versatile collection of smart, efficient, and reusable utility functions for everyday development needs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",