@arrai-innovations/reactive-helpers 13.0.3 → 13.0.4

package/config/listCrud.js

@@ -12,6 +12,7 @@ import { isReactive, toRef } from "vue";
 const defaultCrud = {
     args: {},
     list: undefined,
+    bulkDelete: undefined,
     subscribe: undefined,
 };
 
@@ -39,6 +40,12 @@ const defaultCrud = {
  *  been cancelled.
  */
 
+/**
+ * @typedef {object} DeleteFnArgs
+ * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @property {string[]} ids - The ids of the objects to be deleted.
+ */
+
 /**
  * @typedef {(
  *     newOrUpdatedOrDeleteObject:import('../use/listInstance.js').ListObject|string,
@@ -58,6 +65,10 @@ const defaultCrud = {
  * @typedef {(ListFnArgs)=>void} ListFn
  */
 
+/**
+ * @typedef {(DeleteFnArgs)=>void} BulkDeleteFn
+ */
+
 /**
  * @typedef {(SubscribeFnArgs)=>void} SubscribeFn
  */
@@ -65,6 +76,7 @@ const defaultCrud = {
 /**
  * @typedef {object} ListCrudFunctions
  * @property {ListFn} [list] - The list function to get a list of items.
+ * @property {BulkDeleteFn} [bulkDelete] - The delete function to bulk delete a list of items.
  * @property {SubscribeFn} [subscribe] - The subscribe function to get a subscription to a list of items.
  */
 
@@ -80,9 +92,10 @@ const defaultCrud = {
  * @throws {Error} - If unknown keys are passed.
  * @returns {void}
  */
-export const setListCrud = ({ list, subscribe, args = {}, ...rest }) => {
+export const setListCrud = ({ list, bulkDelete, subscribe, args = {}, ...rest }) => {
     defaultCrud.list = list;
     defaultCrud.subscribe = subscribe;
+    defaultCrud.bulkDelete = bulkDelete;
     Object.assign(defaultCrud.args, cloneDeep(args));
     if (Object.keys(rest).length) {
         throw new Error(`Unknown key(s) passed to setListCrud: ${Object.keys(rest).join(", ")}`);

package/docs/config/listCrud.md

@@ -8,6 +8,24 @@
 
 ## Interfaces
 
+### DeleteFnArgs
+
+#### Properties
+
+##### crudArgs
+
+> **crudArgs**: `any`
+
+The arguments to be passed to the crud functions.
+
+##### ids
+
+> **ids**: `string`[]
+
+The ids of the objects to be deleted.
+
+***
+
 ### ListCrudArgs
 
 #### Properties
@@ -24,6 +42,12 @@ The default arguments for the crud functions.
 
 #### Properties
 
+##### bulkDelete
+
+> **bulkDelete**: [`BulkDeleteFn`](listCrud.md#bulkdeletefn)
+
+The delete function to bulk delete a list of items.
+
 ##### list
 
 > **list**: [`ListFn`](listCrud.md#listfn)
@@ -129,6 +153,22 @@ The method to call when new data is received.
 
 ## Type Aliases
 
+### BulkDeleteFn()
+
+> **BulkDeleteFn**\<\>: (`DeleteFnArgs`) => `void`
+
+#### Type Parameters
+
+#### Parameters
+
+• **DeleteFnArgs**: `any`
+
+#### Returns
+
+`void`
+
+***
+
 ### ListFn()
 
 > **ListFn**\<\>: (`ListFnArgs`) => `void`
@@ -213,6 +253,10 @@ The reactive crud object, which will be mutated.
 
 The default arguments for the crud functions.
 
+• **reactiveCrud.bulkDelete**: [`BulkDeleteFn`](listCrud.md#bulkdeletefn)
+
+The delete function to bulk delete a list of items.
+
 • **reactiveCrud.list**: [`ListFn`](listCrud.md#listfn)
 
 The list function to get a list of items.

package/docs/use/listInstance.md

@@ -175,6 +175,13 @@ Updates an object in the list.
 
 Default implementation are used as set by `setListCrud`.
 
+###### bulkDelete
+
+> **bulkDelete**: [`BulkDeleteFn`](../config/listCrud.md#bulkdeletefn)
+
+Provide the implementation for the bulkDelete
+ function.
+
 ###### list
 
 > **list**: [`ListFn`](../config/listCrud.md#listfn)

package/package.json

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

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

@@ -30,7 +30,7 @@ describe("config/listCrud.js", () => {
              */
             const retrievedCrud = reactive({});
             expect(() => getListCrud(retrievedCrud)).not.toThrow();
-            expect(new Set(Object.keys(retrievedCrud))).toEqual(new Set(["list", "subscribe", "args"]));
+            expect(new Set(Object.keys(retrievedCrud))).toEqual(new Set(["list", "bulkDelete", "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/listInstance.spec.js

@@ -11,15 +11,17 @@ afterAll(() => {
 
 const fields = ["id", "__str__", "name"];
 describe("use/listInstance.spec.js", function () {
-    let useListInstance, ListInstanceError, useListInstances, globalList;
+    let useListInstance, ListInstanceError, useListInstances, globalList, globalbulkDelete;
     beforeEach(async () => {
         const listCrud = await import("../../../config/listCrud.js");
         const imported = await import("../../../use/listInstance.js");
         globalList = vi.fn();
+        globalbulkDelete = vi.fn(() => Promise.resolve(true));
         // @ts-ignore
         globalList.cancel = vi.fn();
         listCrud.setListCrud({
             list: globalList,
+            bulkDelete: globalbulkDelete,
             args: { stream: "test_stream" },
         });
         useListInstance = imported.useListInstance;
@@ -513,6 +515,52 @@ describe("use/listInstance.spec.js", function () {
             expect(listInstance.state.order).toEqual(["2", "3"]);
         });
     });
+    describe("bulkDelete", function () {
+        it("succeeds", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields,
+            });
+            const listInstance = useListInstance({ props: { listArgs, retrieveArgs } });
+            let crudListResolve;
+            const crudListPromise = new Promise((resolve) => {
+                crudListResolve = resolve;
+            });
+            let passedPageCallback;
+            globalList.mockImplementation(({ pageCallback }) => {
+                passedPageCallback = pageCallback;
+                return crudListPromise;
+            });
+            const liListResolve = listInstance.list();
+            await nextTick();
+            // @ts-ignore - pageCallback is set in the mock, if not it will throw which is what we want
+            passedPageCallback(crudListResolvedPage2);
+            // @ts-ignore - crudListResolve is set in a promise, since we await this will be set
+            crudListResolve();
+            await flushPromises();
+            await expect(liListResolve).resolves.toBe(true);
+
+            expect({ ...listInstance.state.objects }).toEqual(crudListResolvedObjects2);
+            const bulkDeleteResolve = listInstance.bulkDelete();
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+            expect(globalbulkDelete).toHaveBeenCalledWith({
+                crudArgs: { stream: "test_stream" },
+                ids: Object.keys(crudListResolvedObjects2).map(Number),
+            });
+
+            expect(globalbulkDelete).toHaveBeenCalledTimes(1);
+
+            // @ts-ignore - bulkDeleteResolve is set in a promise, since we await this will be set
+            crudListResolve();
+            await flushPromises();
+            await expect(bulkDeleteResolve).resolves.toBe(true);
+            expect({ ...listInstance.state.objects }).toEqual({});
+        });
+    });
     describe("getFakeId", function () {
         it("returns fakeId", function () {
             const listInstance = useListInstance({ props: {} });

package/use/listInstance.js

@@ -53,6 +53,8 @@ export class ListInstanceError extends Error {
  * @property {object} [functions] - Default implementation are used as set by `setListCrud`.
  * @property {import('../config/listCrud.js').ListFn} [functions.list] - Provide the implementation for the list
  *  function.
+ *  @property {import('../config/listCrud.js').BulkDeleteFn} [functions.bulkDelete] - Provide the implementation for the bulkDelete
+ *  function.
  * @property {import('../config/listCrud.js').SubscribeFn} [functions.subscribe] - Provide the implementation for the
  *  subscribe function.
  * @property {boolean} [keepOldPages=false] - If true, pages will not be cleared when defaultPageCallback is called.
@@ -254,6 +256,7 @@ export function useListInstance({ props, functions = {}, keepOldPages = false })
         crud: {
             args: {},
             list: undefined,
+            bulkDelete: undefined,
         },
         retrieveArgs: toRef(props, "retrieveArgs"),
         listArgs: toRef(props, "listArgs"),
@@ -292,6 +295,31 @@ export function useListInstance({ props, functions = {}, keepOldPages = false })
         list: null,
     };
 
+    async function bulkDeleteFn() {
+        if (state.loading) {
+            return Promise.reject(new ListInstanceError("already loading.", "already-loading"));
+        }
+        loadingError.setLoading();
+        loadingError.clearError();
+        return state.crud
+            .bulkDelete({
+                crudArgs: state.crud.args,
+                ids: Object.keys(state.objects).map(Number),
+            })
+            .then(() => {
+                assignReactiveObject(state.objects, {});
+                loadingError.clearError();
+                return Promise.resolve(true);
+            })
+            .catch((error) => {
+                loadingError.setError(error);
+                return Promise.resolve(false);
+            })
+            .finally(() => {
+                loadingError.clearLoading();
+            });
+    }
+
     function list() {
         // this function cannot be async, or the resulting promise will lose its .cancel() method
         if (promises.list) {
@@ -316,6 +344,7 @@ export function useListInstance({ props, functions = {}, keepOldPages = false })
             pageCallback: returnedObject.pageCallback,
             isCancelled: readonly(isCancelled),
         });
+
         let resolveState = false;
         if (listPromise.cancel) {
             promises.list.cancel = async () => {
@@ -422,6 +451,7 @@ export function useListInstance({ props, functions = {}, keepOldPages = false })
     const returnedObject = {
         state,
         list,
+        bulkDelete: bulkDeleteFn,
         addListObject,
         updateListObject,
         deleteListObject,

package/use/listKeys.js

@@ -17,6 +17,7 @@ export const listInstanceStateKeys = [
 ];
 export const listInstanceFunctions = [
     "list",
+    "bulkDelete",
     "addListObject",
     "updateListObject",
     "deleteListObject",