nhb-toolbox 2.6.2 → 2.6.3

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

@@ -1 +1 @@
-{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../src/form/transform.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAkB,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErE,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"}
+{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../src/form/transform.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAkB,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErE,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,QAqGF,CAAC"}

package/dist/form/transform.js

@@ -13,6 +13,21 @@ const basics_2 = require("../object/basics");
  */
 const createControlledFormData = (data, configs) => {
     const formData = new FormData();
+    const { stringifyNested = '*' } = configs || {};
+    /** Helper function to check if a key matches a dotNotation path to preserve. */
+    const shouldDotNotate = (fullKey) => {
+        if (Array.isArray(configs?.dotNotateNested)) {
+            return configs?.dotNotateNested?.some((path) => fullKey === path || fullKey.startsWith(`${path}.`));
+        }
+        return configs?.dotNotateNested === '*';
+    };
+    /** - Helper function to check if a key matches a stringifyNested key. */
+    const shouldStringifyNested = (fullKey) => {
+        if (Array.isArray(stringifyNested)) {
+            return stringifyNested?.some((path) => fullKey === path || fullKey.startsWith(`${path}.`));
+        }
+        return stringifyNested === '*';
+    };
     const addToFormData = (key, value) => {
         const transformedKey = (configs?.lowerCaseKeys === '*' ||
             configs?.lowerCaseKeys?.includes(key)) ?
@@ -29,10 +44,14 @@ const createControlledFormData = (data, configs) => {
         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);
-            });
+            if (shouldStringifyNested(key) && !shouldDotNotate(key)) {
+                formData.append(transformedKey, JSON.stringify(value));
+            }
+            else {
+                Object.entries(value).forEach(([nestedKey, nestedValue]) => {
+                    addToFormData(`${key}.${nestedKey}`, nestedValue);
+                });
+            }
         }
         else {
             const isRequired = configs?.requiredKeys === '*' ||
@@ -43,12 +62,6 @@ const createControlledFormData = (data, configs) => {
             }
         }
     };
-    // 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 === '*';
-    };
     const processObject = (obj, parentKey = '') => {
         Object.entries(obj).forEach(([key, value]) => {
             const fullKey = (parentKey ?
@@ -62,13 +75,14 @@ const createControlledFormData = (data, configs) => {
                 value = value.trim();
             }
             // Check if this key is preserved
-            if (isPathPreserved(fullKey)) {
+            if (shouldDotNotate(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) {
+                value != null &&
+                !stringifyNested) {
                 // Process nested objects
                 processObject(value, key);
             }

package/dist/form/types.d.ts

@@ -6,8 +6,10 @@ export interface FormDataConfigs<T> {
     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>[];
+    /** - Dot-notation paths to preserve (e.g., 'user.settings'). `*` to include all keys. In this case `user` is an object and `settings` should also be an object. If `dotNotateNested` and `stringifyNested` both have the same key(s) or `*` it will prioritize `dotNotateNested`. */
+    dotNotateNested?: '*' | DotNotationKey<T>[];
+    /** - Dot-notation paths to stringify nested objects instead of flattening or dot-notate them. Defaults to `*`, use `*` to stringify every nested object. In this case the value of the last part of the key should also be an object. If `dotNotateNested` and `stringifyNested` both have the same key(s) or `*` it will prioritize `dotNotateNested`. */
+    stringifyNested?: '*' | DotNotationKey<T>[];
     /** - Whether to trim string values */
     trimStrings?: boolean;
 }

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

@@ -1 +1 @@
-{"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"}
+{"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,qRAAqR;IACrR,eAAe,CAAC,EAAE,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5C,2VAA2V;IAC3V,eAAe,CAAC,EAAE,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5C,sCAAsC;IACtC,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/dist/object/objectify.d.ts

@@ -36,7 +36,7 @@ export declare const flattenObjectDotNotation: <T extends GenericObject>(object:
  * @param updatedObject The modified object containing potential updates.
  * @returns A new object containing only the changed fields.
  */
-export declare const extractUpdatedFields: <T extends GenericObject>(baseObject: T | Partial<T>, updatedObject: Partial<T>) => Partial<T>;
+export declare const extractUpdatedFields: <T extends GenericObject>(baseObject: T, updatedObject: Partial<T>) => Partial<T>;
 /**
  * * Extracts only new fields that exist in updatedObject but not in baseObject.
  *
@@ -44,7 +44,7 @@ export declare const extractUpdatedFields: <T extends GenericObject>(baseObject:
  * @param updatedObject The modified object containing potential new fields.
  * @returns A new object containing only the new fields.
  */
-export declare const extractNewFields: <T extends GenericObject, U extends GenericObject>(baseObject: T | Partial<T>, updatedObject: Partial<T> & Partial<U>) => Partial<U>;
+export declare const extractNewFields: <T extends GenericObject, U extends GenericObject>(baseObject: T, updatedObject: Partial<T> & Partial<U>) => Partial<U>;
 /**
  * * Extracts changed fields from the updated object while also identifying newly added keys.
  *
@@ -52,5 +52,5 @@ export declare const extractNewFields: <T extends GenericObject, U extends Gener
  * @param updatedObject The modified object containing potential updates.
  * @returns An object containing modified fields and new fields separately.
  */
-export declare const extractUpdatedAndNewFields: <T extends GenericObject, U extends GenericObject>(baseObject: T | Partial<T>, updatedObject: Partial<T> & Partial<U>) => Partial<T> & Partial<U>;
+export declare const extractUpdatedAndNewFields: <T extends GenericObject, U extends GenericObject>(baseObject: T, updatedObject: Partial<T> & Partial<U>) => Partial<T> & Partial<U>;
 //# sourceMappingURL=objectify.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"objectify.d.ts","sourceRoot":"","sources":["../../src/object/objectify.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,aAAa,cAAc,CAAC,EAAE,KAAG,CAuCvE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,GAAI,CAAC,SAAS,aAAa,cACjD,CAAC,EAAE,KACb,aAyBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,aAAa,UACpD,CAAC,KACP,CAmBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,GAAI,CAAC,SAAS,aAAa,UACvD,CAAC,KACP,aAkCF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,aAAa,cAC/C,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,iBACX,OAAO,CAAC,CAAC,CAAC,KACvB,OAAO,CAAC,CAAC,CAwBX,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC5B,CAAC,SAAS,aAAa,EACvB,CAAC,SAAS,aAAa,cAEX,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,iBACX,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KACpC,OAAO,CAAC,CAAC,CAsBX,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,GACtC,CAAC,SAAS,aAAa,EACvB,CAAC,SAAS,aAAa,cAEX,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,iBACX,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KACpC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAwBxB,CAAC"}
+{"version":3,"file":"objectify.d.ts","sourceRoot":"","sources":["../../src/object/objectify.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,aAAa,cAAc,CAAC,EAAE,KAAG,CAuCvE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,GAAI,CAAC,SAAS,aAAa,cACjD,CAAC,EAAE,KACb,aAyBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,aAAa,UACpD,CAAC,KACP,CAmBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,GAAI,CAAC,SAAS,aAAa,UACvD,CAAC,KACP,aAkCF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,aAAa,cAC/C,CAAC,iBACE,OAAO,CAAC,CAAC,CAAC,KACvB,OAAO,CAAC,CAAC,CAwBX,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC5B,CAAC,SAAS,aAAa,EACvB,CAAC,SAAS,aAAa,cAEX,CAAC,iBACE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KACpC,OAAO,CAAC,CAAC,CAsBX,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,GACtC,CAAC,SAAS,aAAa,EACvB,CAAC,SAAS,aAAa,cAEX,CAAC,iBACE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KACpC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAwBxB,CAAC"}

package/package.json

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