@arrai-innovations/reactive-helpers 8.2.0 → 8.3.0

package/.husky/commit-msg

@@ -1,2 +1,4 @@
 #!/usr/bin/env bash
+. "$(dirname "$0")/_/husky.sh"
+
 npx --no-install commitlint --edit "$1"

package/.husky/pre-commit

@@ -1,2 +1,5 @@
 #!/usr/bin/env bash
+. "$(dirname "$0")/_/husky.sh"
+
 npx --no-install lint-staged
+npm run docs

package/docs.md

@@ -11,12 +11,15 @@
 
 ## Constants
 
-| Name               | Description |
-| ------------------ | ----------- |
-| [objectifyClasses] |
-| [combineClasses]   |
-| [stringifyClass]   |
-| [stringifyClasses] |
+| Name                                       | Description                                                                                             |
+| ------------------------------------------ | ------------------------------------------------------------------------------------------------------- |
+| [objectifyClasses]                         |
+| [combineClasses]                           |
+| [stringifyClass]                           |
+| [stringifyClasses]                         |
+| [removeEmptyObjects]                       | Remove empty objects from a mixed object array tree. Mutates the object.                                |
+| [compactSparseArrays]                      | Remove undefined values from arrays in a mixed object array tree. Mutates the object.                   |
+| [removeEmptyObjectsAndCompactSparseArrays] | Remove empty objects and undefined values from arrays in a mixed object array tree. Mutates the object. |
 
 ## Functions
 
@@ -385,6 +388,36 @@ const transformed = transformWalk(obj, (key, value, path) => {
 | ---------- | -------------- | ------------------------------------------------------------------------------ |
 | ...classes | [`CSSClasses`] | Handles as arguments the multiple ways of specifying CSS class related values. |
 
+## removeEmptyObjects
+
+Remove empty objects from a mixed object array tree. Mutates the object.
+
+**Kind**: global constant
+
+| Param | Type                | Description                                       |
+| ----- | ------------------- | ------------------------------------------------- |
+| obj   | `object` \| `Array` | The object or array to remove empty objects from. |
+
+## compactSparseArrays
+
+Remove undefined values from arrays in a mixed object array tree. Mutates the object.
+
+**Kind**: global constant
+
+| Param | Type                | Description                                      |
+| ----- | ------------------- | ------------------------------------------------ |
+| obj   | `object` \| `Array` | The object or array to compact sparse arrays in. |
+
+## removeEmptyObjectsAndCompactSparseArrays
+
+Remove empty objects and undefined values from arrays in a mixed object array tree. Mutates the object.
+
+**Kind**: global constant
+
+| Param | Type                | Description                                                                    |
+| ----- | ------------------- | ------------------------------------------------------------------------------ |
+| obj   | `object` \| `Array` | The object or array to remove empty objects from and compact sparse arrays in. |
+
 ## useCombineClasses(classes)
 
 **Kind**: global function  
@@ -460,6 +493,9 @@ A CSS object or a space-separated list of CSS classes.
 [combineclasses]: #combineclasses
 [stringifyclass]: #stringifyclass
 [stringifyclasses]: #stringifyclasses
+[removeemptyobjects]: #removeemptyobjects
+[compactsparsearrays]: #compactsparsearrays
+[removeemptyobjectsandcompactsparsearrays]: #removeemptyobjectsandcompactsparsearrays
 [cssvalue]: #cssvalue
 [cssobject]: #cssobject
 [cssclasses]: #cssclasses

package/lint-staged.config.js

@@ -1,9 +1,5 @@
 export default {
-    "**/*.{js,cjs,mjs,ts,jsx,tsx}": [
-        "npx --no-install eslint --fix",
-        "npx --no-install prettier --write",
-        () => "npm run docs",
-    ],
+    "**/*.{js,cjs,mjs,ts,jsx,tsx}": ["npx --no-install eslint --fix", "npx --no-install prettier --write"],
     "**/*.{markdown,md}": ["npx --no-install doctoc --github -u ."],
     "**/*.{less,scss,css,vue,markdown,json,md,yml,yaml,html}": ["npx --no-install prettier --write"],
     ".circleci/config.yml": ["circleci config validate"],

package/package.json

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

package/utils/compact.js

@@ -0,0 +1,86 @@
+const removeEmptyObjectsRecursive = (obj) => {
+    if (typeof obj !== "object" || obj === null) {
+        return;
+    }
+    if (Array.isArray(obj)) {
+        for (const item of obj) {
+            removeEmptyObjectsRecursive(item);
+        }
+        return;
+    }
+    for (const [key, value] of Object.entries(obj)) {
+        if (typeof value === "object" && value !== null) {
+            if (Object.keys(value).length === 0) {
+                delete obj[key];
+                continue;
+            }
+            removeEmptyObjectsRecursive(value);
+        }
+    }
+};
+
+/**
+ * Remove empty objects from a mixed object array tree. Mutates the object.
+ * @param {object | Array} obj - The object or array to remove empty objects from.
+ */
+export const removeEmptyObjects = (obj) => {
+    removeEmptyObjectsRecursive(obj);
+};
+
+const compactSparseArraysRecursive = (obj) => {
+    if (typeof obj !== "object" || obj === null) {
+        return;
+    }
+    if (Array.isArray(obj)) {
+        for (let i = 0; i < obj.length; i++) {
+            if (obj[i] === undefined) {
+                obj.splice(i, 1);
+                i--;
+            }
+        }
+    }
+    for (const value of Object.values(obj)) {
+        if (typeof value === "object" && value !== null) {
+            compactSparseArraysRecursive(value);
+        }
+    }
+};
+
+/**
+ * Remove undefined values from arrays in a mixed object array tree. Mutates the object.
+ * @param {object | Array} obj - The object or array to compact sparse arrays in.
+ */
+export const compactSparseArrays = (obj) => {
+    compactSparseArraysRecursive(obj);
+};
+
+const removeEmptyObjectsAndCompactSparseArraysRecursive = (obj) => {
+    if (typeof obj !== "object" || obj === null) {
+        return;
+    }
+    if (Array.isArray(obj)) {
+        for (let i = 0; i < obj.length; i++) {
+            if (obj[i] === undefined) {
+                obj.splice(i, 1);
+                i--;
+            }
+        }
+    }
+    for (const [key, value] of Object.entries(obj)) {
+        if (typeof value === "object" && value !== null) {
+            if (Object.keys(value).length === 0) {
+                delete obj[key];
+                continue;
+            }
+            removeEmptyObjectsAndCompactSparseArraysRecursive(value);
+        }
+    }
+};
+
+/**
+ * Remove empty objects and undefined values from arrays in a mixed object array tree. Mutates the object.
+ * @param {object | Array} obj - The object or array to remove empty objects from and compact sparse arrays in.
+ */
+export const removeEmptyObjectsAndCompactSparseArrays = (obj) => {
+    removeEmptyObjectsAndCompactSparseArraysRecursive(obj);
+};

package/utils/index.js

@@ -1,5 +1,6 @@
 export * from "./assignReactiveObject.js";
 export * from "./classes.js";
+export * from "./compact.js";
 export * from "./debugMessage.js";
 export * from "./debugWatch.js";
 export * from "./flattenPaths.js";