npm - @arrai-innovations/reactive-helpers - Versions diffs - 17.0.1 → 17.0.2 - Mend

@arrai-innovations/reactive-helpers 17.0.1 → 17.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

package/.circleci/config.yml +4 -4
package/docs/config/listCrud.md +1 -1
package/docs/config/objectCrud.md +2 -2
package/docs/use/list.md +3 -3
package/docs/use/listCalculated.md +17 -17
package/docs/use/listFilter.md +18 -18
package/docs/use/listInstance.md +2 -2
package/docs/use/listRelated.md +9 -9
package/docs/use/listSearch.md +13 -13
package/docs/use/listSort.md +18 -18
package/docs/use/object.md +3 -3
package/docs/use/objectCalculated.md +7 -7
package/docs/use/objectInstance.md +2 -2
package/docs/use/objectRelated.md +5 -5
package/docs/use/objectSubscription.md +1 -1
package/docs/utils/relatedCalculatedHelpers.md +4 -4
package/docs/utils/watches.md +4 -4
package/lint-staged.config.js +1 -1
package/make_type_doc.js +59 -0
package/package.json +11 -11
package/tests/unit/use/listInstance.spec.js +20 -12
package/use/listInstance.js +4 -0

package/.circleci/config.yml CHANGED Viewed

@@ -1,9 +1,9 @@
 version: 2.1
 orbs:
-    eslint: arrai/eslint@7.8.0
-    prettier: arrai/prettier@5.7.0
-    npm: arrai/npm@2.11.0
-    github: arrai/github@1.1.0
+    eslint: arrai/eslint@8.1.0
+    prettier: arrai/prettier@5.10.0
+    npm: arrai/npm@3.1.0
+    github: arrai/github@5.0.0
 workflows:
     test:
         jobs:

package/docs/config/listCrud.md CHANGED Viewed

@@ -385,7 +385,7 @@ The functions to set for the crud.
 ###### props
-\{`crudArgs`: `any`; \}
+\{ `crudArgs`: `any`; \}
 The props to set for the crud.

package/docs/config/objectCrud.md CHANGED Viewed

@@ -380,13 +380,13 @@ Any functions to override the default crud functions.
 ###### props
-\{`crudArgs`: \{`args`: `any`; \}; \}
+\{ `crudArgs`: \{ `args`: `any`; \}; \}
 The props with any passed crudArgs.
 ###### props.crudArgs
-\{`args`: `any`; \}
+\{ `args`: `any`; \}
 ###### props.crudArgs.args

package/docs/use/list.md CHANGED Viewed

@@ -152,7 +152,7 @@ Function or rule to determine if an item should be included based on inclusion c
 ##### calculatedObjectsRules
-> **calculatedObjectsRules**: `Ref`\<`object`, `object`\>
+> **calculatedObjectsRules**: `Ref`\<\{\}, \{\}\>
 Defines rules for dynamically calculating properties of list items.
@@ -218,7 +218,7 @@ Defines rules for associating related objects with list items.
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ##### retrieveArgs
@@ -228,7 +228,7 @@ The arguments to pass to the registered list crud functions, related to the item
 ##### textSearchRules
-> **textSearchRules**: [`TextSearchRules`](listSearch.md#textsearchrules-5)
+> **textSearchRules**: [`TextSearchRules`](listSearch.md#textsearchrules-3)
 Defines the properties and conditions used to filter the list via text search.

package/docs/use/listCalculated.md CHANGED Viewed

@@ -16,7 +16,7 @@ Options to configure the behavior of the list calculated properties.
 ##### calculatedObjectsRules
-> **calculatedObjectsRules**: `Ref`\<`object`, `object`\>
+> **calculatedObjectsRules**: `Ref`\<\{\}, \{\}\>
 A reactive reference to rules used for dynamic calculations
  within list objects. Proper setup of this reference ensures that updates are managed reactively, including deep
@@ -66,7 +66,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### intendToList?
@@ -100,7 +100,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objects
@@ -134,7 +134,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning?
@@ -150,7 +150,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning?
@@ -256,7 +256,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### intendToList?
@@ -290,7 +290,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objects
@@ -324,7 +324,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning?
@@ -340,7 +340,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning?
@@ -404,7 +404,7 @@ The calculated objects.
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### calculatedObjectsParentStateObjectsWatchRunning
@@ -420,7 +420,7 @@ The rules for the calculated objects.
 ###### Index Signature
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 ###### calculatedObjectsWatchRunning
@@ -472,7 +472,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### intendToList?
@@ -506,7 +506,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objects
@@ -540,7 +540,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning?
@@ -556,7 +556,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning?
@@ -628,7 +628,7 @@ The calculated objects.
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ##### calculatedObjectsParentStateObjectsWatchRunning
@@ -638,7 +638,7 @@ Whether the parent state objects watch is running.
 ##### calculatedObjectsRules
-> **calculatedObjectsRules**: `Ref`\<`object`, `object`\>
+> **calculatedObjectsRules**: `Ref`\<\{\}, \{\}\>
 The rules for the calculated objects.

package/docs/use/listFilter.md CHANGED Viewed

@@ -38,7 +38,7 @@ The calculated objects.
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### calculatedObjectsParentStateObjectsWatchRunning?
@@ -54,7 +54,7 @@ The rules for the calculated objects.
 ###### Index Signature
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 ###### calculatedObjectsWatchRunning?
@@ -106,7 +106,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### intendToList?
@@ -140,7 +140,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objects
@@ -174,7 +174,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning?
@@ -190,7 +190,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning?
@@ -266,7 +266,7 @@ The calculated objects.
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### calculatedObjectsParentStateObjectsWatchRunning?
@@ -282,7 +282,7 @@ The rules for the calculated objects.
 ###### Index Signature
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 ###### calculatedObjectsWatchRunning?
@@ -334,7 +334,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### intendToList?
@@ -368,7 +368,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objects
@@ -402,7 +402,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning?
@@ -418,7 +418,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning?
@@ -488,7 +488,7 @@ The calculated objects.
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### calculatedObjectsParentStateObjectsWatchRunning?
@@ -504,7 +504,7 @@ The rules for the calculated objects.
 ###### Index Signature
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 ###### calculatedObjectsWatchRunning?
@@ -562,7 +562,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### inResults
@@ -602,7 +602,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objects
@@ -648,7 +648,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning?
@@ -664,7 +664,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning?

package/docs/use/listInstance.md CHANGED Viewed

@@ -429,7 +429,7 @@ Indicates if there are ongoing reactive updates.
 #### Index Signature
- \[`key`: `string`\]: `any`
+\[`key`: `string`\]: `any`
 ##### pk
@@ -453,7 +453,7 @@ Indicates if there are ongoing reactive updates.
 #### Index Signature
- \[`pk`: `string`\]: [`ListObject`](listInstance.md#listobject)
+\[`pk`: `string`\]: [`ListObject`](listInstance.md#listobject)
 ***

package/docs/use/listRelated.md CHANGED Viewed

@@ -134,7 +134,7 @@ Whether the subscription is loading.
 ##### relatedObjectsRules
-> **relatedObjectsRules**: `Ref`\<`object`, `object`\>
+> **relatedObjectsRules**: `Ref`\<\{\}, \{\}\>
 The rules for the related objects.
@@ -314,7 +314,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### intendToList?
@@ -348,7 +348,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objects
@@ -382,7 +382,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning
@@ -398,7 +398,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning
@@ -468,7 +468,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ##### objAndKeyForPkAndRule
@@ -478,7 +478,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ##### relatedObjects
@@ -488,7 +488,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ##### relatedObjectsParentStateObjectsWatchRunning
@@ -504,7 +504,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ##### relatedObjectsWatchRunning

package/docs/use/listSearch.md CHANGED Viewed

@@ -64,7 +64,7 @@ The calculated objects.
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### calculatedObjectsParentStateObjectsWatchRunning?
@@ -80,7 +80,7 @@ The rules for the calculated objects.
 ###### Index Signature
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 ###### calculatedObjectsWatchRunning?
@@ -138,7 +138,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### inResults?
@@ -178,7 +178,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objects
@@ -224,7 +224,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning?
@@ -240,7 +240,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning?
@@ -376,7 +376,7 @@ The calculated objects.
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### calculatedObjectsParentStateObjectsWatchRunning?
@@ -392,7 +392,7 @@ The rules for the calculated objects.
 ###### Index Signature
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 ###### calculatedObjectsWatchRunning?
@@ -462,7 +462,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### inResults?
@@ -502,7 +502,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objectIndexes
@@ -554,7 +554,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning?
@@ -570,7 +570,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning?
@@ -677,7 +677,7 @@ FlexSearch.Search options.
 ##### textSearchRules
-> **textSearchRules**: [`TextSearchRules`](listSearch.md#textsearchrules-5)
+> **textSearchRules**: [`TextSearchRules`](listSearch.md#textsearchrules-3)
 Rules for what to search for. Keys are the keys to search for, values are functions that take the object and return The value to search for.

package/docs/use/listSort.md CHANGED Viewed

@@ -38,7 +38,7 @@ The calculated objects.
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### calculatedObjectsParentStateObjectsWatchRunning?
@@ -54,7 +54,7 @@ The rules for the calculated objects.
 ###### Index Signature
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 ###### calculatedObjectsWatchRunning?
@@ -124,7 +124,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### inResults?
@@ -164,7 +164,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objectIndexes?
@@ -216,7 +216,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning?
@@ -232,7 +232,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning?
@@ -345,7 +345,7 @@ The calculated objects.
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### calculatedObjectsParentStateObjectsWatchRunning?
@@ -361,7 +361,7 @@ The rules for the calculated objects.
 ###### Index Signature
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 ###### calculatedObjectsWatchRunning?
@@ -431,7 +431,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### inResults?
@@ -471,7 +471,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objectIndexes?
@@ -523,7 +523,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning?
@@ -539,7 +539,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning?
@@ -634,7 +634,7 @@ The calculated objects.
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### calculatedObjectsParentStateObjectsWatchRunning?
@@ -650,7 +650,7 @@ The rules for the calculated objects.
 ###### Index Signature
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 ###### calculatedObjectsWatchRunning?
@@ -720,7 +720,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### inResults?
@@ -760,7 +760,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### objectIndexes?
@@ -830,7 +830,7 @@ Stores computed references to related objects, allowing for dynamic access based
 ###### Index Signature
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 ###### relatedObjectsParentStateObjectsWatchRunning?
@@ -846,7 +846,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 ###### Index Signature
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 ###### relatedObjectsWatchRunning?

package/docs/use/object.md CHANGED Viewed

@@ -206,7 +206,7 @@ The calculated object.
 ###### Index Signature
- \[`ruleKey`: `string`\]: `ComputedRef`\<`any`\>
+\[`ruleKey`: `string`\]: `ComputedRef`
 ###### calculatedObjectRules
@@ -372,7 +372,7 @@ Whether the object is loading.
 ###### object
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 The object.
@@ -402,7 +402,7 @@ The related objects, indexed by the key in the related object.
 ###### Index Signature
- \[`rule`: `string`\]: `ComputedRef`\<`any`\>
+\[`rule`: `string`\]: `ComputedRef`
 ###### relatedObjectRules

package/docs/use/objectCalculated.md CHANGED Viewed

@@ -170,7 +170,7 @@ Whether the object is loading.
 ###### object
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 The object.
@@ -200,7 +200,7 @@ The related objects, indexed by the key in the related object.
 ###### Index Signature
- \[`rule`: `string`\]: `ComputedRef`\<`any`\>
+\[`rule`: `string`\]: `ComputedRef`
 ###### relatedObjectRules?
@@ -270,7 +270,7 @@ The calculated object.
 ###### Index Signature
- \[`ruleKey`: `string`\]: `ComputedRef`\<`any`\>
+\[`ruleKey`: `string`\]: `ComputedRef`
 ###### calculatedObjectRules
@@ -436,7 +436,7 @@ Whether the object is loading.
 ###### object
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 The object.
@@ -466,7 +466,7 @@ The related objects, indexed by the key in the related object.
 ###### Index Signature
- \[`rule`: `string`\]: `ComputedRef`\<`any`\>
+\[`rule`: `string`\]: `ComputedRef`
 ###### relatedObjectRules?
@@ -556,7 +556,7 @@ The calculated object.
 ###### Index Signature
- \[`ruleKey`: `string`\]: `ComputedRef`\<`any`\>
+\[`ruleKey`: `string`\]: `ComputedRef`
 ##### calculatedObjectRules
@@ -638,7 +638,7 @@ The object calculated options.
 #### Index Signature
- \[`ruleKey`: `string`\]: (`object`, `relatedObject`) => `any`
+\[`ruleKey`: `string`\]: (`object`, `relatedObject`) => `any`
 ***

package/docs/use/objectInstance.md CHANGED Viewed

@@ -447,7 +447,7 @@ Whether the object is loading.
 ###### object
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 The object.
@@ -563,7 +563,7 @@ The arguments to be passed to the retrieve function.
 ### CrudObject
-> **CrudObject**\<\>: \{`[key: string]`: `any`; `pkKey`: `string`; \} \| \{\}
+> **CrudObject**\<\>: \{ `[key: string]`: `any`;  `pkKey`: `string`; \} \| \{\}
 #### Type Parameters

package/docs/use/objectRelated.md CHANGED Viewed

@@ -170,7 +170,7 @@ Whether the object is loading.
 ###### object
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 The object.
@@ -368,7 +368,7 @@ Whether the object is loading.
 ###### object
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 The object.
@@ -398,7 +398,7 @@ The related objects, indexed by the key in the related object.
 ###### Index Signature
- \[`rule`: `string`\]: `ComputedRef`\<`any`\>
+\[`rule`: `string`\]: `ComputedRef`
 ###### relatedObjectRules
@@ -492,7 +492,7 @@ The related objects, indexed by the key in the related object.
 ###### Index Signature
- \[`rule`: `string`\]: `ComputedRef`\<`any`\>
+\[`rule`: `string`\]: `ComputedRef`
 ##### relatedObjectRules
@@ -590,7 +590,7 @@ The key in the managed object that corresponds to the key in the related object.
 #### Index Signature
- \[`rule`: `string`\]: [`ObjectRelatedRule`](objectRelated.md#objectrelatedrule)
+\[`rule`: `string`\]: [`ObjectRelatedRule`](objectRelated.md#objectrelatedrule)
 ***

package/docs/use/objectSubscription.md CHANGED Viewed

@@ -309,7 +309,7 @@ Whether the object is loading.
 ###### object
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 The object.

package/docs/utils/relatedCalculatedHelpers.md CHANGED Viewed

@@ -22,7 +22,7 @@
 ### getObjectRelatedByKey()
-> **getObjectRelatedByKey**(`obj`, `relatedObj`, `key`): [`any`, `string`]
+> **getObjectRelatedByKey**(`obj`, `relatedObj`, `key`): \[`any`, `string`\]
 Get the object and key of a related item.
@@ -48,7 +48,7 @@ The key to get the related item from.
 #### Returns
-[`any`, `string`]
+\[`any`, `string`\]
 The object and key of the related item.
@@ -56,7 +56,7 @@ The object and key of the related item.
 ### getObjectRelatedCalculatedByKey()
-> **getObjectRelatedCalculatedByKey**(`obj`, `relatedObj`, `calculatedObj`, `key`): [`any`, `string`]
+> **getObjectRelatedCalculatedByKey**(`obj`, `relatedObj`, `calculatedObj`, `key`): \[`any`, `string`\]
 Get the object and key of a calculated item.
@@ -88,6 +88,6 @@ The key to get the calculated item from.
 #### Returns
-[`any`, `string`]
+\[`any`, `string`\]
 The object and key of the calculated item.

package/docs/utils/watches.md CHANGED Viewed

@@ -47,7 +47,7 @@ The property name to watch within the object.
 ###### ref
-`Ref`\<`any`, `any`\>
+`Ref`
 A Vue ref to directly watch if provided.
@@ -77,7 +77,7 @@ The timeout in milliseconds before the promise is rejected.
 ##### ref
-> **ref**: `Readonly`\<`Ref`\<`any`, `any`\>\>
+> **ref**: `Readonly`\<`Ref`\>
 ##### reject()
@@ -398,7 +398,7 @@ Optional arguments to pass to the watch function.
 ###### watchOptions?
-`WatchOptions`\<`boolean`\> = `{}`
+`WatchOptions` = `{}`
 Optional watch options.
@@ -450,7 +450,7 @@ The property name to watch within the object.
 ###### ref
-`Ref`\<`any`, `any`\>
+`Ref`
 A Vue ref to directly watch if provided.

package/lint-staged.config.js CHANGED Viewed

@@ -1,6 +1,6 @@
 export default {
     "**/*.{js,cjs,mjs,ts,jsx,tsx}": [
-        "npx --no-install eslint --fix",
+        "npx --no-install eslint --cache --fix",
         "npx --no-install prettier --write",
         "npm run docs",
     ],

package/make_type_doc.js ADDED Viewed

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+import { execSync } from "child_process";
+import fs from "fs";
+import os from "os";
+import path from "path";
+import { fileURLToPath } from "url";
+const __filename = fileURLToPath(import.meta.url);
+const scriptName = path.basename(__filename);
+const BLUE_COLOR = "\u001b[1;38;2;0;119;247m";
+const ORANGE_COLOR = "\u001b[1;38;2;255;127;0m";
+const RESET_COLOR = "\u001b[0m";
+const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "docs-"));
+const docsDir = path.resolve("./docs");
+function cleanup() {
+    fs.rmSync(tempDir, { recursive: true, force: true });
+}
+process.on("exit", cleanup);
+process.on("SIGINT", () => {
+    cleanup();
+    process.exit(1);
+});
+execSync(`npx --no-install typedoc --out "${tempDir}" --plugin typedoc-plugin-markdown --disableSources`, {
+    stdio: "inherit",
+});
+let docsAreDifferent = false;
+try {
+    execSync(`git diff --no-index --quiet "${tempDir}" "${docsDir}"`, {
+        stdio: "inherit",
+    });
+} catch (error) {
+    if (error.status === 1) {
+        // Differences found
+        docsAreDifferent = true;
+    } else {
+        // Unexpected error
+        throw error;
+    }
+}
+if (docsAreDifferent) {
+    console.log(`[${scriptName}] ${ORANGE_COLOR}Docs are out of date, updating...${RESET_COLOR}`);
+    fs.rmSync("./docs", { recursive: true, force: true });
+    fs.renameSync(tempDir, "./docs");
+    execSync(`git add ./docs`, { stdio: "inherit" });
+} else {
+    console.log(`[${scriptName}] ${BLUE_COLOR}Docs are up to date${RESET_COLOR}`);
+}
+cleanup();
+process.exit(0);

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "17.0.1",
+    "version": "17.0.2",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "type": "module",
@@ -10,13 +10,13 @@
         "tests": "tests"
     },
     "scripts": {
-        "test": "vitest",
+        "test": "npx 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",
-        "prepare": "husky || true",
-        "docs": "./makeTypeDoc.sh"
+        "prepare": "npx --no-install husky",
+        "docs": "node make_type_doc.js"
     },
     "repository": {
         "type": "git",
@@ -32,12 +32,12 @@
         "@arrai-innovations/commitlint-config": "^1.1.0",
         "@commitlint/cli": "^19.4.0",
         "@godaddy/dmd": "^1.0.4",
-        "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+        "@trivago/prettier-plugin-sort-imports": "^5.2.1",
         "@types/browser-util-inspect": "^0.2.4",
         "@types/lodash-es": "^4.17.12",
         "@typescript-eslint/eslint-plugin": "^7.18.0",
         "@typescript-eslint/parser": "^7.18.0",
-        "@vitest/coverage-v8": "^1.6.0",
+        "@vitest/coverage-v8": "^2.1.8",
         "@vue/compiler-sfc": "^3.4.37",
         "@vue/eslint-config-prettier": "^9.0.0",
         "@vue/test-utils": "^2.3.2",
@@ -48,24 +48,24 @@
         "eslint-plugin-vitest-globals": "^1.3.1",
         "eslint-plugin-vue": "^9.27.0",
         "flush-promises": "^1.0.2",
-        "globals": "^15.9.0",
-        "jsdom": "^24.1.1",
+        "globals": "^15.14.0",
+        "husky": "^9.1.7",
+        "jsdom": "^26.0.0",
         "lint-staged": "^15.2.8",
         "prettier": "^3.3.3",
         "typedoc": "^0.27.1",
         "typedoc-plugin-markdown": "^4.3.0",
         "typescript": "^5.5.4",
-        "vitest": "^1.6.0"
+        "vitest": "^2.1.8"
     },
     "dependencies": {
         "@jcoreio/async-throttle": "^1.6.0",
         "browser-util-inspect": "^0.2.0",
         "flexsearch": "0.7.21",
-        "husky": "^9.0.11",
         "vue-deepunref": "^1.0.1"
     },
     "peerDependencies": {
-        "@vueuse/core": "^11.2.0",
+        "@vueuse/core": "^12.4.0",
         "lodash-es": "^4.17.21",
         "vue": "^3.4.30"
     }

package/tests/unit/use/listInstance.spec.js CHANGED Viewed

@@ -1,4 +1,4 @@
-import { doAwaitNot } from "../../../utils/watches.js";
+import { doAwaitNot, doAwaitTimeout } from "../../../utils/watches.js";
 import { expectErrorToBeNull } from "../expectHelpers.js";
 import flushPromises from "flush-promises";
 import keyBy from "lodash-es/keyBy.js";
@@ -274,30 +274,38 @@ describe("use/listInstance.spec.js", function () {
             expect({ ...listInstance.state.objects }).toEqual({});
         });
         it("already loading", async function () {
-            const listArgs = reactive({
-                user: 1,
-            });
-            const retrieveArgs = reactive({
-                fields,
-            });
+            const listArgs = reactive({ user: 1 });
+            const retrieveArgs = reactive({ fields });
             const listInstance = useListInstance({
                 props: { pkKey: "id", listArgs, retrieveArgs },
                 keepOldPages: false,
             });
             expectErrorToBeNull(listInstance.state.error);
             expect(listInstance.state.errored).toBe(false);
             expect(listInstance.state.loading).toBeUndefined();
-            expect({ ...listInstance.state.objects }).toEqual({});
-            globalList.mockImplementation(() => new Promise(() => {}));
+            let bulkDeleteResolve;
+            const bulkDeletePromise = new Promise((resolve) => {
+                bulkDeleteResolve = resolve;
+            });
+            globalBulkDelete.mockImplementation(() => bulkDeletePromise);
             listInstance.bulkDelete();
-            expectErrorToBeNull(listInstance.state.error);
-            expect(listInstance.state.errored).toBe(false);
             expect(listInstance.state.loading).toBe(true);
             await expect(() => listInstance.list()).rejects.toThrow(ListInstanceError);
+            expect(listInstance.state.loading).toBe(true);
+            // @ts-ignore - bulkDeleteResolve is set in a promise. promise executors run immediately
+            bulkDeleteResolve();
+            await flushPromises();
+            expect(globalBulkDelete).toHaveBeenCalledTimes(1);
             expectErrorToBeNull(listInstance.state.error);
             expect(listInstance.state.errored).toBe(false);
-            expect(listInstance.state.loading).toBe(true);
+            expect(listInstance.state.loading).toBe(false);
         });
         it("errored", async function () {
             const listArgs = reactive({

package/use/listInstance.js CHANGED Viewed

@@ -463,6 +463,10 @@ export function useListInstance({ props, functions = {}, keepOldPages }) {
     function clearList() {
         assignReactiveObject(state.objects, {});
+        // to avoid objectsInOrderRefs from being in a broken state
+        // for a tick or two, where all the elements are undefined
+        // we need to clear it as well
+        objectsInOrderRefs.value = [];
         loadingError.clearError();
     }