@esri/hub-common 14.84.0 → 14.85.0

package/dist/esm/objects/deepDeletePropByValue.js

@@ -0,0 +1,67 @@
+import { deepEqual } from "./deepEqual";
+import { _isObject } from "./_deep-map-values";
+import { isFindable } from "./internal/isFindable";
+/**
+ * Recursively deletes properties from an object or array that have a
+ * specific value.
+ *
+ * Hub commonly applies migrations to entities on load. During those
+ * migrations, often we want to delete properties to clean things up.
+ * However, during the save process, we typically fetch the entity
+ * from it's backing store and spread the migrated entity over the top of
+ * the fetched entity. This results in the deleted props being re-added.
+ *
+ * To avoid this, instead of deleting the props in the migration,
+ * we can set them to a specific value (e.g. `remove-this-prop`) and then
+ * use this function to remove them, after the merge.
+ *
+ * @param object - The object or array to delete properties from.
+ * @param value - The value to match and delete.
+ * @returns The modified object or array with properties deleted.
+ */
+export function deepDeletePropByValue(object, value) {
+    // If the object is the value we want to delete, return undefined
+    if (deepEqual(object, value)) {
+        return undefined;
+    }
+    // If the object is an array, iterate over the array and recurse
+    // on the entries
+    if (Array.isArray(object)) {
+        return object.reduce((acc, entry) => {
+            if (isFindable(entry)) {
+                const recursedObject = deepDeletePropByValue(entry, value);
+                if (recursedObject !== undefined) {
+                    acc = [...acc, recursedObject];
+                }
+            }
+            else {
+                if (entry !== value) {
+                    acc = [...acc, entry];
+                } // else we are excluding this entry
+            }
+            return acc;
+        }, []);
+    }
+    if (_isObject(object)) {
+        return Object.keys(object).reduce((acc, key) => {
+            // if this is an object but not a date, regexp, or function, recurse
+            if (isFindable(object[key]) && !deepEqual(object[key], value)) {
+                const filteredEntry = deepDeletePropByValue(object[key], value);
+                acc[key] = filteredEntry;
+            }
+            else {
+                // ensure the value is not the value we want to delete
+                if (!deepEqual(object[key], value)) {
+                    acc = Object.assign(Object.assign({}, acc), { [key]: object[key] });
+                } // else this key matches the value and we are excluding it
+            }
+            return acc;
+        }, {});
+    }
+    else {
+        // just return the object b/c it's not something we can compare
+        // e.g. a function
+        return object;
+    }
+}
+//# sourceMappingURL=deepDeletePropByValue.js.map

package/dist/esm/objects/deepDeletePropByValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deepDeletePropByValue.js","sourceRoot":"","sources":["../../../src/objects/deepDeletePropByValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAW,EAAE,KAAU;IAC3D,iEAAiE;IACjE,IAAI,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;QAC5B,OAAO,SAAS,CAAC;KAClB;IAED,gEAAgE;IAChE,iBAAiB;IACjB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACzB,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAClC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE;gBACrB,MAAM,cAAc,GAAG,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAC3D,IAAI,cAAc,KAAK,SAAS,EAAE;oBAChC,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,cAAc,CAAC,CAAC;iBAChC;aACF;iBAAM;gBACL,IAAI,KAAK,KAAK,KAAK,EAAE;oBACnB,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC;iBACvB,CAAC,mCAAmC;aACtC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;KACR;IAED,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE;QACrB,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC7C,oEAAoE;YACpE,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,EAAE;gBAC7D,MAAM,aAAa,GAAG,qBAAqB,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;gBAC/D,GAAW,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC;aACnC;iBAAM;gBACL,sDAAsD;gBACtD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,EAAE;oBAClC,GAAG,mCAAQ,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,GAAE,CAAC;iBACtC,CAAC,0DAA0D;aAC7D;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;KACR;SAAM;QACL,+DAA+D;QAC/D,kBAAkB;QAClB,OAAO,MAAM,CAAC;KACf;AACH,CAAC"}

package/dist/esm/objects/deepEqual.js

@@ -0,0 +1,31 @@
+import { _isObject } from "./_deep-map-values";
+/**
+ * Compares two values deeply for equality.
+ * Works for primatives, arrays and objects.
+ * Not verified for other types.
+ * @param a - The first value to compare.
+ * @param b - The second value to compare.
+ * @returns True if the values are deeply equal, false otherwise.
+ */
+export function deepEqual(a, b) {
+    // Simple comparison for primitives
+    if (a === b) {
+        return true;
+    }
+    // object checks
+    if (a && b && _isObject(a) && _isObject(b)) {
+        // if either are not arrays, return false
+        if (Array.isArray(a) !== Array.isArray(b)) {
+            return false;
+        }
+        const keys = Object.keys(a);
+        // if key lengths are different, return false
+        if (keys.length !== Object.keys(b).length) {
+            return false;
+        }
+        // recurse on each key
+        return keys.every((key) => deepEqual(a[key], b[key]));
+    }
+    return false;
+}
+//# sourceMappingURL=deepEqual.js.map

package/dist/esm/objects/deepEqual.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deepEqual.js","sourceRoot":"","sources":["../../../src/objects/deepEqual.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CAAC,CAAM,EAAE,CAAM;IACtC,mCAAmC;IACnC,IAAI,CAAC,KAAK,CAAC,EAAE;QACX,OAAO,IAAI,CAAC;KACb;IACD,gBAAgB;IAChB,IAAI,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,EAAE;QAC1C,yCAAyC;QACzC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACzC,OAAO,KAAK,CAAC;SACd;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5B,6CAA6C;QAC7C,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;YACzC,OAAO,KAAK,CAAC;SACd;QACD,sBAAsB;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KACvD;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/esm/objects/index.js

@@ -13,4 +13,6 @@ export * from "./deepFilter";
 export * from "./deepFind";
 export * from "./resolveReferences";
 export * from "./pickProps";
+export * from "./deepEqual";
+export * from "./deepDeletePropByValue";
 //# sourceMappingURL=index.js.map

package/dist/esm/objects/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/objects/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/objects/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC"}

package/dist/node/objects/deepDeletePropByValue.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepDeletePropByValue = void 0;
+const deepEqual_1 = require("./deepEqual");
+const _deep_map_values_1 = require("./_deep-map-values");
+const isFindable_1 = require("./internal/isFindable");
+/**
+ * Recursively deletes properties from an object or array that have a
+ * specific value.
+ *
+ * Hub commonly applies migrations to entities on load. During those
+ * migrations, often we want to delete properties to clean things up.
+ * However, during the save process, we typically fetch the entity
+ * from it's backing store and spread the migrated entity over the top of
+ * the fetched entity. This results in the deleted props being re-added.
+ *
+ * To avoid this, instead of deleting the props in the migration,
+ * we can set them to a specific value (e.g. `remove-this-prop`) and then
+ * use this function to remove them, after the merge.
+ *
+ * @param object - The object or array to delete properties from.
+ * @param value - The value to match and delete.
+ * @returns The modified object or array with properties deleted.
+ */
+function deepDeletePropByValue(object, value) {
+    // If the object is the value we want to delete, return undefined
+    if (deepEqual_1.deepEqual(object, value)) {
+        return undefined;
+    }
+    // If the object is an array, iterate over the array and recurse
+    // on the entries
+    if (Array.isArray(object)) {
+        return object.reduce((acc, entry) => {
+            if (isFindable_1.isFindable(entry)) {
+                const recursedObject = deepDeletePropByValue(entry, value);
+                if (recursedObject !== undefined) {
+                    acc = [...acc, recursedObject];
+                }
+            }
+            else {
+                if (entry !== value) {
+                    acc = [...acc, entry];
+                } // else we are excluding this entry
+            }
+            return acc;
+        }, []);
+    }
+    if (_deep_map_values_1._isObject(object)) {
+        return Object.keys(object).reduce((acc, key) => {
+            // if this is an object but not a date, regexp, or function, recurse
+            if (isFindable_1.isFindable(object[key]) && !deepEqual_1.deepEqual(object[key], value)) {
+                const filteredEntry = deepDeletePropByValue(object[key], value);
+                acc[key] = filteredEntry;
+            }
+            else {
+                // ensure the value is not the value we want to delete
+                if (!deepEqual_1.deepEqual(object[key], value)) {
+                    acc = Object.assign(Object.assign({}, acc), { [key]: object[key] });
+                } // else this key matches the value and we are excluding it
+            }
+            return acc;
+        }, {});
+    }
+    else {
+        // just return the object b/c it's not something we can compare
+        // e.g. a function
+        return object;
+    }
+}
+exports.deepDeletePropByValue = deepDeletePropByValue;
+//# sourceMappingURL=deepDeletePropByValue.js.map

package/dist/node/objects/deepDeletePropByValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deepDeletePropByValue.js","sourceRoot":"","sources":["../../../src/objects/deepDeletePropByValue.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AACxC,yDAA+C;AAC/C,sDAAmD;AAEnD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,qBAAqB,CAAC,MAAW,EAAE,KAAU;IAC3D,iEAAiE;IACjE,IAAI,qBAAS,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;QAC5B,OAAO,SAAS,CAAC;KAClB;IAED,gEAAgE;IAChE,iBAAiB;IACjB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACzB,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAClC,IAAI,uBAAU,CAAC,KAAK,CAAC,EAAE;gBACrB,MAAM,cAAc,GAAG,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAC3D,IAAI,cAAc,KAAK,SAAS,EAAE;oBAChC,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,cAAc,CAAC,CAAC;iBAChC;aACF;iBAAM;gBACL,IAAI,KAAK,KAAK,KAAK,EAAE;oBACnB,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC;iBACvB,CAAC,mCAAmC;aACtC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;KACR;IAED,IAAI,4BAAS,CAAC,MAAM,CAAC,EAAE;QACrB,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC7C,oEAAoE;YACpE,IAAI,uBAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,EAAE;gBAC7D,MAAM,aAAa,GAAG,qBAAqB,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;gBAC/D,GAAW,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC;aACnC;iBAAM;gBACL,sDAAsD;gBACtD,IAAI,CAAC,qBAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,EAAE;oBAClC,GAAG,mCAAQ,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,GAAE,CAAC;iBACtC,CAAC,0DAA0D;aAC7D;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;KACR;SAAM;QACL,+DAA+D;QAC/D,kBAAkB;QAClB,OAAO,MAAM,CAAC;KACf;AACH,CAAC;AA3CD,sDA2CC"}

package/dist/node/objects/deepEqual.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepEqual = void 0;
+const _deep_map_values_1 = require("./_deep-map-values");
+/**
+ * Compares two values deeply for equality.
+ * Works for primatives, arrays and objects.
+ * Not verified for other types.
+ * @param a - The first value to compare.
+ * @param b - The second value to compare.
+ * @returns True if the values are deeply equal, false otherwise.
+ */
+function deepEqual(a, b) {
+    // Simple comparison for primitives
+    if (a === b) {
+        return true;
+    }
+    // object checks
+    if (a && b && _deep_map_values_1._isObject(a) && _deep_map_values_1._isObject(b)) {
+        // if either are not arrays, return false
+        if (Array.isArray(a) !== Array.isArray(b)) {
+            return false;
+        }
+        const keys = Object.keys(a);
+        // if key lengths are different, return false
+        if (keys.length !== Object.keys(b).length) {
+            return false;
+        }
+        // recurse on each key
+        return keys.every((key) => deepEqual(a[key], b[key]));
+    }
+    return false;
+}
+exports.deepEqual = deepEqual;
+//# sourceMappingURL=deepEqual.js.map

package/dist/node/objects/deepEqual.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deepEqual.js","sourceRoot":"","sources":["../../../src/objects/deepEqual.ts"],"names":[],"mappings":";;;AAAA,yDAA+C;AAE/C;;;;;;;GAOG;AACH,SAAgB,SAAS,CAAC,CAAM,EAAE,CAAM;IACtC,mCAAmC;IACnC,IAAI,CAAC,KAAK,CAAC,EAAE;QACX,OAAO,IAAI,CAAC;KACb;IACD,gBAAgB;IAChB,IAAI,CAAC,IAAI,CAAC,IAAI,4BAAS,CAAC,CAAC,CAAC,IAAI,4BAAS,CAAC,CAAC,CAAC,EAAE;QAC1C,yCAAyC;QACzC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACzC,OAAO,KAAK,CAAC;SACd;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5B,6CAA6C;QAC7C,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;YACzC,OAAO,KAAK,CAAC;SACd;QACD,sBAAsB;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KACvD;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AApBD,8BAoBC"}

package/dist/node/objects/index.js

@@ -16,4 +16,6 @@ tslib_1.__exportStar(require("./deepFilter"), exports);
 tslib_1.__exportStar(require("./deepFind"), exports);
 tslib_1.__exportStar(require("./resolveReferences"), exports);
 tslib_1.__exportStar(require("./pickProps"), exports);
+tslib_1.__exportStar(require("./deepEqual"), exports);
+tslib_1.__exportStar(require("./deepDeletePropByValue"), exports);
 //# sourceMappingURL=index.js.map

package/dist/node/objects/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/objects/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC;AACnC,wDAA8B;AAC9B,qDAA2B;AAC3B,wDAA8B;AAC9B,qDAA2B;AAC3B,sDAA4B;AAC5B,6DAAmC;AACnC,+DAAqC;AACrC,gEAAsC;AACtC,0DAAgC;AAChC,qDAA2B;AAC3B,uDAA6B;AAC7B,qDAA2B;AAC3B,8DAAoC;AACpC,sDAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/objects/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC;AACnC,wDAA8B;AAC9B,qDAA2B;AAC3B,wDAA8B;AAC9B,qDAA2B;AAC3B,sDAA4B;AAC5B,6DAAmC;AACnC,+DAAqC;AACrC,gEAAsC;AACtC,0DAAgC;AAChC,qDAA2B;AAC3B,uDAA6B;AAC7B,qDAA2B;AAC3B,8DAAoC;AACpC,sDAA4B;AAC5B,sDAA4B;AAC5B,kEAAwC"}

package/dist/types/objects/deepDeletePropByValue.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Recursively deletes properties from an object or array that have a
+ * specific value.
+ *
+ * Hub commonly applies migrations to entities on load. During those
+ * migrations, often we want to delete properties to clean things up.
+ * However, during the save process, we typically fetch the entity
+ * from it's backing store and spread the migrated entity over the top of
+ * the fetched entity. This results in the deleted props being re-added.
+ *
+ * To avoid this, instead of deleting the props in the migration,
+ * we can set them to a specific value (e.g. `remove-this-prop`) and then
+ * use this function to remove them, after the merge.
+ *
+ * @param object - The object or array to delete properties from.
+ * @param value - The value to match and delete.
+ * @returns The modified object or array with properties deleted.
+ */
+export declare function deepDeletePropByValue(object: any, value: any): any;

package/dist/types/objects/deepEqual.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Compares two values deeply for equality.
+ * Works for primatives, arrays and objects.
+ * Not verified for other types.
+ * @param a - The first value to compare.
+ * @param b - The second value to compare.
+ * @returns True if the values are deeply equal, false otherwise.
+ */
+export declare function deepEqual(a: any, b: any): boolean;

package/dist/types/objects/index.d.ts

@@ -13,3 +13,5 @@ export * from "./deepFilter";
 export * from "./deepFind";
 export * from "./resolveReferences";
 export * from "./pickProps";
+export * from "./deepEqual";
+export * from "./deepDeletePropByValue";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "14.84.0",
+  "version": "14.85.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",