@arrai-innovations/reactive-helpers 17.0.0 → 17.0.2

package/.circleci/config.yml

@@ -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

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

package/docs/config/objectCrud.md

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

package/docs/use/list.md

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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.