@arrai-innovations/reactive-helpers 13.1.0 → 14.0.2

package/docs/use/objectInstance.md

@@ -97,7 +97,7 @@ Called to patch the current object on the server.
 
 > **retrieve**: `Function`
 
-Called to retrieve the current object by id from the server.
+Called to retrieve the current object by pk from the server.
 
 ##### update
 
@@ -219,11 +219,17 @@ A function to be used instead of the default crud update function.
 
 [`ResponseData`](../config/objectCrud.md#responsedata)
 
-###### id
+###### pk
 
-> **id**: `string`
+> **pk**: `string`
 
-The id of the object.
+The pk of the object, optional to support creating new objects.
+
+###### pkKey
+
+> **pkKey**: `string`
+
+The pk key of the object.
 
 ###### retrieveArgs
 
@@ -357,12 +363,6 @@ The error.
 
 Whether the object errored.
 
-###### id
-
-> **id**: `string`
-
-The id of the object.
-
 ###### loading
 
 > **loading**: `boolean`
@@ -375,6 +375,18 @@ Whether the object is loading.
 
 The object.
 
+###### pk
+
+> **pk**: `string`
+
+The pk of the object.
+
+###### pkKey
+
+> **pkKey**: `string`
+
+The pk key of the object.
+
 ###### retrieveArgs
 
 > **retrieveArgs**: `any`
@@ -393,11 +405,17 @@ The arguments to be passed to the retrieve function.
 
 The arguments to be passed to the crud functions.
 
-##### id
+##### pk
 
-> **id**: `string`
+> **pk**: `string`
 
-The id of the object.
+The pk of the object, optional to support creating new objects.
+
+##### pkKey
+
+> **pkKey**: `string`
+
+The pk key of the object.
 
 ##### retrieveArgs
 
@@ -435,12 +453,6 @@ The error.
 
 Whether the object errored.
 
-##### id
-
-> **id**: `string`
-
-The id of the object.
-
 ##### loading
 
 > **loading**: `Readonly`\<`Ref`\<`boolean`\>\>
@@ -453,6 +465,18 @@ Whether the object is loading.
 
 The object.
 
+##### pk
+
+> **pk**: `string`
+
+The pk of the object.
+
+##### pkKey
+
+> **pkKey**: `string`
+
+The pk key of the object.
+
 ##### retrieveArgs
 
 > **retrieveArgs**: `any`
@@ -533,15 +557,16 @@ const props = defineProps({
         type: String,
         required: true,
     },
-    id: {
+    pk: {
         type: String,
         default: '',
     },
 });
 
-const idRef = toRef(props, 'id');
+const pkRef = toRef(props, 'pk');
 const objectInstanceProps = reactive({
-  id: idRef,
+  pk: pkRef,
+  pkKey: 'id',
   crudArgs: {
       app: toRef(props, "app"),
       model: toRef(props, "model"),
@@ -549,14 +574,14 @@ const objectInstanceProps = reactive({
   retrieveArgs: {},
 });
 const objectInstance = useObjectInstance(objectInstanceProps);
-watch(idRef, (newValue, oldValue) => {
+watch(pkRef, (newValue, oldValue) => {
     if (newValue !== oldValue && newValue) {
         objectInstance.retrieve();
     }
 });
 </script>
 <template>
-    <!-- Display the retrieved object reactively, as a valid id is provided in props. -->
+    <!-- Display the retrieved object reactively, as a valid pk is provided in props. -->
     <div>{{ objectInstance.state.object }}</div>
 </template>
 ```

package/docs/use/objectRelated.md

@@ -138,12 +138,6 @@ The error.
 
 Whether the object errored.
 
-###### id
-
-> **id**: `string`
-
-The id of the object.
-
 ###### intendToRetrieve
 
 > **intendToRetrieve**: `boolean`
@@ -168,6 +162,18 @@ Whether the object is loading.
 
 The object.
 
+###### pk
+
+> **pk**: `string`
+
+The pk of the object.
+
+###### pkKey
+
+> **pkKey**: `string`
+
+The pk key of the object.
+
 ###### retrieveArgs
 
 > **retrieveArgs**: `any`
@@ -318,12 +324,6 @@ The error.
 
 Whether the object errored.
 
-###### id
-
-> **id**: `string`
-
-The id of the object.
-
 ###### intendToRetrieve
 
 > **intendToRetrieve**: `boolean`
@@ -354,6 +354,18 @@ The object.
 
 Whether the parent state object watch is running.
 
+###### pk
+
+> **pk**: `string`
+
+The pk of the object.
+
+###### pkKey
+
+> **pkKey**: `string`
+
+The pk key of the object.
+
 ###### relatedObject
 
 > **relatedObject**: `object`
@@ -490,7 +502,7 @@ Whether the related objects are loading or the parent state is loading.
 
 ##### objects
 
-> **objects**: [`ObjectsById`](listInstance.md#objectsbyid)
+> **objects**: [`ObjectsByPk`](listInstance.md#objectsbypk)
 
 The related objects, indexed by the key in the related object.
 
@@ -620,7 +632,8 @@ const someOtherObjectsSource = reactive({
 const objectSubscriptionProps = reactive({
     crudArgs: { app: 'foo', model: 'bar'},
     retrieveArgs: {},
-    id: '99',
+    pk: '99',
+    pkKey: 'id',
     intendToSubscribe: true,
     intendToRetreive: true,
 });

package/docs/use/objectSubscription.md

@@ -269,12 +269,6 @@ The error.
 
 Whether the object errored.
 
-###### id
-
-> **id**: `string`
-
-The id of the object.
-
 ###### intendToRetrieve
 
 > **intendToRetrieve**: `boolean`
@@ -299,6 +293,18 @@ Whether the object is loading.
 
 The object.
 
+###### pk
+
+> **pk**: `string`
+
+The pk of the object.
+
+###### pkKey
+
+> **pkKey**: `string`
+
+The pk key of the object.
+
 ###### retrieveArgs
 
 > **retrieveArgs**: `any`
@@ -458,10 +464,11 @@ Options for initializing the object subscription.
 import { useObjectSubscription } from "@arrai-innovations/reactive-helpers";
 import { reactive, ref, toRef } from "vue";
 
+const pkKey = "id";
 const props = defineProps({
     app: { type: String, required: true },
     model: { type: String, required: true },
-    id: { type: String, default: "" },
+    pk: { type: String, default: "" },
 });
 
 const objectSubscriptionProps = reactive({
@@ -469,19 +476,21 @@ const objectSubscriptionProps = reactive({
         app: toRef(props, "app"),
         model: toRef(props, "model"),
     },
+    pk: toRef(props, "pk"),
+    pkKey: pkKey,
     retrieveArgs: {
         fields: ['foo', 'bar'],
     },
     intendToRetrieve: false,
     intendToSubscribe: false,
 });
-objectSubscriptionProps.intendToRetrieve = objectSubscriptionProps.intendToSubscribe = computed(()=> !!props.id);
+objectSubscriptionProps.intendToRetrieve = objectSubscriptionProps.intendToSubscribe = computed(()=> !!props.pk);
 const objectSubscription = useObjectSubscription(objectSubscriptionProps);
 </script>
 <template>
     <div v-if="objectSubscription.state.loading">Loading...</div>
     <div v-else-if="objectSubscription.state.errored">Error: {{ objectSubscription.state.error.message }}</div>
-    <div v-else-if="objectSubscription.state.object.id">Foo: {{ objectSubscription.state.object.foo }}</div>
+    <div v-else-if="objectSubscription.state.object[pkKey]">Foo: {{ objectSubscription.state.object.foo }}</div>
     <div v-else>Object not found.</div>
 </template>
 ```

package/docs/use/paginatedListInstance.md

@@ -64,9 +64,9 @@ Indicates if the list is currently loading.
 
 ###### objects
 
-> **objects**: [`ObjectsById`](listInstance.md#objectsbyid)
+> **objects**: [`ObjectsByPk`](listInstance.md#objectsbypk)
 
-The list objects stored by their IDs.
+The list objects stored by their pks.
 
 ###### objectsInOrder
 
@@ -80,6 +80,12 @@ The objects in the order specified by the list.
 
 The order of objects in the list.
 
+###### pkKey
+
+> **pkKey**: `string`
+
+The primary key field for the list objects.
+
 ###### retrieveArgs
 
 > **retrieveArgs**: `any`

package/docs/use/search.md

@@ -16,7 +16,7 @@
 
 > **id**: `string`
 
-The document field to use as an identifier. Default is "id".
+The document field to use as an identifier. Populated from `pkKey`.
 
 ##### index
 
@@ -106,7 +106,7 @@ FlexSearch.Document options.
 
 > **id**: `string`
 
-The document field to use as an identifier. Default is "id".
+The document field to use as an identifier. Populated from `pkKey`.
 
 ###### customDocumentOptions.index
 
@@ -222,6 +222,12 @@ FlexSearch.Document options.
 
 Search options.
 
+##### pkKey
+
+> **pkKey**: `string`
+
+The primary key field.
+
 ***
 
 ### SearchRawState

package/docs/utils/{getFakeId.md → getFakePk.md}

@@ -2,23 +2,23 @@
 
 ***
 
-[@arrai-innovations/reactive-helpers](../README.md) / utils/getFakeId
+[@arrai-innovations/reactive-helpers](../README.md) / utils/getFakePk
 
-# utils/getFakeId
+# utils/getFakePk
 
 ## Functions
 
-### getFakeId()
+### getFakePk()
 
-> **getFakeId**(`arraySetMapOrObject`, `key`): `string`
+> **getFakePk**(`arraySetMapOrObject`, `key`): `string`
 
-Get a fake id that is not in the array, set, map, or object.
+Get a fake pk that is not in the array, set, map, or object.
 
 #### Parameters
 
 • **arraySetMapOrObject**: `any`
 
-The array, set, map, or object to check for the fake id.
+The array, set, map, or object to check for the fake pk.
  An array is assumed to be an array of objects.
  A set is assumed to be a set of ids.
  A map or object is assumed to be an object with keys that are ids.
@@ -31,4 +31,4 @@ The key to check for in the array or object.
 
 `string`
 
-- The fake id.
+- The fake pk.

package/index.js

@@ -27,7 +27,7 @@ export * from "./utils/classes.js";
 export * from "./utils/compact.js";
 export * from "./utils/deleteKey.js";
 export * from "./utils/flattenPaths.js";
-export * from "./utils/getFakeId.js";
+export * from "./utils/getFakePk.js";
 export * from "./utils/keyDiff.js";
 export * from "./utils/loadingCombine.js";
 export * from "./utils/relatedCalculatedHelpers.js";

package/package.json

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

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

@@ -15,8 +15,8 @@ describe("use/listCalculated", () => {
         AwaitNot = watchesModule.AwaitNot;
     });
     it("should return a list of calculated items", async () => {
-        const mainListInstance = useListInstance({ props: {} });
-        const calculatedListInstance = useListInstance({ props: {} });
+        const mainListInstance = useListInstance({ props: { pkKey: "id" } });
+        const calculatedListInstance = useListInstance({ props: { pkKey: "id" } });
         mainListInstance.addListObject({
             id: "1",
             name: "main",
@@ -77,8 +77,8 @@ describe("use/listCalculated", () => {
         });
     });
     it("should allow calculated objects to return results based on related objects", 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",

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

@@ -19,7 +19,7 @@ describe("use/listFilter", () => {
     });
 
     it("should match an allowed filter function", async () => {
-        const list = useListInstance({ props: {} });
+        const list = useListInstance({ props: { pkKey: "id" } });
         const filter = useListFilter({
             parentState: list.state,
             allowedFilter: (object) => object.id === 1 || object.id === 3,
@@ -65,7 +65,7 @@ describe("use/listFilter", () => {
         });
     });
     it("should match an excluded filter function", async () => {
-        const list = useListInstance({ props: {} });
+        const list = useListInstance({ props: { pkKey: "id" } });
         const filter = useListFilter({
             parentState: list.state,
             excludedFilter: (object) => object.id == 2 || object.id == 4,
@@ -111,7 +111,7 @@ describe("use/listFilter", () => {
         });
     });
     it("no args: returns objects unfiltered", 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 },
@@ -135,7 +135,7 @@ describe("use/listFilter", () => {
             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 },
@@ -172,6 +172,7 @@ describe("use/listFilter", () => {
                 props: {
                     crudArgs: { stream: "test_streamA" },
                     listArgs: { user: 1 },
+                    pkKey: "id",
                     retrieveArgs: {
                         fields,
                     },
@@ -222,7 +223,7 @@ describe("use/listFilter", () => {
     });
     describe("useListFilters updates index when", () => {
         it("parentInstance.objects is updated", async () => {
-            const list = useListInstance({ props: {} });
+            const list = useListInstance({ props: { pkKey: "id" } });
             const filter = useListFilter({
                 parentState: list.state,
                 allowedFilter: (object) => !!object.allowed?.every((e) => e),
@@ -263,8 +264,8 @@ describe("use/listFilter", () => {
             });
         });
         it("parentInstance.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: {
@@ -319,7 +320,7 @@ describe("use/listFilter", () => {
             });
         });
         it("parentInstance.calculatedObjects is updated", async () => {
-            const list = useListInstance({ props: {} });
+            const list = useListInstance({ props: { pkKey: "id" } });
             const calculated = useListCalculated({
                 parentState: list.state,
                 calculatedObjectsRules: reactive({
@@ -363,7 +364,7 @@ describe("use/listFilter", () => {
         });
     });
     it("you can use nested useListFilters", async () => {
-        const list = useListInstance({ props: {} });
+        const list = useListInstance({ props: { pkKey: "id" } });
 
         function filter1AllowedFilter(object) {
             return object.has_things && object.has_stuff;