@arrai-innovations/reactive-helpers 11.2.0 → 11.3.0

package/docs.md

@@ -686,12 +686,13 @@ The configuration options used to create a list subscription.
 **Kind**: global typedef  
 **Properties**
 
-| Name         | Type             | Description                                                                              |
-| ------------ | ---------------- | ---------------------------------------------------------------------------------------- |
-| props        | `object`         | passed on to a created list instance if one is not provided                              |
-| functions    | `object`         | passed on to a created list instance if one is not provided                              |
-| listInstance | [`ListInstance`] | a list instance to use instead of creating one                                           |
-| keepOldPages | `boolean`        | if true, pages will not be cleared when defaultPageCallback is called. default is false. |
+| Name                           | Type             | Description                                                                              |
+| ------------------------------ | ---------------- | ---------------------------------------------------------------------------------------- |
+| props                          | `object`         | passed on to a created list instance if one is not provided                              |
+| functions                      | `object`         | passed on to a created list instance if one is not provided                              |
+| listInstance                   | [`ListInstance`] | a list instance to use instead of creating one                                           |
+| keepOldPages                   | `boolean`        | if true, pages will not be cleared when defaultPageCallback is called. default is false. |
+| clearListOnListIntentTriggered | `boolean`        | if true, the list will be cleared when the list intent is triggered. default is false.   |
 
 ## ListSubscriptionState
 

package/package.json

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

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

@@ -615,4 +615,52 @@ describe("use/listSubscription.spec.js", function () {
         expect(inspect(listSubscription.A)).toEqual(inspect(listSubscriptionA));
         expect(inspect(listSubscription.B)).toEqual(inspect(listSubscriptionB));
     });
+    describe("clearListOnListIntentTriggered true", function () {
+        it("on true", async function () {
+            crudSubscribeResolvable[0].promise.cancel.mockImplementation(() => Promise.resolve(true));
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields: fields,
+            });
+            const listInstance = useListInstance({
+                props: { listArgs, retrieveArgs },
+            });
+            listInstance.clearList = vi.fn().mockImplementationOnce(() => undefined);
+            const listSubscription = useListSubscription({
+                listInstance,
+                clearListOnListIntentTriggered: true,
+            });
+            listSubscription.subscribe();
+            await nextTick();
+            await flushPromises();
+            listArgs.user = 2;
+            expect(listInstance.clearList).toHaveBeenCalledTimes(1);
+        });
+    });
+    describe("clearListOnListIntentTriggered false", function () {
+        it("on true", async function () {
+            crudSubscribeResolvable[0].promise.cancel.mockImplementation(() => Promise.resolve(true));
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields: fields,
+            });
+            const listInstance = useListInstance({
+                props: { listArgs, retrieveArgs },
+            });
+            listInstance.clearList = vi.fn().mockImplementationOnce(() => undefined);
+            const listSubscription = useListSubscription({
+                listInstance,
+                clearListOnListIntentTriggered: false,
+            });
+            listSubscription.subscribe();
+            await nextTick();
+            await flushPromises();
+            listArgs.user = 2;
+            expect(listInstance.clearList).toHaveBeenCalledTimes(0);
+        });
+    });
 });

package/use/list.js

@@ -31,6 +31,7 @@ export const useList = ({
     functions = {},
     paged = false,
     keepOldPages = false,
+    clearListOnListIntentTriggered = false,
     searchThrottle = 500,
     sortThrottleWait,
     searchShowAllWhenEmpty,
@@ -63,6 +64,7 @@ export const useList = ({
 
         managed.listSubscription = useListSubscription({
             listInstance: managed.listInstance,
+            clearListOnListIntentTriggered,
         });
         managed.listSubscription.state.intendToList = toRef(props, "intendToList");
         managed.listSubscription.state.intendToSubscribe = toRef(props, "intendToSubscribe");

package/use/listSubscription.js

@@ -22,6 +22,7 @@ export class ListSubscriptionError extends Error {
  * @property {object} functions - passed on to a created list instance if one is not provided
  * @property {ListInstance} listInstance - a list instance to use instead of creating one
  * @property {boolean} keepOldPages - if true, pages will not be cleared when defaultPageCallback is called. default is false.
+ * @property {boolean} clearListOnListIntentTriggered - if true, the list will be cleared when the list intent is triggered. default is false.
  */
 
 /* eslint-disable jsdoc/check-types */
@@ -70,7 +71,13 @@ export function useListSubscriptions(args, listInstances = {}) {
  * @param {ListSubscriptionOptions} options - the configuration options for the list subscription
  * @returns {ListSubscription} - the list subscription
  */
-export function useListSubscription({ listInstance, props, functions, keepOldPages = false }) {
+export function useListSubscription({
+    listInstance,
+    props,
+    functions,
+    keepOldPages = false,
+    clearListOnListIntentTriggered = false,
+}) {
     if (!listInstance && !props) {
         throw new ListSubscriptionError("useListSubscription should be passed listInstance or props and functions.");
     }
@@ -233,7 +240,12 @@ export function useListSubscription({ listInstance, props, functions, keepOldPag
         state.subscribed = toRef(subscribeIntent.state, "active");
 
         listIntent = useCancellableIntent({
-            awaitableWithCancel: listInstance.list,
+            awaitableWithCancel: () => {
+                if (clearListOnListIntentTriggered) {
+                    listInstance.clearList();
+                }
+                return listInstance.list();
+            },
             watchArguments: reactive({
                 intendToList: toRef(state, "intendToList"),
                 listArgs: toRef(parentState, "listArgs"),