@arrai-innovations/reactive-helpers 13.0.2 → 13.0.4

package/use/listInstance.js

@@ -51,7 +51,12 @@ export class ListInstanceError extends Error {
  * @typedef {object} ListInstanceOptions
  * @property {import('vue').UnwrapNestedRefs<ListInstanceProps>} props - The props for the list instance.
  * @property {object} [functions] - Default implementation are used as set by `setListCrud`.
- * @property {Function} [functions.list] - Provide the implementation for the list function.
+ * @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.
  */
 
@@ -251,6 +256,7 @@ export function useListInstance({ props, functions = {}, keepOldPages = false })
         crud: {
             args: {},
             list: undefined,
+            bulkDelete: undefined,
         },
         retrieveArgs: toRef(props, "retrieveArgs"),
         listArgs: toRef(props, "listArgs"),
@@ -289,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) {
@@ -313,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 () => {
@@ -419,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",

package/use/loadingError.js

@@ -5,20 +5,27 @@ import { readonly, ref } from "vue";
  */
 
 /**
- * A composable function for managing loading and error states.
- *
- * @returns {object} - An object containing reactive fields and actions for loading and error states.
- * @property {import("vue").Ref<boolean|undefined>} loading - Whether the component is loading.
- * @property {import("vue").Ref<Error|null>} error - The error that occurred.
- * @property {import("vue").Ref<boolean>} errored - Whether an error has occurred.
+ * @typedef {object} LoadingError
+ * @property {Readonly<import("vue").Ref<boolean|undefined>>} loading - Whether the component is loading.
+ * @property {Readonly<import("vue").Ref<Error|null>>} error - The error that occurred.
+ * @property {Readonly<import("vue").Ref<boolean>>} errored - Whether an error has occurred.
  * @property {() => void} setLoading - Set the loading state.
  * @property {() => void} clearLoading - Clear the loading state.
  * @property {(error) => void} setError - Set the error state.
  * @property {() => void} clearError - Clear the error state.
  */
+
+/**
+ * A composable function for managing loading and error states.
+ *
+ * @returns {LoadingError} - An object containing reactive fields and actions for loading and error states.
+ */
 export function useLoadingError() {
+    /** @type {import("vue").Ref<boolean|undefined>} */
     const loading = ref(undefined);
+    /** @type {import("vue").Ref<Error|null>} */
     const error = ref(null);
+    /** @type {import("vue").Ref<boolean>} */
     const errored = ref(false);
 
     return {