@arrai-innovations/reactive-helpers 13.1.0 → 14.0.2

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

@@ -65,6 +65,23 @@ describe("use/listInstance.spec.js", function () {
             name: "nm,.",
         },
     ];
+    const crudListResolvedPageNonStandardPK = [
+        {
+            unique: 1,
+            __str__: "fdg",
+            name: "fdg",
+        },
+        {
+            unique: 2,
+            __str__: "ryt",
+            name: "ryt",
+        },
+        {
+            unique: 3,
+            __str__: "pui",
+            name: "pui",
+        },
+    ];
     const listObject = {
         id: null,
         __str__: "nvm",
@@ -72,6 +89,7 @@ describe("use/listInstance.spec.js", function () {
     };
     const crudListResolvedObjects1 = keyBy(crudListResolvedPage1, "id");
     const crudListResolvedObjects2 = keyBy(crudListResolvedPage2, "id");
+    const crudListResolvedObjectsNonStandardPK = keyBy(crudListResolvedPageNonStandardPK, "unique");
     describe("list", function () {
         it("success", async function () {
             const listArgs = reactive({
@@ -80,7 +98,7 @@ describe("use/listInstance.spec.js", function () {
             const retrieveArgs = reactive({
                 fields,
             });
-            const listInstance = useListInstance({ props: { listArgs, retrieveArgs } });
+            const listInstance = useListInstance({ props: { pkKey: "id", listArgs, retrieveArgs } });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
                 crudListResolve = resolve;
@@ -132,6 +150,56 @@ describe("use/listInstance.spec.js", function () {
             expect({ ...listInstance.state.objects }).toEqual(crudListResolvedObjects2);
             expect(globalList).toHaveBeenCalledWith({
                 crudArgs: { stream: "test_stream" },
+                pkKey: "id",
+                listArgs: { user: 1 },
+                retrieveArgs: { fields: fields },
+                pageCallback: passedPageCallback,
+                isCancelled: expect.any(Object), // ref
+            });
+            expect(globalList).toHaveBeenCalledTimes(1);
+        });
+        it("success with non-standard primary key", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields,
+            });
+            const listInstance = useListInstance({ props: { pkKey: "unique", listArgs, retrieveArgs } });
+            let crudListResolve;
+            const crudListPromise = new Promise((resolve) => {
+                crudListResolve = resolve;
+            });
+            let passedPageCallback;
+            globalList.mockImplementation(({ pageCallback }) => {
+                passedPageCallback = pageCallback;
+                return crudListPromise;
+            });
+
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBeUndefined();
+            expect({ ...listInstance.state.objects }).toEqual({});
+
+            listInstance.list();
+
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+            expect({ ...listInstance.state.objects }).toEqual({});
+
+            await nextTick();
+
+            // @ts-ignore - pageCallback is set in the mock, if not it will throw which is what we want
+            passedPageCallback(crudListResolvedPageNonStandardPK);
+
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+            expect({ ...listInstance.state.objects }).toEqual(crudListResolvedObjectsNonStandardPK);
+            expect(globalList).toHaveBeenCalledWith({
+                crudArgs: { stream: "test_stream" },
+                pkKey: "unique",
                 listArgs: { user: 1 },
                 retrieveArgs: { fields: fields },
                 pageCallback: passedPageCallback,
@@ -146,7 +214,7 @@ describe("use/listInstance.spec.js", function () {
             const retrieveArgs = reactive({
                 fields,
             });
-            const listInstance = useListInstance({ props: { listArgs, retrieveArgs } });
+            const listInstance = useListInstance({ props: { pkKey: "id", listArgs, retrieveArgs } });
             expectErrorToBeNull(listInstance.state.error);
             expect(listInstance.state.errored).toBe(false);
             expect(listInstance.state.loading).toBeUndefined();
@@ -158,6 +226,7 @@ describe("use/listInstance.spec.js", function () {
 
             expect(globalList).toHaveBeenCalledWith({
                 crudArgs: { stream: "test_stream" },
+                pkKey: "id",
                 listArgs: { user: 1 },
                 retrieveArgs: { fields: fields },
                 pageCallback: expect.any(Function),
@@ -176,7 +245,7 @@ describe("use/listInstance.spec.js", function () {
             const retrieveArgs = reactive({
                 fields,
             });
-            const listInstance = useListInstance({ props: { listArgs, retrieveArgs } });
+            const listInstance = useListInstance({ props: { pkKey: "id", listArgs, retrieveArgs } });
             let crudListReject;
             const crudListPromise = new Promise((resolve, reject) => {
                 crudListReject = reject;
@@ -214,6 +283,7 @@ describe("use/listInstance.spec.js", function () {
             expect({ ...listInstance.state.objects }).toEqual({});
             expect(globalList).toHaveBeenCalledWith({
                 crudArgs: { stream: "test_stream" },
+                pkKey: "id",
                 listArgs: { user: 1 },
                 retrieveArgs: { fields: fields },
                 pageCallback: passedPageCallback,
@@ -229,7 +299,7 @@ describe("use/listInstance.spec.js", function () {
                 fields,
             });
             const listInstance = useListInstance({
-                props: { listArgs, retrieveArgs, crudArgs: { stream: "custom_stream" } },
+                props: { pkKey: "id", listArgs, retrieveArgs, crudArgs: { stream: "custom_stream" } },
             });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
@@ -283,6 +353,7 @@ describe("use/listInstance.spec.js", function () {
             expect({ ...listInstance.state.objects }).toEqual(crudListResolvedObjects2);
             expect(globalList).toHaveBeenCalledWith({
                 crudArgs: { stream: "custom_stream" },
+                pkKey: "id",
                 listArgs: { user: 1 },
                 retrieveArgs: { fields: fields },
                 pageCallback: passedPageCallback,
@@ -301,6 +372,7 @@ describe("use/listInstance.spec.js", function () {
                 props: {
                     listArgs,
                     retrieveArgs,
+                    pkKey: "id",
                 },
             });
             let crudListResolve;
@@ -333,6 +405,7 @@ describe("use/listInstance.spec.js", function () {
             expect(listInstance.state.objectsInOrder).toEqual(Object.values(crudListResolvedObjects2));
             expect(globalList).toHaveBeenCalledWith({
                 crudArgs: { stream: "test_stream" },
+                pkKey: "id",
                 listArgs: { user: 1 },
                 retrieveArgs: { fields: fields },
                 pageCallback: passedPageCallback,
@@ -354,7 +427,8 @@ describe("use/listInstance.spec.js", function () {
         const listInstanceA = useListInstance({
             props: {
                 crudArgs: { stream: "test_streamA" },
-                id: 1,
+                pk: 1,
+                pkKey: "id",
                 retrieveArgs: {
                     fields,
                 },
@@ -363,7 +437,8 @@ describe("use/listInstance.spec.js", function () {
         const listInstanceB = useListInstance({
             props: {
                 crudArgs: { stream: "test_streamB" },
-                id: 2,
+                pk: 2,
+                pkKey: "id",
                 retrieveArgs: {
                     fields,
                 },
@@ -373,7 +448,8 @@ describe("use/listInstance.spec.js", function () {
             A: {
                 props: {
                     crudArgs: { stream: "test_streamA" },
-                    id: 1,
+                    pk: 1,
+                    pkKey: "id",
                     retrieveArgs: {
                         fields,
                     },
@@ -382,7 +458,8 @@ describe("use/listInstance.spec.js", function () {
             B: {
                 props: {
                     crudArgs: { stream: "test_streamB" },
-                    id: 2,
+                    pk: 2,
+                    pkKey: "id",
                     retrieveArgs: {
                         fields,
                     },
@@ -394,15 +471,15 @@ describe("use/listInstance.spec.js", function () {
     });
     describe("addListObject", function () {
         it("errored", function () {
-            const listInstance = useListInstance({ props: {} });
+            const listInstance = useListInstance({ props: { pkKey: "id" } });
             expect(() => listInstance.addListObject({ listObject })).toThrowError(ListInstanceError);
-            listObject.id = listInstance.getFakeId();
+            listObject.id = listInstance.getFakePk();
             listInstance.addListObject(listObject);
             expect(() => listInstance.addListObject({ listObject })).toThrowError(ListInstanceError);
         });
         it("succeeded", async function () {
-            const listInstance = useListInstance({ props: {} });
-            const newId = listInstance.getFakeId();
+            const listInstance = useListInstance({ props: { pkKey: "id" } });
+            const newId = listInstance.getFakePk();
             listObject.id = newId;
             listInstance.addListObject(listObject);
             expect(listInstance.state.objects[newId]).toEqual(listObject);
@@ -424,7 +501,7 @@ describe("use/listInstance.spec.js", function () {
     });
     describe("updateListObject", function () {
         it("errors", function () {
-            const listInstance = useListInstance({ props: {} });
+            const listInstance = useListInstance({ props: { pkKey: "id" } });
             expect(() => listInstance.updateListObject({ listObject })).toThrowError(ListInstanceError);
             listObject.id = -50002000;
             listInstance.addListObject(listObject);
@@ -432,7 +509,7 @@ describe("use/listInstance.spec.js", function () {
         });
         it("succeeds", async function () {
             const listInstance = useListInstance({
-                props: {},
+                props: { pkKey: "id" },
             });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
@@ -455,7 +532,6 @@ describe("use/listInstance.spec.js", function () {
                 obj: listInstance.state,
                 prop: "running",
             });
-
             let updateObject = listInstance.state.objects["1"];
             updateObject.name = "updated";
             listInstance.updateListObject(updateObject);
@@ -470,12 +546,12 @@ describe("use/listInstance.spec.js", function () {
     });
     describe("deleteListObject", function () {
         it("errors", function () {
-            const listInstance = useListInstance({ props: {} });
+            const listInstance = useListInstance({ props: { pkKey: "id" } });
             expect(() => listInstance.deleteListObject(-50002000)).toThrowError(ListInstanceError);
         });
         it("succeeds", async function () {
             const listInstance = useListInstance({
-                props: {},
+                props: { pkKey: "id" },
             });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
@@ -523,7 +599,7 @@ describe("use/listInstance.spec.js", function () {
             const retrieveArgs = reactive({
                 fields,
             });
-            const listInstance = useListInstance({ props: { listArgs, retrieveArgs } });
+            const listInstance = useListInstance({ props: { pkKey: "id", listArgs, retrieveArgs } });
             let crudListResolve;
             const crudListPromise = new Promise((resolve) => {
                 crudListResolve = resolve;
@@ -549,7 +625,53 @@ describe("use/listInstance.spec.js", function () {
             expect(listInstance.state.loading).toBe(true);
             expect(globalbulkDelete).toHaveBeenCalledWith({
                 crudArgs: { stream: "test_stream" },
-                ids: Object.keys(crudListResolvedObjects2).map(Number),
+                pkKey: "id",
+                pks: Object.keys(crudListResolvedObjects2).map(Number),
+            });
+
+            expect(globalbulkDelete).toHaveBeenCalledTimes(1);
+
+            // @ts-ignore - bulkDeleteResolve is set in a promise, since we await this will be set
+            crudListResolve();
+            await flushPromises();
+            await expect(bulkDeleteResolve).resolves.toBe(true);
+            expect({ ...listInstance.state.objects }).toEqual({});
+        });
+        it("succeeds with non-standard primary key", async function () {
+            const listArgs = reactive({
+                user: 1,
+            });
+            const retrieveArgs = reactive({
+                fields,
+            });
+            const listInstance = useListInstance({ props: { pkKey: "unique", listArgs, retrieveArgs } });
+            let crudListResolve;
+            const crudListPromise = new Promise((resolve) => {
+                crudListResolve = resolve;
+            });
+            let passedPageCallback;
+            globalList.mockImplementation(({ pageCallback }) => {
+                passedPageCallback = pageCallback;
+                return crudListPromise;
+            });
+            const liListResolve = listInstance.list();
+            await nextTick();
+            // @ts-ignore - pageCallback is set in the mock, if not it will throw which is what we want
+            passedPageCallback(crudListResolvedPageNonStandardPK);
+            // @ts-ignore - crudListResolve is set in a promise, since we await this will be set
+            crudListResolve();
+            await flushPromises();
+            await expect(liListResolve).resolves.toBe(true);
+
+            expect({ ...listInstance.state.objects }).toEqual(crudListResolvedObjectsNonStandardPK);
+            const bulkDeleteResolve = listInstance.bulkDelete();
+            expectErrorToBeNull(listInstance.state.error);
+            expect(listInstance.state.errored).toBe(false);
+            expect(listInstance.state.loading).toBe(true);
+            expect(globalbulkDelete).toHaveBeenCalledWith({
+                crudArgs: { stream: "test_stream" },
+                pkKey: "unique",
+                pks: Object.keys(crudListResolvedObjectsNonStandardPK).map(Number),
             });
 
             expect(globalbulkDelete).toHaveBeenCalledTimes(1);
@@ -561,10 +683,10 @@ describe("use/listInstance.spec.js", function () {
             expect({ ...listInstance.state.objects }).toEqual({});
         });
     });
-    describe("getFakeId", function () {
+    describe("getFakePk", function () {
         it("returns fakeId", function () {
-            const listInstance = useListInstance({ props: {} });
-            const fakeId = listInstance.getFakeId();
+            const listInstance = useListInstance({ props: { pkKey: "id" } });
+            const fakeId = listInstance.getFakePk();
             expect(fakeId).toBeTruthy();
         });
     });
@@ -592,7 +714,9 @@ describe("use/listInstance.spec.js", function () {
             __str__: "yuio",
             name: "yiuo",
         };
-        const listInstance = useListInstance({ props: { listArgs: { user: 1 }, retrieveArgs: { fields: fields } } });
+        const listInstance = useListInstance({
+            props: { pkKey: "id", listArgs: { user: 1 }, retrieveArgs: { fields: fields } },
+        });
         let crudListResolve;
         const crudListPromise = new Promise((resolve) => {
             crudListResolve = resolve;

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

@@ -13,8 +13,8 @@ describe("use/listRelated", () => {
         AwaitNot = watchesModule.AwaitNot;
     });
     it("should return a list of related items", async () => {
-        const mainListInstance = useListInstance({ props: {} });
-        const relatedListInstance = useListInstance({ props: {} });
+        const mainListInstance = useListInstance({ props: { pkKey: "id" } });
+        const relatedListInstance = useListInstance({ props: { pkKey: "id" } });
         mainListInstance.addListObject({
             id: "1",
             name: "main",
@@ -82,9 +82,9 @@ describe("use/listRelated", () => {
     });
     it('should allow related objects pkKey to be prefixed with "relatedItem." to reference previously related objects', async () => {
         //
-        const mainListInstance = useListInstance({ props: {} });
-        const intermediateListInstance = useListInstance({ props: {} });
-        const relatedListInstance = useListInstance({ props: {} });
+        const mainListInstance = useListInstance({ props: { pkKey: "id" } });
+        const intermediateListInstance = useListInstance({ props: { pkKey: "id" } });
+        const relatedListInstance = useListInstance({ props: { pkKey: "id" } });
         mainListInstance.addListObject({
             id: "1",
             name: "main",

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

@@ -22,7 +22,7 @@ describe("use/listSearch", () => {
     it("should match by search term", async () => {
         const textSearchValue = ref("one");
         // const textSearchValue = ref("");
-        const list = useListInstance({ props: {} });
+        const list = useListInstance({ props: { pkKey: "id" } });
         const search = useListSearch({
             parentState: list.state,
             props: reactive({
@@ -79,7 +79,7 @@ describe("use/listSearch", () => {
         });
     });
     it("no args: returns objects unsearched", async () => {
-        const listInstance = useListInstance({ props: {} });
+        const listInstance = useListInstance({ props: { pkKey: "id" } });
         const listItems = [
             { id: 4, name: "four", has_things: true },
             { id: 2, name: "two", has_things: true },
@@ -103,7 +103,7 @@ describe("use/listSearch", () => {
             vi.resetAllMocks();
             const orderByRules = [{ key: "name", desc: true, localeCompare: false }];
             const sortThrottleWait = 0;
-            const listInstance = useListInstance({ props: {} });
+            const listInstance = useListInstance({ props: { pkKey: "id" } });
             const listItems = [
                 { id: 4, name: "four", has_things: true },
                 { id: 2, name: "two", has_things: true },
@@ -140,6 +140,7 @@ describe("use/listSearch", () => {
             const listInstanceA = useListInstance({
                 props: {
                     crudArgs: { stream: "test_streamA" },
+                    pkKey: "id",
                     listArgs: { user: 1 },
                     retrieveArgs: {
                         fields,
@@ -149,6 +150,7 @@ describe("use/listSearch", () => {
             const listInstanceB = useListInstance({
                 props: {
                     crudArgs: { stream: "test_streamB" },
+                    pkKey: "id",
                     listArgs: { user: 2 },
                     retrieveArgs: {
                         fields,
@@ -242,8 +244,8 @@ describe("use/listSearch", () => {
     describe("useListSearch accepts relatedItem. and calculatedItem. rules", () => {
         it("in textSearchRules", async () => {
             const textSearchValue = ref("four");
-            const list = useListInstance({ props: {} });
-            const relatedList = useListInstance({ props: {} });
+            const list = useListInstance({ props: { pkKey: "id" } });
+            const relatedList = useListInstance({ props: { pkKey: "id" } });
             const related = useListRelated({
                 parentState: list.state,
                 relatedObjectsRules: {
@@ -296,7 +298,7 @@ describe("use/listSearch", () => {
     });
     describe("useListSearch updates index when", () => {
         it("parentState.objects is updated", async () => {
-            const list = useListInstance({ props: {} });
+            const list = useListInstance({ props: { pkKey: "id" } });
             const textSearchValue = ref("");
             const search = useListSearch({
                 parentState: list.state,
@@ -338,8 +340,8 @@ describe("use/listSearch", () => {
             });
         });
         it("parentState.relatedObjects is updated", async () => {
-            const list = useListInstance({ props: {} });
-            const relatedList = useListInstance({ props: {} });
+            const list = useListInstance({ props: { pkKey: "id" } });
+            const relatedList = useListInstance({ props: { pkKey: "id" } });
             const related = useListRelated({
                 parentState: list.state,
                 relatedObjectsRules: reactive({
@@ -382,7 +384,7 @@ describe("use/listSearch", () => {
             });
         });
         it("parentState.calculatedObjects is updated", async () => {
-            const list = useListInstance({ props: {} });
+            const list = useListInstance({ props: { pkKey: "id" } });
             const calculated = useListCalculated({
                 parentState: list.state,
                 calculatedObjectsRules: reactive({
@@ -429,7 +431,7 @@ describe("use/listSearch", () => {
             });
         });
         it("textSearchRules is updated", async () => {
-            const list = useListInstance({ props: {} });
+            const list = useListInstance({ props: { pkKey: "id" } });
             const textSearchValue = ref("");
             const searchProps = reactive({
                 textSearchValue,
@@ -477,7 +479,7 @@ describe("use/listSearch", () => {
         });
     });
     it("does not pass through when showAllWhenEmpty is false", async () => {
-        const list = useListInstance({ props: {} });
+        const list = useListInstance({ props: { pkKey: "id" } });
         const textSearchValue = ref("");
         const search = useListSearch({
             parentState: list.state,
@@ -508,7 +510,7 @@ describe("use/listSearch", () => {
     });
     it("should update when parentState is filtered in pass through mode.", async () => {
         const listInstance = useListInstance({
-            props: {},
+            props: { pkKey: "id" },
         });
         const allowedFilter = ref((obj) => !obj.filtered);
         const listFilter = useListFilter({

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

@@ -58,6 +58,7 @@ describe("use/useListSort", () => {
         listInstance = useListInstance({
             props: {
                 crudArgs: {},
+                pkKey: "id",
                 retrieveArgs: {
                     fields: ["id", "lexical_name", "organization", "relatedObjects"],
                 },
@@ -169,6 +170,7 @@ describe("use/useListSort", () => {
         const listInstanceA = useListInstance({
             props: {
                 crudArgs: { stream: "test_streamA" },
+                pkKey: "id",
                 listArgs: { user: 1 },
                 retrieveArgs: {
                     fields,
@@ -179,6 +181,7 @@ describe("use/useListSort", () => {
             props: {
                 crudArgs: { stream: "test_streamB" },
                 listArgs: { user: 2 },
+                pkKey: "id",
                 retrieveArgs: {
                     fields,
                 },
@@ -200,6 +203,7 @@ describe("use/useListSort", () => {
                     retrieveArgs: {
                         fields,
                     },
+                    pkKey: "id",
                 },
             },
             B: {
@@ -209,6 +213,7 @@ describe("use/useListSort", () => {
                     retrieveArgs: {
                         fields,
                     },
+                    pkKey: "id",
                 },
             },
         });
@@ -232,6 +237,7 @@ describe("use/useListSort", () => {
             props: reactive({
                 crudArgs: { stream: "test_stream" },
                 listArgs: { user: 1 },
+                pkKey: "id",
                 retrieveArgs: {
                     fields: ["id", "__str__", "name", "relatedItem", "calculatedItem"],
                 },
@@ -241,6 +247,7 @@ describe("use/useListSort", () => {
             props: reactive({
                 crudArgs: { stream: "test_related_stream" },
                 listArgs: { user: 1 },
+                pkKey: "id",
                 retrieveArgs: {
                     fields: ["id", "__str__", "name"],
                 },
@@ -350,7 +357,7 @@ describe("use/useListSort", () => {
     });
     it("pass through correctly when parentState changes their order", async () => {
         const listInstance = useListInstance({
-            props: reactive({}),
+            props: reactive({ pkKey: "id" }),
         });
         const allowedFilter = ref((obj) => obj.name !== "two");
         const listFilter = useListFilter({