@genesislcap/expression-builder 14.408.0 → 14.409.0

package/docs/api/expression-builder.types.md

@@ -1,286 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Types](./expression-builder.types.md)
-
-## Types namespace
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[\_Operator](./expression-builder.types._operator.md)
-
-
-</td><td>
-
-**_(BETA)_** \*
-
-
-</td></tr>
-<tr><td>
-
-[BinaryOperator](./expression-builder.types.binaryoperator.md)
-
-
-</td><td>
-
-**_(BETA)_** An operator which has one value. Example `greater_than` \*
-
-
-</td></tr>
-<tr><td>
-
-[CheckboxInput](./expression-builder.types.checkboxinput.md)
-
-
-</td><td>
-
-**_(BETA)_** Configuration for a boolean-type input, which has a boolean value and a checkbox. \*
-
-
-</td></tr>
-<tr><td>
-
-[Combinator](./expression-builder.types.combinator.md)
-
-
-</td><td>
-
-**_(BETA)_** \*
-
-
-</td></tr>
-<tr><td>
-
-[Config](./expression-builder.types.config.md)
-
-
-</td><td>
-
-**_(BETA)_** \*
-
-
-</td></tr>
-<tr><td>
-
-[CustomElements](./expression-builder.types.customelements.md)
-
-
-</td><td>
-
-**_(BETA)_** By default the expression builder uses the basic html components such as buttons and inputs. If you want to integrate your own components from a design system or otherwise you can add the tag names for your elements here. For your custom components to work they must expose the same API as the underlying HTML element they're overriding.
-
-`checkbox`<!-- -->: Custom element tag for checkbox inputs
-
-`text`<!-- -->: Custom element tag for text inputs
-
-`number`<!-- -->: Custom element tag for number inputs
-
-`date`<!-- -->: Custom element tag for date inputs
-
-`datetimeLocal`<!-- -->: Custom element tag for datetime-local inputs
-
-`select`<!-- -->: Custom element tag for select inputs
-
-`option`<!-- -->: Custom element tag for option elements
-
-`button`<!-- -->: Custom element tag for button elements
-
-`radio`<!-- -->: Custom element tag for radio and radio group elements. When using a custom element for a radio you require a parent radio group component to semantically link the radios into a group. The parent radio group must expose the `change` event and `value` attribute.
-
-
-</td></tr>
-<tr><td>
-
-[CustomStyles](./expression-builder.types.customstyles.md)
-
-
-</td><td>
-
-**_(BETA)_** Optional strings for configuring css to be applied inside of each constituent element's shadow DOM. To apply styles to components which are used inside of multiple different components (such as buttons which are used in groups, rules, and values) you must ensure the styling is set in each block. If your styling isn't showing the ensure that you're using more specific css rules to override the precedence of your rule.
-
-`rule`<!-- -->: Additional CSS for expression rule component
-
-`value`<!-- -->: Additional CSS for rule value component
-
-`field`<!-- -->: Additional CSS for rule field component
-
-`operator`<!-- -->: Additional CSS for rule operator component
-
-`group`<!-- -->: Additional CSS for expression group component
-
-
-</td></tr>
-<tr><td>
-
-[DateInput](./expression-builder.types.dateinput.md)
-
-
-</td><td>
-
-**_(BETA)_** Configuration for a date input, which has s string value and a date field input \*
-
-
-</td></tr>
-<tr><td>
-
-[DateTimeInput](./expression-builder.types.datetimeinput.md)
-
-
-</td><td>
-
-**_(BETA)_** Configuration for a datetime input, which has s string value and a datetime field input \*
-
-
-</td></tr>
-<tr><td>
-
-[Field](./expression-builder.types.field.md)
-
-
-</td><td>
-
-**_(BETA)_** \*
-
-
-</td></tr>
-<tr><td>
-
-[FieldTypes](./expression-builder.types.fieldtypes.md)
-
-
-</td><td>
-
-**_(BETA)_** Union of all input types \*
-
-
-</td></tr>
-<tr><td>
-
-[Group](./expression-builder.types.group.md)
-
-
-</td><td>
-
-**_(BETA)_** A group forms the overall model of the expression builder, and is recursive to itself allowing for a nested tree.
-
-
-</td></tr>
-<tr><td>
-
-[NumberInput](./expression-builder.types.numberinput.md)
-
-
-</td><td>
-
-**_(BETA)_** Configuration for a number-type input, which has a number value and a number input. \*
-
-
-</td></tr>
-<tr><td>
-
-[Operator](./expression-builder.types.operator.md)
-
-
-</td><td>
-
-**_(BETA)_** \*
-
-
-</td></tr>
-<tr><td>
-
-[Rule](./expression-builder.types.rule.md)
-
-
-</td><td>
-
-**_(BETA)_** A rule is a single constituent element of a larger expression, and is the smallest whole part of an expression.
-
-
-</td></tr>
-<tr><td>
-
-[SelectInput](./expression-builder.types.selectinput.md)
-
-
-</td><td>
-
-**_(BETA)_** Configuration for an enum-type input, which as a string or number value, and uses a select input. \*
-
-
-</td></tr>
-<tr><td>
-
-[Styles](./expression-builder.types.styles.md)
-
-
-</td><td>
-
-**_(BETA)_** Configuration items for the expression builder styles.
-
-`customElements`<!-- -->: optional `Types.CustomElements` block for overriding the html tags used in the expression builder
-
-`customStyles`<!-- -->: optional `Types.CustomStyles` block to configure custom css for components.
-
-
-</td></tr>
-<tr><td>
-
-[TernararyOperator](./expression-builder.types.ternararyoperator.md)
-
-
-</td><td>
-
-**_(BETA)_** An operator which has two values. Example `between_inclusive` \*
-
-
-</td></tr>
-<tr><td>
-
-[TextInput](./expression-builder.types.textinput.md)
-
-
-</td><td>
-
-**_(BETA)_** Configuration for a text-type input, which has a string value and a text input. \*
-
-
-</td></tr>
-<tr><td>
-
-[UniraryOperator](./expression-builder.types.uniraryoperator.md)
-
-
-</td><td>
-
-**_(BETA)_** An operator which doesn't have any value. Example `is_null`
-
-\*
-
-
-</td></tr>
-<tr><td>
-
-[VariadicOperator](./expression-builder.types.variadicoperator.md)
-
-
-</td><td>
-
-**_(BETA)_** An operator which can have any number of values where `NumVals >= 1`<!-- -->, defaulting to 1. Example `one_of`<!-- -->. \*
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/expression-builder.types.numberinput.md

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Types](./expression-builder.types.md) &gt; [NumberInput](./expression-builder.types.numberinput.md)
-
-## Types.NumberInput type
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Configuration for a number-type input, which has a number value and a number input. \*
-
-**Signature:**
-
-```typescript
-export type NumberInput = {
-    input: 'number';
-    type: 'int' | 'short' | 'double' | 'long' | 'bigdecimal';
-    validation?: (x: unknown) => string | null;
-};
-```

package/docs/api/expression-builder.types.operator.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Types](./expression-builder.types.md) &gt; [Operator](./expression-builder.types.operator.md)
-
-## Types.Operator type
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-\*
-
-**Signature:**
-
-```typescript
-export type Operator = UniraryOperator | BinaryOperator | TernararyOperator | VariadicOperator;
-```
-**References:** [UniraryOperator](./expression-builder.types.uniraryoperator.md)<!-- -->, [BinaryOperator](./expression-builder.types.binaryoperator.md)<!-- -->, [TernararyOperator](./expression-builder.types.ternararyoperator.md)<!-- -->, [VariadicOperator](./expression-builder.types.variadicoperator.md)
-

package/docs/api/expression-builder.types.rule.md

@@ -1,45 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Types](./expression-builder.types.md) &gt; [Rule](./expression-builder.types.rule.md)
-
-## Types.Rule type
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-A rule is a single constituent element of a larger expression, and is the smallest whole part of an expression.
-
-**Signature:**
-
-```typescript
-export type Rule = {
-    field: Field | null;
-} & ({
-    operator: null;
-} | {
-    operator: UniraryOperator;
-} | {
-    operator: BinaryOperator;
-    value: any;
-} | {
-    operator: TernararyOperator;
-    value: [any, any];
-} | {
-    operator: VariadicOperator;
-    value: any[];
-});
-```
-**References:** [Field](./expression-builder.types.field.md)<!-- -->, [UniraryOperator](./expression-builder.types.uniraryoperator.md)<!-- -->, [BinaryOperator](./expression-builder.types.binaryoperator.md)<!-- -->, [TernararyOperator](./expression-builder.types.ternararyoperator.md)<!-- -->, [VariadicOperator](./expression-builder.types.variadicoperator.md)
-
-## Example
-
-
-```
-FIELD : PROFILE_AGE
-OPERATOR : GREATER_THAN
-VALUE : 18
-
-If you're constructing a boolean expression then this rule could be used to restrict users who are 17 or younger.
-```
-\*
-

package/docs/api/expression-builder.types.selectinput.md

@@ -1,23 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Types](./expression-builder.types.md) &gt; [SelectInput](./expression-builder.types.selectinput.md)
-
-## Types.SelectInput type
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Configuration for an enum-type input, which as a string or number value, and uses a select input. \*
-
-**Signature:**
-
-```typescript
-export type SelectInput = {
-    input: 'select';
-    type: 'enum';
-    values: Record<string, string | number | {
-        label: string;
-        tooltip?: string;
-    }>;
-};
-```

package/docs/api/expression-builder.types.styles.md

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Types](./expression-builder.types.md) &gt; [Styles](./expression-builder.types.styles.md)
-
-## Types.Styles type
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Configuration items for the expression builder styles.
-
-`customElements`<!-- -->: optional `Types.CustomElements` block for overriding the html tags used in the expression builder
-
-`customStyles`<!-- -->: optional `Types.CustomStyles` block to configure custom css for components.
-
-**Signature:**
-
-```typescript
-export type Styles = {
-    customElements?: CustomElements;
-    customStyles?: CustomStyles;
-};
-```
-**References:** [CustomElements](./expression-builder.types.customelements.md)<!-- -->, [CustomStyles](./expression-builder.types.customstyles.md)
-

package/docs/api/expression-builder.types.ternararyoperator.md

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Types](./expression-builder.types.md) &gt; [TernararyOperator](./expression-builder.types.ternararyoperator.md)
-
-## Types.TernararyOperator type
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-An operator which has two values. Example `between_inclusive` \*
-
-**Signature:**
-
-```typescript
-export type TernararyOperator = {
-    nbInputs: 2;
-} & _Operator;
-```
-**References:** [\_Operator](./expression-builder.types._operator.md)
-

package/docs/api/expression-builder.types.textinput.md

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Types](./expression-builder.types.md) &gt; [TextInput](./expression-builder.types.textinput.md)
-
-## Types.TextInput type
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Configuration for a text-type input, which has a string value and a text input. \*
-
-**Signature:**
-
-```typescript
-export type TextInput = {
-    type: 'string';
-    input: 'text';
-    validation?: (x: unknown) => string | null;
-};
-```

package/docs/api/expression-builder.types.uniraryoperator.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Types](./expression-builder.types.md) &gt; [UniraryOperator](./expression-builder.types.uniraryoperator.md)
-
-## Types.UniraryOperator type
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-An operator which doesn't have any value. Example `is_null`
-
-\*
-
-**Signature:**
-
-```typescript
-export type UniraryOperator = {
-    nbInputs: 0;
-} & _Operator;
-```
-**References:** [\_Operator](./expression-builder.types._operator.md)
-

package/docs/api/expression-builder.types.variadicoperator.md

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Types](./expression-builder.types.md) &gt; [VariadicOperator](./expression-builder.types.variadicoperator.md)
-
-## Types.VariadicOperator type
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-An operator which can have any number of values where `NumVals >= 1`<!-- -->, defaulting to 1. Example `one_of`<!-- -->. \*
-
-**Signature:**
-
-```typescript
-export type VariadicOperator = {
-    nbInputs: 'many';
-} & _Operator;
-```
-**References:** [\_Operator](./expression-builder.types._operator.md)
-

package/docs/api/index.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md)
-
-## API Reference
-
-## Packages
-
-<table><thead><tr><th>
-
-Package
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[@genesislcap/expression-builder](./expression-builder.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-