@arrai-innovations/reactive-helpers 13.0.4 → 14.0.1

package/docs/use/listFilter.md

@@ -38,7 +38,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning
 
@@ -98,15 +98,15 @@ The last error encountered.
 
 Indicates if an error occurred during the last operation.
 
-###### fkForIdAndRule
+###### fkForPkAndRule
 
-> **fkForIdAndRule**: `object`
+> **fkForPkAndRule**: `object`
 
-Maintains computed references to the foreign keys for each object ID and rule, crucial for navigating complex data relationships.
+Maintains computed references to the foreign keys for each object pk and rule, crucial for navigating complex data relationships.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### intendToList
 
@@ -132,21 +132,21 @@ Arguments passed to the server for listing operations.
 
 Indicates if the list is currently loading.
 
-###### objAndKeyForIdAndRule
+###### objAndKeyForPkAndRule
 
-> **objAndKeyForIdAndRule**: `object`
+> **objAndKeyForPkAndRule**: `object`
 
-Maps each object ID and rule to a tuple consisting of the related object and its respective key, facilitating direct data manipulation.
+Maps each object pk and rule to a tuple consisting of the related object and its respective key, facilitating direct data manipulation.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### 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
 
@@ -160,15 +160,21 @@ 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.
+
 ###### relatedObjects
 
 > **relatedObjects**: `object`
 
-Stores computed references to related objects, allowing for dynamic access based on object ID and specific rules.
+Stores computed references to related objects, allowing for dynamic access based on object pk and specific rules.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### relatedObjectsParentStateObjectsWatchRunning
 
@@ -260,7 +266,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning
 
@@ -320,15 +326,15 @@ The last error encountered.
 
 Indicates if an error occurred during the last operation.
 
-###### fkForIdAndRule
+###### fkForPkAndRule
 
-> **fkForIdAndRule**: `object`
+> **fkForPkAndRule**: `object`
 
-Maintains computed references to the foreign keys for each object ID and rule, crucial for navigating complex data relationships.
+Maintains computed references to the foreign keys for each object pk and rule, crucial for navigating complex data relationships.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### intendToList
 
@@ -354,21 +360,21 @@ Arguments passed to the server for listing operations.
 
 Indicates if the list is currently loading.
 
-###### objAndKeyForIdAndRule
+###### objAndKeyForPkAndRule
 
-> **objAndKeyForIdAndRule**: `object`
+> **objAndKeyForPkAndRule**: `object`
 
-Maps each object ID and rule to a tuple consisting of the related object and its respective key, facilitating direct data manipulation.
+Maps each object pk and rule to a tuple consisting of the related object and its respective key, facilitating direct data manipulation.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### 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
 
@@ -382,15 +388,21 @@ 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.
+
 ###### relatedObjects
 
 > **relatedObjects**: `object`
 
-Stores computed references to related objects, allowing for dynamic access based on object ID and specific rules.
+Stores computed references to related objects, allowing for dynamic access based on object pk and specific rules.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### relatedObjectsParentStateObjectsWatchRunning
 
@@ -476,7 +488,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning
 
@@ -542,15 +554,15 @@ Indicates if an error occurred during the last operation.
 
 Function to determine if an item should be excluded based on custom logic.
 
-###### fkForIdAndRule
+###### fkForPkAndRule
 
-> **fkForIdAndRule**: `object`
+> **fkForPkAndRule**: `object`
 
-Maintains computed references to the foreign keys for each object ID and rule, crucial for navigating complex data relationships.
+Maintains computed references to the foreign keys for each object pk and rule, crucial for navigating complex data relationships.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### inResults
 
@@ -582,21 +594,21 @@ Arguments passed to the server for listing operations.
 
 Indicates if the list is currently loading.
 
-###### objAndKeyForIdAndRule
+###### objAndKeyForPkAndRule
 
-> **objAndKeyForIdAndRule**: `object`
+> **objAndKeyForPkAndRule**: `object`
 
-Maps each object ID and rule to a tuple consisting of the related object and its respective key, facilitating direct data manipulation.
+Maps each object pk and rule to a tuple consisting of the related object and its respective key, facilitating direct data manipulation.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### 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
 
@@ -622,15 +634,21 @@ The order of objects in the list.
 
 Flag indicating if the order watch is active.
 
+###### pkKey
+
+> **pkKey**: `string`
+
+The primary key field for the list objects.
+
 ###### relatedObjects
 
 > **relatedObjects**: `object`
 
-Stores computed references to related objects, allowing for dynamic access based on object ID and specific rules.
+Stores computed references to related objects, allowing for dynamic access based on object pk and specific rules.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### relatedObjectsParentStateObjectsWatchRunning
 

package/docs/use/listInstance.md

@@ -105,7 +105,7 @@ Handles new or updated objects, respecting the keepOldPages setting.
 
 > **deleteListObject**: (`objectId`) => `void`
 
-Deletes an object from the list by ID.
+Deletes an object from the list by pk.
 
 ###### Parameters
 
@@ -115,11 +115,11 @@ Deletes an object from the list by ID.
 
 `void`
 
-##### getFakeId()
+##### getFakePk()
 
-> **getFakeId**: () => `string`
+> **getFakePk**: () => `string`
 
-Generates a unique fake ID for use within the list.
+Generates a unique fake pk for use within the list.
 
 ###### Returns
 
@@ -220,6 +220,12 @@ Implementation specific arguments.
 
 The arguments passed to the server.
 
+###### pkKey
+
+> **pkKey**: `string`
+
+The primary key field for the list objects.
+
 ###### retrieveArgs
 
 > **retrieveArgs**: `any`
@@ -244,6 +250,12 @@ Implementation specific arguments.
 
 The arguments passed to the server.
 
+##### pkKey
+
+> **pkKey**: `string`
+
+The primary key field for the list objects.
+
 ##### retrieveArgs
 
 > **retrieveArgs**: `any`
@@ -300,9 +312,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
 
@@ -316,6 +328,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`
@@ -372,9 +390,9 @@ Indicates if there are ongoing reactive updates.
 
 #### Type declaration
 
-##### id
+##### pk
 
-> **id**: `string`
+> **pk**: `string`
 
 ***
 
@@ -386,15 +404,15 @@ Indicates if there are ongoing reactive updates.
 
 ***
 
-### ObjectsById
+### ObjectsByPk
 
-> **ObjectsById**\<\>: `object`
+> **ObjectsByPk**\<\>: `object`
 
 #### Type Parameters
 
 #### Index Signature
 
- \[`key`: `string`\]: [`ListObject`](listInstance.md#listobject)
+ \[`pk`: `string`\]: [`ListObject`](listInstance.md#listobject)
 
 ***
 

package/docs/use/listRelated.md

@@ -74,9 +74,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
 
@@ -90,6 +90,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`
@@ -206,9 +212,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
 
@@ -222,6 +228,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`
@@ -294,15 +306,15 @@ The last error encountered.
 
 Indicates if an error occurred during the last operation.
 
-###### fkForIdAndRule
+###### fkForPkAndRule
 
-> **fkForIdAndRule**: `object`
+> **fkForPkAndRule**: `object`
 
-Maintains computed references to the foreign keys for each object ID and rule, crucial for navigating complex data relationships.
+Maintains computed references to the foreign keys for each object pk and rule, crucial for navigating complex data relationships.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### intendToList
 
@@ -328,21 +340,21 @@ Arguments passed to the server for listing operations.
 
 Indicates if the list is currently loading.
 
-###### objAndKeyForIdAndRule
+###### objAndKeyForPkAndRule
 
-> **objAndKeyForIdAndRule**: `object`
+> **objAndKeyForPkAndRule**: `object`
 
-Maps each object ID and rule to a tuple consisting of the related object and its respective key, facilitating direct data manipulation.
+Maps each object pk and rule to a tuple consisting of the related object and its respective key, facilitating direct data manipulation.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### 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
 
@@ -356,15 +368,21 @@ 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.
+
 ###### relatedObjects
 
 > **relatedObjects**: `object`
 
-Stores computed references to related objects, allowing for dynamic access based on object ID and specific rules.
+Stores computed references to related objects, allowing for dynamic access based on object pk and specific rules.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### relatedObjectsParentStateObjectsWatchRunning
 
@@ -442,35 +460,35 @@ The watches running instance.
 
 #### Properties
 
-##### fkForIdAndRule
+##### fkForPkAndRule
 
-> **fkForIdAndRule**: `object`
+> **fkForPkAndRule**: `object`
 
-Maintains computed references to the foreign keys for each object ID and rule, crucial for navigating complex data relationships.
+Maintains computed references to the foreign keys for each object pk and rule, crucial for navigating complex data relationships.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
-##### objAndKeyForIdAndRule
+##### objAndKeyForPkAndRule
 
-> **objAndKeyForIdAndRule**: `object`
+> **objAndKeyForPkAndRule**: `object`
 
-Maps each object ID and rule to a tuple consisting of the related object and its respective key, facilitating direct data manipulation.
+Maps each object pk and rule to a tuple consisting of the related object and its respective key, facilitating direct data manipulation.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ##### relatedObjects
 
 > **relatedObjects**: `object`
 
-Stores computed references to related objects, allowing for dynamic access based on object ID and specific rules.
+Stores computed references to related objects, allowing for dynamic access based on object pk and specific rules.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ##### relatedObjectsParentStateObjectsWatchRunning
 
@@ -514,7 +532,7 @@ General flag that indicates if the list-related logic is processing, used to man
 
 ##### objects
 
-> **objects**: [`ObjectsById`](listInstance.md#objectsbyid)
+> **objects**: [`ObjectsByPk`](listInstance.md#objectsbypk)
 
 The objects that can be related based on the foreign key.
 
@@ -629,6 +647,7 @@ const listInstanceProps = reactive({
         // whatever arguments are required for your configured list function to get the right list
         someListFilter: toRef(props, "someListFilter"),
     },
+    pkKey: 'id',
     retrieveArgs: {
         // whatever arguments are required for your configured list function to get items back looking as expected
     },
@@ -641,7 +660,7 @@ const listRelatedProps = reactive({
     relatedObjectsRules: {
         someRule: {
             // this can point to a key or an array of keys to relate to
-            pkKey: "dot.separated.key.to.id.on.an.listInstance.object",
+            pkKey: "dot.separated.key.to.pk.on.an.listInstance.object",
             objects: toRef(props, "objects"),
             order: toRef(props, "order"),
         },