@arrai-innovations/reactive-helpers 14.1.0 → 16.0.0

package/docs/use/objectSubscription.md

@@ -225,7 +225,7 @@ A function to be used instead of the default crud retrieve function.
 
 ###### crud.subscribe()
 
-> **subscribe**: (`SubscribeArgs`) => `void`
+> **subscribe**: (`SubscribeArgs`) => `void` & `object`
 
 A function to be used instead of the default crud subscribe function.
 
@@ -235,7 +235,7 @@ A function to be used instead of the default crud subscribe function.
 
 ###### Returns
 
-`void`
+`void` & `object`
 
 ###### crud.update()
 

package/docs/utils/classes.md

@@ -59,7 +59,7 @@ Normalize various ways of specifying CSS classes into an object for use in Vue.j
 
 #### Parameters
 
-• ...**classes**: (`string` \| `string`[] \| `string`[][] \| `object` \| `Ref`\<`string` \| `string`[] \| `string`[][]\>)[]
+• ...**classes**: (`string` \| `string`[] \| `object` \| `string`[][] \| `Ref`\<`string` \| `string`[] \| `string`[][]\>)[]
 
 A mixed array containing multiple ways of specifying CSS classes.
 

package/docs/utils/keepAliveTry.md

@@ -0,0 +1,51 @@
+[**@arrai-innovations/reactive-helpers**](../README.md) • **Docs**
+
+***
+
+[@arrai-innovations/reactive-helpers](../README.md) / utils/keepAliveTry
+
+# utils/keepAliveTry
+
+## Functions
+
+### tryOnActivated()
+
+> **tryOnActivated**(`fn`, `target`?): `void`
+
+If there is an active component, set up an onActivated hook.
+
+#### Parameters
+
+• **fn**: `Function`
+
+The function to call.
+
+• **target?**: `any`
+
+The target to call the function on.
+
+#### Returns
+
+`void`
+
+***
+
+### tryOnDeactivated()
+
+> **tryOnDeactivated**(`fn`, `target`?): `void`
+
+If there is an active component, set up an onDeactivated hook.
+
+#### Parameters
+
+• **fn**: `Function`
+
+The function to call.
+
+• **target?**: `any`
+
+The target to call the function on.
+
+#### Returns
+
+`void`

package/index.js

@@ -28,6 +28,7 @@ export * from "./utils/compact.js";
 export * from "./utils/deleteKey.js";
 export * from "./utils/flattenPaths.js";
 export * from "./utils/getFakePk.js";
+export * from "./utils/keepAliveTry.js";
 export * from "./utils/keyDiff.js";
 export * from "./utils/loadingCombine.js";
 export * from "./utils/relatedCalculatedHelpers.js";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "14.1.0",
+    "version": "16.0.0",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "type": "module",
@@ -65,6 +65,7 @@
         "vue-deepunref": "^1.0.1"
     },
     "peerDependencies": {
+        "@vueuse/core": "^11.2.0",
         "lodash-es": "^4.17.21",
         "vue": "^3.4.30"
     }

package/tests/unit/config/listCrud.spec.js

@@ -30,7 +30,9 @@ describe("config/listCrud.js", () => {
              */
             const retrievedCrud = reactive({});
             expect(() => getListCrud(retrievedCrud)).not.toThrow();
-            expect(new Set(Object.keys(retrievedCrud))).toEqual(new Set(["list", "bulkDelete", "subscribe", "args"]));
+            expect(new Set(Object.keys(retrievedCrud))).toEqual(
+                new Set(["list", "bulkDelete", "executeAction", "subscribe", "args"])
+            );
             expect(retrievedCrud.args).not.toBe(crud.args);
             expect(retrievedCrud.args).toEqual(crud.args);
             expect(retrievedCrud.list).toBe(crud.list);

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

@@ -15,8 +15,8 @@ describe("use/listCalculated", () => {
         AwaitNot = watchesModule.AwaitNot;
     });
     it("should return a list of calculated items", async () => {
-        const mainListInstance = useListInstance({ props: { pkKey: "id" } });
-        const calculatedListInstance = useListInstance({ props: { pkKey: "id" } });
+        const mainListInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
+        const calculatedListInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
         mainListInstance.addListObject({
             id: "1",
             name: "main",
@@ -77,8 +77,8 @@ describe("use/listCalculated", () => {
         });
     });
     it("should allow calculated objects to return results based on related objects", async () => {
-        const mainListInstance = useListInstance({ props: { pkKey: "id" } });
-        const relatedListInstance = useListInstance({ props: { pkKey: "id" } });
+        const mainListInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
+        const relatedListInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
         mainListInstance.addListObject({
             id: "1",
             name: "main",

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

@@ -19,7 +19,7 @@ describe("use/listFilter", () => {
     });
 
     it("should match an allowed filter function", async () => {
-        const list = useListInstance({ props: { pkKey: "id" } });
+        const list = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
         const filter = useListFilter({
             parentState: list.state,
             allowedFilter: (object) => object.id === 1 || object.id === 3,
@@ -65,7 +65,7 @@ describe("use/listFilter", () => {
         });
     });
     it("should match an excluded filter function", async () => {
-        const list = useListInstance({ props: { pkKey: "id" } });
+        const list = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
         const filter = useListFilter({
             parentState: list.state,
             excludedFilter: (object) => object.id == 2 || object.id == 4,
@@ -111,7 +111,7 @@ describe("use/listFilter", () => {
         });
     });
     it("no args: returns objects unfiltered", async () => {
-        const listInstance = useListInstance({ props: { pkKey: "id" } });
+        const listInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
         const listItems = [
             { id: 4, name: "four", has_things: true },
             { id: 2, name: "two", has_things: true },
@@ -135,7 +135,7 @@ describe("use/listFilter", () => {
             vi.resetAllMocks();
             const orderByRules = [{ key: "name", desc: true, localeCompare: false }];
             const sortThrottleWait = 0;
-            const listInstance = useListInstance({ props: { pkKey: "id" } });
+            const listInstance = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
             const listItems = [
                 { id: 4, name: "four", has_things: true },
                 { id: 2, name: "two", has_things: true },
@@ -177,6 +177,7 @@ describe("use/listFilter", () => {
                         fields,
                     },
                 },
+                keepOldPages: false,
             });
             const listInstanceB = useListInstance({
                 props: {
@@ -186,6 +187,7 @@ describe("use/listFilter", () => {
                         fields,
                     },
                 },
+                keepOldPages: false,
             });
             const excludedFilter = (object) => object.id === 1 || object.name === "three";
             const allowedFilter = (object) => object.id === 2 || object.name === "four";
@@ -223,7 +225,7 @@ describe("use/listFilter", () => {
     });
     describe("useListFilters updates index when", () => {
         it("parentInstance.objects is updated", async () => {
-            const list = useListInstance({ props: { pkKey: "id" } });
+            const list = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
             const filter = useListFilter({
                 parentState: list.state,
                 allowedFilter: (object) => !!object.allowed?.every((e) => e),
@@ -264,8 +266,8 @@ describe("use/listFilter", () => {
             });
         });
         it("parentInstance.relatedObjects is updated", async () => {
-            const list = useListInstance({ props: { pkKey: "id" } });
-            const relatedList = useListInstance({ props: { pkKey: "id" } });
+            const list = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
+            const relatedList = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
             const related = useListRelated({
                 parentState: list.state,
                 relatedObjectsRules: {
@@ -320,7 +322,7 @@ describe("use/listFilter", () => {
             });
         });
         it("parentInstance.calculatedObjects is updated", async () => {
-            const list = useListInstance({ props: { pkKey: "id" } });
+            const list = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
             const calculated = useListCalculated({
                 parentState: list.state,
                 calculatedObjectsRules: reactive({
@@ -364,7 +366,7 @@ describe("use/listFilter", () => {
         });
     });
     it("you can use nested useListFilters", async () => {
-        const list = useListInstance({ props: { pkKey: "id" } });
+        const list = useListInstance({ props: { pkKey: "id" }, keepOldPages: false });
 
         function filter1AllowedFilter(object) {
             return object.has_things && object.has_stuff;