@arrai-innovations/reactive-helpers 16.0.0 → 17.0.0

package/.husky/commit-msg

@@ -1,4 +1,3 @@
 #!/usr/bin/env bash
-. "$(dirname "$0")/_/husky.sh"
 
 npx --no-install commitlint --edit "$1"

package/.husky/pre-commit

@@ -1,4 +1,3 @@
 #!/usr/bin/env bash
-. "$(dirname "$0")/_/husky.sh"
 
 npx --no-install lint-staged

package/docs/README.md

@@ -1,4 +1,4 @@
-**@arrai-innovations/reactive-helpers** • **Docs**
+**@arrai-innovations/reactive-helpers**
 
 ***
 

package/docs/config/listCrud.md

@@ -1,4 +1,4 @@
-[**@arrai-innovations/reactive-helpers**](../README.md) • **Docs**
+[**@arrai-innovations/reactive-helpers**](../README.md)
 
 ***
 
@@ -66,9 +66,9 @@ The ids of the objects to be acted upon.
 
 #### Properties
 
-##### args
+##### args?
 
-> **args**: `any`
+> `optional` **args**: `any`
 
 The default arguments for the crud functions.
 
@@ -78,27 +78,27 @@ The default arguments for the crud functions.
 
 #### Properties
 
-##### bulkDelete
+##### bulkDelete?
 
-> **bulkDelete**: [`BulkDeleteFn`](listCrud.md#bulkdeletefn)
+> `optional` **bulkDelete**: [`BulkDeleteFn`](listCrud.md#bulkdeletefn)
 
 The delete function to bulk delete a list of items.
 
-##### executeAction
+##### executeAction?
 
-> **executeAction**: [`ExecuteActionFn`](listCrud.md#executeactionfn)
+> `optional` **executeAction**: [`ExecuteActionFn`](listCrud.md#executeactionfn)
 
 The  function to execute a certain action on a list of items.
 
-##### list
+##### list?
 
-> **list**: [`ListFn`](listCrud.md#listfn)
+> `optional` **list**: [`ListFn`](listCrud.md#listfn)
 
 The list function to get a list of items.
 
-##### subscribe
+##### subscribe?
 
-> **subscribe**: [`SubscribeFn`](listCrud.md#subscribefn)
+> `optional` **subscribe**: [`SubscribeFn`](listCrud.md#subscribefn)
 
 The subscribe function to get a subscription to a list of items.
 
@@ -116,7 +116,7 @@ The arguments to be passed to the crud functions.
 
 ##### isCancelled
 
-> **isCancelled**: `Readonly`\<`Ref`\<`boolean`\>\>
+> **isCancelled**: `Readonly`\<`Ref`\<`boolean`, `boolean`\>\>
 
 A ref to a boolean indicating whether the request has
  been cancelled.
@@ -217,7 +217,9 @@ The delete function to bulk delete a list of items.
 
 #### Parameters
 
-• **DeleteFnArgs**: `any`
+##### DeleteFnArgs
+
+`any`
 
 #### Returns
 
@@ -227,7 +229,7 @@ The delete function to bulk delete a list of items.
 
 ### ExecuteActionFn()
 
-> **ExecuteActionFn**\<\>: (`ExecuteActionFnArgs`) => `Promise`\<[`config/objectCrud`](objectCrud.md) \| `false`\> & `object`
+> **ExecuteActionFn**\<\>: (`ExecuteActionFnArgs`) => `Promise`\<[`ResponseData`](objectCrud.md#responsedata) \| `false`\> & `object`
 
 The function to execute a certain action on a list of items, returning the response data or false.
 
@@ -235,11 +237,13 @@ The function to execute a certain action on a list of items, returning the respo
 
 #### Parameters
 
-• **ExecuteActionFnArgs**: `any`
+##### ExecuteActionFnArgs
+
+`any`
 
 #### Returns
 
-`Promise`\<[`config/objectCrud`](objectCrud.md) \| `false`\> & `object`
+`Promise`\<[`ResponseData`](objectCrud.md#responsedata) \| `false`\> & `object`
 
 ***
 
@@ -253,7 +257,9 @@ The list function to get a list of items, returning a boolean indicating success
 
 #### Parameters
 
-• **ListFnArgs**: `any`
+##### ListFnArgs
+
+`any`
 
 #### Returns
 
@@ -269,9 +275,13 @@ The list function to get a list of items, returning a boolean indicating success
 
 #### Parameters
 
-• **newObjects**: [`use/listInstance`](../use/listInstance.md)
+##### newObjects
+
+[`ListObject`](../use/listInstance.md#listobject)
+
+##### paginationInfo
 
-• **paginationInfo**: [`PaginateInfo`](listCrud.md#paginateinfo) \| `undefined`
+[`PaginateInfo`](listCrud.md#paginateinfo) | `undefined`
 
 #### Returns
 
@@ -289,7 +299,9 @@ The subscribe function to set up a subscription to a list of items.
 
 #### Parameters
 
-• **SubscribeFnArgs**: `any`
+##### SubscribeFnArgs
+
+`any`
 
 #### Returns
 
@@ -305,9 +317,13 @@ The subscribe function to set up a subscription to a list of items.
 
 #### Parameters
 
-• **newOrUpdatedOrDeleteObject**: [`use/listInstance`](../use/listInstance.md) \| `string`
+##### newOrUpdatedOrDeleteObject
+
+[`ListObject`](../use/listInstance.md#listobject) | `string`
+
+##### action
 
-• **action**: `"create"` \| `"update"` \| `"delete"`
+`"create"` | `"update"` | `"delete"`
 
 #### Returns
 
@@ -323,43 +339,59 @@ Get the previously set list and subscribe functions for the default crud.
 
 #### Parameters
 
-• **reactiveCrud**
+##### reactiveCrud
 
 The reactive crud object, which will be mutated.
 
-• **reactiveCrud.args**: `any`
+###### reactiveCrud.args
+
+`any`
 
 The default arguments for the crud functions.
 
-• **reactiveCrud.bulkDelete**: [`BulkDeleteFn`](listCrud.md#bulkdeletefn)
+###### reactiveCrud.bulkDelete
+
+[`BulkDeleteFn`](listCrud.md#bulkdeletefn)
 
 The delete function to bulk delete a list of items.
 
-• **reactiveCrud.executeAction**: [`ExecuteActionFn`](listCrud.md#executeactionfn)
+###### reactiveCrud.executeAction
+
+[`ExecuteActionFn`](listCrud.md#executeactionfn)
 
 The  function to execute a certain action on a list of items.
 
-• **reactiveCrud.list**: [`ListFn`](listCrud.md#listfn)
+###### reactiveCrud.list
+
+[`ListFn`](listCrud.md#listfn)
 
 The list function to get a list of items.
 
-• **reactiveCrud.subscribe**: [`SubscribeFn`](listCrud.md#subscribefn)
+###### reactiveCrud.subscribe
+
+[`SubscribeFn`](listCrud.md#subscribefn)
 
 The subscribe function to get a subscription to a list of items.
 
-• **options** = `{}`
+##### options
 
 The options for the default crud.
 
-• **options.functions**: [`ListCrudFunctions`](listCrud.md#listcrudfunctions) & [`ListCrudArgs`](listCrud.md#listcrudargs)
+###### options.functions
+
+[`ListCrudFunctions`](listCrud.md#listcrudfunctions) & [`ListCrudArgs`](listCrud.md#listcrudargs)
 
 The functions to set for the crud.
 
-• **options.props**
+###### options.props
+
+`object`
 
 The props to set for the crud.
 
-• **options.props.crudArgs**: `any`
+###### options.props.crudArgs
+
+`any`
 
 #### Returns
 
@@ -375,7 +407,9 @@ Set the list and subscribe functions for the default crud.
 
 #### Parameters
 
-• **options**: [`ListCrudFunctions`](listCrud.md#listcrudfunctions) & `Partial`\<[`ListCrudArgs`](listCrud.md#listcrudargs)\>
+##### options
+
+[`ListCrudFunctions`](listCrud.md#listcrudfunctions) & `Partial`\<[`ListCrudArgs`](listCrud.md#listcrudargs)\>
 
 The options for the default crud.
 

package/docs/config/objectCrud.md

@@ -1,4 +1,4 @@
-[**@arrai-innovations/reactive-helpers**](../README.md) • **Docs**
+[**@arrai-innovations/reactive-helpers**](../README.md)
 
 ***
 
@@ -72,9 +72,9 @@ The arguments to be passed to the retrieve function.
 
 #### Properties
 
-##### args
+##### args?
 
-> **args**: `any`
+> `optional` **args**: `any`
 
 The arguments to be passed to the crud functions.
 
@@ -84,85 +84,97 @@ The arguments to be passed to the crud functions.
 
 #### Properties
 
-##### create()
+##### create()?
 
-> **create**: (`CreateDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
+> `optional` **create**: (`CreateDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
 ###### Parameters
 
-• **CreateDetailArgs**: `any`
+###### CreateDetailArgs
+
+`any`
 
 ###### Returns
 
 [`ResponseData`](objectCrud.md#responsedata)
 
-##### delete()
+##### delete()?
 
-> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
+> `optional` **delete**: (`DeleteDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
 ###### Parameters
 
-• **DeleteDetailArgs**: `any`
+###### DeleteDetailArgs
+
+`any`
 
 ###### Returns
 
 [`ResponseData`](objectCrud.md#responsedata)
 
-##### patch()
+##### patch()?
 
-> **patch**: (`PartialDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
+> `optional` **patch**: (`PartialDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
 ###### Parameters
 
-• **PartialDetailArgs**: `any`
+###### PartialDetailArgs
+
+`any`
 
 ###### Returns
 
 [`ResponseData`](objectCrud.md#responsedata)
 
-##### retrieve()
+##### retrieve()?
 
-> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
+> `optional` **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
 ###### Parameters
 
-• **RetrieveDetailArgs**: `any`
+###### RetrieveDetailArgs
+
+`any`
 
 ###### Returns
 
 [`ResponseData`](objectCrud.md#responsedata)
 
-##### subscribe()
+##### subscribe()?
 
-> **subscribe**: (`SubscribeArgs`) => `void` & `object`
+> `optional` **subscribe**: (`SubscribeArgs`) => `void` & `object`
 
 A function to be used instead of the default crud subscribe function.
 
 ###### Parameters
 
-• **SubscribeArgs**: `any`
+###### SubscribeArgs
+
+`any`
 
 ###### Returns
 
 `void` & `object`
 
-##### update()
+##### update()?
 
-> **update**: (`UpdateDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
+> `optional` **update**: (`UpdateDetailArgs`) => [`ResponseData`](objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
 ###### Parameters
 
-• **UpdateDetailArgs**: `any`
+###### UpdateDetailArgs
+
+`any`
 
 ###### Returns
 
@@ -248,9 +260,13 @@ The callback to be called when the object is updated.
 
 ###### Parameters
 
-• **data**: [`CrudObject`](../use/objectInstance.md#crudobject)
+###### data
+
+[`CrudObject`](../use/objectInstance.md#crudobject)
 
-• **action**: `string`
+###### action
+
+`string`
 
 ###### Returns
 
@@ -346,25 +362,35 @@ Get the previously set object crud functions.
 
 #### Parameters
 
-• **reactiveCrud**: `any`
+##### reactiveCrud
+
+`any`
 
 The reactive object you want to add the resulting crud to.
 
-• **options** = `{}`
+##### options
 
 The options for the reactive crud object.
 
-• **options.functions**: [`ObjectCrudFunctions`](objectCrud.md#objectcrudfunctions)
+###### options.functions
+
+[`ObjectCrudFunctions`](objectCrud.md#objectcrudfunctions)
 
 Any functions to override the default crud functions.
 
-• **options.props**
+###### options.props
+
+`object`
 
 The props with any passed crudArgs.
 
-• **options.props.crudArgs**
+###### options.props.crudArgs
 
-• **options.props.crudArgs.args**: `any`
+`object`
+
+###### options.props.crudArgs.args
+
+`any`
 
 The arguments to be passed to the crud functions.
 
@@ -386,7 +412,9 @@ Set the object crud functions.
 
 #### Parameters
 
-• **options**: [`ObjectCrudArgs`](objectCrud.md#objectcrudargs)
+##### options
+
+[`ObjectCrudArgs`](objectCrud.md#objectcrudargs)
 
 The options for the object crud functions.
 

package/docs/use/cancellableIntent.md

@@ -1,4 +1,4 @@
-[**@arrai-innovations/reactive-helpers**](../README.md) • **Docs**
+[**@arrai-innovations/reactive-helpers**](../README.md)
 
 ***
 
@@ -62,21 +62,21 @@ The function that returns a promise that can be cancelled.
 
 [`CancellablePromise`](cancellableIntent.md#cancellablepromise)
 
-##### clearActiveOnResolved
+##### clearActiveOnResolved?
 
-> **clearActiveOnResolved**: `boolean`
+> `optional` **clearActiveOnResolved**: `boolean`
 
 Whether to clear the active state when the promise resolves.
 
-##### guardArguments
+##### guardArguments?
 
-> **guardArguments**: `any`
+> `optional` **guardArguments**: `any`
 
 The reactive object to watch for truthiness before running the intent.
 
-##### watchArguments
+##### watchArguments?
 
-> **watchArguments**: `any`
+> `optional` **watchArguments**: `any`
 
 The reactive object to watch for changes.
 
@@ -120,7 +120,9 @@ If the promise is not resolved before the watch arguments change again, the prev
 
 #### Parameters
 
-• **options**: [`CancellableIntentOptions`](cancellableIntent.md#cancellableintentoptions)
+##### options
+
+[`CancellableIntentOptions`](cancellableIntent.md#cancellableintentoptions)
 
 The options for the cancellable intent.
 

package/docs/use/combineClasses.md

@@ -1,4 +1,4 @@
-[**@arrai-innovations/reactive-helpers**](../README.md) • **Docs**
+[**@arrai-innovations/reactive-helpers**](../README.md)
 
 ***
 
@@ -10,7 +10,7 @@
 
 ### CSSClasses
 
-> **CSSClasses**\<\>: `string` \| `string`[] \| `object` \| `Ref`
+> **CSSClasses**\<\>: `string` \| `string`[] \| \{\} \| `Ref`
 
 #### Type Parameters
 
@@ -18,7 +18,7 @@
 
 ### useCombineClasses()
 
-> **useCombineClasses**(...`classes`): `Ref`\<[`CombinedClasses`](../utils/classes.md#combinedclasses)\>
+> **useCombineClasses**(...`classes`): `Ref`\<[`CombinedClasses`](../utils/classes.md#combinedclasses), [`CombinedClasses`](../utils/classes.md#combinedclasses)\>
 
 Normalize various ways of specifying CSS classes into an object for use in Vue.js with reactivity. If refs are
  present, the resulting object will be a ref containing an array of objects to preserve order of operations in
@@ -26,13 +26,15 @@ Normalize various ways of specifying CSS classes into an object for use in Vue.j
 
 #### Parameters
 
-• ...**classes**: [`CSSClasses`](combineClasses.md#cssclasses)[]
+##### classes
+
+...[`CSSClasses`](combineClasses.md#cssclasses)[]
 
 A mixed array containing multiple ways of specifying CSS classes.
 
 #### Returns
 
-`Ref`\<[`CombinedClasses`](../utils/classes.md#combinedclasses)\>
+`Ref`\<[`CombinedClasses`](../utils/classes.md#combinedclasses), [`CombinedClasses`](../utils/classes.md#combinedclasses)\>
 
 - A ref
  containing an object or array of objects containing CSS classes. Arrays are used if refs are present, to

package/docs/use/list.md

@@ -1,4 +1,4 @@
-[**@arrai-innovations/reactive-helpers**](../README.md) • **Docs**
+[**@arrai-innovations/reactive-helpers**](../README.md)
 
 ***
 
@@ -26,11 +26,15 @@ Creates a new ListError.
 
 ###### Parameters
 
-• **message**: `string`
+###### message
+
+`string`
 
 The error message.
 
-• **code**: `string`
+###### code
+
+`string`
 
 The error code.
 
@@ -148,13 +152,13 @@ Function or rule to determine if an item should be included based on inclusion c
 
 ##### calculatedObjectsRules
 
-> **calculatedObjectsRules**: `Ref`\<`object`\>
+> **calculatedObjectsRules**: `Ref`\<`object`, `object`\>
 
 Defines rules for dynamically calculating properties of list items.
 
 ##### crudArgs
 
-> **crudArgs**: `boolean`
+> **crudArgs**: `any`
 
 General arguments to pass to the registered list crud functions, often related to endpoints.
 
@@ -190,7 +194,7 @@ Indicates whether changes to the list should be subscribed to.
 
 ##### listArgs
 
-> **listArgs**: `boolean`
+> **listArgs**: `any`
 
 The arguments to pass to the registered list crud functions, related to the list itself.
 
@@ -218,7 +222,7 @@ Defines rules for associating related objects with list items.
 
 ##### retrieveArgs
 
-> **retrieveArgs**: `boolean`
+> **retrieveArgs**: `any`
 
 The arguments to pass to the registered list crud functions, related to the items.
 
@@ -238,7 +242,7 @@ Current text query used for filtering the list.
 
 ### ListFunctions
 
-> **ListFunctions**\<\>: [`use/listInstance`](listInstance.md) & [`use/listSubscription`](listSubscription.md)
+> **ListFunctions**\<\>: [`ListInstanceFunctions`](listInstance.md#listinstancefunctions) & [`ListSubscriptionFunctions`](listSubscription.md#listsubscriptionfunctions)
 
 #### Type Parameters
 
@@ -254,31 +258,31 @@ Current text query used for filtering the list.
 
 ##### listCalculated
 
-> **listCalculated**: [`use/listCalculated`](listCalculated.md)
+> **listCalculated**: [`ListCalculated`](listCalculated.md#listcalculated)
 
 ##### listFilter
 
-> **listFilter**: [`use/listFilter`](listFilter.md)
+> **listFilter**: [`ListFilter`](listFilter.md#listfilter)
 
 ##### listInstance
 
-> **listInstance**: [`use/listInstance`](listInstance.md)
+> **listInstance**: [`ListInstance`](listInstance.md#listinstance)
 
 ##### listRelated
 
-> **listRelated**: [`use/listRelated`](listRelated.md)
+> **listRelated**: [`ListRelated`](listRelated.md#listrelated)
 
 ##### listSearch
 
-> **listSearch**: [`use/listSearch`](listSearch.md)
+> **listSearch**: [`ListSearch`](listSearch.md#listsearch)
 
 ##### listSort
 
-> **listSort**: [`use/listSort`](listSort.md)
+> **listSort**: [`ListSort`](listSort.md#listsort)
 
 ##### listSubscription
 
-> **listSubscription**: [`use/listSubscription`](listSubscription.md)
+> **listSubscription**: [`ListSubscription`](listSubscription.md#listsubscription)
 
 ***
 
@@ -292,7 +296,7 @@ Current text query used for filtering the list.
 
 ### ListRawState
 
-> **ListRawState**\<\>: [`use/listInstance`](listInstance.md) \| [`use/listSubscription`](listSubscription.md) \| [`use/listRelated`](listRelated.md) \| [`use/listCalculated`](listCalculated.md) \| [`use/listFilter`](listFilter.md) \| [`use/listSearch`](listSearch.md) \| [`use/listSort`](listSort.md)
+> **ListRawState**\<\>: [`ListInstanceRawState`](listInstance.md#listinstancerawstate) \| [`ListSubscriptionRawState`](listSubscription.md#listsubscriptionrawstate) \| [`ListRelatedRawState`](listRelated.md#listrelatedrawstate) \| [`ListCalculatedRawState`](listCalculated.md#listcalculatedrawstate) \| [`ListFilterRawState`](listFilter.md#listfilterrawstate) \| [`ListSearchRawState`](listSearch.md#listsearchrawstate) \| [`ListSortRawState`](listSort.md#listsortrawstate)
 
 #### Type Parameters
 
@@ -315,7 +319,9 @@ It ensures seamless integration of all list functionalities such as sorting, sea
 
 #### Parameters
 
-• **options**: [`ListOptions`](list.md#listoptions)
+##### options
+
+[`ListOptions`](list.md#listoptions)
 
 The options for the list./.
 
@@ -344,7 +350,7 @@ Initializes multiple list management instances with provided configurations.
 
 #### Parameters
 
-• **listOptions**
+##### listOptions
 
 The options for initializing multiple list instances.