@arrai-innovations/reactive-helpers 2.1.0 → 2.1.2

package/package.json

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

package/use/listInstance.js

@@ -152,6 +152,11 @@ export function useListInstance({ crudArgs, listArgs = {}, retrieveArgs = {} })
         return getFakeId(state.objects);
     }
 
+    function clearError() {
+        state.errored = false;
+        state.error = null;
+    }
+
     const es = effectScope();
 
     es.run(() => {
@@ -165,10 +170,11 @@ export function useListInstance({ crudArgs, listArgs = {}, retrieveArgs = {} })
         updateListObject,
         deleteListObject,
         clearList,
-        effectScope: es,
+        clearError,
         getFakeId: ourGetFakeId,
         defaultPageCallback,
         pageCallback: defaultPageCallback,
+        effectScope: es,
     };
     return returnedObject;
 }

package/use/listSubscription.js

@@ -4,6 +4,7 @@ import { cloneDeep, isEmpty, isObject } from "lodash";
 import { assignReactiveObject } from "../utils/assignReactiveObject";
 import inspect from "browser-util-inspect";
 import { useCancellableIntent } from "../utils/cancellableIntent";
+import loadingCombine from "../utils/loadingCombine";
 
 export class ListSubscriptionError extends Error {
     constructor(message) {
@@ -137,10 +138,16 @@ export function useListSubscription({ listInstance, crudArgs, listArgs, retrieve
         }
     }
 
+    function clearErrors() {
+        state.subscriptionErrored = false;
+        state.subscriptionError = null;
+        listInstance.clearErrors();
+    }
+
     const es = effectScope();
 
     es.run(() => {
-        state.loading = computed(() => listInstance.state.loading || state.subscriptionLoading);
+        state.loading = computed(() => loadingCombine(listInstance.state.loading, state.subscriptionLoading));
         state.errored = computed(() => listInstance.state.errored || state.subscriptionErrored);
         state.error = computed(() => listInstance.state.error || state.subscriptionError);
 
@@ -190,6 +197,7 @@ export function useListSubscription({ listInstance, crudArgs, listArgs, retrieve
         subscribeIntent,
         subscribe: publicSubscribe,
         unsubscribe: publicUnsubscribe,
+        clearErrors,
         effectScope: es,
     };
 }

package/use/objectInstance.js

@@ -209,6 +209,11 @@ export function useObjectInstance({ crudArgs, id, retrieveArgs }) {
             });
     }
 
+    function clearError() {
+        state.errored = false;
+        state.error = null;
+    }
+
     const es = effectScope();
 
     // we could have effects? let's keep the interface to keep our options open to add without major changes.
@@ -221,6 +226,7 @@ export function useObjectInstance({ crudArgs, id, retrieveArgs }) {
         update,
         patch,
         delete: deleteFn,
+        clearError,
         effectScope: es,
     };
 }

package/use/objectSubscription.js

@@ -3,6 +3,7 @@ import { computed, effectScope, reactive, toRef } from "vue";
 import { assignReactiveObject } from "../utils/assignReactiveObject";
 import { useObjectInstance } from "./objectInstance";
 import { useCancellableIntent } from "../utils/cancellableIntent";
+import loadingCombine from "../utils/loadingCombine";
 
 export class ObjectSubscriptionError extends Error {
     constructor(message) {
@@ -146,10 +147,16 @@ export function useObjectSubscription({ objectInstance, crudArgs, id, retrieveAr
         return didUnsubscribe;
     }
 
+    function clearError() {
+        state.subscriptionErrored = false;
+        state.subscriptionError = null;
+        objectInstance.clearError();
+    }
+
     const es = effectScope();
 
     es.run(() => {
-        state.loading = computed(() => objectInstance.state.loading || state.subscriptionLoading);
+        state.loading = computed(() => loadingCombine(objectInstance.state.loading, state.subscriptionLoading));
         state.errored = computed(() => objectInstance.state.errored || state.subscriptionErrored);
         state.error = computed(() => objectInstance.state.error || state.subscriptionError);
 
@@ -178,6 +185,7 @@ export function useObjectSubscription({ objectInstance, crudArgs, id, retrieveAr
         unsubscribe: publicUnsubscribe,
         updateFromSubscription,
         deleteFromSubscription,
+        clearError,
         effectScope: es,
     };
 }

package/utils/loadingCombine.js

@@ -0,0 +1,13 @@
+export default function (...loadingStates) {
+    // loadingStates is an array of booleans or undefined
+    // if any true, return true
+    // if all undefined, return undefined
+    // otherwise return false (all false)
+    if (loadingStates.some((loadingState) => loadingState === true)) {
+        return true;
+    }
+    if (loadingStates.every((loadingState) => loadingState === undefined)) {
+        return undefined;
+    }
+    return false;
+}