@takeshape/util 11.133.0 → 11.133.4

package/dist/common/clone.d.ts

@@ -8,7 +8,7 @@ export declare function deepClone<T>(value: T): T;
  * @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;
+export 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
@@ -19,10 +19,23 @@ type CloneHelper = (value: unknown, key: string | number | undefined, parent: Re
  */
 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 obj the value to clone
+ * @param customizer a callback that is called for every key/index
+ */
+export declare function deepCloneWith(obj: unknown, customizer: DeepCloneWithCustomizer): unknown;
+/**
+ * @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 path the path to the current value being cloned
+ * @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 CloneWithPathHelper = (value: unknown, key: string | number | undefined, parent: Record<string, unknown> | unknown[] | undefined, path: string[]) => unknown;
 /**
  * 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 {};
+export declare function deepCloneWithPath(obj: unknown, customizer: CloneWithPathHelper): unknown;

package/dist/common/clone.js

@@ -33,10 +33,10 @@ function arrayFilter(value) {
 }
 /**
  * Clone any JSON serializable value and transform using a callback
- * @param value the value to clone
+ * @param obj the value to clone
  * @param customizer a callback that is called for every key/index
  */
-export function deepCloneWith(value, customizer) {
+export function deepCloneWith(obj, customizer) {
     const clone = (value, key, parent) => {
         const newValue = customizer(value, key, parent, clone);
         if (newValue !== undefined) {
@@ -67,5 +67,44 @@ export function deepCloneWith(value, customizer) {
         }
         return value;
     };
-    return clone(value, undefined, undefined);
+    return clone(obj, undefined, undefined);
+}
+/**
+ * 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 deepCloneWithPath(obj, customizer) {
+    const clone = (value, key, parent, path) => {
+        const customizedValue = customizer(value, key, parent, path);
+        if (customizedValue === REMOVE) {
+            return customizedValue;
+        }
+        const cloneValue = customizedValue ?? value;
+        if (Array.isArray(cloneValue)) {
+            const { length } = cloneValue;
+            const arr = new Array(length);
+            let edited = false;
+            for (let i = 0; i < length; i++) {
+                const newValue = clone(cloneValue[i], i, cloneValue, [...path, String(i)]);
+                if (newValue === REMOVE) {
+                    edited = true;
+                }
+                arr[i] = newValue;
+            }
+            return edited ? arr.filter(arrayFilter) : arr;
+        }
+        if (isIterableObject(cloneValue)) {
+            const newObject = {};
+            for (const key of Object.keys(cloneValue)) {
+                const newValue = clone(cloneValue[key], key, cloneValue, [...path, key]);
+                if (newValue !== undefined && newValue !== REMOVE) {
+                    newObject[key] = newValue;
+                }
+            }
+            return newObject;
+        }
+        return cloneValue;
+    };
+    return clone(obj, undefined, undefined, []);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takeshape/util",
-  "version": "11.133.0",
+  "version": "11.133.4",
   "description": "Shared utilities",
   "homepage": "https://www.takeshape.io",
   "repository": {
@@ -45,8 +45,8 @@
     "tiny-invariant": "1.3.3",
     "uint8array-extras": "1.4.0",
     "url-parse": "1.5.3",
-    "@takeshape/prism": "11.133.0",
-    "@takeshape/routing": "11.133.0"
+    "@takeshape/prism": "11.133.4",
+    "@takeshape/routing": "11.133.4"
   },
   "devDependencies": {
     "@types/classnames": "2.2.11",
@@ -76,6 +76,7 @@
     "test:ci": "TZ=UTC vitest run --reporter=default --reporter=junit --outputFile=\"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}/vitest-results.xml\" --coverage.enabled --coverage.reportsDirectory=\"${GITHUB_WORKSPACE}/coverage/${npm_package_name#*\\/}\"",
     "todo": "leasot 'src/**/*.{js,jsx,ts,tsx}'",
     "typecheck": "tsc --noEmit",
-    "typecheck:ci": "mkdir -p  \"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}\" && tsc --noEmit --pretty false | typescript-jest-junit-reporter | tee \"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}/typescript-results.xml\""
+    "typecheck:ci": "mkdir -p  \"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}\" && tsc --noEmit --pretty false | typescript-jest-junit-reporter | tee \"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}/typescript-results.xml\"",
+    "watch": "TZ=UTC vitest --watch"
   }
 }