@arrai-innovations/reactive-helpers 13.0.1 → 13.0.3

package/config/listCrud.js

@@ -3,16 +3,69 @@ import cloneDeep from "lodash-es/cloneDeep.js";
 import isFunction from "lodash-es/isFunction.js";
 import { isReactive, toRef } from "vue";
 
+/**
+ * Configuration for the default list crud functions.
+ *
+ * @module config/listCrud.js
+ */
+
 const defaultCrud = {
     args: {},
     list: undefined,
     subscribe: undefined,
 };
 
+/**
+ * @typedef {object} PaginateInfo
+ * @property {number} totalRecords - The total records.
+ * @property {number} totalPages - The total pages.
+ * @property {number} perPage - The per page.
+ */
+
+/**
+ * @typedef {(
+ *     newObjects:import('../use/listInstance.js').ListObject,
+ *     paginationInfo: PaginateInfo|undefined
+ * )=>void} PageCallback
+ */
+
+/**
+ * @typedef {object} ListFnArgs
+ * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @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.
+ * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to a boolean indicating whether the request has
+ *  been cancelled.
+ */
+
+/**
+ * @typedef {(
+ *     newOrUpdatedOrDeleteObject:import('../use/listInstance.js').ListObject|string,
+ *     action: 'create'|'update'|'delete'
+ * )=>void} SubscriptionEventCallback
+ */
+
+/**
+ * @typedef {object} SubscribeFnArgs
+ * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @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.
+ */
+
+/**
+ * @typedef {(ListFnArgs)=>void} ListFn
+ */
+
+/**
+ * @typedef {(SubscribeFnArgs)=>void} SubscribeFn
+ */
+
 /**
  * @typedef {object} ListCrudFunctions
- * @property {Function} [list] - The list function to get a list of items.
- * @property {Function} [subscribe] - The subscribe function to get a subscription to a list of items.
+ * @property {ListFn} [list] - The list function to get a list of items.
+ * @property {SubscribeFn} [subscribe] - The subscribe function to get a subscription to a list of items.
  */
 
 /**

package/config/objectCrud.js

@@ -3,6 +3,12 @@ import cloneDeep from "lodash-es/cloneDeep.js";
 import isFunction from "lodash-es/isFunction.js";
 import { isReactive, toRef } from "vue";
 
+/**
+ * Configuration for the default object crud functions.
+ *
+ * @module config/objectCrud.js
+ */
+
 const defaultCrud = {
     args: {},
     retrieve: undefined,
@@ -20,16 +26,66 @@ const defaultCrud = {
  * @property {object} [args={}] - The arguments to be passed to the crud functions.
  */
 
+/**
+ * @typedef {object} CreateDetailArgs
+ * @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.
+ */
+
+/**
+ * @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 {object} retrieveArgs - The arguments to be passed to the retrieve function.
+ */
+
+/**
+ * @typedef {object} UpdateDetailArgs
+ * @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.
+ */
+
+/**
+ * @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 {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 {object} partialObject - The data to be acted upon.
+ * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
+ */
+
+/**
+ * @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 {object} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {(
+ *     data:import('../use/objectInstance.js').CrudObject, action:string
+ * ) => void} callback - The callback to be called when the object is updated.
+ */
+
+/**
+ * @typedef {Promise<object|string>} ResponseData
+ */
+
 /**
  * Defines the CRUD-related functions and additional utilities provided by the object instance.
  *
  * @typedef {object} ObjectCrudFunctions
- * @property {Function} [create] - A function to be used instead of the default crud create function.
- * @property {Function} [retrieve] - A function to be used instead of the default crud retrieve function.
- * @property {Function} [update] - A function to be used instead of the default crud update function.
- * @property {Function} [delete] - A function to be used instead of the default crud delete function.
- * @property {Function} [patch] - A function to be used instead of the default crud patch function.
- * @property {Function} [subscribe] - A function to be used instead of the default crud subscribe function.
+ * @property {(CreateDetailArgs)=>ResponseData} [create] - A function to be used instead of the default crud create function.
+ * @property {(RetrieveDetailArgs)=>ResponseData} [retrieve] - A function to be used instead of the default crud retrieve function.
+ * @property {(UpdateDetailArgs)=>ResponseData} [update] - A function to be used instead of the default crud update function.
+ * @property {(DeleteDetailArgs)=>ResponseData} [delete] - A function to be used instead of the default crud delete function.
+ * @property {(PartialDetailArgs)=>ResponseData} [patch] - A function to be used instead of the default crud patch function.
+ * @property {(SubscribeArgs)=>void} [subscribe] - A function to be used instead of the default crud subscribe function.
  */
 
 /**

package/docs/config/listCrud.md

@@ -26,16 +26,175 @@ The default arguments for the crud functions.
 
 ##### list
 
-> **list**: `Function`
+> **list**: [`ListFn`](listCrud.md#listfn)
 
 The list function to get a list of items.
 
 ##### subscribe
 
-> **subscribe**: `Function`
+> **subscribe**: [`SubscribeFn`](listCrud.md#subscribefn)
 
 The subscribe function to get a subscription to a list of items.
 
+***
+
+### ListFnArgs
+
+#### Properties
+
+##### crudArgs
+
+> **crudArgs**: `any`
+
+The arguments to be passed to the crud functions.
+
+##### isCancelled
+
+> **isCancelled**: `Readonly`\<`Ref`\<`boolean`\>\>
+
+A ref to a boolean indicating whether the request has
+ been cancelled.
+
+##### listArgs
+
+> **listArgs**: `any`
+
+The arguments to be passed for list crud functions.
+
+##### pageCallback
+
+> **pageCallback**: [`PageCallback`](listCrud.md#pagecallback-1)
+
+The method to call with new page(s) of data received.
+
+##### retrieveArgs
+
+> **retrieveArgs**: `any`
+
+The arguments to be passed to the retrieve function.
+
+***
+
+### PaginateInfo
+
+#### Properties
+
+##### perPage
+
+> **perPage**: `number`
+
+The per page.
+
+##### totalPages
+
+> **totalPages**: `number`
+
+The total pages.
+
+##### totalRecords
+
+> **totalRecords**: `number`
+
+The total records.
+
+***
+
+### SubscribeFnArgs
+
+#### Properties
+
+##### crudArgs
+
+> **crudArgs**: `any`
+
+The arguments to be passed to the crud functions.
+
+##### listArgs
+
+> **listArgs**: `any`
+
+The arguments to be passed for list crud functions.
+
+##### retrieveArgs
+
+> **retrieveArgs**: `any`
+
+The arguments to be passed to the retrieve function.
+
+##### subscriptionEventCallback
+
+> **subscriptionEventCallback**: [`SubscriptionEventCallback`](listCrud.md#subscriptioneventcallback-1)
+
+The method to call when new data is received.
+
+## Type Aliases
+
+### ListFn()
+
+> **ListFn**\<\>: (`ListFnArgs`) => `void`
+
+#### Type Parameters
+
+#### Parameters
+
+• **ListFnArgs**: `any`
+
+#### Returns
+
+`void`
+
+***
+
+### PageCallback()
+
+> **PageCallback**\<\>: (`newObjects`, `paginationInfo`) => `void`
+
+#### Type Parameters
+
+#### Parameters
+
+• **newObjects**: [`use/listInstance`](../use/listInstance.md)
+
+• **paginationInfo**: [`PaginateInfo`](listCrud.md#paginateinfo) \| `undefined`
+
+#### Returns
+
+`void`
+
+***
+
+### SubscribeFn()
+
+> **SubscribeFn**\<\>: (`SubscribeFnArgs`) => `void`
+
+#### Type Parameters
+
+#### Parameters
+
+• **SubscribeFnArgs**: `any`
+
+#### Returns
+
+`void`
+
+***
+
+### SubscriptionEventCallback()
+
+> **SubscriptionEventCallback**\<\>: (`newOrUpdatedOrDeleteObject`, `action`) => `void`
+
+#### Type Parameters
+
+#### Parameters
+
+• **newOrUpdatedOrDeleteObject**: [`use/listInstance`](../use/listInstance.md) \| `string`
+
+• **action**: `"create"` \| `"update"` \| `"delete"`
+
+#### Returns
+
+`void`
+
 ## Functions
 
 ### getListCrud()
@@ -54,11 +213,11 @@ The reactive crud object, which will be mutated.
 
 The default arguments for the crud functions.
 
-• **reactiveCrud.list**: `Function`
+• **reactiveCrud.list**: [`ListFn`](listCrud.md#listfn)
 
 The list function to get a list of items.
 
-• **reactiveCrud.subscribe**: `Function`
+• **reactiveCrud.subscribe**: [`SubscribeFn`](listCrud.md#subscribefn)
 
 The subscribe function to get a subscription to a list of items.
 

package/docs/config/objectCrud.md

@@ -8,6 +8,54 @@
 
 ## Interfaces
 
+### CreateDetailArgs
+
+#### Properties
+
+##### crudArgs
+
+> **crudArgs**: `any`
+
+The arguments to be passed to the crud functions.
+
+##### object
+
+> **object**: `any`
+
+The data to be acted upon.
+
+##### retrieveArgs
+
+> **retrieveArgs**: `any`
+
+The arguments to be passed to the retrieve function.
+
+***
+
+### DeleteDetailArgs
+
+#### Properties
+
+##### crudArgs
+
+> **crudArgs**: `any`
+
+The arguments to be passed to the crud functions.
+
+##### id
+
+> **id**: `string`
+
+The id of the object to be acted upon.
+
+##### retrieveArgs
+
+> **retrieveArgs**: `any`
+
+The arguments to be passed to the retrieve function.
+
+***
+
 ### ObjectCrudArgsProperties
 
 #### Properties
@@ -24,42 +72,208 @@ The arguments to be passed to the crud functions.
 
 #### Properties
 
-##### create
+##### create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-##### delete
+###### Parameters
+
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](objectCrud.md#responsedata)
+
+##### delete()
 
-> **delete**: `Function`
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-##### patch
+###### Parameters
 
-> **patch**: `Function`
+• **DeleteDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](objectCrud.md#responsedata)
+
+##### patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-##### retrieve
+###### Parameters
+
+• **PartialDetailArgs**: `any`
 
-> **retrieve**: `Function`
+###### Returns
+
+[`ResponseData`](objectCrud.md#responsedata)
+
+##### retrieve()
+
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-##### subscribe
+###### Parameters
+
+• **RetrieveDetailArgs**: `any`
 
-> **subscribe**: `Function`
+###### Returns
+
+[`ResponseData`](objectCrud.md#responsedata)
+
+##### subscribe()
+
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-##### update
+###### Parameters
+
+• **SubscribeArgs**: `any`
+
+###### Returns
+
+`void`
+
+##### update()
 
-> **update**: `Function`
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](objectCrud.md#responsedata)
+
+***
+
+### PartialDetailArgs
+
+#### Properties
+
+##### crudArgs
+
+> **crudArgs**: `any`
+
+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.
+
+##### retrieveArgs
+
+> **retrieveArgs**: `any`
+
+The arguments to be passed to the retrieve function.
+
+***
+
+### RetrieveDetailArgs
+
+#### Properties
+
+##### crudArgs
+
+> **crudArgs**: `any`
+
+The arguments to be passed to the crud functions.
+
+##### id
+
+> **id**: `string`
+
+The id of the object to be acted upon.
+
+##### retrieveArgs
+
+> **retrieveArgs**: `any`
+
+The arguments to be passed to the retrieve function.
+
+***
+
+### SubscribeArgs
+
+#### Properties
+
+##### callback()
+
+> **callback**: (`data`, `action`) => `void`
+
+The callback to be called when the object is updated.
+
+###### Parameters
+
+• **data**: [`CrudObject`](../use/objectInstance.md#crudobject)
+
+• **action**: `string`
+
+###### Returns
+
+`void`
+
+##### crudArgs
+
+> **crudArgs**: `any`
+
+The arguments to be passed to the crud functions.
+
+##### id
+
+> **id**: `string`
+
+The id of the object to be acted upon.
+
+##### retrieveArgs
+
+> **retrieveArgs**: `any`
+
+The arguments to be passed to the retrieve function.
+
+***
+
+### UpdateDetailArgs
+
+#### Properties
+
+##### crudArgs
+
+> **crudArgs**: `any`
+
+The arguments to be passed to the crud functions.
+
+##### object
+
+> **object**: [`CrudObject`](../use/objectInstance.md#crudobject)
+
+The data to be acted upon.
+
+##### retrieveArgs
+
+> **retrieveArgs**: `any`
+
+The arguments to be passed to the retrieve function.
+
 ## Type Aliases
 
 ### ObjectCrudArgs
@@ -68,6 +282,14 @@ A function to be used instead of the default crud update function.
 
 #### Type Parameters
 
+***
+
+### ResponseData
+
+> **ResponseData**\<\>: `Promise`\<`object` \| `string`\>
+
+#### Type Parameters
+
 ## Functions
 
 ### getObjectCrud()

package/docs/use/combineClasses.md

@@ -6,6 +6,14 @@
 
 # use/combineClasses
 
+## Type Aliases
+
+### CSSClasses
+
+> **CSSClasses**\<\>: `string` \| `string`[] \| `object` \| `Ref`
+
+#### Type Parameters
+
 ## Functions
 
 ### useCombineClasses()
@@ -18,7 +26,7 @@ Normalize various ways of specifying CSS classes into an object for use in Vue.j
 
 #### Parameters
 
-• ...**classes**: (`string` \| `string`[] \| `object` \| `Ref`\<`string` \| `string`[]\>)[]
+• ...**classes**: [`CSSClasses`](combineClasses.md#cssclasses)[]
 
 A mixed array containing multiple ways of specifying CSS classes.
 

package/docs/use/listInstance.md

@@ -177,9 +177,17 @@ Default implementation are used as set by `setListCrud`.
 
 ###### list
 
-> **list**: `Function`
+> **list**: [`ListFn`](../config/listCrud.md#listfn)
+
+Provide the implementation for the list
+ function.
+
+###### subscribe
+
+> **subscribe**: [`SubscribeFn`](../config/listCrud.md#subscribefn)
 
-Provide the implementation for the list function.
+Provide the implementation for the
+ subscribe function.
 
 ##### keepOldPages