@arrai-innovations/reactive-helpers 13.0.2 → 13.0.4

package/docs/use/objectInstance.md

@@ -135,42 +135,90 @@ The arguments to be passed to the crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crudArgs.create
+###### crudArgs.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crudArgs.delete
+###### Parameters
 
-> **delete**: `Function`
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crudArgs.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crudArgs.patch
+###### Parameters
 
-> **patch**: `Function`
+• **DeleteDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crudArgs.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crudArgs.retrieve
+###### Parameters
+
+• **PartialDetailArgs**: `any`
 
-> **retrieve**: `Function`
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crudArgs.retrieve()
+
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crudArgs.subscribe
+###### Parameters
+
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crudArgs.subscribe()
 
-> **subscribe**: `Function`
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crudArgs.update
+###### Parameters
 
-> **update**: `Function`
+• **SubscribeArgs**: `any`
+
+###### Returns
+
+`void`
+
+###### crudArgs.update()
+
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### id
 
 > **id**: `string`
@@ -207,42 +255,90 @@ The crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crud.create
+###### crud.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crud.delete
+###### Parameters
 
-> **delete**: `Function`
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crud.patch
+###### Parameters
 
-> **patch**: `Function`
+• **DeleteDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crud.retrieve
+###### Parameters
+
+• **PartialDetailArgs**: `any`
 
-> **retrieve**: `Function`
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.retrieve()
+
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crud.subscribe
+###### Parameters
+
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.subscribe()
 
-> **subscribe**: `Function`
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crud.update
+###### Parameters
 
-> **update**: `Function`
+• **SubscribeArgs**: `any`
+
+###### Returns
+
+`void`
+
+###### crud.update()
+
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### deleted
 
 > **deleted**: `boolean`

package/docs/use/objectRelated.md

@@ -36,42 +36,90 @@ The crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crud.create
+###### crud.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crud.delete
+###### Parameters
 
-> **delete**: `Function`
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crud.patch
+###### Parameters
+
+• **DeleteDetailArgs**: `any`
+
+###### Returns
 
-> **patch**: `Function`
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crud.retrieve
+###### Parameters
+
+• **PartialDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.retrieve()
 
-> **retrieve**: `Function`
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crud.subscribe
+###### Parameters
 
-> **subscribe**: `Function`
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.subscribe()
+
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crud.update
+###### Parameters
+
+• **SubscribeArgs**: `any`
+
+###### Returns
 
-> **update**: `Function`
+`void`
+
+###### crud.update()
+
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### deleted
 
 > **deleted**: `boolean`
@@ -168,42 +216,90 @@ The crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crud.create
+###### crud.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crud.delete
+###### Parameters
 
-> **delete**: `Function`
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crud.patch
+###### Parameters
+
+• **DeleteDetailArgs**: `any`
+
+###### Returns
 
-> **patch**: `Function`
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crud.retrieve
+###### Parameters
+
+• **PartialDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.retrieve()
 
-> **retrieve**: `Function`
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crud.subscribe
+###### Parameters
 
-> **subscribe**: `Function`
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.subscribe()
+
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crud.update
+###### Parameters
+
+• **SubscribeArgs**: `any`
+
+###### Returns
 
-> **update**: `Function`
+`void`
+
+###### crud.update()
+
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### deleted
 
 > **deleted**: `boolean`

package/docs/use/objectSubscription.md

@@ -167,42 +167,90 @@ The crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crud.create
+###### crud.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crud.delete
+###### Parameters
+
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
 
-> **delete**: `Function`
+###### crud.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crud.patch
+###### Parameters
+
+• **DeleteDetailArgs**: `any`
+
+###### Returns
 
-> **patch**: `Function`
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crud.retrieve
+###### Parameters
 
-> **retrieve**: `Function`
+• **PartialDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.retrieve()
+
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crud.subscribe
+###### Parameters
 
-> **subscribe**: `Function`
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.subscribe()
+
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crud.update
+###### Parameters
+
+• **SubscribeArgs**: `any`
+
+###### Returns
+
+`void`
+
+###### crud.update()
 
-> **update**: `Function`
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### deleted
 
 > **deleted**: `boolean`

package/index.js

@@ -1,3 +1,4 @@
+// don't use default exports. it is easier if each file defines the canonical name for the function it exports.
 export * from "./config/listCrud.js";
 export * from "./config/objectCrud.js";
 export * from "./use/cancellableIntent.js";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "13.0.2",
+    "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/combineClasses.js

@@ -15,6 +15,15 @@ import { isRef, ref, watch, isReactive } from "vue";
  */
 const isRefOrReactive = (v) => isRef(v) || isReactive(v);
 
+/**
+ * @typedef {(
+ *     string |
+ *     string[] |
+ *     { [key: string]: boolean | import("vue").Ref<boolean> } |
+ *     import("vue").Ref<string | string[]>
+ * )} CSSClasses
+ */
+
 /**
  * Normalize various ways of specifying CSS classes into an object for use in Vue.js with reactivity. If refs are
  *  present, the resulting object will be a ref containing an array of objects to preserve order of operations in
@@ -40,12 +49,7 @@ const isRefOrReactive = (v) => isRef(v) || isReactive(v);
  * </script>
  * ```
  *
- * @param {...(
- *     string |
- *     string[] |
- *     { [key: string]: boolean | import("vue").Ref<boolean> } |
- *     import("vue").Ref<string | string[]>
- * )} classes - A mixed array containing multiple ways of specifying CSS classes.
+ * @param {...(CSSClasses)} classes - A mixed array containing multiple ways of specifying CSS classes.
  * @returns {import("vue").Ref<import('../utils/classes.js').CombinedClasses>} - A ref
  *  containing an object or array of objects containing CSS classes. Arrays are used if refs are present, to
  *  preserve order of operations in reactive contexts.