@arrai-innovations/reactive-helpers 2.1.2 → 2.3.0

package/package.json

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

package/use/index.js

@@ -1,8 +1,10 @@
+export * from "./listCalculated.js";
 export * from "./listFilter.js";
 export * from "./listInstance.js";
 export * from "./listRelated.js";
 export * from "./listSort.js";
 export * from "./listSubscription.js";
+export * from "./objectCalculated.js";
 export * from "./objectInstance.js";
 export * from "./objectSubscription.js";
 export * from "./paginatedListInstance.js";

package/use/listCalculated.js

@@ -0,0 +1,136 @@
+import { isEmpty } from "lodash";
+import { computed, effectScope, onScopeDispose, reactive, toRef, toRefs, watch } from "vue";
+import { keyDiff } from "../utils";
+
+export function useListCalculateds(instances, args) {
+    for (const [key, value] of Object.entries(args)) {
+        useListCalculated({
+            parentState: instances[key].state,
+            ...value,
+        });
+    }
+}
+// the simpler sibling of useListRelated
+// rules are just keys to functions that will be called with the object
+// and the result will be added as a computed property
+export function useListCalculated({
+    parentState,
+    calculatedObjectsRules,
+    calculatedObjectsPropertyName = "calculatedObjects", // NOT REACTIVE
+}) {
+    const state = reactive({
+        calculatedObjectsRules,
+        calculatedObjectsObjects: {},
+        objects: {},
+    });
+    const calculatedObjectsEffectScopes = {};
+    const combinedEffectScopes = {};
+
+    // don't change calculatedObjectsPropertyName on us or it will break
+    const copn = calculatedObjectsPropertyName + "";
+
+    function parentStateObjectsWatch() {
+        const { addedKeys, removedKeys } = keyDiff(
+            Object.keys(parentState.objects),
+            Object.keys(state.calculatedObjectsObjects)
+        );
+        for (const removedKey of removedKeys) {
+            delete state.calculatedObjectsObjects[removedKey];
+            delete state.objects[removedKey];
+            if (calculatedObjectsEffectScopes[removedKey]) {
+                calculatedObjectsEffectScopes[removedKey].stop();
+                delete calculatedObjectsEffectScopes[removedKey];
+            }
+            if (combinedEffectScopes[removedKey]) {
+                combinedEffectScopes[removedKey].stop();
+                delete combinedEffectScopes[removedKey];
+            }
+        }
+        for (const addedKey of addedKeys) {
+            state.calculatedObjectsObjects[addedKey] = {};
+            combinedEffectScopes[addedKey] = effectScope();
+            combinedEffectScopes[addedKey].run(() => {
+                state.objects[addedKey] = computed(() =>
+                    reactive({
+                        ...toRefs(state.calculatedObjectsObjects[addedKey]),
+                        ...toRefs(parentState.objects[addedKey]),
+                    })
+                );
+            });
+        }
+    }
+
+    function calculatedObjectsWatch() {
+        if (state.calculatedObjectsRules === false) {
+            return;
+        }
+        const calculatedObjectsRulesIsEmpty = isEmpty(state.calculatedObjectsRules);
+        for (const objectKey of Object.keys(state.calculatedObjectsObjects)) {
+            const calculatedObjectsEffectScope = effectScope();
+            calculatedObjectsEffectScope.run(() => {
+                const calculatedObjectsObject = state.calculatedObjectsObjects[objectKey];
+                const originalObject = parentState.objects[objectKey];
+                if (!calculatedObjectsObject[copn]) {
+                    calculatedObjectsObject[copn] = {};
+                }
+                let removedRuleKeys, addedRuleKeys;
+                if (!calculatedObjectsRulesIsEmpty) {
+                    ({ removedKeys: removedRuleKeys, addedKeys: addedRuleKeys } = keyDiff(
+                        Object.keys(state.calculatedObjectsRules),
+                        Object.keys(calculatedObjectsObject[copn])
+                    ));
+                } else {
+                    if (isEmpty(calculatedObjectsObject[copn])) {
+                        return;
+                    }
+                    removedRuleKeys = Object.keys(calculatedObjectsObject[copn]);
+                    addedRuleKeys = [];
+                }
+                for (const removedRuleKey of removedRuleKeys) {
+                    delete calculatedObjectsObject[copn][removedRuleKey];
+                }
+                for (const addedRuleKey of addedRuleKeys) {
+                    calculatedObjectsObject[copn][addedRuleKey] = computed(() => {
+                        return state.calculatedObjectsRules?.[addedRuleKey]?.(originalObject);
+                    });
+                }
+            });
+            calculatedObjectsEffectScopes[objectKey] = calculatedObjectsEffectScope;
+        }
+        parentStateObjectsWatch();
+    }
+
+    const es = effectScope();
+
+    es.run(() => {
+        state.order = toRef(parentState, "order");
+        state.objectsInOrder = computed(() => state.order.map((id) => state.objects[id]));
+
+        watch(() => Object.keys(parentState.objects), parentStateObjectsWatch, { immediate: true });
+        watch(
+            [
+                () => Object.keys(state.calculatedObjectsObjects),
+                () =>
+                    state.calculatedObjectsRules
+                        ? Object.keys(state.calculatedObjectsRules)
+                        : state.calculatedObjectsRules,
+            ],
+            calculatedObjectsWatch,
+            { immediate: true }
+        );
+
+        onScopeDispose(() => {
+            for (const objectKey of Object.keys(calculatedObjectsEffectScopes)) {
+                calculatedObjectsEffectScopes[objectKey].stop();
+            }
+            for (const objectKey of Object.keys(combinedEffectScopes)) {
+                combinedEffectScopes[objectKey].stop();
+            }
+        });
+    });
+
+    return {
+        state,
+        effectScope: es,
+    };
+}

package/use/listRelated.js

@@ -4,7 +4,10 @@ import { keyDiff } from "../utils/keyDiff";
 
 export function useListRelateds(instances, args) {
     for (const [key, value] of Object.entries(args)) {
-        useListRelated({ listInstance: instances[key], ...value });
+        useListRelated({
+            parentState: instances[key].state,
+            ...value,
+        });
     }
 }
 

package/use/objectCalculated.js

@@ -0,0 +1,88 @@
+import { computed, effectScope, onScopeDispose, reactive, toRef, toRefs, watch } from "vue";
+import { keyDiff } from "../utils";
+
+export function useObjectCalculateds(instances, args) {
+    for (const [key, value] of Object.entries(args)) {
+        useObjectCalculated({
+            parentState: instances[key].state,
+            ...value,
+        });
+    }
+}
+// the single object version of useListCalculated
+export function useObjectCalculated({
+    parentState,
+    calculatedObjectRules,
+    calculatedObjectPropertyName = "calculatedObject", // NOT REACTIVE
+}) {
+    const state = reactive({
+        calculatedObjectRules,
+        calculatedObjectObject: {},
+        object: {},
+    });
+    const calculatedObjectEffectScopes = {};
+    const calculatedObjectOriginalFunctions = {};
+
+    // don't change calculatedObjectPropertyName on us or it will break
+    const copn = calculatedObjectPropertyName + "";
+
+    const es = effectScope();
+
+    es.run(() => {
+        state.object = computed(() =>
+            reactive({
+                [copn]: toRef(state, "calculatedObjectObject"),
+                ...toRefs(parentState.object),
+            })
+        );
+
+        watch(
+            [() => Object.keys(state.calculatedObjectRules)],
+            () => {
+                const { addedKeys, removedKeys, changedKeys } = keyDiff(
+                    state.calculatedObjectRules,
+                    calculatedObjectOriginalFunctions
+                );
+                for (const removedKey of removedKeys) {
+                    delete calculatedObjectOriginalFunctions[removedKey];
+                    delete state.calculatedObjectObject[removedKey];
+                    if (calculatedObjectEffectScopes[removedKey]) {
+                        calculatedObjectEffectScopes[removedKey].stop();
+                        delete calculatedObjectEffectScopes[removedKey];
+                    }
+                }
+                for (const addedKey of addedKeys) {
+                    calculatedObjectOriginalFunctions[addedKey] = state.calculatedObjectRules[addedKey];
+                    calculatedObjectEffectScopes[addedKey] = effectScope();
+                    calculatedObjectEffectScopes[addedKey].run(() => {
+                        state.calculatedObjectObject[addedKey] = computed(() =>
+                            calculatedObjectOriginalFunctions[addedKey](state.object)
+                        );
+                    });
+                }
+                for (const changedKey of changedKeys) {
+                    calculatedObjectOriginalFunctions[changedKey] = state.calculatedObjectRules[changedKey];
+                    calculatedObjectEffectScopes[changedKey].stop();
+                    calculatedObjectEffectScopes[changedKey] = effectScope();
+                    calculatedObjectEffectScopes[changedKey].run(() => {
+                        state.calculatedObjectObject[changedKey] = computed(() =>
+                            calculatedObjectOriginalFunctions[changedKey](state.object)
+                        );
+                    });
+                }
+            },
+            {
+                immediate: true,
+            }
+        );
+
+        onScopeDispose(() => {
+            for (const key in calculatedObjectEffectScopes) {
+                calculatedObjectEffectScopes[key].stop();
+            }
+            for (const key in calculatedObjectOriginalFunctions) {
+                delete calculatedObjectOriginalFunctions[key];
+            }
+        });
+    });
+}