@arrai-innovations/reactive-helpers 2.7.0 → 3.0.0

package/package.json

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

package/tests/unit/use/objectSubscription.spec.js

@@ -601,7 +601,7 @@ describe("use/objectSubscription.js", function () {
                 },
             });
             objectSubscription.objectInstance.state.crud.retrieve = customCrudRetrieve;
-            objectSubscription.state.crud.subscribe = customCrudSubscribe;
+            objectSubscription.objectInstance.state.crud.subscribe = customCrudSubscribe;
 
             const subscribePromise = objectSubscription.subscribe();
             crudRetrieveResolve(crudRetrieveResolved);

package/use/index.js

@@ -4,6 +4,7 @@ export * from "./listInstance.js";
 export * from "./listRelated.js";
 export * from "./listSort.js";
 export * from "./listSubscription.js";
+export * from "./object.js";
 export * from "./objectCalculated.js";
 export * from "./objectInstance.js";
 export * from "./objectRelated.js";

package/use/listInstance.js

@@ -1,7 +1,7 @@
 import inspect from "browser-util-inspect";
 import { cloneDeep } from "lodash";
 import { computed, effectScope, reactive } from "vue";
-import { assignReactiveObject } from "../utils/assignReactiveObject";
+import { addOrUpdateReactiveObject, assignReactiveObject } from "../utils/assignReactiveObject";
 import { getFakeId } from "../utils/getFakeId";
 
 export class ListError extends Error {
@@ -80,7 +80,7 @@ export function useListInstance({ crudArgs, listArgs = {}, retrieveArgs = {} })
     // prevent linking of all instances to the same default .args object
     Object.assign(state.crud, cloneDeep(defaultCrud));
     if (crudArgs) {
-        assignReactiveObject(state.crud.args, crudArgs);
+        addOrUpdateReactiveObject(state.crud.args, crudArgs);
     }
 
     const defaultPageCallback = (newObjects) => {

package/use/listSubscription.js

@@ -1,10 +1,9 @@
-import { computed, effectScope, reactive, toRef } from "vue";
-import { useListInstance } from "./listInstance";
-import { cloneDeep, isEmpty, isObject } from "lodash";
-import { assignReactiveObject } from "../utils/assignReactiveObject";
 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 { loadingCombine } from "../utils/loadingCombine";
+import { useListInstance } from "./listInstance";
 
 export class ListSubscriptionError extends Error {
     constructor(message) {
@@ -14,13 +13,11 @@ export class ListSubscriptionError extends Error {
 }
 
 const defaultCrud = {
-    args: {},
     subscribe: undefined,
 };
 
-export function setListSubscriptionCrud({ subscribe, args = {} }) {
+export function setListSubscriptionCrud({ subscribe }) {
     defaultCrud.subscribe = subscribe;
-    Object.assign(defaultCrud.args, args);
 }
 
 export function useListSubscriptions(args, listInstances = {}) {
@@ -35,23 +32,18 @@ export function useListSubscription({ listInstance, crudArgs, listArgs, retrieve
     if (!listInstance) {
         listInstance = useListInstance({ crudArgs, listArgs, retrieveArgs });
     }
+    if (!listInstance.state.crud.subscribe) {
+        listInstance.state.crud.subscribe = defaultCrud.subscribe;
+    }
+
     let subscribeIntent, listIntent;
     const state = reactive({
-        crud: {
-            args: {},
-            subscribe: undefined,
-        },
         subscriptionLoading: undefined,
         subscriptionErrored: false,
         subscriptionError: null,
         intendToList: false,
         intendToSubscribe: false,
     });
-    // prevent linking of all instances to the same default .args object
-    Object.assign(state.crud, cloneDeep(defaultCrud));
-    if (crudArgs) {
-        assignReactiveObject(state.crud.args, crudArgs);
-    }
 
     function publicSubscribe({ list = true } = {}) {
         let didSubscribe = false;
@@ -160,8 +152,8 @@ export function useListSubscription({ listInstance, crudArgs, listArgs, retrieve
         subscribeIntent = useCancellableIntent({
             awaitableWithCancel: () => {
                 // this function cannot be async, or the resulting promise will lose its .cancel() method
-                const subscribePromise = state.crud.subscribe({
-                    crudArgs: cloneDeep(state.crud.args),
+                const subscribePromise = listInstance.state.crud.subscribe({
+                    crudArgs: cloneDeep(listInstance.state.crud.args),
                     listArgs: cloneDeep(listInstance.state.listArgs),
                     retrieveArgs: cloneDeep(listInstance.state.retrieveArgs),
                     subscriptionEventCallback,
@@ -175,7 +167,11 @@ export function useListSubscription({ listInstance, crudArgs, listArgs, retrieve
                 catchPromise.cancel = subscribePromise.cancel;
                 return catchPromise;
             },
-            watchArguments: [toRef(state, "intendToSubscribe"), toRef(state, "listArgs"), toRef(state, "retrieveArgs")],
+            watchArguments: [
+                toRef(state, "intendToSubscribe"),
+                toRef(listInstance.state, "listArgs"),
+                toRef(state, "retrieveArgs"),
+            ],
             clearActiveOnResolved: false,
         });
 
@@ -186,7 +182,12 @@ export function useListSubscription({ listInstance, crudArgs, listArgs, retrieve
                 listInstance.clearList();
                 return listInstance.list();
             },
-            watchArguments: [toRef(state, "intendToList"), toRef(state, "listArgs"), toRef(state, "retrieveArgs")],
+            watchArguments: [
+                toRef(state, "intendToList"),
+                toRef(listInstance.state, "listArgs"),
+                toRef(state, "retrieveArgs"),
+            ],
+            nameOnLog: "listIntent",
         });
     });
 

package/use/object.js

@@ -0,0 +1,99 @@
+import { effectScope, shallowReactive, shallowReadonly, toRef, watch } from "vue";
+import { useObjectCalculated } from "./objectCalculated";
+import { useObjectInstance } from "./objectInstance";
+import { useObjectRelated } from "./objectRelated";
+import { useObjectSubscription } from "./objectSubscription";
+
+// Manages a chain of useObject functions, based on existence of keys in props: intendToRetrieve, relatedObjectRules, calculatedObjectRules
+export const useObject = ({ props }) => {
+    const managed = shallowReactive({
+        objectInstance: null,
+        objectSubscription: null,
+        objectRelated: null,
+        objectCalculated: null,
+    });
+    const es = effectScope();
+
+    managed.objectInstance = useObjectInstance({
+        crudArgs: toRef(props, "crudArgs"),
+        id: toRef(props, "id"),
+        retrieveArgs: toRef(props, "retrieveArgs"),
+    });
+
+    const intentPropsWatch = () => {
+        es.run(() => {
+            let nextState = managed.objectInstance?.state;
+            // true or false, having a key is intent to use
+            const hasIntendToRetrieve = "intendToRetrieve" in props;
+            if (hasIntendToRetrieve && !managed.objectSubscription) {
+                managed.objectSubscription = useObjectSubscription({
+                    objectInstance: managed.objectInstance,
+                });
+                managed.objectSubscription.state.intendToRetrieve = toRef(props, "intendToRetrieve");
+            } else if (!hasIntendToRetrieve && managed.objectSubscription) {
+                managed.objectSubscription.effectScope.stop();
+                managed.objectSubscription = null;
+            }
+            const hasRelatedObjectRules = "relatedObjectRules" in props;
+            if (hasRelatedObjectRules && !managed.objectRelated) {
+                nextState = managed.objectSubscription?.state || nextState;
+                managed.objectRelated = useObjectRelated({
+                    parentState: nextState,
+                    relatedObjectRules: toRef(props, "relatedObjectRules"),
+                });
+            } else if (!hasRelatedObjectRules && managed.objectRelated) {
+                managed.objectRelated.effectScope.stop();
+                managed.objectRelated = null;
+            }
+            const hasCalculatedObjectRules = "calculatedObjectRules" in props;
+            if (hasCalculatedObjectRules && !managed.objectCalculated) {
+                nextState = managed.objectRelated?.state || nextState;
+                managed.objectCalculated = useObjectCalculated({
+                    parentState: nextState,
+                    calculatedObjectRules: toRef(props, "calculatedObjectRules"),
+                });
+            } else if (!hasCalculatedObjectRules && managed.objectCalculated) {
+                managed.objectCalculated.effectScope.stop();
+                managed.objectCalculated = null;
+            }
+        });
+    };
+
+    let exposedState;
+
+    es.run(() => {
+        watch(
+            [
+                toRef(props, "intendToRetrieve"),
+                toRef(props, "relatedObjectRules"),
+                toRef(props, "calculatedObjectRules"),
+            ],
+            intentPropsWatch,
+            { immediate: true }
+        );
+        const getState = () =>
+            managed.objectCalculated?.state ||
+            managed.objectRelated?.state ||
+            managed.objectSubscription?.state ||
+            managed.objectInstance.state;
+        // used as proxy to have the properties and not be settable, so we only have to override get
+        const proxyBase = shallowReadonly({
+            loading: null,
+            error: null,
+            errored: null,
+            object: null,
+        });
+        exposedState = new Proxy(proxyBase, {
+            // get values from the current state
+            get(target, key) {
+                return Reflect.get(getState(), key);
+            },
+        });
+    });
+
+    return {
+        managed: shallowReadonly(managed),
+        state: exposedState,
+        effectScope: es,
+    };
+};

package/use/objectCalculated.js

@@ -67,12 +67,19 @@ export function useObjectCalculated({
         state.deleted = toRef(parentState, "deleted");
 
         watch(
-            [() => Object.keys(state.calculatedObjectRules)],
+            [() => state.calculatedObjectRules && Object.keys(state.calculatedObjectRules)],
             () => {
-                const { addedKeys, removedKeys, sameKeys } = keyDiff(
-                    Object.keys(state.calculatedObjectRules),
-                    Object.keys(calculatedObjectOriginalFunctions)
-                );
+                let addedKeys = [],
+                    removedKeys = [],
+                    sameKeys = [];
+                if (!state.calculatedObjectRules) {
+                    removedKeys = Object.keys(calculatedObjectOriginalFunctions);
+                } else {
+                    ({ addedKeys, removedKeys, sameKeys } = keyDiff(
+                        Object.keys(state.calculatedObjectRules),
+                        Object.keys(calculatedObjectOriginalFunctions)
+                    ));
+                }
                 for (const sameKey of sameKeys) {
                     if (calculatedObjectOriginalFunctions[sameKey] !== state.calculatedObjectRules[sameKey]) {
                         removedKeys.push(sameKey);

package/use/objectInstance.js

@@ -1,6 +1,6 @@
 import { cloneDeep } from "lodash";
 import { effectScope, reactive } from "vue";
-import { assignReactiveObject } from "../utils/assignReactiveObject";
+import { addOrUpdateReactiveObject, assignReactiveObject } from "../utils/assignReactiveObject";
 
 export class ObjectError extends Error {
     constructor(message) {
@@ -56,7 +56,7 @@ export function useObjectInstance({ crudArgs, id, retrieveArgs }) {
     // prevent linking of all instances to the same default .args object
     Object.assign(state.crud, cloneDeep(defaultCrud));
     if (crudArgs) {
-        assignReactiveObject(state.crud.args, crudArgs);
+        addOrUpdateReactiveObject(state.crud.args, crudArgs);
     }
 
     // due to retrieve being called by `useCancelleableIntent`, if called manually then by the watch,

package/use/objectRelated.js

@@ -67,12 +67,19 @@ export function useObjectRelated({
         state.deleted = toRef(parentState, "deleted");
 
         watch(
-            [() => Object.keys(state.relatedObjectRules)],
+            [() => state.relatedObjectRules && Object.keys(state.relatedObjectRules)],
             () => {
-                const { addedKeys: addedRuleKeys, removedKeys: removedRuleKeys } = keyDiff(
-                    Object.keys(state.relatedObjectRules),
-                    Object.keys(state.relatedObjectObjects)
-                );
+                let addedRuleKeys = [],
+                    removedRuleKeys = [];
+                if (!state.relatedObjectRules) {
+                    removedRuleKeys = Object.keys(state.relatedObjectObjects);
+                } else {
+                    ({ addedKeys: addedRuleKeys, removedKeys: removedRuleKeys } = keyDiff(
+                        Object.keys(state.relatedObjectRules),
+                        Object.keys(state.relatedObjectObjects)
+                    ));
+                }
+
                 for (const removedRuleKey of removedRuleKeys) {
                     delete state.relatedObjectObjects[removedRuleKey];
                     if (relatedObjectEffectScopes[removedRuleKey]) {

package/use/objectSubscription.js

@@ -1,9 +1,8 @@
-import { cloneDeep } from "lodash";
 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";
+import { useObjectInstance } from "./objectInstance";
 
 export class ObjectSubscriptionError extends Error {
     constructor(message) {
@@ -13,13 +12,11 @@ export class ObjectSubscriptionError extends Error {
 }
 
 const defaultCrud = {
-    args: {},
     subscribe: undefined,
 };
 
-export function setObjectSubscriptionCrud({ subscribe, args = {} }) {
+export function setObjectSubscriptionCrud({ subscribe }) {
     defaultCrud.subscribe = subscribe;
-    Object.assign(defaultCrud.args, args);
 }
 
 export function useObjectSubscriptions(subscriptionArgs) {
@@ -30,7 +27,7 @@ export function useObjectSubscriptions(subscriptionArgs) {
     return subscriptions;
 }
 
-export function useObjectSubscription({ objectInstance, crudArgs, id, retrieveArgs = {} }) {
+export function useObjectSubscription({ objectInstance, crudArgs, id, retrieveArgs }) {
     if (retrieveArgs && objectInstance) {
         throw new ObjectSubscriptionError(
             "Cannot use retrieveArgs and objectInstance together, set retrieveArgs on objectInstance instead"
@@ -39,12 +36,10 @@ export function useObjectSubscription({ objectInstance, crudArgs, id, retrieveAr
     if (!objectInstance) {
         objectInstance = useObjectInstance({ crudArgs, id, retrieveArgs });
     }
+    if (!objectInstance.state.crud.subscribe) {
+        objectInstance.state.crud.subscribe = defaultCrud.subscribe;
+    }
     const state = reactive({
-        crud: {
-            args: {},
-            subscribe: undefined,
-        },
-        id,
         subscriptionLoading: undefined,
         subscriptionErrored: false,
         subscriptionError: null,
@@ -52,11 +47,6 @@ export function useObjectSubscription({ objectInstance, crudArgs, id, retrieveAr
         intendToSubscribe: false,
         intendToRetrieve: false,
     });
-    // prevent linking of all instances to the same default .args object
-    Object.assign(state.crud, cloneDeep(defaultCrud));
-    if (crudArgs) {
-        assignReactiveObject(state.crud.args, crudArgs);
-    }
 
     let subscribeIntent, retrieveIntent;
 
@@ -93,9 +83,9 @@ export function useObjectSubscription({ objectInstance, crudArgs, id, retrieveAr
         state.subscriptionErrored = false;
         state.subscriptionError = null;
         let subscribePromise;
-        subscribePromise = state.crud.subscribe({
-            crudArgs: state.crud.args,
-            id,
+        subscribePromise = objectInstance.state.crud.subscribe({
+            crudArgs: objectInstance.state.crud.args,
+            id: objectInstance.state.id,
             retrieveArgs: state.retrieveArgs,
             callback: (data, action) => {
                 if (action === "delete") {
@@ -166,13 +156,22 @@ export function useObjectSubscription({ objectInstance, crudArgs, id, retrieveAr
 
         subscribeIntent = useCancellableIntent({
             awaitableWithCancel: subscribe,
-            watchArguments: [toRef(state, "intendToSubscribe"), toRef(state, "id"), toRef(state, "retrieveArgs")],
+            watchArguments: [
+                toRef(state, "intendToSubscribe"),
+                toRef(objectInstance.state, "id"),
+                toRef(state, "retrieveArgs"),
+            ],
             clearActiveOnResolved: false,
         });
 
         retrieveIntent = useCancellableIntent({
             awaitableWithCancel: objectInstance.retrieve,
-            watchArguments: [toRef(state, "intendToRetrieve"), toRef(state, "id"), toRef(state, "retrieveArgs")],
+            watchArguments: [
+                toRef(state, "intendToRetrieve"),
+                toRef(objectInstance.state, "id"),
+                toRef(state, "retrieveArgs"),
+            ],
+            nameForLog: "retrieveIntent",
         });
     });
 

package/utils/assignReactiveObject.js

@@ -1,8 +1,8 @@
+import inspect from "browser-util-inspect";
+import { isArray, isObject } from "lodash";
+import { isReactive, isRef, toRef, unref } from "vue";
 import { keyDiff } from "./keyDiff.js";
 import { union } from "./set.js";
-import { isReactive, toRef } from "vue";
-import { isArray, isObject } from "lodash";
-import inspect from "browser-util-inspect";
 
 export class AssignReactiveObjectError extends Error {
     constructor(message) {
@@ -20,6 +20,16 @@ function isArrayOrObject(key, value) {
 export function addOrUpdateReactiveObject(target, source, exclude = [], addedKeys = null, sameKeys = null) {
     isArrayOrObject("target", target);
     isArrayOrObject("source", source);
+    if (isRef(target)) {
+        const unrefedTarget = unref(target);
+        isArrayOrObject("unrefedTarget", unrefedTarget);
+        target = unrefedTarget;
+    }
+    if (isRef(source)) {
+        const unrefedSource = unref(source);
+        isArrayOrObject("unrefedSource", unrefedSource);
+        source = unrefedSource;
+    }
     if (!addedKeys && !sameKeys) {
         ({ addedKeys, sameKeys } = keyDiff(Object.keys(source) || [], Object.keys(target) || []));
     }
@@ -42,6 +52,16 @@ export function assignReactiveObject(target, source, exclude = []) {
     }
     isArrayOrObject("target", target);
     isArrayOrObject("source", source);
+    if (isRef(target)) {
+        const unrefedTarget = unref(target);
+        isArrayOrObject("unrefedTarget", unrefedTarget);
+        target = unrefedTarget;
+    }
+    if (isRef(source)) {
+        const unrefedSource = unref(source);
+        isArrayOrObject("unrefedSource", unrefedSource);
+        source = unrefedSource;
+    }
     const targetIsArray = isArray(target);
     const { addedKeys, sameKeys, removedKeys } = keyDiff(Object.keys(source) || [], Object.keys(target) || []);
     if (targetIsArray) {