@arrai-innovations/reactive-helpers 17.0.0 → 17.0.2

package/make_type_doc.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+
+import { execSync } from "child_process";
+import fs from "fs";
+import os from "os";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const scriptName = path.basename(__filename);
+
+const BLUE_COLOR = "\u001b[1;38;2;0;119;247m";
+const ORANGE_COLOR = "\u001b[1;38;2;255;127;0m";
+const RESET_COLOR = "\u001b[0m";
+
+const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "docs-"));
+const docsDir = path.resolve("./docs");
+
+function cleanup() {
+    fs.rmSync(tempDir, { recursive: true, force: true });
+}
+
+process.on("exit", cleanup);
+process.on("SIGINT", () => {
+    cleanup();
+    process.exit(1);
+});
+
+execSync(`npx --no-install typedoc --out "${tempDir}" --plugin typedoc-plugin-markdown --disableSources`, {
+    stdio: "inherit",
+});
+
+let docsAreDifferent = false;
+
+try {
+    execSync(`git diff --no-index --quiet "${tempDir}" "${docsDir}"`, {
+        stdio: "inherit",
+    });
+} catch (error) {
+    if (error.status === 1) {
+        // Differences found
+        docsAreDifferent = true;
+    } else {
+        // Unexpected error
+        throw error;
+    }
+}
+
+if (docsAreDifferent) {
+    console.log(`[${scriptName}] ${ORANGE_COLOR}Docs are out of date, updating...${RESET_COLOR}`);
+    fs.rmSync("./docs", { recursive: true, force: true });
+    fs.renameSync(tempDir, "./docs");
+    execSync(`git add ./docs`, { stdio: "inherit" });
+} else {
+    console.log(`[${scriptName}] ${BLUE_COLOR}Docs are up to date${RESET_COLOR}`);
+}
+
+cleanup();
+process.exit(0);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "17.0.0",
+    "version": "17.0.2",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "type": "module",
@@ -10,13 +10,13 @@
         "tests": "tests"
     },
     "scripts": {
-        "test": "vitest",
+        "test": "npx vitest",
         "eslint": "npx --no-install eslint --fix index.js config/**/*.js tests/**/*.js use/**/*.js utils/**/*.js",
         "prettier": "npx --no-install prettier --write .",
         "coverage": "npm run coverage:clean; npm test -- --coverage=true",
         "coverage:clean": "rm -rf coverage",
-        "prepare": "husky || true",
-        "docs": "./makeTypeDoc.sh"
+        "prepare": "npx --no-install husky",
+        "docs": "node make_type_doc.js"
     },
     "repository": {
         "type": "git",
@@ -32,12 +32,12 @@
         "@arrai-innovations/commitlint-config": "^1.1.0",
         "@commitlint/cli": "^19.4.0",
         "@godaddy/dmd": "^1.0.4",
-        "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+        "@trivago/prettier-plugin-sort-imports": "^5.2.1",
         "@types/browser-util-inspect": "^0.2.4",
         "@types/lodash-es": "^4.17.12",
         "@typescript-eslint/eslint-plugin": "^7.18.0",
         "@typescript-eslint/parser": "^7.18.0",
-        "@vitest/coverage-v8": "^1.6.0",
+        "@vitest/coverage-v8": "^2.1.8",
         "@vue/compiler-sfc": "^3.4.37",
         "@vue/eslint-config-prettier": "^9.0.0",
         "@vue/test-utils": "^2.3.2",
@@ -48,24 +48,24 @@
         "eslint-plugin-vitest-globals": "^1.3.1",
         "eslint-plugin-vue": "^9.27.0",
         "flush-promises": "^1.0.2",
-        "globals": "^15.9.0",
-        "jsdom": "^24.1.1",
+        "globals": "^15.14.0",
+        "husky": "^9.1.7",
+        "jsdom": "^26.0.0",
         "lint-staged": "^15.2.8",
         "prettier": "^3.3.3",
         "typedoc": "^0.27.1",
         "typedoc-plugin-markdown": "^4.3.0",
         "typescript": "^5.5.4",
-        "vitest": "^1.6.0"
+        "vitest": "^2.1.8"
     },
     "dependencies": {
         "@jcoreio/async-throttle": "^1.6.0",
         "browser-util-inspect": "^0.2.0",
         "flexsearch": "0.7.21",
-        "husky": "^9.0.11",
         "vue-deepunref": "^1.0.1"
     },
     "peerDependencies": {
-        "@vueuse/core": "^11.2.0",
+        "@vueuse/core": "^12.4.0",
         "lodash-es": "^4.17.21",
         "vue": "^3.4.30"
     }

package/tests/unit/use/listInstance.spec.js

@@ -1,4 +1,4 @@
-import { doAwaitNot } from "../../../utils/watches.js";
+import { doAwaitNot, doAwaitTimeout } from "../../../utils/watches.js";
 import { expectErrorToBeNull } from "../expectHelpers.js";
 import flushPromises from "flush-promises";
 import keyBy from "lodash-es/keyBy.js";
@@ -274,30 +274,38 @@ describe("use/listInstance.spec.js", function () {
             expect({ ...listInstance.state.objects }).toEqual({});
         });
         it("already loading", async function () {
-            const listArgs = reactive({
-                user: 1,
-            });
-            const retrieveArgs = reactive({
-                fields,
-            });
+            const listArgs = reactive({ user: 1 });
+            const retrieveArgs = reactive({ fields });
             const listInstance = useListInstance({
                 props: { pkKey: "id", listArgs, retrieveArgs },
                 keepOldPages: false,
             });
+
             expectErrorToBeNull(listInstance.state.error);
             expect(listInstance.state.errored).toBe(false);
             expect(listInstance.state.loading).toBeUndefined();
-            expect({ ...listInstance.state.objects }).toEqual({});
-            globalList.mockImplementation(() => new Promise(() => {}));
+
+            let bulkDeleteResolve;
+            const bulkDeletePromise = new Promise((resolve) => {
+                bulkDeleteResolve = resolve;
+            });
+            globalBulkDelete.mockImplementation(() => bulkDeletePromise);
             listInstance.bulkDelete();
 
-            expectErrorToBeNull(listInstance.state.error);
-            expect(listInstance.state.errored).toBe(false);
             expect(listInstance.state.loading).toBe(true);
+
             await expect(() => listInstance.list()).rejects.toThrow(ListInstanceError);
+
+            expect(listInstance.state.loading).toBe(true);
+
+            // @ts-ignore - bulkDeleteResolve is set in a promise. promise executors run immediately
+            bulkDeleteResolve();
+            await flushPromises();
+
+            expect(globalBulkDelete).toHaveBeenCalledTimes(1);
             expectErrorToBeNull(listInstance.state.error);
             expect(listInstance.state.errored).toBe(false);
-            expect(listInstance.state.loading).toBe(true);
+            expect(listInstance.state.loading).toBe(false);
         });
         it("errored", async function () {
             const listArgs = reactive({

package/use/listInstance.js

@@ -463,6 +463,10 @@ export function useListInstance({ props, functions = {}, keepOldPages }) {
 
     function clearList() {
         assignReactiveObject(state.objects, {});
+        // to avoid objectsInOrderRefs from being in a broken state
+        // for a tick or two, where all the elements are undefined
+        // we need to clear it as well
+        objectsInOrderRefs.value = [];
         loadingError.clearError();
     }
 

package/utils/classes.js

@@ -176,5 +176,13 @@ export const stringifyClass = (cls) => {
             .filter((key) => unref(/** @type {boolean | import('vue').Ref<boolean>} */ (cls[key])))
             .join(" ");
     }
+    if (isString(cls)) {
+        const arrayish = cls.split(/\s+/);
+        const unique = new Set(arrayish);
+        if (unique.size === arrayish.length) {
+            return cls;
+        }
+        return [...unique].join(" ");
+    }
     return cls;
 };