@arrai-innovations/reactive-helpers 1.0.2 → 1.0.3

package/.circleci/config.yml

@@ -1,9 +1,8 @@
 version: 2.1
 orbs:
-    eslint: arrai/eslint@7.3.0
+    eslint: arrai/eslint@7.4.0
     prettier: arrai/prettier@5.1.1
-    utils: arrai/utils@1.9.0
-    npm: arrai/npm@2.3.2
+    npm: arrai/npm@2.4.1
     github: arrai/github@1.1.0
 workflows:
     test:

package/package.json

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

package/use/index.js

@@ -5,4 +5,5 @@ export * from "./listSort.js";
 export * from "./listSubscription.js";
 export * from "./objectInstance.js";
 export * from "./objectSubscription.js";
+export * from "./paginatedListInstance.js";
 export * from "./search.js";

package/use/listInstance.js

@@ -48,6 +48,16 @@ export function useListInstance({ crudArgs, defaultListArgs = {}, defaultRetriev
         assignReactiveObject(state.listInstanceCrud.args, crudArgs);
     }
 
+    const defaultPageCallback = (newObjects) => {
+        newObjects.forEach((newObject) => {
+            if (newObject.id in state.objects) {
+                updateListObject(newObject);
+            } else {
+                addListObject(newObject);
+            }
+        });
+    };
+
     async function list({ listArgs, retrieveArgs } = {}) {
         if (state.loading) {
             throw new ListError("already loading.");
@@ -66,15 +76,7 @@ export function useListInstance({ crudArgs, defaultListArgs = {}, defaultRetriev
                 crudArgs: state.listInstanceCrud.args,
                 retrieveArgs,
                 listArgs,
-                pageCallback: (newObjects) => {
-                    newObjects.forEach((newObject) => {
-                        if (newObject.id in state.objects) {
-                            updateListObject(newObject);
-                        } else {
-                            addListObject(newObject);
-                        }
-                    });
-                },
+                pageCallback: returnedObject.pageCallback,
             })
             .then(() => {
                 return Promise.resolve(true);
@@ -125,6 +127,13 @@ export function useListInstance({ crudArgs, defaultListArgs = {}, defaultRetriev
         delete state.objects[objectId];
     }
 
+    function clearList() {
+        state.addedOrder.splice(0);
+        for (const item in state.objects) {
+            delete state.objects[item];
+        }
+    }
+
     function getFakeId() {
         let fakeId;
         do {
@@ -139,13 +148,17 @@ export function useListInstance({ crudArgs, defaultListArgs = {}, defaultRetriev
         state.objectsInOrder = computed(() => state.addedOrder.map((id) => state.objects[id]));
     });
 
-    return {
+    const returnedObject = {
         state,
         list,
         addListObject,
         updateListObject,
         deleteListObject,
+        clearList,
         effectScope: es,
         getFakeId,
+        defaultPageCallback,
+        pageCallback: defaultPageCallback,
     };
+    return returnedObject;
 }

package/use/paginatedListInstance.js

@@ -0,0 +1,19 @@
+import { useListInstance } from "./listInstance";
+
+export function usePagedListInstance({ crudArgs, defaultListArgs = {}, defaultRetrieveArgs = {} }) {
+    const listInstance = useListInstance({ crudArgs, defaultListArgs, defaultRetrieveArgs });
+
+    listInstance.state.count = 0;
+
+    listInstance.pageCallback = (newObjects, count) => {
+        // display one page at a time, clear the list
+        listInstance.clearList();
+
+        listInstance.defaultPageCallback(newObjects);
+        if (count !== undefined) {
+            listInstance.state.count = count;
+        }
+    };
+
+    return listInstance;
+}