@valkyriestudios/utils 12.21.0 → 12.23.0

package/README.md

@@ -787,7 +787,7 @@ isFormData(new FormData()); // TRUE
 isFormData({hi: 'there'}); // FALSE
 ```
 
-### formdata/toObject(val:FormData)
+### formdata/toObject(val:FormData, {raw?:string[]|true;single?:string[]} = {})
 Converts an instance of FormData to an object
 ```typescript
 import toObject from '@valkyriestudios/utils/formdata/toObject';
@@ -800,6 +800,59 @@ form.append('emptyField', '');
 toObject(form); // {name: 'Alice', hobbies: ['reading', 'writing'], emptyField: ''}
 ```
 
+Automatically converts strings to numbers and booleans, and nests objects/arrays based on key structures:
+```typescript
+const form = new FormData();
+form.append('user[0].name', 'Alice');
+form.append('user[1].age', '25');
+form.append('enabled', 'false');
+form.append('config.isGood', 'true');
+form.append('config.amount', ' 50 ');
+
+toObject(form); /* {
+    user: [
+        {name: 'Alice'},
+        {age: 25},
+    ],
+    enabled: false,
+    config: {
+        isGood: true,
+        amount: 50,
+    },
+} */
+```
+
+Allows blacklisting keys that should not be normalized into numbers/booleans but should remain as they are:
+```typescript
+const form = new FormData();
+form.append('pincode', '0123');
+form.append('enabled', 'false');
+form.append('config.isGood', 'true');
+form.append('config.amount', ' 50 ');
+
+toObject(form, {raw: ['pincode']}); /* {
+    pincode: '0123',
+    enabled: false,
+    config: {
+        isGood: true,
+        amount: 50,
+    },
+} */
+```
+
+Take Note: Set raw to `true` to do no normalization
+
+Allows passing a 'single' list that tells the system to NEVER turn a particular value into an array of values:
+```typescript
+const formData = new FormData();
+formData.append('status', 'active');
+formData.append('status', 'inactive');
+formData.append('action', 'save');
+formData.append('action', 'reset');
+
+toObject(formData, { single: ['status', 'action'] }) /* {status: 'inactive', action: 'reset'} */
+```
+
 ### hash/guid()
 Generate a unique identifier (guid) according to RFC4122
 ```typescript
@@ -1199,4 +1252,4 @@ humanizeNumber(47328748923747923479); // '47,328.75q'
 
 ## Contributors
 - [Peter Vermeulen](https://www.linkedin.com/in/petervermeulen1/)
-- [Xander Berkein](https://github.com/xanderberkein)
+- [Xander Berkein](https://github.com/xanderberkein)

package/formdata/toObject.d.ts

@@ -1,3 +1,13 @@
+type toObjectConfig = {
+    /**
+     * Pass array of keys that should not be normalized into number/bool when seen
+     */
+    raw?: string[] | true;
+    /**
+     * Pass array of keys that should only have a single value (e.g., 'action')
+     */
+    single?: string[];
+};
 /**
  * Converts a FormData instance to a json object
  * Eg:
@@ -11,6 +21,7 @@
  *  {name: 'Alice', hobbies: ['reading', 'writing'], emptyField: ''}
  *
  * @param {FormData} val - FormData instance to convert to an object
+ * @param {}
  */
-declare function toObject<T extends Record<string, unknown>>(form: FormData): T;
+declare function toObject<T extends Record<string, unknown>>(form: FormData, config?: toObjectConfig): T;
 export { toObject, toObject as default };

package/formdata/toObject.js

@@ -2,22 +2,58 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toObject = toObject;
 exports.default = toObject;
-function toObject(form) {
-    if (!(form instanceof FormData))
-        throw new Error('formdata/toObject: Value is not an instance of FormData');
-    const acc = {};
-    form.forEach((value, key) => {
-        if (acc[key] !== undefined) {
-            if (Array.isArray(acc[key])) {
-                acc[key].push(value);
+const RGX_CLOSE = /\]/g;
+function assignValue(acc, rawkey, value, single) {
+    let cursor = acc;
+    const keys = rawkey.replace(RGX_CLOSE, '').split(/\[|\./);
+    for (let i = 0; i < keys.length; i++) {
+        const key = keys[i];
+        if (i === keys.length - 1) {
+            if (cursor[key] !== undefined && (!single || !single.has(key))) {
+                if (Array.isArray(cursor[key])) {
+                    cursor[key].push(value);
+                }
+                else {
+                    cursor[key] = [cursor[key], value];
+                }
             }
             else {
-                acc[key] = [acc[key], value];
+                cursor[key] = value;
             }
+            return;
+        }
+        if (Array.isArray(cursor)) {
+            const index = Number(key);
+            if (!cursor[index])
+                cursor[index] = isNaN(Number(keys[i + 1])) ? {} : [];
+            cursor = cursor[index];
         }
         else {
-            acc[key] = value;
+            if (!cursor[key])
+                cursor[key] = isNaN(Number(keys[i + 1])) ? {} : [];
+            cursor = cursor[key];
+        }
+    }
+}
+function toObject(form, config) {
+    if (!(form instanceof FormData))
+        throw new Error('formdata/toObject: Value is not an instance of FormData');
+    const set = config?.raw === true ? true : new Set(Array.isArray(config?.raw) ? config?.raw : []);
+    const single = Array.isArray(config?.single) && config?.single.length ? new Set(config.single) : null;
+    const acc = {};
+    form.forEach((value, key) => {
+        let normalizedValue = value;
+        if (set !== true && typeof value === 'string' && !set.has(key)) {
+            const lower = value.toLowerCase();
+            normalizedValue = (lower === 'true'
+                ? true
+                : lower === 'false'
+                    ? false
+                    : !isNaN(Number(value)) && value.trim() !== ''
+                        ? Number(value)
+                        : value);
         }
+        assignValue(acc, key, normalizedValue, single);
     });
     return acc;
 }

package/hash/fnv1A.d.ts

@@ -1,3 +1,5 @@
+export declare const FNV_32 = 2166136261;
+export declare const FNV_64 = 1099511628211;
 /**
  * Convert a provided value into a Fowler-Noll-Vo 1A hash
  * For more info: https://tools.ietf.org/html/draft-eastlake-fnv-03

package/hash/fnv1A.js

@@ -1,14 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.FNV_64 = exports.FNV_32 = void 0;
 exports.fnv1A = fnv1A;
 exports.default = fnv1A;
-const FNV_32 = 2166136261;
+exports.FNV_32 = 2166136261;
+exports.FNV_64 = 1099511628211;
 const REPL_NAN = 'nan';
 const REPL_TRUE = 'true';
 const REPL_FALSE = 'false';
 const REPL_UNDEF = 'undefined';
 const REPL_NULL = 'null';
-function fnv1A(data, offset = FNV_32) {
+function fnv1A(data, offset = exports.FNV_32) {
     let hash = offset;
     let sanitized;
     switch (typeof data) {

package/index.d.ts

@@ -226,7 +226,11 @@ declare module "formdata/is" {
     export { isFormData, isFormData as default };
 }
 declare module "formdata/toObject" {
-    function toObject<T extends Record<string, unknown>>(form: FormData): T;
+    type toObjectConfig = {
+        raw?: string[] | true;
+        single?: string[];
+    };
+    function toObject<T extends Record<string, unknown>>(form: FormData, config?: toObjectConfig): T;
     export { toObject, toObject as default };
 }
 declare module "formdata/index" {
@@ -566,6 +570,8 @@ declare module "deep/index" {
     export { deepFreeze as freeze, deepFreeze, deepGet as get, deepGet, deepSeal as seal, deepSeal, deepSet as set, deepSet };
 }
 declare module "hash/fnv1A" {
+    export const FNV_32 = 2166136261;
+    export const FNV_64 = 1099511628211;
     function fnv1A(data: unknown, offset?: number): number;
     export { fnv1A, fnv1A as default };
 }

package/package.json

@@ -1 +1 @@
-{ "name": "@valkyriestudios/utils", "version": "12.21.0", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "url": "https://www.linkedin.com/in/petervermeulen1/" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }
+{ "name": "@valkyriestudios/utils", "version": "12.23.0", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "url": "https://www.linkedin.com/in/petervermeulen1/" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }