@arrai-innovations/reactive-helpers 19.0.0 → 20.0.0

package/README.md

@@ -70,11 +70,11 @@ The container for your list of objects, providing loading or error status.
 import { setListCrud } from "@arrai-innovations/reactive-helpers";
 
 setListCrud({
-    list: async function listCrudAdaptor({ crudArgs, retrieveArgs, listArgs, pageCallback }) {
+    list: async function listCrudAdaptor({ target, params, pageCallback }) {
         // todo: your implemenation here.
-        const listOfObjects = await talkToServer(crudArgs, retrieveArgs, listArgs);
+        const listOfObjects = await talkToServer(target, params);
         pageCallback(listOfObjects);
-        const nextListOfObjects = await talkToServerAgain(crudArgs, retrieveArgs, listArgs);
+        const nextListOfObjects = await talkToServerAgain(target, params);
         pageCallback(nextListOfObjects);
     },
 });
@@ -86,15 +86,12 @@ import { useListInstance } from "@arrai-innovations/reactive-helpers";
 import { reactive } from "vue";
 
 const listProps = reactive({
-    // crudArgs are implementation specific to your crud functions.
-    crudArgs: {
+    // target are implementation specific to your crud handlers.
+    target: {
         stream: "contacts",
     },
     pkKey: "id",
-    retrieveArgs: {
-        fields: ["id", "has_name", "lexical_name", "organization", "phone"],
-    },
-    listArgs,
+    params,
 });
 const contacts = useListInstance({
     props: listProps,
@@ -110,12 +107,12 @@ console.log(contacts.error);
 console.log(contacts.objects);
 // { contacts keyed by 'id' }
 // change list or retrieve args directly
-contacts.state.retrieveArgs.fields.push("message_count");
+contacts.state.params.fields.push("message_count");
 await contacts.list();
 console.log(contacts.objects);
 // { contacts keyed by 'id' with message_count  }
 // change list or retrieve args indirectly
-listProps.listArgs.has_organization = false;
+listProps.params.has_organization = false;
 await contacts.list();
 console.log(contacts.objects);
 // { contacts keyed by 'id' with organizationless contacts  }
@@ -130,7 +127,7 @@ Adds functionality to a list instance to receive updates from the server.
 import { setListCrud } from "@arrai-innovations/reactive-helpers";
 setListCrud({
     ..., // in addition to the list crud adaptor above
-    subscribe: function subscribeCrudAdaptor({ crudArgs, retrieveArgs, listArgs, eventCallback }) {
+    subscribe: function subscribeCrudAdaptor({ target, params, eventCallback }) {
         // todo: your implemenation here.
         const subscription = talkToServer(function (data, action) {
             eventCallback(data, action);
@@ -150,19 +147,17 @@ import { useListInstance, useListSubscription } from "@arrai-innovations/reactiv
 import { reactive } from "vue";
 
 const listProps = reactive({
-    // crudArgs are implementation specific to your crud functions.
-    crudArgs: {
+    // target are implementation specific to your crud handlers.
+    target: {
         stream: "contacts",
         includeCreateEvents: true,
         subscribeAction: "subscribe_contacts",
         unsubscribeAction: "unsubscribe_contacts",
     },
     pkKey: "id",
-    retrieveArgs: {
-        fields: ["id", "has_name", "lexical_name", "organization", "phone"],
-    },
-    listArgs: {
+    params: {
         has_organization: true,
+        fields: ["id", "has_name", "lexical_name", "organization", "phone"],
     },
 });
 const contacts = useListInstance({
@@ -179,9 +174,9 @@ contactsSubscription.subscribe();
 // stop getting updates.
 contactsSubscription.unsubscribe();
 // re-retreive the list of existing contacts including another field.
-contacts.retrieveArgs.fields.push("message_count");
+contacts.params.fields.push("message_count");
 // re-retreive the list of all existing contacts.
-delete contacts.listArgs.has_organization;
+delete contacts.params.has_organization;
 ```
 
 ```js
@@ -190,17 +185,15 @@ import { useListSubscription } from "@arrai-innovations/reactive-helpers";
 import { reactive } from "vue";
 
 const listProps = reactive({
-    // crudArgs are implementation specific to your crud functions.
-    crudArgs: {
+    // target are implementation specific to your crud handlers.
+    target: {
         stream: "contacts",
         includeCreateEvents: true,
         subscribeAction: "subscribe_contacts",
         unsubscribeAction: "unsubscribe_contacts",
     },
-    retrieveArgs: {
+    params: {
         fields: ["id", "has_name", "lexical_name", "organization", "phone"],
-    },
-    listArgs: {
         has_organization: true,
     },
 });
@@ -221,7 +214,7 @@ import { reactive, toRef } from "vue";
 
 const organizationsProps = reactive({
     pkKey: "id",
-    retrieveArgs: {
+    params: {
         fields: ["id", "name"],
     },
 });
@@ -230,7 +223,7 @@ const organizations = useListInstance({
 });
 const contactsProps = reactive({
     pkKey: "id",
-    retrieveArgs: {
+    params: {
         fields: ["id", "lexical_name", "organization"],
     },
 });
@@ -306,7 +299,7 @@ import { nextTick, reactive } from "vue";
 
 const contactsProps = reactive({
     pkKey: "id",
-    retrieveArgs: {
+    params: {
         fields: ["id", "has_name", "has_billing", "lexical_name", "organization"],
     },
 });
@@ -361,7 +354,7 @@ import { reactive, ref } from "vue";
 
 const contactsProps = reactive({
     pkKey: "id",
-    retrieveArgs: {
+    params: {
         fields: ["id", "has_name", "has_billing", "lexical_name", "organization"],
     },
 });
@@ -406,7 +399,7 @@ import { reactive } from "vue";
 
 const contactsProps = reactive({
     pkKey: "id",
-    retrieveArgs: {
+    params: {
         fields: ["id", "has_name", "has_billing", "lexical_name", "organization"],
     },
 });
@@ -451,7 +444,7 @@ import { reactive } from "vue";
 
 const contactsProps = reactive({
     pkKey: "id",
-    retrieveArgs: {
+    params: {
         fields: ["id", "has_name", "lexical_name", "organization"],
     },
 });
@@ -488,19 +481,17 @@ import { useList } from "@arrai-innovations/reactive-helpers";
 import { reactive, toRef } from "vue";
 
 const managedListProps = reactive({
-    // crudArgs are implementation specific to your crud functions.
-    crudArgs: {
+    // target are implementation specific to your crud handlers.
+    target: {
         stream: "contacts",
         includeCreateEvents: true,
         subscribeAction: "subscribe_contacts",
         unsubscribeAction: "unsubscribe_contacts",
     },
     pkKey: "id",
-    retrieveArgs: {
-        fields: ["id", "has_name", "lexical_name", "organization", "phone"],
-    },
-    listArgs: {
+    params: {
         has_organization: true,
+        fields: ["id", "has_name", "lexical_name", "organization", "phone"],
     },
     relatedObjectsRules: {
         organization: {
@@ -524,7 +515,7 @@ const managedListProps = reactive({
 });
 const managedList = useList({
     props: managedListProps,
-    functions: {
+    handlers: {
         list: customListFunction,
         subscribe: customSubscribeFunction,
     },
@@ -553,31 +544,31 @@ console.log(managedList.managed);
 import { setObjectCrud } from "@arrai-innovations/reactive-helpers";
 
 setObjectCrud({
-    create: async function createCrudAdaptor({ crudArgs, retrieveArgs, object }) {
+    create: async function createCrudAdaptor({ target, params, object }) {
         // todo: your implemenation here.
         const newObject = await talkToServer(object);
         return newObject;
     },
-    retrieve: async function retrieveCrudAdaptor({ crudArgs, retrieveArgs, id }) {
+    retrieve: async function retrieveCrudAdaptor({ target, params, id }) {
         // todo: your implemenation here.
         const retrievedObject = await talkToServer(id);
         return retrievedObject;
     },
-    update: async function updateCrudAdaptor({ crudArgs, retrieveArgs, object }) {
+    update: async function updateCrudAdaptor({ target, params, object }) {
         // todo: your implemenation here.
         const updatedObject = await talkToServer(object);
         return updatedObject;
     },
-    delete: async function deleteCrudAdaptor({ crudArgs, id }) {
+    delete: async function deleteCrudAdaptor({ target, id }) {
         // todo: your implemenation here.
         await talkToServer(id);
     },
-    patch: async function patchCrudAdaptor({ crudArgs, retrieveArgs, id, partialObject }) {
+    patch: async function patchCrudAdaptor({ target, params, id, partialObject }) {
         // todo: your implemenation here.
         const patchedObject = await talkToServer(object);
         return patchedObject; // still return the full object.
     },
-    subscribe: function subscribeCrudAdaptor({ crudArgs, retrieveArgs, listArgs, eventCallback }) {
+    subscribe: function subscribeCrudAdaptor({ target, params, params, eventCallback }) {
         // todo: your implemenation here.
         const subscription = talkToServer(function (data, action) {
             eventCallback(data, action);
@@ -602,10 +593,10 @@ import {
 
 const contactObject = useObjectInstance({
     props: {
-        crudArgs: {
+        target: {
             stream: "contacts",
         },
-        retrieveArgs: {
+        params: {
             fields: ["id", "has_name", "lexical_name", "organization", "phone"],
         },
         id: contactId,
@@ -618,10 +609,10 @@ const contactSubscription = useObjectSubscription({
 // or
 const contactSubscription = useObjectSubscription({
     props: {
-        crudArgs: {
+        target: {
             stream: "contacts",
         },
-        retrieveArgs: {
+        params: {
             fields: ["id", "has_name", "lexical_name", "organization", "phone"],
         },
         id: contactId,
@@ -630,10 +621,10 @@ const contactSubscription = useObjectSubscription({
 console.log(contactSubscription.state.object);
 const organizations = useList({
     props: {
-        crudArgs: {
+        target: {
             stream: "organizations",
         },
-        retrieveArgs: {
+        params: {
             fields: ["id", "name"],
         },
     },
@@ -667,10 +658,10 @@ import { useObject } from "@arrai-innovations/reactive-helpers";
 import { reactive } from "vue";
 
 const managedObjectProps = reactive({
-    crudArgs: {
+    target: {
         stream: "contacts",
     },
-    retrieveArgs: {
+    params: {
         fields: ["id", "has_name", "lexical_name", "organization", "phone"],
     },
     pk: contactId,
@@ -690,7 +681,7 @@ const managedObjectProps = reactive({
 });
 const managedObject = useObject({
     props: managedObjectProps,
-    functions: {
+    handlers: {
         retrieve: customRetrieveFunction,
         subscribe: customSubscribeFunction,
     },

package/config/commonCrud.js

@@ -43,33 +43,33 @@ export const createDefaultCrud = (keys, cancellableKeys = new Set()) => {
 };
 
 /**
- * Assigns the default CRUD functions to the target object.
+ * Assigns the default CRUD handlers to the target object.
  *
  * @param {object} target - The reactive object to assign to.
  * @param {object} defaultCrud - The default CRUD definition (usually created by `createDefaultCrud`).
  * @param {object} [options] - The options object.
  * @param {object} [options.props] - The props object.
- * @param {object} [options.functions] - The functions to assign.
- * @param {Set<string>} [options.validKeys] - The valid keys for the functions.
+ * @param {object} [options.handlers] - The functions to assign.
+ * @param {Set<string>} [options.validKeys] - The valid keys for the handlers.
  */
 export function assignCrud(
     target,
     defaultCrud,
-    { props, functions, validKeys = new Set(Object.keys(defaultCrud).filter((k) => k !== "args")) } = {}
+    { props, handlers, validKeys = new Set(Object.keys(defaultCrud).filter((k) => k !== "args")) } = {}
 ) {
     Object.assign(target, cloneDeep(defaultCrud));
-    if (props?.crudArgs) {
-        addOrUpdateReactiveObject(target.args, props.crudArgs);
+    if (props?.target) {
+        addOrUpdateReactiveObject(target.args, props.target);
     }
-    if (functions) {
-        for (const [key, fn] of Object.entries(functions)) {
+    if (handlers) {
+        for (const [key, fn] of Object.entries(handlers)) {
             if (!validKeys.has(key)) {
                 throw new Error(`Invalid function key "${key}" passed to assignCrud`);
             }
             if (!isFunction(fn)) {
                 throw new Error(`Function "${key}" is not actually a function`);
             }
-            target[key] = refIfReactive(functions, key, fn);
+            target[key] = refIfReactive(handlers, key, fn);
         }
     }
 }

package/config/listCrud.js

@@ -3,7 +3,7 @@ import cloneDeep from "lodash-es/cloneDeep.js";
 import { readonly } from "vue";
 
 /**
- * Configuration for the default list crud functions.
+ * Configuration for the default list crud handlers.
  *
  * @module config/listCrud.js
  */
@@ -24,10 +24,9 @@ import { readonly } from "vue";
 
 /**
  * @typedef {object} ListArgs
- * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @property {object} target - The arguments to be passed to the crud handlers.
  * @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 {object} params - The arguments to be passed for list crud handlers.
  * @property {PageCallback} pageCallback - The method to call with new page(s) of data received.
  * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to a boolean indicating whether the request has
  *  been cancelled.
@@ -35,7 +34,7 @@ import { readonly } from "vue";
 
 /**
  * @typedef {object} BulkDeleteArgs
- * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @property {object} target - The arguments to be passed to the crud handlers.
  * @property {string[]} pks - The ids of the objects to be deleted.
  * @property {string} pkKey - The key name of the primary key.
  * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to a boolean indicating whether the request has
@@ -51,10 +50,9 @@ import { readonly } from "vue";
 
 /**
  * @typedef {object} ListSubscribeArgs
- * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @property {object} target - The arguments to be passed to the crud handlers.
  * @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 {object} params - The arguments to be passed for list crud handlers.
  * @property {SubscriptionEventCallback} subscriptionEventCallback - The method to call when new data is received.
  * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to a boolean indicating whether the request has
  *  been cancelled.
@@ -62,7 +60,7 @@ import { readonly } from "vue";
 
 /**
  * @typedef {object} ExecuteActionArgs
- * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @property {object} target - The arguments to be passed to the crud handlers.
  * @property {string[]} pks - The ids of the objects to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
  * @property {string} action - The action to execute.
@@ -72,30 +70,30 @@ import { readonly } from "vue";
 
 /**
  * @callback CrudListFn
- * @param {ListArgs} args - The arguments to be passed to the crud functions.
+ * @param {ListArgs} args - The arguments to be passed to the crud handlers.
  * @returns {import('../utils/cancellablePromise.js').MaybeCancellablePromise<void>} - A promise that resolves to a boolean indicating success.
  */
 
 /**
  * @callback CrudBulkDeleteFn
- * @param {BulkDeleteArgs} args - The arguments to be passed to the crud functions.
+ * @param {BulkDeleteArgs} args - The arguments to be passed to the crud handlers.
  * @returns {import('../utils/cancellablePromise.js').MaybeCancellablePromise<void>} - A promise that resolves to a boolean indicating success.
  */
 
 /**
  * @callback CrudListSubscribeFn
- * @param {ListSubscribeArgs} args - The arguments to be passed to the crud functions.
+ * @param {ListSubscribeArgs} args - The arguments to be passed to the crud handlers.
  * @returns {import('../utils/cancellablePromise.js').CancellablePromise<void>} - A promise that resolves to a boolean indicating success.
  */
 
 /**
  * @callback CrudExecuteActionFn
- * @param {ExecuteActionArgs} args - The arguments to be passed to the crud functions.
+ * @param {ExecuteActionArgs} args - The arguments to be passed to the crud handlers.
  * @returns {import('../utils/cancellablePromise.js').MaybeCancellablePromise<object|string|null>} - A promise that resolves the result of the action, returned to the executor.
  */
 
 /**
- * @typedef {object} ListCrudFunctions
+ * @typedef {object} ListCrudHandlers
  * @property {CrudListFn} [list] - The list function to get a list of items.
  * @property {CrudBulkDeleteFn} [bulkDelete] - The delete function to bulk delete a list of items.
  * @property {CrudExecuteActionFn} [executeAction] - The  function to execute a certain action on a list of items.
@@ -103,28 +101,28 @@ import { readonly } from "vue";
  */
 
 /**
- * @typedef {object} ListCrudArgs
- * @property {object} args - The default arguments for the crud functions.
+ * @typedef {object} ListTarget
+ * @property {object} args - The default arguments for the crud handlers.
  */
 
 /**
- * @typedef {object} ListCrudArgsOption
- * @property {object} [crudArgs={}] - The default arguments for the crud functions.
+ * @typedef {object} ListTargetOption
+ * @property {object} [target={}] - The default arguments for the crud handlers.
  */
 
 const _defaultCrud = createDefaultCrud(["list", "bulkDelete", "executeAction", "subscribe"], new Set(["subscribe"]));
 
 /**
- * The default list crud functions.
+ * The default list crud handlers.
  *
- * @type {Readonly<ListCrudFunctions>}
+ * @type {Readonly<ListCrudHandlers>}
  */
 export const defaultListCrud = readonly(_defaultCrud);
 
 /**
- * Set the list and subscribe functions for the default crud.
+ * Set the list and subscribe handlers for the default crud.
  *
- * @param {ListCrudFunctions & Partial<ListCrudArgs>} options - The options for the default crud.
+ * @param {ListCrudHandlers & Partial<ListTarget>} options - The options for the default crud.
  * @throws {Error} - If unknown keys are passed.
  * @returns {void}
  */
@@ -139,12 +137,12 @@ export const setListCrud = ({ args = {}, ...rest }) => {
 };
 
 /**
- * Get the previously set list and subscribe functions for the default crud.
+ * Get the previously set list and subscribe handlers for the default crud.
  *
- * @param {import("vue").UnwrapNestedRefs<ListCrudFunctions & ListCrudArgs>} target - The reactive crud object, which will be mutated.
+ * @param {import("vue").UnwrapNestedRefs<ListCrudHandlers & ListTarget>} target - The reactive crud object, which will be mutated.
  * @param {object} options - The options for the default crud.
- * @param {import("vue").UnwrapNestedRefs<ListCrudArgsOption>} [options.props] - The props to set for the crud.
- * @param {ListCrudFunctions} [options.functions] - The functions to set for the crud.
+ * @param {import("vue").UnwrapNestedRefs<ListTargetOption>} [options.props] - The props to set for the crud.
+ * @param {ListCrudHandlers} [options.handlers] - The functions to set for the crud.
  * @throws {Error} - If an invalid function is passed, or if the function is not a function.
  */
 export const getListCrud = (target, options) => {

package/config/objectCrud.js

@@ -3,57 +3,57 @@ import cloneDeep from "lodash-es/cloneDeep.js";
 import { readonly } from "vue";
 
 /**
- * Configuration for the default object crud functions.
+ * Configuration for the default object crud handlers.
  *
  * @module config/objectCrud.js
  */
 
 /**
- * @typedef {{[key:string]: any}} ObjectCrudArgsArgs
+ * @typedef {{[key:string]: any}} ObjectTargetArgs
  */
 
 /**
- * Defines the CRUD-related functions and additional utilities provided by the object instance.
+ * Defines the CRUD-related handlers and additional utilities provided by the object instance.
  *
- * @typedef {object} ObjectCrudArgsProperties
- * @property {ObjectCrudArgsArgs} args - The arguments to be passed to the crud functions.
+ * @typedef {object} ObjectTargetProperties
+ * @property {ObjectTargetArgs} args - The arguments to be passed to the crud handlers.
  */
 
 /**
- * @typedef {object} ObjectCrudArgsOption
- * @property {ObjectCrudArgsArgs} [crudArgs={}] - The arguments to be passed to the crud functions.
+ * @typedef {object} ObjectTargetOption
+ * @property {ObjectTargetArgs} [target={}] - The arguments to be passed to the crud handlers.
  */
 
 /**
  * @typedef {object} CreateArgs
- * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @property {{[key:string]: any}} object - The data to be acted upon.
- * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {{[key:string]: any}} params - The arguments to be passed to the retrieve function.
  * @property {string} pkKey - The key name of the primary key.
  * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
  */
 
 /**
  * @typedef {object} RetrieveArgs
- * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @property {string} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
- * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {{[key:string]: any}} params - The arguments to be passed to the retrieve function.
  * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
  */
 
 /**
  * @typedef {object} UpdateArgs
- * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @property {import('../use/objectInstance.js').ExistingCrudObject} object - The data to be acted upon.
- * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {{[key:string]: any}} params - The arguments to be passed to the retrieve function.
  * @property {string} pkKey - The key name of the primary key.
  * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
  */
 
 /**
  * @typedef {object} DeleteArgs
- * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @property {string} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
  * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
@@ -61,11 +61,11 @@ import { readonly } from "vue";
 
 /**
  * @typedef {object} PartialArgs
- * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @property {string} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
  * @property {{[key:string]: any}} partialObject - The data to be acted upon.
- * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {{[key:string]: any}} params - The arguments to be passed to the retrieve function.
  * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
  */
 
@@ -77,10 +77,10 @@ import { readonly } from "vue";
 
 /**
  * @typedef {object} ObjectSubscribeArgs
- * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @property {string} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
- * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {{[key:string]: any}} params - The arguments to be passed to the retrieve function.
  * @property {CrudSubscribeCallback} callback - The callback to be called when the object is updated.
  * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
  */
@@ -126,9 +126,9 @@ import { readonly } from "vue";
  */
 
 /**
- * Defines the CRUD-related functions and additional utilities provided by the object instance.
+ * Defines the CRUD-related handlers and additional utilities provided by the object instance.
  *
- * @typedef {object} ObjectCrudFunctions
+ * @typedef {object} ObjectCrudHandlers
  * @property {CrudCreateFn} [create] - A function to be used instead of the default crud create function.
  * @property {CrudRetrieveFn} [retrieve] - A function to be used instead of the default crud retrieve function.
  * @property {CrudUpdateFn} [update] - A function to be used instead of the default crud update function.
@@ -140,7 +140,7 @@ import { readonly } from "vue";
 /**
  * The CRUD arguments.
  *
- * @typedef {ObjectCrudArgsProperties & ObjectCrudFunctions} ObjectCrudArgs
+ * @typedef {ObjectTargetProperties & ObjectCrudHandlers} ObjectTarget
  *
  */
 
@@ -150,16 +150,16 @@ const _defaultCrud = createDefaultCrud(
 );
 
 /**
- * The default object crud functions.
+ * The default object crud handlers.
  *
- * @type {Readonly<ObjectCrudFunctions>}
+ * @type {Readonly<ObjectCrudHandlers>}
  */
 export const defaultObjectCrud = readonly(_defaultCrud);
 
 /**
- * Set the object crud functions.
+ * Set the object crud handlers.
  *
- * @param {ObjectCrudArgs} options - The options for the object crud functions.
+ * @param {ObjectTarget} options - The options for the object crud handlers.
  * @throws {Error} - if unknown keys are passed.
  */
 export const setObjectCrud = ({ args = {}, ...rest }) => {
@@ -173,12 +173,12 @@ export const setObjectCrud = ({ args = {}, ...rest }) => {
 };
 
 /**
- * Get the previously set object crud functions.
+ * Get the previously set object crud handlers.
  *
- * @param {import("vue").UnwrapNestedRefs<ObjectCrudArgsProperties>} target - The reactive object you want to add the resulting crud to.
+ * @param {import("vue").UnwrapNestedRefs<ObjectTargetProperties>} target - The reactive object you want to add the resulting crud to.
  * @param {object} options - The options for the reactive crud object.
- * @param {import("vue").UnwrapNestedRefs<ObjectCrudArgsOption>} [options.props] - The props with any passed crudArgs.
- * @param {ObjectCrudFunctions} [options.functions] - Any functions to override the default crud functions.
+ * @param {import("vue").UnwrapNestedRefs<ObjectTargetOption>} [options.props] - The props with any passed target.
+ * @param {ObjectCrudHandlers} [options.handlers] - Any functions to override the default crud functions.
  * @throws {Error} - If an invalid function is passed, or if the function is not a function.
  */
 export const getObjectCrud = (target, options) => {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "19.0.0",
+    "version": "20.0.0",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "type": "module",
@@ -52,7 +52,7 @@
         "@types/lodash-es": "^4.17.12",
         "@typescript-eslint/eslint-plugin": "^7.18.0",
         "@typescript-eslint/parser": "^7.18.0",
-        "@vitest/coverage-v8": "^3.0.8",
+        "@vitest/coverage-v8": "^3.1.2",
         "@vue/compiler-sfc": "^3.4.37",
         "@vue/eslint-config-prettier": "^9.0.0",
         "@vue/test-utils": "^2.3.2",
@@ -71,7 +71,7 @@
         "typedoc": "^0.27.1",
         "typedoc-plugin-markdown": "^4.3.0",
         "typescript": "^5.5.4",
-        "vitest": "^3.0.8"
+        "vitest": "^3.1.2"
     },
     "dependencies": {
         "@jcoreio/async-throttle": "^1.6.0",