@arrai-innovations/reactive-helpers 17.0.2 → 18.0.1

package/docs/config/listCrud.md

@@ -343,31 +343,31 @@ Get the previously set list and subscribe functions for the default crud.
 
 The reactive crud object, which will be mutated.
 
-###### args
+###### args?
 
 `any`
 
 The default arguments for the crud functions.
 
-###### bulkDelete
+###### bulkDelete?
 
 [`BulkDeleteFn`](listCrud.md#bulkdeletefn)
 
 The delete function to bulk delete a list of items.
 
-###### executeAction
+###### executeAction?
 
 [`ExecuteActionFn`](listCrud.md#executeactionfn)
 
 The  function to execute a certain action on a list of items.
 
-###### list
+###### list?
 
 [`ListFn`](listCrud.md#listfn)
 
 The list function to get a list of items.
 
-###### subscribe
+###### subscribe?
 
 [`SubscribeFn`](listCrud.md#subscribefn)
 
@@ -377,13 +377,13 @@ The subscribe function to get a subscription to a list of items.
 
 The options for the default crud.
 
-###### functions
+###### functions?
 
 [`ListCrudFunctions`](listCrud.md#listcrudfunctions) & [`ListCrudArgs`](listCrud.md#listcrudargs)
 
 The functions to set for the crud.
 
-###### props
+###### props?
 
 \{ `crudArgs`: `any`; \}
 

package/docs/config/objectCrud.md

@@ -372,13 +372,13 @@ The reactive object you want to add the resulting crud to.
 
 The options for the reactive crud object.
 
-###### functions
+###### functions?
 
 [`ObjectCrudFunctions`](objectCrud.md#objectcrudfunctions)
 
 Any functions to override the default crud functions.
 
-###### props
+###### props?
 
 \{ `crudArgs`: \{ `args`: `any`; \}; \}
 
@@ -388,7 +388,7 @@ The props with any passed crudArgs.
 
 \{ `args`: `any`; \}
 
-###### props.crudArgs.args
+###### props.crudArgs.args?
 
 `any`
 

package/docs/use/loadingError.md

@@ -32,7 +32,7 @@ Set the error state.
 
 ###### error
 
-`any`
+`Error`
 
 ###### Returns
 

package/docs/use/object.md

@@ -206,7 +206,7 @@ The calculated object.
 
 ###### Index Signature
 
-\[`ruleKey`: `string`\]: `ComputedRef`
+\[`ruleKey`: `string`\]: `ComputedRef`\<`any`\>
 
 ###### calculatedObjectRules
 
@@ -402,7 +402,7 @@ The related objects, indexed by the key in the related object.
 
 ###### Index Signature
 
-\[`rule`: `string`\]: `ComputedRef`
+\[`rule`: `string`\]: `ComputedRef`\<`any`\>
 
 ###### relatedObjectRules
 

package/docs/use/objectCalculated.md

@@ -200,7 +200,7 @@ The related objects, indexed by the key in the related object.
 
 ###### Index Signature
 
-\[`rule`: `string`\]: `ComputedRef`
+\[`rule`: `string`\]: `ComputedRef`\<`any`\>
 
 ###### relatedObjectRules?
 
@@ -270,7 +270,7 @@ The calculated object.
 
 ###### Index Signature
 
-\[`ruleKey`: `string`\]: `ComputedRef`
+\[`ruleKey`: `string`\]: `ComputedRef`\<`any`\>
 
 ###### calculatedObjectRules
 
@@ -466,7 +466,7 @@ The related objects, indexed by the key in the related object.
 
 ###### Index Signature
 
-\[`rule`: `string`\]: `ComputedRef`
+\[`rule`: `string`\]: `ComputedRef`\<`any`\>
 
 ###### relatedObjectRules?
 
@@ -556,7 +556,7 @@ The calculated object.
 
 ###### Index Signature
 
-\[`ruleKey`: `string`\]: `ComputedRef`
+\[`ruleKey`: `string`\]: `ComputedRef`\<`any`\>
 
 ##### calculatedObjectRules
 

package/docs/use/objectRelated.md

@@ -398,7 +398,7 @@ The related objects, indexed by the key in the related object.
 
 ###### Index Signature
 
-\[`rule`: `string`\]: `ComputedRef`
+\[`rule`: `string`\]: `ComputedRef`\<`any`\>
 
 ###### relatedObjectRules
 
@@ -492,7 +492,7 @@ The related objects, indexed by the key in the related object.
 
 ###### Index Signature
 
-\[`rule`: `string`\]: `ComputedRef`
+\[`rule`: `string`\]: `ComputedRef`\<`any`\>
 
 ##### relatedObjectRules
 

package/docs/use/objectSubscription.md

@@ -98,7 +98,7 @@ Subscribes to updates from an object, managing subscription state and
 
 ###### \_\_namedParameters?
 
-###### retrieve
+###### retrieve?
 
 `boolean`
 

package/docs/use/search.md

@@ -308,7 +308,7 @@ Options.
 
 Props.
 
-###### throttle
+###### throttle?
 
 `number` = `500`
 

package/docs/utils/flattenPaths.md

@@ -28,19 +28,19 @@ Array or object to flatten.
 
 Options.
 
-###### currentPath
+###### currentPath?
 
 `string`
 
 Current path, for recursion or as a starting point.
 
-###### depth
+###### depth?
 
 `number`
 
 Current depth, for recursion.
 
-###### limit
+###### limit?
 
 `number`
 

package/docs/utils/getFakePk.md

@@ -12,7 +12,8 @@
 
 > **getFakePk**(`arraySetMapOrObject`, `key`): `string`
 
-Get a fake pk that is not in the array, set, map, or object.
+Get a fake pk that is not in the array, set, map, or object. The fake pk is negative number, so they can be
+differentiated from real ids. They are returned as strings, as javascript object property keys are always strings.
 
 #### Parameters
 

package/docs/utils/keyDiff.md

@@ -57,19 +57,19 @@ Keys to consider as old.
 
 Which differences are returned.
 
-###### addedKeys
+###### addedKeys?
 
 `boolean` = `true`
 
 If true, return keys that are added.
 
-###### removedKeys
+###### removedKeys?
 
 `boolean` = `true`
 
 If true, return keys that are removed.
 
-###### sameKeys
+###### sameKeys?
 
 `boolean` = `true`
 

package/docs/utils/watches.md

@@ -27,31 +27,31 @@ Initializes the AwaitNot with specified options for reactive property watching a
 
 Configuration options for AwaitNot.
 
-###### couldAlreadyBeFalse
+###### couldAlreadyBeFalse?
 
 `boolean` = `false`
 
 Indicates if the property could already be in the false state at initialization.
 
-###### obj
+###### obj?
 
 `any`
 
 The object containing the property to watch.
 
-###### prop
+###### prop?
 
 `string`
 
 The property name to watch within the object.
 
-###### ref
+###### ref?
 
-`Ref`
+`Ref`\<`any`, `any`\>
 
 A Vue ref to directly watch if provided.
 
-###### timeout
+###### timeout?
 
 `number` = `1000`
 
@@ -77,7 +77,7 @@ The timeout in milliseconds before the promise is rejected.
 
 ##### ref
 
-> **ref**: `Readonly`\<`Ref`\>
+> **ref**: `Readonly`\<`Ref`\<`any`, `any`\>\>
 
 ##### reject()
 
@@ -216,7 +216,7 @@ Creates an instance of AwaitTimeout with a specified timeout duration.
 
 The options for the AwaitTimeout.
 
-###### timeout
+###### timeout?
 
 `number` = `1000`
 
@@ -398,7 +398,7 @@ Optional arguments to pass to the watch function.
 
 ###### watchOptions?
 
-`WatchOptions` = `{}`
+`WatchOptions`\<`boolean`\> = `{}`
 
 Optional watch options.
 
@@ -430,7 +430,7 @@ Helper function to get the resulting promise from an AwaitNot instance.
 
 Configuration options for AwaitNot.
 
-###### couldAlreadyBeFalse
+###### couldAlreadyBeFalse?
 
 `boolean` = `true`
 
@@ -448,13 +448,13 @@ The object containing the property to watch.
 
 The property name to watch within the object.
 
-###### ref
+###### ref?
 
-`Ref`
+`Ref`\<`any`, `any`\>
 
 A Vue ref to directly watch if provided.
 
-###### timeout
+###### timeout?
 
 `number` = `1000`
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "17.0.2",
+    "version": "18.0.1",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "type": "module",
@@ -10,11 +10,10 @@
         "tests": "tests"
     },
     "scripts": {
-        "test": "npx vitest",
+        "test": "npx --no-install vitest",
         "eslint": "npx --no-install eslint --fix index.js config/**/*.js tests/**/*.js use/**/*.js utils/**/*.js",
         "prettier": "npx --no-install prettier --write .",
-        "coverage": "npm run coverage:clean; npm test -- --coverage=true",
-        "coverage:clean": "rm -rf coverage",
+        "coverage": "npm test -- run --coverage=true",
         "prepare": "npx --no-install husky",
         "docs": "node make_type_doc.js"
     },
@@ -29,7 +28,7 @@
     },
     "homepage": "https://github.com/arrai-innovations/reactive-helpers#readme",
     "devDependencies": {
-        "@arrai-innovations/commitlint-config": "^1.1.0",
+        "@arrai-innovations/commitlint-config": "^2.0.0",
         "@commitlint/cli": "^19.4.0",
         "@godaddy/dmd": "^1.0.4",
         "@trivago/prettier-plugin-sort-imports": "^5.2.1",
@@ -37,7 +36,7 @@
         "@types/lodash-es": "^4.17.12",
         "@typescript-eslint/eslint-plugin": "^7.18.0",
         "@typescript-eslint/parser": "^7.18.0",
-        "@vitest/coverage-v8": "^2.1.8",
+        "@vitest/coverage-v8": "^3.0.8",
         "@vue/compiler-sfc": "^3.4.37",
         "@vue/eslint-config-prettier": "^9.0.0",
         "@vue/test-utils": "^2.3.2",
@@ -48,7 +47,7 @@
         "eslint-plugin-vitest-globals": "^1.3.1",
         "eslint-plugin-vue": "^9.27.0",
         "flush-promises": "^1.0.2",
-        "globals": "^15.14.0",
+        "globals": "^16.0.0",
         "husky": "^9.1.7",
         "jsdom": "^26.0.0",
         "lint-staged": "^15.2.8",
@@ -56,7 +55,7 @@
         "typedoc": "^0.27.1",
         "typedoc-plugin-markdown": "^4.3.0",
         "typescript": "^5.5.4",
-        "vitest": "^2.1.8"
+        "vitest": "^3.0.8"
     },
     "dependencies": {
         "@jcoreio/async-throttle": "^1.6.0",
@@ -65,8 +64,8 @@
         "vue-deepunref": "^1.0.1"
     },
     "peerDependencies": {
-        "@vueuse/core": "^12.4.0",
+        "@vueuse/core": "^13.0.0",
         "lodash-es": "^4.17.21",
-        "vue": "^3.4.30"
+        "vue": "^3.5.13"
     }
 }

package/use/loadingError.js

@@ -24,7 +24,7 @@ import { readonly, ref } from "vue";
  * @typedef {object} LoadingErrorMutations
  * @property {() => void} setLoading - Set the loading state.
  * @property {() => void} clearLoading - Clear the loading state.
- * @property {(error) => void} setError - Set the error state.
+ * @property {(error: Error) => void} setError - Set the error state.
  */
 
 /**

package/utils/getFakePk.js

@@ -3,7 +3,8 @@ import isMap from "lodash-es/isMap.js";
 import isSet from "lodash-es/isSet.js";
 
 /**
- * Get a fake pk that is not in the array, set, map, or object.
+ * Get a fake pk that is not in the array, set, map, or object. The fake pk is negative number, so they can be
+ * differentiated from real ids. They are returned as strings, as javascript object property keys are always strings.
  *
  * @param {Array|Set|Map|object} arraySetMapOrObject - The array, set, map, or object to check for the fake pk.
  *  An array is assumed to be an array of objects.