@valkyriestudios/utils 12.25.1 → 12.27.0

package/README.md

@@ -493,8 +493,8 @@ Format a date according to a spec/locale and zone
 | `W` | Week Number as pure digit | 1 2 .. 52 53 |
 | `DD` | Day of month as 2 char | 01 02 .. 30 31 |
 | `D` | Day of month as 1 char | 1 2 .. 30 31 |
-| `dddd` | Day of week as 3 char | Sun Mon ... Fri Sat |
-| `ddd` | Day of week in full | Sunday Monday ... Saturday |
+| `dddd` | Day of week in full | Sunday Monday ... Saturday |
+| `ddd` | Day of week as 3 char | Sun Mon ... Fri Sat |
 | `HH` | Hours as 2-char | 00 01 .. 22 23 |
 | `H` | Hours as pure digit | 0 1 .. 22 23 |
 | `hh` | Hours in 12 hour time as 2 char | 01 02 ... 11 12 |
@@ -1150,13 +1150,37 @@ isNotEmptyObject('Hi'); // FALSE
 ```
 
 ### object/pick(obj:Object={}, keys:Array[string]=[])
-Copies the keys passed in the 'keys' array from the passed object to a new object and returns that object.**
+Copies the keys passed in the 'keys' array from the passed object to a new object and returns that object.
 <small>If a key wasn't found it will be set as undefined</small>
 ```typescript
 import pick from '@valkyriestudios/utils/object/pick';
 pick({a: 1, b: 2, c: 3}, ['a','b']); // {a: 1, b: 2}
 ```
 
+### object/omit(obj:Object={}, keys:Array[string]=[])
+Returns an object with the keys provided in the keys array stripped from the provided object.
+```typescript
+import { omit } from "@valkyriestudios/utils/object"; /* Or @valkyriestudios/utils/object/omit; */
+const redacted = omit({
+    firstName: "Peter",
+    lastName: "Vermeulen",
+    age: 34,
+    details: {
+        phone: "...",
+        email: "...",
+        isActive: true,
+        password: "...",
+    },
+}, ["age", "details.phone", "details.email", "details.password"]);
+/**
+Redacted here will be:
+{firstName: "Peter", lastName: "Vermeulen", "details": {"isActive": true}}
+
+Its type will be
+{firstName: string; lastName: string; details: {isActive: boolean}}
+*/
+```
+
 ### object/merge(target:Object={},obj:Object|Object[]={}, opts?:{union?:boolean})
 Merges two objects together, with the preference over the second object.
 ```typescript

package/formdata/toObject.js

@@ -4,45 +4,45 @@ exports.toObject = toObject;
 exports.default = toObject;
 const isFormat_1 = require("../date/isFormat");
 const RGX_CLOSE = /\]/g;
+const RGX_DIGIT = /^\d+$/;
 function assignValue(acc, rawkey, value, single) {
     let cursor = acc;
     const keys = rawkey.replace(RGX_CLOSE, '').split(/\[|\./);
     const keys_len = keys.length;
     for (let i = 0; i < keys_len; i++) {
         const key = keys[i];
-        if (i === keys_len - 1) {
+        if (i < (keys_len - 1)) {
+            const n_key = Array.isArray(cursor) ? Number(key) : key;
+            if (!cursor[n_key]) {
+                cursor[n_key] = RGX_DIGIT.test(keys[i + 1]) ? [] : {};
+            }
+            cursor = cursor[n_key];
+        }
+        else if (!(key in cursor) || single.has(key)) {
+            cursor[key] = value;
+        }
+        else {
             const cursor_val = cursor[key];
-            if (cursor_val !== undefined && (!single || !single.has(key))) {
-                if (Array.isArray(cursor_val)) {
-                    cursor[key].push(value);
-                }
-                else {
-                    cursor[key] = [cursor_val, value];
-                }
+            if (Array.isArray(cursor_val)) {
+                cursor_val.push(value);
             }
             else {
-                cursor[key] = value;
+                cursor[key] = [cursor_val, value];
             }
         }
-        else {
-            const n_key = Array.isArray(cursor) ? Number(key) : key;
-            if (!cursor[n_key])
-                cursor[n_key] = isNaN(Number(keys[i + 1])) ? {} : [];
-            cursor = cursor[n_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 single = new Set(Array.isArray(config?.single) ? config.single : []);
     const nBool = config?.normalize_bool !== false;
     const nDate = config?.normalize_date !== false;
     const nNumber = config?.normalize_number !== false;
     const acc = {};
     form.forEach((value, key) => {
-        if (set !== true && typeof value === 'string' && !set.has(key)) {
+        if (set !== true && typeof value === 'string' && value !== '' && !set.has(key)) {
             if (nBool) {
                 const lower = value.toLowerCase();
                 if (lower === 'true') {
@@ -54,17 +54,17 @@ function toObject(form, config) {
                     return;
                 }
             }
-            const trimmed = value.trim();
-            if (trimmed.length) {
-                if (nNumber && !isNaN(Number(value))) {
-                    assignValue(acc, key, Number(value), single);
-                    return;
-                }
-                if (nDate && (0, isFormat_1.isDateFormat)(value, 'ISO')) {
-                    assignValue(acc, key, new Date(value), single);
+            if (nNumber) {
+                const nVal = Number(value);
+                if (!isNaN(nVal)) {
+                    assignValue(acc, key, nVal, single);
                     return;
                 }
             }
+            if (nDate && (0, isFormat_1.isDateFormat)(value, 'ISO')) {
+                assignValue(acc, key, new Date(value), single);
+                return;
+            }
         }
         assignValue(acc, key, value, single);
     });

package/index.d.ts

@@ -342,13 +342,27 @@ declare module "object/pick" {
     function pick<T extends Record<string, any>, K extends readonly DottedKeys<T>[]>(obj: T, keys: K): UnionToIntersection<PickFromObject<T, K[number]>>;
     export { pick, pick as default };
 }
+declare module "object/omit" {
+    type ObjectType = {
+        [key: string]: any;
+    };
+    type DottedKeys<T> = (T extends ObjectType ? {
+        [K in keyof T & string]: T[K] extends ObjectType ? K | `${K}.${DottedKeys<T[K]>}` : K;
+    }[keyof T & string] : string) & string;
+    type OmitFromObject<T, K extends string> = K extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? T[Key] extends ObjectType ? {
+        [P in keyof T]: P extends Key ? OmitFromObject<T[Key], Rest> : T[P];
+    } : T : T : Omit<T, K>;
+    function omit<T extends Record<string, any>, K extends readonly DottedKeys<T>[]>(obj: T, keys: K): OmitFromObject<T, K[number]>;
+    export { omit, omit as default };
+}
 declare module "object/index" {
     import { define } from "object/define";
     import { isObject } from "object/is";
     import { isNotEmptyObject } from "object/isNotEmpty";
     import { merge } from "object/merge";
     import { pick } from "object/pick";
-    export { define, isObject, isObject as is, isNotEmptyObject, isNotEmptyObject as isNotEmpty, isNotEmptyObject as isNeObject, isNotEmptyObject as isNe, merge, pick };
+    import { omit } from "object/omit";
+    export { define, isObject, isObject as is, isNotEmptyObject, isNotEmptyObject as isNotEmpty, isNotEmptyObject as isNeObject, isNotEmptyObject as isNe, merge, pick, omit };
 }
 declare module "number/is" {
     function isNumber(val: unknown): val is number;

package/object/index.d.ts

@@ -3,4 +3,5 @@ import { isObject } from './is';
 import { isNotEmptyObject } from './isNotEmpty';
 import { merge } from './merge';
 import { pick } from './pick';
-export { define, isObject, isObject as is, isNotEmptyObject, isNotEmptyObject as isNotEmpty, isNotEmptyObject as isNeObject, isNotEmptyObject as isNe, merge, pick };
+import { omit } from './omit';
+export { define, isObject, isObject as is, isNotEmptyObject, isNotEmptyObject as isNotEmpty, isNotEmptyObject as isNeObject, isNotEmptyObject as isNe, merge, pick, omit };

package/object/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pick = exports.merge = exports.isNe = exports.isNeObject = exports.isNotEmpty = exports.isNotEmptyObject = exports.is = exports.isObject = exports.define = void 0;
+exports.omit = exports.pick = exports.merge = exports.isNe = exports.isNeObject = exports.isNotEmpty = exports.isNotEmptyObject = exports.is = exports.isObject = exports.define = void 0;
 const define_1 = require("./define");
 Object.defineProperty(exports, "define", { enumerable: true, get: function () { return define_1.define; } });
 const is_1 = require("./is");
@@ -15,3 +15,5 @@ const merge_1 = require("./merge");
 Object.defineProperty(exports, "merge", { enumerable: true, get: function () { return merge_1.merge; } });
 const pick_1 = require("./pick");
 Object.defineProperty(exports, "pick", { enumerable: true, get: function () { return pick_1.pick; } });
+const omit_1 = require("./omit");
+Object.defineProperty(exports, "omit", { enumerable: true, get: function () { return omit_1.omit; } });

package/object/omit.d.ts

@@ -0,0 +1,17 @@
+type ObjectType = {
+    [key: string]: any;
+};
+type DottedKeys<T> = (T extends ObjectType ? {
+    [K in keyof T & string]: T[K] extends ObjectType ? K | `${K}.${DottedKeys<T[K]>}` : K;
+}[keyof T & string] : string) & string;
+type OmitFromObject<T, K extends string> = K extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? T[Key] extends ObjectType ? {
+    [P in keyof T]: P extends Key ? OmitFromObject<T[Key], Rest> : T[P];
+} : T : T : Omit<T, K>;
+/**
+ * Returns a new object with the keys omitted from the passed object, handling nested keys recursively
+ *
+ * @param {Record<string, any>} obj - Object to omit from
+ * @param {string[]} keys - Array of keys to omit from object
+ */
+declare function omit<T extends Record<string, any>, K extends readonly DottedKeys<T>[]>(obj: T, keys: K): OmitFromObject<T, K[number]>;
+export { omit, omit as default };

package/object/omit.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.omit = omit;
+exports.default = omit;
+function innerOmit(obj, keys) {
+    const result = { ...obj };
+    const groups = {};
+    for (let i = 0; i < keys.length; i++) {
+        const key = keys[i];
+        if (typeof key !== 'string')
+            continue;
+        const [root, path] = key.trim().split('.', 2);
+        if (path) {
+            if (!groups[root])
+                groups[root] = [];
+            groups[root].push(path);
+        }
+        else {
+            delete result[root];
+        }
+    }
+    for (const root in groups) {
+        if (typeof result[root] !== 'object' || result[root] === null)
+            continue;
+        result[root] = innerOmit(result[root], groups[root]);
+    }
+    return result;
+}
+function omit(obj, keys) {
+    if (Object.prototype.toString.call(obj) !== '[object Object]' ||
+        !Array.isArray(keys) ||
+        !keys.length)
+        throw new TypeError('Please pass an object to omit from and a keys array');
+    return innerOmit(obj, keys);
+}

package/object/pick.d.ts

@@ -13,8 +13,8 @@ type UnionToIntersection<U> = (U extends any ? (k: U) => void : object) extends
 /**
  * Returns a new object with the keys picked from the passed object
  *
- * @param obj - Object to pick from
- * @param keys - Array of keys to pick from object
+ * @param {Record<string, any>} obj - Object to pick from
+ * @param {string[]} keys - Array of keys to pick from object
  */
 declare function pick<T extends Record<string, any>, K extends readonly DottedKeys<T>[]>(obj: T, keys: K): UnionToIntersection<PickFromObject<T, K[number]>>;
 export { pick, pick as default };

package/package.json

@@ -1 +1 @@
-{ "name": "@valkyriestudios/utils", "version": "12.25.1", "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.27.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" }