@arrai-innovations/reactive-helpers 13.1.0 → 14.0.2

package/README.md

@@ -90,6 +90,7 @@ const listProps = reactive({
     crudArgs: {
         stream: "contacts",
     },
+    pkKey: "id",
     retrieveArgs: {
         fields: ["id", "has_name", "lexical_name", "organization", "phone"],
     },
@@ -156,6 +157,7 @@ const listProps = reactive({
         subscribeAction: "subscribe_contacts",
         unsubscribeAction: "unsubscribe_contacts",
     },
+    pkKey: "id",
     retrieveArgs: {
         fields: ["id", "has_name", "lexical_name", "organization", "phone"],
     },
@@ -218,6 +220,7 @@ import { useListInstance, useListRelated, doAwaitNot } from "@arrai-innovations/
 import { reactive, toRef } from "vue";
 
 const organizationsProps = reactive({
+    pkKey: "id",
     retrieveArgs: {
         fields: ["id", "name"],
     },
@@ -226,6 +229,7 @@ const organizations = useListInstance({
     props: organizationsProps,
 });
 const contactsProps = reactive({
+    pkKey: "id",
     retrieveArgs: {
         fields: ["id", "lexical_name", "organization"],
     },
@@ -301,6 +305,7 @@ import { useListInstance, useListCalculated } from "@arrai-innovations/reactive-
 import { nextTick, reactive } from "vue";
 
 const contactsProps = reactive({
+    pkKey: "id",
     retrieveArgs: {
         fields: ["id", "has_name", "has_billing", "lexical_name", "organization"],
     },
@@ -355,6 +360,7 @@ import { useListInstance, useListFilter, doAwaitNot } from "@arrai-innovations/r
 import { reactive, ref } from "vue";
 
 const contactsProps = reactive({
+    pkKey: "id",
     retrieveArgs: {
         fields: ["id", "has_name", "has_billing", "lexical_name", "organization"],
     },
@@ -399,6 +405,7 @@ import { useListInstance, useListSearch, doAwaitNot } from "@arrai-innovations/r
 import { reactive } from "vue";
 
 const contactsProps = reactive({
+    pkKey: "id",
     retrieveArgs: {
         fields: ["id", "has_name", "has_billing", "lexical_name", "organization"],
     },
@@ -443,6 +450,7 @@ import { useListInstance, useListSort, doAwaitNot } from "@arrai-innovations/rea
 import { reactive } from "vue";
 
 const contactsProps = reactive({
+    pkKey: "id",
     retrieveArgs: {
         fields: ["id", "has_name", "lexical_name", "organization"],
     },
@@ -487,6 +495,7 @@ const managedListProps = reactive({
         subscribeAction: "subscribe_contacts",
         unsubscribeAction: "unsubscribe_contacts",
     },
+    pkKey: "id",
     retrieveArgs: {
         fields: ["id", "has_name", "lexical_name", "organization", "phone"],
     },
@@ -664,7 +673,8 @@ const managedObjectProps = reactive({
     retrieveArgs: {
         fields: ["id", "has_name", "lexical_name", "organization", "phone"],
     },
-    id: contactId,
+    pk: contactId,
+    pkKey: "id",
     relatedObjectRules: {
         organization: {
             // desired key on relatedObjects

package/config/listCrud.js

@@ -33,6 +33,7 @@ const defaultCrud = {
 /**
  * @typedef {object} ListFnArgs
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @property {string} pkKey - The key name of the primary key.
  * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
  * @property {object} listArgs - The arguments to be passed for list crud functions.
  * @property {PageCallback} pageCallback - The method to call with new page(s) of data received.
@@ -43,7 +44,8 @@ const defaultCrud = {
 /**
  * @typedef {object} DeleteFnArgs
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
- * @property {string[]} ids - The ids of the objects to be deleted.
+ * @property {string[]} pks - The ids of the objects to be deleted.
+ * @property {string} pkKey - The key name of the primary key.
  */
 
 /**
@@ -56,6 +58,7 @@ const defaultCrud = {
 /**
  * @typedef {object} SubscribeFnArgs
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @property {string} pkKey - The key name of the primary key.
  * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
  * @property {object} listArgs - The arguments to be passed for list crud functions.
  * @property {SubscriptionEventCallback} subscriptionEventCallback - The method to call when new data is received.

package/config/objectCrud.js

@@ -31,12 +31,14 @@ const defaultCrud = {
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
  * @property {object} object - The data to be acted upon.
  * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {string} pkKey - The key name of the primary key.
  */
 
 /**
  * @typedef {object} RetrieveDetailArgs
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
- * @property {string} id - The id of the object to be acted upon.
+ * @property {string} pk - The pk of the object to be acted upon.
+ * @property {string} pkKey - The key name of the primary key.
  * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
  */
 
@@ -45,19 +47,22 @@ const defaultCrud = {
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
  * @property {import('../use/objectInstance.js').CrudObject} object - The data to be acted upon.
  * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {string} pkKey - The key name of the primary key.
  */
 
 /**
  * @typedef {object} DeleteDetailArgs
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
- * @property {string} id - The id of the object to be acted upon.
+ * @property {string} pk - The pk of the object to be acted upon.
+ * @property {string} pkKey - The key name of the primary key.
  * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
  */
 
 /**
  * @typedef {object} PartialDetailArgs
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
- * @property {string} id - The id of the object to be acted upon.
+ * @property {string} pk - The pk of the object to be acted upon.
+ * @property {string} pkKey - The key name of the primary key.
  * @property {object} partialObject - The data to be acted upon.
  * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
  */
@@ -65,7 +70,8 @@ const defaultCrud = {
 /**
  * @typedef {object} SubscribeArgs
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
- * @property {string} id - The id of the object to be acted upon.
+ * @property {string} pk - The pk of the object to be acted upon.
+ * @property {string} pkKey - The key name of the primary key.
  * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
  * @property {(
  *     data:import('../use/objectInstance.js').CrudObject, action:string

package/docs/README.md

@@ -34,7 +34,7 @@
 - [utils/compact](utils/compact.md)
 - [utils/deleteKey](utils/deleteKey.md)
 - [utils/flattenPaths](utils/flattenPaths.md)
-- [utils/getFakeId](utils/getFakeId.md)
+- [utils/getFakePk](utils/getFakePk.md)
 - [utils/keyDiff](utils/keyDiff.md)
 - [utils/loadingCombine](utils/loadingCombine.md)
 - [utils/proxyRunning](utils/proxyRunning.md)

package/docs/config/listCrud.md

@@ -18,9 +18,15 @@
 
 The arguments to be passed to the crud functions.
 
-##### ids
+##### pkKey
 
-> **ids**: `string`[]
+> **pkKey**: `string`
+
+The key name of the primary key.
+
+##### pks
+
+> **pks**: `string`[]
 
 The ids of the objects to be deleted.
 
@@ -91,6 +97,12 @@ The arguments to be passed for list crud functions.
 
 The method to call with new page(s) of data received.
 
+##### pkKey
+
+> **pkKey**: `string`
+
+The key name of the primary key.
+
 ##### retrieveArgs
 
 > **retrieveArgs**: `any`
@@ -139,6 +151,12 @@ The arguments to be passed to the crud functions.
 
 The arguments to be passed for list crud functions.
 
+##### pkKey
+
+> **pkKey**: `string`
+
+The key name of the primary key.
+
 ##### retrieveArgs
 
 > **retrieveArgs**: `any`

package/docs/config/objectCrud.md

@@ -24,6 +24,12 @@ The arguments to be passed to the crud functions.
 
 The data to be acted upon.
 
+##### pkKey
+
+> **pkKey**: `string`
+
+The key name of the primary key.
+
 ##### retrieveArgs
 
 > **retrieveArgs**: `any`
@@ -42,11 +48,17 @@ The arguments to be passed to the retrieve function.
 
 The arguments to be passed to the crud functions.
 
-##### id
+##### pk
+
+> **pk**: `string`
+
+The pk of the object to be acted upon.
+
+##### pkKey
 
-> **id**: `string`
+> **pkKey**: `string`
 
-The id of the object to be acted upon.
+The key name of the primary key.
 
 ##### retrieveArgs
 
@@ -168,18 +180,24 @@ A function to be used instead of the default crud update function.
 
 The arguments to be passed to the crud functions.
 
-##### id
-
-> **id**: `string`
-
-The id of the object to be acted upon.
-
 ##### partialObject
 
 > **partialObject**: `any`
 
 The data to be acted upon.
 
+##### pk
+
+> **pk**: `string`
+
+The pk of the object to be acted upon.
+
+##### pkKey
+
+> **pkKey**: `string`
+
+The key name of the primary key.
+
 ##### retrieveArgs
 
 > **retrieveArgs**: `any`
@@ -198,11 +216,17 @@ The arguments to be passed to the retrieve function.
 
 The arguments to be passed to the crud functions.
 
-##### id
+##### pk
+
+> **pk**: `string`
+
+The pk of the object to be acted upon.
+
+##### pkKey
 
-> **id**: `string`
+> **pkKey**: `string`
 
-The id of the object to be acted upon.
+The key name of the primary key.
 
 ##### retrieveArgs
 
@@ -238,11 +262,17 @@ The callback to be called when the object is updated.
 
 The arguments to be passed to the crud functions.
 
-##### id
+##### pk
 
-> **id**: `string`
+> **pk**: `string`
 
-The id of the object to be acted upon.
+The pk of the object to be acted upon.
+
+##### pkKey
+
+> **pkKey**: `string`
+
+The key name of the primary key.
 
 ##### retrieveArgs
 
@@ -268,6 +298,12 @@ The arguments to be passed to the crud functions.
 
 The data to be acted upon.
 
+##### pkKey
+
+> **pkKey**: `string`
+
+The key name of the primary key.
+
 ##### retrieveArgs
 
 > **retrieveArgs**: `any`

package/docs/use/list.md

@@ -150,6 +150,12 @@ The arguments to pass to the registered list crud functions, related to the list
 
 Sorting rules that define the order of list items.
 
+##### pkKey
+
+> **pkKey**: `string`
+
+The primary key for the list items.
+
 ##### relatedObjectsRules
 
 > **relatedObjectsRules**: `object`

package/docs/use/listCalculated.md

@@ -58,15 +58,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
 
@@ -92,21 +92,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
 
@@ -120,15 +120,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
 
@@ -242,15 +248,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
 
@@ -276,21 +282,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
 
@@ -304,15 +310,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
 
@@ -392,7 +404,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning
 
@@ -452,15 +464,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
 
@@ -486,21 +498,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
 
@@ -514,15 +526,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
 
@@ -610,7 +628,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`id`: `string`\]: `object`
+ \[`pk`: `string`\]: `object`
 
 ##### calculatedObjectsParentStateObjectsWatchRunning
 
@@ -720,6 +738,7 @@ const listSubscriptionProps = reactive({
     // whatever props you need to get the list to work with your crud implementation
     crudArgs: {},
     listArgs: {},
+    pkKey: "pk",
     retrieveArgs: {},
     intendToList: true,
 });
@@ -745,7 +764,7 @@ const listComputed = useListComputed(listComputedProps);
             {{ obj }}
             <div>
                 <!-- the computed object or objects based on the rule -->
-                {{ listComputed.state.computedObjects[obj.id].someRule }}
+                {{ listComputed.state.computedObjects[obj.pk].someRule }}
             </div>
         </li>
     </ul>