@arrai-innovations/reactive-helpers 13.1.0 → 14.0.2

package/docs/use/listSearch.md

@@ -64,7 +64,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning
 
@@ -130,15 +130,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
 
@@ -170,21 +170,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
 
@@ -210,15 +210,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
 
@@ -370,7 +376,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning
 
@@ -448,15 +454,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
 
@@ -488,15 +494,15 @@ 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`
 
 ###### objectIndexes
 
@@ -506,7 +512,7 @@ Indexes built for quick search across objects based on rules.
 
 ###### objects
 
-> **objects**: [`ObjectsById`](listInstance.md#objectsbyid)
+> **objects**: [`ObjectsByPk`](listInstance.md#objectsbypk)
 
 Currently filtered objects based on the search.
 
@@ -526,7 +532,7 @@ Flag indicating if the object watch is active.
 
 > **order**: `string`[]
 
-The current sort order of object IDs after search have been applied.
+The current sort order of object pks after search have been applied.
 
 ###### orderWatchRunning
 
@@ -534,15 +540,21 @@ The current sort order of object IDs after search have been applied.
 
 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
 
@@ -739,7 +751,7 @@ Indexes built for quick search across objects based on rules.
 
 ##### objects
 
-> **objects**: [`ObjectsById`](listInstance.md#objectsbyid)
+> **objects**: [`ObjectsByPk`](listInstance.md#objectsbypk)
 
 Currently filtered objects based on the search.
 
@@ -753,7 +765,7 @@ The list of objects sorted according to the current search criteria.
 
 > **order**: `ComputedRef`\<`string`[]\>
 
-The current sort order of object IDs after search have been applied.
+The current sort order of object pks after search have been applied.
 
 ##### running
 

package/docs/use/listSort.md

@@ -38,7 +38,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning
 
@@ -116,15 +116,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
 
@@ -156,15 +156,15 @@ 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`
 
 ###### objectIndexes
 
@@ -174,9 +174,9 @@ Indexes built for quick search across objects based on rules.
 
 ###### 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
 
@@ -202,15 +202,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
 
@@ -339,7 +345,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning
 
@@ -417,15 +423,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
 
@@ -457,15 +463,15 @@ 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`
 
 ###### objectIndexes
 
@@ -475,9 +481,9 @@ Indexes built for quick search across objects based on rules.
 
 ###### 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
 
@@ -503,15 +509,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
 
@@ -622,7 +634,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning
 
@@ -700,15 +712,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
 
@@ -740,15 +752,15 @@ 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`
 
 ###### objectIndexes
 
@@ -758,9 +770,9 @@ Indexes built for quick search across objects based on rules.
 
 ###### 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
 
@@ -804,15 +816,21 @@ Flag indicating if the order watch is active.
 
 Flag to indicate if there are pending reactive effects needing resolution.
 
+###### 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
 
@@ -1100,6 +1118,7 @@ import { useListSort, useListInstance } from '@arrai-innovations/reactive-helper
 const listInstanceProps = reactive({
     crudArgs: {},
     listArgs: {},
+    pkKey: 'id',
     retrieveArgs: {},
     intendToList: true,
 });

package/docs/use/listSubscription.md

@@ -166,9 +166,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
 
@@ -182,6 +182,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/object.md

@@ -126,12 +126,6 @@ A function to be used instead of the default crud update function.
 
 [`ResponseData`](../config/objectCrud.md#responsedata)
 
-###### id
-
-> **id**: `string`
-
-The id of the object.
-
 ###### intendToRetrieve
 
 > **intendToRetrieve**: `boolean`
@@ -144,6 +138,18 @@ Whether the object intends to retrieve.
 
 Whether the object intends to subscribe.
 
+###### pk
+
+> **pk**: `string`
+
+The pk of the object, optional to support creating new objects.
+
+###### pkKey
+
+> **pkKey**: `string`
+
+The pk key of the object.
+
 ###### relatedObjectRules
 
 > **relatedObjectRules**: [`ObjectRelatedRawRules`](objectRelated.md#objectrelatedrawrules)
@@ -322,12 +328,6 @@ The error.
 
 Whether the object errored.
 
-###### id
-
-> **id**: `string`
-
-The id of the object.
-
 ###### intendToRetrieve
 
 > **intendToRetrieve**: `boolean`
@@ -358,6 +358,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`
@@ -540,7 +552,7 @@ const someOtherObjectsSource = reactive({
 const props = defineProps({
     app: { type: String, required: true },
     model: { type: String, required: true },
-    id: { type: String, default: "" },
+    pk: { type: String, default: "" },
 });
 
 const objectProps = reactive({
@@ -548,6 +560,8 @@ const objectProps = reactive({
         app: toRef(props, "app"),
         model: toRef(props, "model"),
     },
+    pk: toRef(props, "pk"),
+    pkKey: 'id',
     retrieveArgs: {
         fields: ['foo', 'bar'],
     },
@@ -579,7 +593,7 @@ const objectProps = reactive({
     intendToRetrieve: false,
     intendToSubscribe: false,
 });
-objectProps.intendToRetrieve = objectProps.intendToSubscribe = computed(()=> !!props.id);
+objectProps.intendToRetrieve = objectProps.intendToSubscribe = computed(()=> !!props.pk);
 const objectManager = useObject(objectProps);
 // objectManager.state.object comes back from the server (via configured crud retrieve function)
 // { id: 2, name: 'two', foo: 'bar', some_objects_id: 2, some_objects_list_ids: ['1','2','3'] }

package/docs/use/objectCalculated.md

@@ -138,12 +138,6 @@ The error.
 
 Whether the object errored.
 
-###### id
-
-> **id**: `string`
-
-The id of the object.
-
 ###### intendToRetrieve
 
 > **intendToRetrieve**: `boolean`
@@ -174,6 +168,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`
@@ -386,12 +392,6 @@ The error.
 
 Whether the object errored.
 
-###### id
-
-> **id**: `string`
-
-The id of the object.
-
 ###### intendToRetrieve
 
 > **intendToRetrieve**: `boolean`
@@ -422,6 +422,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`
@@ -655,7 +667,8 @@ const objectSubscriptionProps = reactive({
     // whatever object subscription props you need to work with your crud implementation
     crudArgs: {},
     retrieveArgs: {},
-    id: '1',
+    pk: '1',
+    pkKey: 'id',
     intendToRetrieve: true,
 };
 const objectSubscription = useObjectSubscription(objectSubscriptionProps);