@arrai-innovations/reactive-helpers 6.1.0 → 7.1.0

package/.vscode/extensions.json

@@ -1,3 +1,3 @@
 {
-    "recommendations": ["Vue.volar", "dbaeumer.vscode-eslint"]
+    "recommendations": ["dbaeumer.vscode-eslint", "znck.vue"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "6.1.0",
+    "version": "7.1.0",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "directories": {
@@ -30,9 +30,9 @@
         "@commitlint/cli": "^16.2.4",
         "@trivago/prettier-plugin-sort-imports": "^4.1.1",
         "@types/jest": "^27.5.0",
-        "@vue/compiler-sfc": "^3.2.33",
+        "@vue/compiler-sfc": "^3.3.4",
         "@vue/eslint-config-prettier": "^7.0.0",
-        "@vue/test-utils": "^2.0.0-rc.21",
+        "@vue/test-utils": "^2.3.2",
         "@vue/vue3-jest": "^27.0.0",
         "babel-eslint": "^10.1.0",
         "babel-jest": "^27.5.1",
@@ -54,6 +54,6 @@
     },
     "peerDependencies": {
         "lodash-es": "^4.17.21",
-        "vue": "^3.2.47"
+        "vue": "^3.3.4"
     }
 }

package/use/list.js

@@ -3,7 +3,7 @@ import { useListInstance } from "./listInstance";
 import { useListRelated } from "./listRelated";
 import { useListSubscription } from "./listSubscription";
 import { usePagedListInstance } from "./paginatedListInstance";
-import { reactive, shallowReactive, shallowReadonly, toRef } from "vue";
+import { effectScope, reactive, shallowReactive, shallowReadonly, toRef } from "vue";
 
 export const useLists = (listArgs) => {
     const lists = {};
@@ -22,30 +22,48 @@ export const useList = ({ props, functions, paged = false, keepOldPages = false
         listCalculated: null,
     });
 
-    managed.listInstance = (paged ? usePagedListInstance : useListInstance)({
-        props,
-        functions,
-        keepOldPages,
-    });
+    const es = effectScope();
 
-    managed.listSubscription = useListSubscription({
-        listInstance: managed.listInstance,
-    });
-    managed.listSubscription.state.intendToList = toRef(props, "intendToList");
+    es.run(() => {
+        managed.listInstance = (paged ? usePagedListInstance : useListInstance)({
+            props,
+            functions,
+            keepOldPages,
+        });
 
-    managed.listRelated = useListRelated({
-        parentState: managed.listSubscription.state,
-        relatedObjectsRules: toRef(props, "relatedObjectsRules"),
-    });
+        managed.listSubscription = useListSubscription({
+            listInstance: managed.listInstance,
+        });
+        managed.listSubscription.state.intendToList = toRef(props, "intendToList");
 
-    managed.listCalculated = useListCalculated({
-        parentState: managed.listRelated.state,
-        calculatedObjectsRules: toRef(props, "calculatedObjectsRules"),
+        managed.listRelated = useListRelated({
+            parentState: managed.listSubscription.state,
+            relatedObjectsRules: toRef(props, "relatedObjectsRules"),
+        });
+
+        managed.listCalculated = useListCalculated({
+            parentState: managed.listRelated.state,
+            calculatedObjectsRules: toRef(props, "calculatedObjectsRules"),
+        });
     });
 
+    const clearError = (error) => {
+        managed.listSubscription.clearError(error);
+        managed.listInstance.clearError(error);
+    };
+
     return reactive({
         // we manage the keys on both of these, so hands off the root.
         managed: shallowReadonly(managed),
         state: managed.listCalculated.state,
+        list: managed.listInstance.list,
+        addListObject: managed.listInstance.addListObject,
+        updateListObject: managed.listInstance.updateListObject,
+        deleteListObject: managed.listInstance.deleteListObject,
+        clearList: managed.listInstance.clearList,
+        clearError,
+        getFakeId: managed.listInstance.getFakeId,
+        defaultPageCallback: managed.listInstance.defaultPageCallback,
+        effectScope: es,
     });
 };

package/use/object.js

@@ -2,7 +2,7 @@ import { useObjectCalculated } from "./objectCalculated";
 import { useObjectInstance } from "./objectInstance";
 import { useObjectRelated } from "./objectRelated";
 import { useObjectSubscription } from "./objectSubscription";
-import { reactive, shallowReadonly, toRef } from "vue";
+import { effectScope, reactive, shallowReadonly, toRef } from "vue";
 
 // Manages a chain of useObject* functions
 export const useObject = ({ props, functions }) => {
@@ -13,27 +13,45 @@ export const useObject = ({ props, functions }) => {
         objectCalculated: null,
     });
 
-    managed.objectInstance = useObjectInstance({
-        props,
-        functions,
-    });
-    managed.objectSubscription = useObjectSubscription({
-        objectInstance: managed.objectInstance,
-        props: reactive({
-            intendToSubscribe: toRef(props, "intendToSubscribe"),
-            intendToRetrieve: toRef(props, "intendToRetrieve"),
-        }),
-    });
-    managed.objectRelated = useObjectRelated({
-        parentState: managed.objectSubscription.state,
-        relatedObjectRules: toRef(props, "relatedObjectRules"),
-    });
-    managed.objectCalculated = useObjectCalculated({
-        parentState: managed.objectRelated.state,
-        calculatedObjectRules: toRef(props, "calculatedObjectRules"),
+    const es = effectScope();
+
+    es.run(() => {
+        managed.objectInstance = useObjectInstance({
+            props,
+            functions,
+        });
+        managed.objectSubscription = useObjectSubscription({
+            objectInstance: managed.objectInstance,
+            props: reactive({
+                intendToSubscribe: toRef(props, "intendToSubscribe"),
+                intendToRetrieve: toRef(props, "intendToRetrieve"),
+            }),
+        });
+        managed.objectRelated = useObjectRelated({
+            parentState: managed.objectSubscription.state,
+            relatedObjectRules: toRef(props, "relatedObjectRules"),
+        });
+        managed.objectCalculated = useObjectCalculated({
+            parentState: managed.objectRelated.state,
+            calculatedObjectRules: toRef(props, "calculatedObjectRules"),
+        });
     });
+    const clearError = () => {
+        managed.objectSubscription.clearError();
+        managed.objectInstance.clearError();
+    };
     return reactive({
         managed: shallowReadonly(managed),
         state: managed.objectCalculated.state,
+        retrieve: managed.objectInstance.retrieve,
+        create: managed.objectInstance.create,
+        update: managed.objectInstance.update,
+        patch: managed.objectInstance.patch,
+        subscribe: managed.objectSubscription.subscribe,
+        unsubscribe: managed.objectSubscription.unsubscribe,
+        updateFromSubscription: managed.objectSubscription.updateFromSubscription,
+        deleteFromSubscription: managed.objectSubscription.deleteFromSubscription,
+        clearError,
+        effectScope: es,
     });
 };