@arrai-innovations/reactive-helpers 20.1.2 → 20.1.3

package/index.js

@@ -30,6 +30,7 @@ export * from "./utils/compact.js";
 export * from "./utils/deepUnref.js";
 export * from "./utils/deleteKey.js";
 export * from "./utils/flattenPaths.js";
+export * from "./utils/flattenPathsWithValues.js";
 export * from "./utils/getFakePk.js";
 export * from "./utils/keepAliveTry.js";
 export * from "./utils/keyDiff.js";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "20.1.2",
+    "version": "20.1.3",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "type": "module",

package/types/index.d.ts

@@ -29,6 +29,7 @@ export * from "./utils/compact.js";
 export * from "./utils/deepUnref.js";
 export * from "./utils/deleteKey.js";
 export * from "./utils/flattenPaths.js";
+export * from "./utils/flattenPathsWithValues.js";
 export * from "./utils/getFakePk.js";
 export * from "./utils/keepAliveTry.js";
 export * from "./utils/keyDiff.js";

package/types/utils/deepUnref.d.ts

@@ -1,26 +1,6 @@
+export function deepUnref<T>(val: T): DeepUnwrap<T> | T;
 /**
  * Recursively unwraps refs from a nested object, array, or primitive.
- *
- * @template T
- * @typedef {T extends import('vue').Ref<infer U>
- *   ? DeepUnwrap<U>
- *   : T extends Array<infer V>
- *     ? Array<DeepUnwrap<V>>
- *     : T extends object
- *       ? { [K in keyof T]: DeepUnwrap<T[K]> }
- *       : T
- * } DeepUnwrap
  */
-/**
- * Safe, recursively-typed deep unref.
- *
- * @template T
- * @param {T} val - The value to deeply unwrap.
- * @returns {DeepUnwrap<T>} - The deeply unwrapped value.
- */
-export const deepUnref: any;
-/**
- * Recursively unwraps refs from a nested object, array, or primitive.
- */
-export type DeepUnwrap<T_1> = T_1 extends import("vue").Ref<infer U> ? DeepUnwrap<U> : T_1 extends Array<infer V> ? Array<DeepUnwrap<V>> : T_1 extends object ? { [K in keyof T_1]: DeepUnwrap<T_1[K]>; } : T_1;
+export type DeepUnwrap<T> = T extends import("vue").Ref<infer U> ? DeepUnwrap<U> : T extends Array<infer V> ? Array<DeepUnwrap<V>> : T extends object ? { [K in keyof T]: DeepUnwrap<T[K]>; } : T;
 //# sourceMappingURL=deepUnref.d.ts.map

package/types/utils/deepUnref.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deepUnref.d.ts","sourceRoot":"","sources":["../../utils/deepUnref.js"],"names":[],"mappings":"AAIA;;;;;;;;;;;;GAYG;AAIH;;;;;;GAMG;AACH,4BAAoC;;;;8BAnBvB,GAAC,SAAS,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,GAC1C,UAAU,CAAC,CAAC,CAAC,GACb,GAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACtB,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GACpB,GAAC,SAAS,MAAM,GACd,GAAG,CAAC,IAAI,MAAM,GAAC,GAAG,UAAU,CAAC,GAAC,CAAC,CAAC,CAAC,CAAC,GAAE,GACpC,GAAC"}
+{"version":3,"file":"deepUnref.d.ts","sourceRoot":"","sources":["../../utils/deepUnref.js"],"names":[],"mappings":"AA2BO,0BAJM,CAAC,OACH,CAAC,GACC,UAAU,CAAC,CAAC,CAAC,GAAC,CAAC,CAe3B;;;;uBAjCY,CAAC,IACD,CAAC,SAAS,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,GAC1C,UAAU,CAAC,CAAC,CAAC,GACb,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACtB,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GACpB,CAAC,SAAS,MAAM,GACd,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAE,GACpC,CAAC"}

package/types/utils/deleteKey.d.ts

@@ -11,6 +11,7 @@ export function lodashLikePathSplit(string: string, object: object): string[];
  *
  * @param {object} obj - The object to modify.
  * @param {string} path - The key to delete.
+ * @returns {boolean} Returns true if the key was deleted, false otherwise.
  */
-export function del(obj: object, path: string): void;
+export function del(obj: object, path: string): boolean;
 //# sourceMappingURL=deleteKey.d.ts.map

package/types/utils/deleteKey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deleteKey.d.ts","sourceRoot":"","sources":["../../utils/deleteKey.js"],"names":[],"mappings":"AAgBA;;;;;;GAMG;AACH,4CAJW,MAAM,UACN,MAAM,GACJ,MAAM,EAAE,CAkBpB;AAED;;;;;GAKG;AACH,yBAHW,MAAM,QACN,MAAM,QAiBhB"}
+{"version":3,"file":"deleteKey.d.ts","sourceRoot":"","sources":["../../utils/deleteKey.js"],"names":[],"mappings":"AAgBA;;;;;;GAMG;AACH,4CAJW,MAAM,UACN,MAAM,GACJ,MAAM,EAAE,CAkBpB;AAED;;;;;;GAMG;AACH,yBAJW,MAAM,QACN,MAAM,GACJ,OAAO,CAkBnB"}

package/types/utils/flattenPathsWithValues.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Get all primitive paths and their corresponding values from an array or object.
+ *
+ * @module utils/flattenPathsWithValues.js
+ */
+/**
+ * Turn an array or object into an array of `[path, value]` pairs (for primitives)
+ * and a list of container paths (for arrays and objects).
+ *
+ * Array indexes are wrapped in square brackets and object keys are prefixed with a period.
+ *
+ * @param {any[] | object} arrayOrObject - Array or object to flatten.
+ * @param {object} [options] - Options.
+ * @param {string} [options.currentPath=""] - Current path, for recursion or as a starting point.
+ * @param {number} [options.depth=0] - Current depth, for recursion.
+ * @param {number} [options.limit=0] - Limit the depth of recursion.
+ * @returns {{
+ *   pathValues: [string, any][],
+ *   containerPaths: string[]
+ * }} - Paths and their corresponding values.
+ */
+export function flattenPathsWithValues(arrayOrObject: any[] | object, { currentPath, depth, limit }?: {
+    currentPath?: string;
+    depth?: number;
+    limit?: number;
+}): {
+    pathValues: [string, any][];
+    containerPaths: string[];
+};
+//# sourceMappingURL=flattenPathsWithValues.d.ts.map

package/types/utils/flattenPathsWithValues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flattenPathsWithValues.d.ts","sourceRoot":"","sources":["../../utils/flattenPathsWithValues.js"],"names":[],"mappings":"AAGA;;;;GAIG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,sDAVW,GAAG,EAAE,GAAG,MAAM,kCAEtB;IAAyB,WAAW,GAA5B,MAAM;IACW,KAAK,GAAtB,MAAM;IACW,KAAK,GAAtB,MAAM;CACd,GAAU;IACR,UAAU,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;IAC5B,cAAc,EAAE,MAAM,EAAE,CAAA;CACzB,CAyCH"}

package/types/utils/keyDiff.d.ts

@@ -8,23 +8,23 @@
  * Result object of keyDiff and keyDiffDeep.
  *
  * @typedef {object} KeyDiffResult
- * @property {Set} [sameKeys] - If sameKeys option is true, return keys that are the same.
- * @property {Set} [removedKeys] - If removedKeys option is true, return keys that are removed.
- * @property {Set} [addedKeys] - If addedKeys option is true, return keys that are added.
+ * @property {Set<string>} [sameKeys] - If sameKeys option is true, return keys that are the same.
+ * @property {Set<string>} [removedKeys] - If removedKeys option is true, return keys that are removed.
+ * @property {Set<string>} [addedKeys] - If addedKeys option is true, return keys that are added.
  */
 /**
  * Calculate the difference between two arrays of keys, in terms of what keys
  * are the same, what keys are removed, and what keys are added.
  *
- * @param {string[]|Set} newKeys - Keys to consider as new.
- * @param {string[]|Set} oldKeys - Keys to consider as old.
+ * @param {string[]|Set<string>} newKeys - Keys to consider as new.
+ * @param {string[]|Set<string>} oldKeys - Keys to consider as old.
  * @param {object} [options] - Which differences are returned.
  * @param {boolean} [options.sameKeys=true] - If true, return keys that are the same.
  * @param {boolean} [options.removedKeys=true] - If true, return keys that are removed.
  * @param {boolean} [options.addedKeys=true] - If true, return keys that are added.
  * @returns {KeyDiffResult} - The differences.
  */
-export function keyDiff(newKeys: string[] | Set<any>, oldKeys: string[] | Set<any>, { sameKeys, removedKeys, addedKeys }?: {
+export function keyDiff(newKeys: string[] | Set<string>, oldKeys: string[] | Set<string>, { sameKeys, removedKeys, addedKeys }?: {
     sameKeys?: boolean;
     removedKeys?: boolean;
     addedKeys?: boolean;
@@ -50,14 +50,14 @@ export type KeyDiffResult = {
     /**
      * - If sameKeys option is true, return keys that are the same.
      */
-    sameKeys?: Set<any>;
+    sameKeys?: Set<string>;
     /**
      * - If removedKeys option is true, return keys that are removed.
      */
-    removedKeys?: Set<any>;
+    removedKeys?: Set<string>;
     /**
      * - If addedKeys option is true, return keys that are added.
      */
-    addedKeys?: Set<any>;
+    addedKeys?: Set<string>;
 };
 //# sourceMappingURL=keyDiff.d.ts.map

package/types/utils/keyDiff.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"keyDiff.d.ts","sourceRoot":"","sources":["../../utils/keyDiff.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;GAWG;AACH,iCARW,MAAM,EAAE,WAAI,WACZ,MAAM,EAAE,WAAI,yCAEpB;IAA0B,QAAQ,GAA1B,OAAO;IACW,WAAW,GAA7B,OAAO;IACW,SAAS,GAA3B,OAAO;CACf,GAAU,aAAa,CAgBzB;AAED;;;;;;;;;;;;GAYG;AACH,oCATW,MAAM,UACN,MAAM,YACN,MAAM,GAKJ,aAAa,CAUzB"}
+{"version":3,"file":"keyDiff.d.ts","sourceRoot":"","sources":["../../utils/keyDiff.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;GAWG;AACH,iCARW,MAAM,EAAE,GAAC,GAAG,CAAC,MAAM,CAAC,WACpB,MAAM,EAAE,GAAC,GAAG,CAAC,MAAM,CAAC,yCAE5B;IAA0B,QAAQ,GAA1B,OAAO;IACW,WAAW,GAA7B,OAAO;IACW,SAAS,GAA3B,OAAO;CACf,GAAU,aAAa,CAgBzB;AAED;;;;;;;;;;;;GAYG;AACH,oCATW,MAAM,UACN,MAAM,YACN,MAAM,GAKJ,aAAa,CAUzB;;;;;;;;eAtDa,GAAG,CAAC,MAAM,CAAC;;;;kBACX,GAAG,CAAC,MAAM,CAAC;;;;gBACX,GAAG,CAAC,MAAM,CAAC"}

package/utils/deepUnref.js

@@ -23,6 +23,19 @@ import { deepUnref as _deepUnref } from "vue-deepunref";
  *
  * @template T
  * @param {T} val - The value to deeply unwrap.
- * @returns {DeepUnwrap<T>} - The deeply unwrapped value.
+ * @returns {DeepUnwrap<T>|T} - The deeply unwrapped value.
  */
-export const deepUnref = _deepUnref;
+export const deepUnref = (val) => {
+    if (
+        val instanceof Date ||
+        val instanceof RegExp ||
+        val instanceof Map ||
+        val instanceof Set ||
+        val instanceof WeakMap ||
+        val instanceof WeakSet
+    ) {
+        return val;
+    }
+
+    return _deepUnref(val);
+};

package/utils/deleteKey.js

@@ -44,10 +44,11 @@ export function lodashLikePathSplit(string, object) {
  *
  * @param {object} obj - The object to modify.
  * @param {string} path - The key to delete.
+ * @returns {boolean} Returns true if the key was deleted, false otherwise.
  */
 export function del(obj, path) {
     if (!obj) {
-        return;
+        return false;
     }
     const pathArray = lodashLikePathSplit(path, obj);
     let index = 0;
@@ -57,7 +58,8 @@ export function del(obj, path) {
         obj = obj[toKey(pathArray[index++])];
     }
     if (!obj) {
-        return;
+        return false;
     }
     delete obj[toKey(pathArray[index])];
+    return true;
 }

package/utils/flattenPathsWithValues.js

@@ -0,0 +1,65 @@
+import isArray from "lodash-es/isArray.js";
+import isObject from "lodash-es/isObject.js";
+
+/**
+ * Get all primitive paths and their corresponding values from an array or object.
+ *
+ * @module utils/flattenPathsWithValues.js
+ */
+
+/**
+ * Turn an array or object into an array of `[path, value]` pairs (for primitives)
+ * and a list of container paths (for arrays and objects).
+ *
+ * Array indexes are wrapped in square brackets and object keys are prefixed with a period.
+ *
+ * @param {any[] | object} arrayOrObject - Array or object to flatten.
+ * @param {object} [options] - Options.
+ * @param {string} [options.currentPath=""] - Current path, for recursion or as a starting point.
+ * @param {number} [options.depth=0] - Current depth, for recursion.
+ * @param {number} [options.limit=0] - Limit the depth of recursion.
+ * @returns {{
+ *   pathValues: [string, any][],
+ *   containerPaths: string[]
+ * }} - Paths and their corresponding values.
+ */
+export function flattenPathsWithValues(arrayOrObject, { currentPath = "", depth = 0, limit = 0 } = {}) {
+    /** @type {[string, any][]} */
+    const pathValues = [];
+    /** @type {string[]} */
+    const containerPaths = [];
+
+    const keysOrIndexes = isArray(arrayOrObject);
+    const dotOrNot = currentPath ? "." : "";
+
+    if (limit && depth >= limit) {
+        return { pathValues, containerPaths };
+    }
+
+    if (isObject(arrayOrObject)) {
+        if (currentPath) {
+            containerPaths.push(currentPath);
+        }
+
+        for (const [key, value] of Object.entries(arrayOrObject)) {
+            const keyPath = keysOrIndexes ? `[${key}]` : `${dotOrNot}${key}`;
+            const nextPath = `${currentPath}${keyPath}`;
+
+            if (isObject(value) || isArray(value)) {
+                const { pathValues: childValues, containerPaths: childContainers } = flattenPathsWithValues(value, {
+                    currentPath: nextPath,
+                    depth: depth + 1,
+                    limit,
+                });
+                pathValues.push(...childValues);
+                containerPaths.push(...childContainers);
+            } else {
+                pathValues.push([nextPath, value]);
+            }
+        }
+    } else if (currentPath) {
+        pathValues.push([currentPath, arrayOrObject]);
+    }
+
+    return { pathValues, containerPaths };
+}

package/utils/keyDiff.js

@@ -12,17 +12,17 @@ import { difference, intersection } from "./set.js";
  * Result object of keyDiff and keyDiffDeep.
  *
  * @typedef {object} KeyDiffResult
- * @property {Set} [sameKeys] - If sameKeys option is true, return keys that are the same.
- * @property {Set} [removedKeys] - If removedKeys option is true, return keys that are removed.
- * @property {Set} [addedKeys] - If addedKeys option is true, return keys that are added.
+ * @property {Set<string>} [sameKeys] - If sameKeys option is true, return keys that are the same.
+ * @property {Set<string>} [removedKeys] - If removedKeys option is true, return keys that are removed.
+ * @property {Set<string>} [addedKeys] - If addedKeys option is true, return keys that are added.
  */
 
 /**
  * Calculate the difference between two arrays of keys, in terms of what keys
  * are the same, what keys are removed, and what keys are added.
  *
- * @param {string[]|Set} newKeys - Keys to consider as new.
- * @param {string[]|Set} oldKeys - Keys to consider as old.
+ * @param {string[]|Set<string>} newKeys - Keys to consider as new.
+ * @param {string[]|Set<string>} oldKeys - Keys to consider as old.
  * @param {object} [options] - Which differences are returned.
  * @param {boolean} [options.sameKeys=true] - If true, return keys that are the same.
  * @param {boolean} [options.removedKeys=true] - If true, return keys that are removed.