@arrai-innovations/reactive-helpers 3.0.0 → 3.1.0

package/package.json

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

package/use/index.js

@@ -1,3 +1,4 @@
+export * from "./cancellableIntent.js";
 export * from "./listCalculated.js";
 export * from "./listFilter.js";
 export * from "./listInstance.js";
@@ -11,3 +12,4 @@ export * from "./objectRelated.js";
 export * from "./objectSubscription.js";
 export * from "./paginatedListInstance.js";
 export * from "./search.js";
+export * from "./watchesRunning.js";

package/use/listCalculated.js

@@ -1,6 +1,7 @@
 import { isEmpty } from "lodash";
 import { computed, effectScope, onScopeDispose, reactive, toRef, watch } from "vue";
-import { keyDiff } from "../utils";
+import { keyDiff, loadingCombine } from "../utils";
+import { useWatchesRunning } from "./watchesRunning";
 
 export function useListCalculateds(instances, args) {
     for (const [key, value] of Object.entries(args)) {
@@ -23,6 +24,8 @@ export function useListCalculated({
         calculatedObjectsRules,
         calculatedObjectsObjects: {},
         objects: {},
+        parentStateObjectsWatchRunning: false,
+        calculatedObjectsWatchRunning: false,
     });
     const calculatedObjectsEffectScopes = {};
 
@@ -56,6 +59,7 @@ export function useListCalculated({
                 },
             });
         }
+        state.parentStateObjectsWatchRunning = false;
     }
 
     function calculatedObjectsWatch() {
@@ -98,9 +102,12 @@ export function useListCalculated({
             }
             calculatedObjectsEffectScopes[objectKey] = calculatedObjectsEffectScope;
         }
+        state.calculatedObjectsWatchRunning = false;
         parentStateObjectsWatch();
     }
 
+    let watchesRunning = null;
+
     const es = effectScope();
 
     es.run(() => {
@@ -126,6 +133,16 @@ export function useListCalculated({
             { immediate: true }
         );
 
+        watchesRunning = useWatchesRunning({
+            triggerRefs: [computed(() => (!isEmpty(state.calculatedObjectsRules) ? parentState.loading : false))],
+            watchSentinelRefs: [
+                toRef(state, "parentStateObjectsWatchRunning"),
+                toRef(state, "calculatedObjectsWatchRunning"),
+            ],
+        });
+
+        state.running = computed(() => loadingCombine(watchesRunning.state.running, parentState.running));
+
         onScopeDispose(() => {
             for (const objectKey of Object.keys(calculatedObjectsEffectScopes)) {
                 calculatedObjectsEffectScopes[objectKey].stop();
@@ -135,6 +152,8 @@ export function useListCalculated({
 
     return {
         state,
+        parentState,
+        watchesRunning,
         effectScope: es,
     };
 }

package/use/listRelated.js

@@ -1,6 +1,7 @@
 import { get, isArray, isEmpty, isUndefined } from "lodash";
 import { computed, effectScope, onScopeDispose, reactive, toRef, unref, watch } from "vue";
-import { keyDiff } from "../utils/keyDiff";
+import { keyDiff, loadingCombine } from "../utils";
+import { useWatchesRunning } from "./watchesRunning";
 
 export function useListRelateds(instances, args) {
     for (const [key, value] of Object.entries(args)) {
@@ -20,6 +21,8 @@ export function useListRelated({
         relatedObjectsRules: relatedObjectsRules,
         relatedObjectsObjects: {},
         objects: {},
+        parentStateObjectsWatchRunning: false,
+        relatedObjectsWatchRunning: false,
     });
     const relatedObjectsEffectScopes = {};
 
@@ -128,6 +131,8 @@ export function useListRelated({
         parentStateObjectsWatch();
     }
 
+    let watchesRunning = null;
+
     const es = effectScope();
 
     es.run(() => {
@@ -150,6 +155,16 @@ export function useListRelated({
             { immediate: true }
         );
 
+        watchesRunning = useWatchesRunning({
+            triggerRefs: [computed(() => (!isEmpty(state.relatedObjectsRules) ? parentState.loading : false))],
+            watchSentinelRefs: [
+                toRef(state, "parentStateObjectsWatchRunning"),
+                toRef(state, "relatedObjectsWatchRunning"),
+            ],
+        });
+
+        state.running = computed(() => loadingCombine(watchesRunning.state.running, parentState.running));
+
         onScopeDispose(() => {
             for (const objectKey of Object.keys(relatedObjectsEffectScopes)) {
                 relatedObjectsEffectScopes[objectKey].stop();
@@ -159,6 +174,7 @@ export function useListRelated({
     return {
         state,
         parentState,
+        watchesRunning,
         effectScope: es,
     };
 }

package/use/listSubscription.js

@@ -1,7 +1,7 @@
 import inspect from "browser-util-inspect";
 import { cloneDeep, isEmpty, isObject } from "lodash";
 import { computed, effectScope, reactive, toRef } from "vue";
-import { useCancellableIntent } from "../utils/cancellableIntent";
+import { useCancellableIntent } from "./cancellableIntent";
 import { loadingCombine } from "../utils/loadingCombine";
 import { useListInstance } from "./listInstance";
 

package/use/object.js

@@ -82,6 +82,7 @@ export const useObject = ({ props }) => {
             error: null,
             errored: null,
             object: null,
+            running: null,
         });
         exposedState = new Proxy(proxyBase, {
             // get values from the current state

package/use/objectCalculated.js

@@ -1,5 +1,7 @@
+import { isEmpty } from "lodash";
 import { computed, effectScope, onScopeDispose, reactive, toRef, watch } from "vue";
-import { keyDiff } from "../utils";
+import { keyDiff, loadingCombine } from "../utils";
+import { useWatchesRunning } from "./watchesRunning";
 
 export function useObjectCalculateds(instances, args) {
     for (const [key, value] of Object.entries(args)) {
@@ -20,6 +22,8 @@ export function useObjectCalculated({
         calculatedObjectRules,
         calculatedObjectObjects: {},
         object: {},
+        parentStateObjectWatchRunning: false,
+        calculatedObjectWatchRunning: false,
     });
     const calculatedObjectEffectScopes = {};
     const calculatedObjectOriginalFunctions = {};
@@ -27,6 +31,8 @@ export function useObjectCalculated({
     // don't change calculatedObjectPropertyName on us or it will break
     const copn = calculatedObjectPropertyName + "";
 
+    let watchesRunning = null;
+
     const es = effectScope();
 
     es.run(() => {
@@ -109,6 +115,16 @@ export function useObjectCalculated({
             }
         );
 
+        watchesRunning = useWatchesRunning({
+            triggerRefs: [computed(() => (!isEmpty(state.calculatedObjectRules) ? parentState.loading : false))],
+            watchSentinelRefs: [
+                toRef(state, "parentStateObjectWatchRunning"),
+                toRef(state, "calculatedObjectWatchRunning"),
+            ],
+        });
+
+        state.running = computed(() => loadingCombine(watchesRunning.state.running, parentState.running));
+
         onScopeDispose(() => {
             for (const key in calculatedObjectEffectScopes) {
                 calculatedObjectEffectScopes[key].stop();
@@ -121,6 +137,7 @@ export function useObjectCalculated({
     return {
         state,
         parentState,
+        watchesRunning,
         effectScope: es,
     };
 }

package/use/objectRelated.js

@@ -1,6 +1,7 @@
-import { get, isArray, isUndefined } from "lodash";
+import { get, isArray, isEmpty, isUndefined } from "lodash";
 import { computed, effectScope, onScopeDispose, reactive, toRef, unref, watch } from "vue";
-import { keyDiff } from "../utils";
+import { keyDiff, loadingCombine } from "../utils";
+import { useWatchesRunning } from "./watchesRunning";
 
 export function useObjectRelateds(instances, args) {
     for (const [key, value] of Object.entries(args)) {
@@ -21,12 +22,16 @@ export function useObjectRelated({
         relatedObjectRules,
         relatedObjectObjects: {},
         object: {},
+        parentStateObjectWatchRunning: false,
+        relatedObjectWatchRunning: false,
     });
     const relatedObjectEffectScopes = {};
 
     // don't change relatedObjectPropertyName on us or it will break
     const ropn = relatedObjectPropertyName + "";
 
+    let watchesRunning = null;
+
     const es = effectScope();
 
     es.run(() => {
@@ -114,15 +119,27 @@ export function useObjectRelated({
             }
         );
 
+        watchesRunning = useWatchesRunning({
+            triggerRefs: [computed(() => (!isEmpty(state.relatedObjectRules) ? parentState.loading : false))],
+            watchSentinelRefs: [
+                toRef(state, "parentStateObjectWatchRunning"),
+                toRef(state, "relatedObjectWatchRunning"),
+            ],
+        });
+
+        state.running = computed(() => loadingCombine(watchesRunning.state.running, parentState.running));
+
         onScopeDispose(() => {
             for (const key in relatedObjectEffectScopes) {
                 relatedObjectEffectScopes[key].stop();
             }
         });
     });
+
     return {
         state,
         parentState,
+        watchesRunning,
         effectScope: es,
     };
 }

package/use/objectSubscription.js

@@ -1,7 +1,6 @@
 import { computed, effectScope, reactive, toRef } from "vue";
-import { assignReactiveObject } from "../utils/assignReactiveObject";
-import { useCancellableIntent } from "../utils/cancellableIntent";
-import { loadingCombine } from "../utils/loadingCombine";
+import { assignReactiveObject, loadingCombine } from "../utils";
+import { useCancellableIntent } from "./cancellableIntent";
 import { useObjectInstance } from "./objectInstance";
 
 export class ObjectSubscriptionError extends Error {

package/use/watchesRunning.js

@@ -0,0 +1,31 @@
+import { computed, effectScope, reactive, unref, watch } from "vue";
+import { loadingCombine } from "../utils";
+
+export function useWatchesRunning({ triggerRefs, watchSentinelRefs }) {
+    const state = reactive({});
+
+    const es = effectScope();
+
+    es.run(() => {
+        watch(
+            triggerRefs,
+            (values) => {
+                if (values.every((value) => unref(value))) {
+                    watchSentinelRefs.forEach((ref) => {
+                        ref.value = true;
+                    });
+                }
+            },
+            {
+                immediate: true,
+                deep: true,
+            }
+        );
+        state.running = computed(() => loadingCombine(watchSentinelRefs.map((ref) => ref.value)));
+    });
+
+    return {
+        state,
+        effectScope: es,
+    };
+}

package/utils/index.js

@@ -1,5 +1,4 @@
 export * from "./assignReactiveObject";
-export * from "./cancellableIntent";
 export * from "./flattenPaths";
 export * from "./getFakeId";
 export * from "./keyDiff";