@takeshape/util 9.103.27 → 9.104.0

package/dist/clone.d.ts

@@ -1,2 +1,29 @@
-export declare function deepClone<T>(input: T): T;
+/**
+ * Clone any JSON serializable value similar to JSON.parse(JSON.stringify()) but better performance
+ */
+export declare function deepClone<T>(value: T): T;
+/**
+ * @param value the value to clone
+ * @param key the key/index this value is stored under if parent is an object or array
+ * @param parent the parent object or array if applicable
+ * @return a new value to use instead of the value argument. Return REMOVE to remove value from the parent. Return  undefined to continue to clone recursively.
+ */
+type CloneHelper = (value: unknown, key: string | number | undefined, parent: Record<string, unknown> | unknown[] | undefined) => unknown;
+/**
+ * The callback for deepCloneWith which is called for every value in a object
+ * @param value the value to clone
+ * @param key the key/index this value is stored under if parent is an object or array
+ * @param parent the parent object or array if applicable
+ * @param clone a function used to continue to recusively clone
+ * @return a new value to use instead of the value argument. Return REMOVE to remove value from the parent. Return  undefined to continue to clone recursively.
+ */
+export type DeepCloneWithCustomizer = (value: unknown, key: string | number | undefined, parent: Record<string, unknown> | unknown[] | undefined, clone: CloneHelper) => unknown;
+export declare const REMOVE: unique symbol;
+/**
+ * Clone any JSON serializable value and transform using a callback
+ * @param value the value to clone
+ * @param customizer a callback that is called for every key/index
+ */
+export declare function deepCloneWith(value: unknown, customizer: DeepCloneWithCustomizer): unknown;
+export {};
 //# sourceMappingURL=clone.d.ts.map

package/dist/clone.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clone.d.ts","sourceRoot":"","sources":["../../src/clone.ts"],"names":[],"mappings":"AAAA,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAExC"}
+{"version":3,"file":"clone.d.ts","sourceRoot":"","sources":["../../src/clone.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CA8BxC;AAED;;;;;GAKG;AACH,KAAK,WAAW,GAAG,CACjB,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,EAChC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,GAAG,SAAS,KACpD,OAAO,CAAC;AAEb;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAAG,CACpC,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,EAChC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,GAAG,SAAS,EACvD,KAAK,EAAE,WAAW,KACf,OAAO,CAAC;AAEb,eAAO,MAAM,MAAM,eAAmB,CAAC;AAMvC;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,uBAAuB,GAAG,OAAO,CAwC1F"}

package/dist/clone.js

@@ -3,7 +3,100 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.REMOVE = void 0;
 exports.deepClone = deepClone;
-function deepClone(input) {
-  return JSON.parse(JSON.stringify(input));
+exports.deepCloneWith = deepCloneWith;
+var _types = require("./types");
+/**
+ * Clone any JSON serializable value similar to JSON.parse(JSON.stringify()) but better performance
+ */
+function deepClone(value) {
+  if (!value) {
+    return value;
+  }
+  if (Array.isArray(value)) {
+    const {
+      length
+    } = value;
+    const result = new Array(length);
+    for (let i = 0; i < length; i++) {
+      result[i] = deepClone(value[i]);
+    }
+    return result;
+  }
+  if ((0, _types.isIterableObject)(value)) {
+    const obj = value;
+    const result = {};
+    for (const key of Object.keys(obj)) {
+      const value = obj[key];
+      if (value !== undefined) {
+        result[key] = deepClone(value);
+      }
+    }
+    return result;
+  }
+  return value;
+}
+
+/**
+ * @param value the value to clone
+ * @param key the key/index this value is stored under if parent is an object or array
+ * @param parent the parent object or array if applicable
+ * @return a new value to use instead of the value argument. Return REMOVE to remove value from the parent. Return  undefined to continue to clone recursively.
+ */
+
+/**
+ * The callback for deepCloneWith which is called for every value in a object
+ * @param value the value to clone
+ * @param key the key/index this value is stored under if parent is an object or array
+ * @param parent the parent object or array if applicable
+ * @param clone a function used to continue to recusively clone
+ * @return a new value to use instead of the value argument. Return REMOVE to remove value from the parent. Return  undefined to continue to clone recursively.
+ */
+
+const REMOVE = Symbol('REMOVE');
+exports.REMOVE = REMOVE;
+function arrayFilter(value) {
+  return value !== REMOVE;
+}
+
+/**
+ * Clone any JSON serializable value and transform using a callback
+ * @param value the value to clone
+ * @param customizer a callback that is called for every key/index
+ */
+function deepCloneWith(value, customizer) {
+  const clone = (value, key, parent) => {
+    const newValue = customizer(value, key, parent, clone);
+    if (newValue !== undefined) {
+      return newValue;
+    }
+    if (Array.isArray(value)) {
+      const {
+        length
+      } = value;
+      const arr = new Array(length);
+      let edited = false;
+      for (let i = 0; i < length; i++) {
+        const newValue = clone(value[i], i, value);
+        if (newValue === REMOVE) {
+          edited = true;
+        }
+        arr[i] = newValue;
+      }
+      return edited ? arr.filter(arrayFilter) : arr;
+    }
+    if ((0, _types.isIterableObject)(value)) {
+      const newObject = {};
+      for (const key of Object.keys(value)) {
+        const newValue = clone(value[key], key, value);
+        if (newValue !== undefined && newValue !== REMOVE) {
+          newObject[key] = newValue;
+        }
+      }
+      return newObject;
+    }
+    return value;
+  };
+  return clone(value, undefined, undefined);
 }

package/dist/types.d.ts

@@ -19,6 +19,11 @@ export type StringProps<Obj> = {
  * reasonably be typed as a Record.
  */
 export declare function isRecord(maybeRecord: unknown): maybeRecord is Record<string, unknown>;
+/**
+ A guard for objects that ensures they are iterable records objects
+ not as strict as isRecord but better performance when that matters
+ */
+export declare function isIterableObject(x: unknown): x is Record<string, unknown>;
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 export type Maybe<T> = T | undefined;
 /**

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AAIzC;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,SAAS,IAAI,IAAI,CAAC,CAAC,EAAE;KAAE,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,SAAS,SAAS,GAAG,GAAG,GAAG,KAAK;CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAEvH,MAAM,MAAM,WAAW,CAAC,GAAG,IAAI;KAAE,CAAC,IAAI,MAAM,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK;CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AAE1G;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAErF;AAED,MAAM,MAAM,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAG/E,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAErE;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,SAAS,MAAM,EAAE,YAAY,EAAE;KAAE,GAAG,IAAI,CAAC,GAAG,KAAK;CAAC,eACtF,MAAM,mCAC1B;AAED,wBAAgB,WAAW,CAAC,cAAc,EAAE,OAAO,GAAG,cAAc,IAAI,SAAS,CAUhF;AAED,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAExD,wBAAgB,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,WAAW,IAAI,MAAM,CAOpE;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAMlD;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEpD"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AAIzC;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,SAAS,IAAI,IAAI,CAAC,CAAC,EAAE;KAAE,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,SAAS,SAAS,GAAG,GAAG,GAAG,KAAK;CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAEvH,MAAM,MAAM,WAAW,CAAC,GAAG,IAAI;KAAE,CAAC,IAAI,MAAM,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK;CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AAE1G;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAErF;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE;AAED,MAAM,MAAM,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAG/E,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAErE;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,SAAS,MAAM,EAAE,YAAY,EAAE;KAAE,GAAG,IAAI,CAAC,GAAG,KAAK;CAAC,eACtF,MAAM,mCAC1B;AAED,wBAAgB,WAAW,CAAC,cAAc,EAAE,OAAO,GAAG,cAAc,IAAI,SAAS,CAUhF;AAED,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAExD,wBAAgB,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,WAAW,IAAI,MAAM,CAOpE;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAMlD;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEpD"}

package/dist/types.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.createEnumMatcher = createEnumMatcher;
 exports.getSingle = getSingle;
+exports.isIterableObject = isIterableObject;
 exports.isNumericString = isNumericString;
 exports.isPrimitive = isPrimitive;
 exports.isRecord = isRecord;
@@ -30,6 +31,14 @@ function isRecord(maybeRecord) {
   return (0, _isPlainObject.default)(maybeRecord);
 }
 
+/**
+ A guard for objects that ensures they are iterable records objects
+ not as strict as isRecord but better performance when that matters
+ */
+function isIterableObject(x) {
+  return Boolean(x) && typeof x === 'object';
+}
+
 // https://stackoverflow.com/questions/50573891/maybe-a-type-in-typescript
 
 /**

package/es/clone.js

@@ -1,3 +1,94 @@
-export function deepClone(input) {
-  return JSON.parse(JSON.stringify(input));
+import { isIterableObject } from './types';
+
+/**
+ * Clone any JSON serializable value similar to JSON.parse(JSON.stringify()) but better performance
+ */
+export function deepClone(value) {
+  if (!value) {
+    return value;
+  }
+  if (Array.isArray(value)) {
+    const {
+      length
+    } = value;
+    const result = new Array(length);
+    for (let i = 0; i < length; i++) {
+      result[i] = deepClone(value[i]);
+    }
+    return result;
+  }
+  if (isIterableObject(value)) {
+    const obj = value;
+    const result = {};
+    for (const key of Object.keys(obj)) {
+      const value = obj[key];
+      if (value !== undefined) {
+        result[key] = deepClone(value);
+      }
+    }
+    return result;
+  }
+  return value;
+}
+
+/**
+ * @param value the value to clone
+ * @param key the key/index this value is stored under if parent is an object or array
+ * @param parent the parent object or array if applicable
+ * @return a new value to use instead of the value argument. Return REMOVE to remove value from the parent. Return  undefined to continue to clone recursively.
+ */
+
+/**
+ * The callback for deepCloneWith which is called for every value in a object
+ * @param value the value to clone
+ * @param key the key/index this value is stored under if parent is an object or array
+ * @param parent the parent object or array if applicable
+ * @param clone a function used to continue to recusively clone
+ * @return a new value to use instead of the value argument. Return REMOVE to remove value from the parent. Return  undefined to continue to clone recursively.
+ */
+
+export const REMOVE = Symbol('REMOVE');
+function arrayFilter(value) {
+  return value !== REMOVE;
+}
+
+/**
+ * Clone any JSON serializable value and transform using a callback
+ * @param value the value to clone
+ * @param customizer a callback that is called for every key/index
+ */
+export function deepCloneWith(value, customizer) {
+  const clone = (value, key, parent) => {
+    const newValue = customizer(value, key, parent, clone);
+    if (newValue !== undefined) {
+      return newValue;
+    }
+    if (Array.isArray(value)) {
+      const {
+        length
+      } = value;
+      const arr = new Array(length);
+      let edited = false;
+      for (let i = 0; i < length; i++) {
+        const newValue = clone(value[i], i, value);
+        if (newValue === REMOVE) {
+          edited = true;
+        }
+        arr[i] = newValue;
+      }
+      return edited ? arr.filter(arrayFilter) : arr;
+    }
+    if (isIterableObject(value)) {
+      const newObject = {};
+      for (const key of Object.keys(value)) {
+        const newValue = clone(value[key], key, value);
+        if (newValue !== undefined && newValue !== REMOVE) {
+          newObject[key] = newValue;
+        }
+      }
+      return newObject;
+    }
+    return value;
+  };
+  return clone(value, undefined, undefined);
 }

package/es/types.js

@@ -19,6 +19,14 @@ export function isRecord(maybeRecord) {
   return isPlainObject(maybeRecord);
 }
 
+/**
+ A guard for objects that ensures they are iterable records objects
+ not as strict as isRecord but better performance when that matters
+ */
+export function isIterableObject(x) {
+  return Boolean(x) && typeof x === 'object';
+}
+
 // https://stackoverflow.com/questions/50573891/maybe-a-type-in-typescript
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takeshape/util",
-  "version": "9.103.27",
+  "version": "9.104.0",
   "description": "Shared utilities",
   "homepage": "https://www.takeshape.io",
   "repository": {
@@ -33,7 +33,7 @@
     "shortid": "^2.2.16",
     "tiny-invariant": "^1.2.0",
     "url-parse": "^1.5.3",
-    "@takeshape/routing": "9.103.27"
+    "@takeshape/routing": "9.104.0"
   },
   "devDependencies": {
     "@types/classnames": "^2.2.9",
@@ -46,7 +46,7 @@
     "@types/prismjs": "^1.16.2",
     "@types/shortid": "^0.0.29",
     "stripe": "13.8.0",
-    "@takeshape/typescript-jest-junit-reporter": "9.103.27"
+    "@takeshape/typescript-jest-junit-reporter": "9.104.0"
   },
   "engines": {
     "node": ">=16"