@arrai-innovations/reactive-helpers 15.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/config/listCrud.js

@@ -66,19 +66,27 @@ const defaultCrud = {
  */
 
 /**
- * @typedef {(ListFnArgs)=>void} ListFn
+ * @typedef {object} ExecuteActionFnArgs
+ * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @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.
+ */
+
+/**
+ * @typedef {(ListFnArgs)=>Promise<boolean> & { cancel: () => Promise<void>|void }} ListFn - The list function to get a list of items, returning a boolean indicating success.
  */
 
 /**
- * @typedef {(DeleteFnArgs)=>void} BulkDeleteFn
+ * @typedef {(DeleteFnArgs)=>Promise<boolean> & { cancel: () => Promise<void>|void }} BulkDeleteFn - The delete function to bulk delete a list of items.
  */
 
 /**
- * @typedef {(SubscribeFnArgs)=>void} SubscribeFn
+ * @typedef {(SubscribeFnArgs)=>Promise<boolean> & { cancel: () => Promise<void>|void }} SubscribeFn - The subscribe function to set up a subscription to a list of items.
  */
 
 /**
- * @typedef {(ExecuteActionFnArgs)=>void} ExecuteActionFn
+ * @typedef {(ExecuteActionFnArgs)=>Promise<import('./objectCrud.js').ResponseData|false> & { cancel: () => Promise<void>|void }} ExecuteActionFn - The function to execute a certain action on a list of items, returning the response data or false.
  */
 
 /**

package/config/objectCrud.js

@@ -79,7 +79,7 @@ const defaultCrud = {
  */
 
 /**
- * @typedef {Promise<object|string>} ResponseData
+ * @typedef {Promise<object|string> & { cancel: () => Promise<void>|void }} ResponseData
  */
 
 /**
@@ -91,7 +91,7 @@ const defaultCrud = {
  * @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.
+ * @property {(SubscribeArgs)=>void & { cancel: () => Promise<void>|void }} [subscribe] - A function to be used instead of the default crud subscribe function.
  */
 
 /**

package/docs/README.md

@@ -1,4 +1,4 @@
-**@arrai-innovations/reactive-helpers** • **Docs**
+**@arrai-innovations/reactive-helpers**
 
 ***
 
@@ -35,6 +35,7 @@
 - [utils/deleteKey](utils/deleteKey.md)
 - [utils/flattenPaths](utils/flattenPaths.md)
 - [utils/getFakePk](utils/getFakePk.md)
+- [utils/keepAliveTry](utils/keepAliveTry.md)
 - [utils/keyDiff](utils/keyDiff.md)
 - [utils/loadingCombine](utils/loadingCombine.md)
 - [utils/proxyRunning](utils/proxyRunning.md)

package/docs/config/listCrud.md

@@ -1,4 +1,4 @@
-[**@arrai-innovations/reactive-helpers**](../README.md) • **Docs**
+[**@arrai-innovations/reactive-helpers**](../README.md)
 
 ***
 
@@ -32,13 +32,43 @@ The ids of the objects to be deleted.
 
 ***
 
+### ExecuteActionFnArgs
+
+#### Properties
+
+##### action
+
+> **action**: `string`
+
+The action to execute.
+
+##### crudArgs
+
+> **crudArgs**: `any`
+
+The arguments to be passed to the crud functions.
+
+##### pkKey
+
+> **pkKey**: `string`
+
+The key name of the primary key.
+
+##### pks
+
+> **pks**: `string`[]
+
+The ids of the objects to be acted upon.
+
+***
+
 ### ListCrudArgs
 
 #### Properties
 
-##### args
+##### args?
 
-> **args**: `any`
+> `optional` **args**: `any`
 
 The default arguments for the crud functions.
 
@@ -48,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.
 
@@ -86,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.
@@ -179,49 +209,61 @@ The method to call when new data is received.
 
 ### BulkDeleteFn()
 
-> **BulkDeleteFn**\<\>: (`DeleteFnArgs`) => `void`
+> **BulkDeleteFn**\<\>: (`DeleteFnArgs`) => `Promise`\<`boolean`\> & `object`
+
+The delete function to bulk delete a list of items.
 
 #### Type Parameters
 
 #### Parameters
 
-• **DeleteFnArgs**: `any`
+##### DeleteFnArgs
+
+`any`
 
 #### Returns
 
-`void`
+`Promise`\<`boolean`\> & `object`
 
 ***
 
 ### ExecuteActionFn()
 
-> **ExecuteActionFn**\<\>: (`ExecuteActionFnArgs`) => `void`
+> **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.
 
 #### Type Parameters
 
 #### Parameters
 
-• **ExecuteActionFnArgs**: `any`
+##### ExecuteActionFnArgs
+
+`any`
 
 #### Returns
 
-`void`
+`Promise`\<[`ResponseData`](objectCrud.md#responsedata) \| `false`\> & `object`
 
 ***
 
 ### ListFn()
 
-> **ListFn**\<\>: (`ListFnArgs`) => `void`
+> **ListFn**\<\>: (`ListFnArgs`) => `Promise`\<`boolean`\> & `object`
+
+The list function to get a list of items, returning a boolean indicating success.
 
 #### Type Parameters
 
 #### Parameters
 
-• **ListFnArgs**: `any`
+##### ListFnArgs
+
+`any`
 
 #### Returns
 
-`void`
+`Promise`\<`boolean`\> & `object`
 
 ***
 
@@ -233,9 +275,13 @@ The method to call when new data is received.
 
 #### Parameters
 
-• **newObjects**: [`use/listInstance`](../use/listInstance.md)
+##### newObjects
+
+[`ListObject`](../use/listInstance.md#listobject)
 
-• **paginationInfo**: [`PaginateInfo`](listCrud.md#paginateinfo) \| `undefined`
+##### paginationInfo
+
+[`PaginateInfo`](listCrud.md#paginateinfo) | `undefined`
 
 #### Returns
 
@@ -245,17 +291,21 @@ The method to call when new data is received.
 
 ### SubscribeFn()
 
-> **SubscribeFn**\<\>: (`SubscribeFnArgs`) => `void`
+> **SubscribeFn**\<\>: (`SubscribeFnArgs`) => `Promise`\<`boolean`\> & `object`
+
+The subscribe function to set up a subscription to a list of items.
 
 #### Type Parameters
 
 #### Parameters
 
-• **SubscribeFnArgs**: `any`
+##### SubscribeFnArgs
+
+`any`
 
 #### Returns
 
-`void`
+`Promise`\<`boolean`\> & `object`
 
 ***
 
@@ -267,9 +317,13 @@ The method to call when new data is received.
 
 #### Parameters
 
-• **newOrUpdatedOrDeleteObject**: [`use/listInstance`](../use/listInstance.md) \| `string`
+##### newOrUpdatedOrDeleteObject
+
+[`ListObject`](../use/listInstance.md#listobject) | `string`
+
+##### action
 
-• **action**: `"create"` \| `"update"` \| `"delete"`
+`"create"` | `"update"` | `"delete"`
 
 #### Returns
 
@@ -285,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
 
@@ -337,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`
+> `optional` **subscribe**: (`SubscribeArgs`) => `void` & `object`
 
 A function to be used instead of the default crud subscribe function.
 
 ###### Parameters
 
-• **SubscribeArgs**: `any`
+###### SubscribeArgs
+
+`any`
 
 ###### Returns
 
-`void`
+`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
 
-• **action**: `string`
+`string`
 
 ###### Returns
 
@@ -322,7 +338,17 @@ The arguments to be passed to the retrieve function.
 
 ### ResponseData
 
-> **ResponseData**\<\>: `Promise`\<`object` \| `string`\>
+> **ResponseData**\<\>: `Promise`\<`object` \| `string`\> & `object`
+
+#### Type declaration
+
+##### cancel()
+
+> **cancel**: () => `Promise`\<`void`\> \| `void`
+
+###### Returns
+
+`Promise`\<`void`\> \| `void`
 
 #### Type Parameters
 
@@ -336,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
+
+`object`
 
-• **options.props.crudArgs.args**: `any`
+###### options.props.crudArgs.args
+
+`any`
 
 The arguments to be passed to the crud functions.
 
@@ -376,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