@arrai-innovations/reactive-helpers 13.0.2 → 13.0.3

package/docs/use/objectRelated.md

@@ -36,42 +36,90 @@ The crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crud.create
+###### crud.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crud.delete
+###### Parameters
 
-> **delete**: `Function`
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crud.patch
+###### Parameters
+
+• **DeleteDetailArgs**: `any`
+
+###### Returns
 
-> **patch**: `Function`
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crud.retrieve
+###### Parameters
+
+• **PartialDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.retrieve()
 
-> **retrieve**: `Function`
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crud.subscribe
+###### Parameters
 
-> **subscribe**: `Function`
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.subscribe()
+
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crud.update
+###### Parameters
+
+• **SubscribeArgs**: `any`
+
+###### Returns
 
-> **update**: `Function`
+`void`
+
+###### crud.update()
+
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### deleted
 
 > **deleted**: `boolean`
@@ -168,42 +216,90 @@ The crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crud.create
+###### crud.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crud.delete
+###### Parameters
 
-> **delete**: `Function`
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crud.patch
+###### Parameters
+
+• **DeleteDetailArgs**: `any`
+
+###### Returns
 
-> **patch**: `Function`
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crud.retrieve
+###### Parameters
+
+• **PartialDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.retrieve()
 
-> **retrieve**: `Function`
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crud.subscribe
+###### Parameters
 
-> **subscribe**: `Function`
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.subscribe()
+
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crud.update
+###### Parameters
+
+• **SubscribeArgs**: `any`
+
+###### Returns
 
-> **update**: `Function`
+`void`
+
+###### crud.update()
+
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### deleted
 
 > **deleted**: `boolean`

package/docs/use/objectSubscription.md

@@ -167,42 +167,90 @@ The crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crud.create
+###### crud.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crud.delete
+###### Parameters
+
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
 
-> **delete**: `Function`
+###### crud.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crud.patch
+###### Parameters
+
+• **DeleteDetailArgs**: `any`
+
+###### Returns
 
-> **patch**: `Function`
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crud.retrieve
+###### Parameters
 
-> **retrieve**: `Function`
+• **PartialDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.retrieve()
+
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crud.subscribe
+###### Parameters
 
-> **subscribe**: `Function`
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.subscribe()
+
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crud.update
+###### Parameters
+
+• **SubscribeArgs**: `any`
+
+###### Returns
+
+`void`
+
+###### crud.update()
 
-> **update**: `Function`
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### deleted
 
 > **deleted**: `boolean`

package/index.js

@@ -1,3 +1,4 @@
+// don't use default exports. it is easier if each file defines the canonical name for the function it exports.
 export * from "./config/listCrud.js";
 export * from "./config/objectCrud.js";
 export * from "./use/cancellableIntent.js";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "13.0.2",
+    "version": "13.0.3",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "type": "module",

package/use/combineClasses.js

@@ -15,6 +15,15 @@ import { isRef, ref, watch, isReactive } from "vue";
  */
 const isRefOrReactive = (v) => isRef(v) || isReactive(v);
 
+/**
+ * @typedef {(
+ *     string |
+ *     string[] |
+ *     { [key: string]: boolean | import("vue").Ref<boolean> } |
+ *     import("vue").Ref<string | string[]>
+ * )} CSSClasses
+ */
+
 /**
  * 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
@@ -40,12 +49,7 @@ const isRefOrReactive = (v) => isRef(v) || isReactive(v);
  * </script>
  * ```
  *
- * @param {...(
- *     string |
- *     string[] |
- *     { [key: string]: boolean | import("vue").Ref<boolean> } |
- *     import("vue").Ref<string | string[]>
- * )} classes - A mixed array containing multiple ways of specifying CSS classes.
+ * @param {...(CSSClasses)} classes - A mixed array containing multiple ways of specifying CSS classes.
  * @returns {import("vue").Ref<import('../utils/classes.js').CombinedClasses>} - A ref
  *  containing an object or array of objects containing CSS classes. Arrays are used if refs are present, to
  *  preserve order of operations in reactive contexts.

package/use/listInstance.js

@@ -51,7 +51,10 @@ export class ListInstanceError extends Error {
  * @typedef {object} ListInstanceOptions
  * @property {import('vue').UnwrapNestedRefs<ListInstanceProps>} props - The props for the list instance.
  * @property {object} [functions] - Default implementation are used as set by `setListCrud`.
- * @property {Function} [functions.list] - Provide the implementation for the list function.
+ * @property {import('../config/listCrud.js').ListFn} [functions.list] - Provide the implementation for the list
+ *  function.
+ * @property {import('../config/listCrud.js').SubscribeFn} [functions.subscribe] - Provide the implementation for the
+ *  subscribe function.
  * @property {boolean} [keepOldPages=false] - If true, pages will not be cleared when defaultPageCallback is called.
  */
 

package/use/loadingError.js

@@ -5,20 +5,27 @@ import { readonly, ref } from "vue";
  */
 
 /**
- * A composable function for managing loading and error states.
- *
- * @returns {object} - An object containing reactive fields and actions for loading and error states.
- * @property {import("vue").Ref<boolean|undefined>} loading - Whether the component is loading.
- * @property {import("vue").Ref<Error|null>} error - The error that occurred.
- * @property {import("vue").Ref<boolean>} errored - Whether an error has occurred.
+ * @typedef {object} LoadingError
+ * @property {Readonly<import("vue").Ref<boolean|undefined>>} loading - Whether the component is loading.
+ * @property {Readonly<import("vue").Ref<Error|null>>} error - The error that occurred.
+ * @property {Readonly<import("vue").Ref<boolean>>} errored - Whether an error has occurred.
  * @property {() => void} setLoading - Set the loading state.
  * @property {() => void} clearLoading - Clear the loading state.
  * @property {(error) => void} setError - Set the error state.
  * @property {() => void} clearError - Clear the error state.
  */
+
+/**
+ * A composable function for managing loading and error states.
+ *
+ * @returns {LoadingError} - An object containing reactive fields and actions for loading and error states.
+ */
 export function useLoadingError() {
+    /** @type {import("vue").Ref<boolean|undefined>} */
     const loading = ref(undefined);
+    /** @type {import("vue").Ref<Error|null>} */
     const error = ref(null);
+    /** @type {import("vue").Ref<boolean>} */
     const errored = ref(false);
 
     return {