@arrai-innovations/reactive-helpers 8.3.2 → 8.4.0

package/README.md

@@ -447,7 +447,14 @@ We make use of the basic set operations provided as example on mdn:
 https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set#implementing_basic_set_operations
 
 ```js
-import { isSuperset, union, intersection, symmetricDifference, difference } from "@arrai-innovations/reactive-helpers";
+import {
+    isSuperset,
+    union,
+    intersection,
+    symmetricDifference,
+    difference,
+    equals,
+} from "@arrai-innovations/reactive-helpers";
 
 isSuperset(new Set([1, 2, 3, 4]), new Set([1, 2, 3])); // true
 union(new Set([1, 2, 3, 4]), new Set([1, 2, 3])); // Set { 1, 2, 3, 4 }
@@ -455,6 +462,7 @@ intersection(new Set([1, 2, 3, 4]), new Set([1, 2, 3])); // Set { 1, 2, 3 }
 symmetricDifference(new Set([1, 2, 3, 4]), new Set([1, 2, 3, 5])); // Set { 4, 5 }
 difference(new Set([1, 2, 3, 4]), new Set([1, 2, 3, 5])); // Set { 4 }
 difference(new Set([1, 2, 3, 5]), new Set([1, 2, 3, 4])); // Set { 5 }
+equals(new Set([1, 2, 3, 4]), new Set([1, 2, 3, 5])); // false
 ```
 
 #### watches

package/package.json

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

package/tests/unit/utils/set.spec.js

@@ -1,4 +1,4 @@
-import { difference, intersection, isSuperset, symmetricDifference, union } from "../../../utils/set.js";
+import { difference, intersection, isSuperset, symmetricDifference, union, equals } from "../../../utils/set.js";
 
 describe("utils/set", function () {
     describe("isSuperset", function () {
@@ -57,6 +57,18 @@ describe("utils/set", function () {
             expect(difference(set2, set1)).toEqual(new Set([5, 6]));
         });
     });
+    describe("equals", function () {
+        it("should return true if the two sets are equal", function () {
+            const set1 = new Set([1, 2, 3, 4]);
+            const set2 = new Set([1, 2, 3, 4]);
+            expect(equals(set1, set2)).toBe(true);
+        });
+        it("should return false if the two sets are not equal", function () {
+            const set1 = new Set([1, 2, 3, 4]);
+            const set2 = new Set([1, 2, 3, 5]);
+            expect(equals(set1, set2)).toBe(false);
+        });
+    });
     it("should work as in the example for the readme", function () {
         expect(isSuperset(new Set([1, 2, 3, 4]), new Set([1, 2, 3]))).toBe(true);
         expect(union(new Set([1, 2, 3, 4]), new Set([1, 2, 3]))).toEqual(new Set([1, 2, 3, 4]));
@@ -64,5 +76,6 @@ describe("utils/set", function () {
         expect(symmetricDifference(new Set([1, 2, 3, 4]), new Set([1, 2, 3, 5]))).toEqual(new Set([4, 5]));
         expect(difference(new Set([1, 2, 3, 4]), new Set([1, 2, 3, 5]))).toEqual(new Set([4]));
         expect(difference(new Set([1, 2, 3, 5]), new Set([1, 2, 3, 4]))).toEqual(new Set([5]));
+        expect(equals(new Set([1, 2, 3, 4]), new Set([1, 2, 3, 5]))).toBe(false);
     });
 });

package/use/objectSubscription.js

@@ -175,7 +175,7 @@ export function useObjectSubscription({
             awaitableWithCancel: subscribe,
             watchArguments: reactive({
                 intendToSubscribe: toRef(state, "intendToSubscribe"),
-                listArgs: toRef(parentState, "id"),
+                id: toRef(parentState, "id"),
                 retrieveArgs: toRef(parentState, "retrieveArgs"),
             }),
             clearActiveOnResolved: false,
@@ -184,10 +184,15 @@ export function useObjectSubscription({
         retrieveIntent = useCancellableIntent({
             awaitableWithCancel: objectInstance.retrieve,
             watchArguments: reactive({
-                intendToSubscribe: toRef(state, "intendToRetrieve"),
-                listArgs: toRef(parentState, "id"),
+                intendToRetrieve: toRef(state, "intendToRetrieve"),
+                id: toRef(parentState, "id"),
                 retrieveArgs: toRef(parentState, "retrieveArgs"),
             }),
+            // delay triggering a retrieve until the last retrieve has finished/cancelled
+            // cancel can still be triggered
+            guardArguments: reactive({
+                loading: toRef(state, "loading"),
+            }),
         });
     });
 

package/utils/set.js

@@ -46,3 +46,7 @@ export const difference = (setA, setB) => {
     }
     return _difference;
 };
+
+export const equals = (setA, setB) => {
+    return setA.size === setB.size && isSuperset(setA, setB);
+};