@genesislcap/expression-builder 14.408.0 → 14.409.0

package/docs/api/expression-builder.md

@@ -1,149 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md)
-
-## expression-builder package
-
-## Classes
-
-<table><thead><tr><th>
-
-Class
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ExpressionBuilder](./expression-builder.expressionbuilder.md)
-
-
-</td><td>
-
-**_(BETA)_** Top level component to allow the user to build expressions. It produces a generic payload which doesn't have any system by itself to evaluate or execute the built expression.
-
-The basics required to work with this component:
-
-[ExpressionBuilder.config](./expression-builder.expressionbuilder.config.md) property to configure and input data and models into the component.
-
-\_Event\_ change - `Types.Group` emits the model configuration on change. If you create a child component of the expression builder where you want to use a different (e.g. domain specific) model then it will likely override then emit event and instead emit it's own model. To check the underlying `Types.Group` model check the [ExpressionBuilder.model](./expression-builder.expressionbuilder.model.md) property.
-
-
-</td></tr>
-</tbody></table>
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[formatDateString(date)](./expression-builder.formatdatestring.md)
-
-
-</td><td>
-
-**_(BETA)_** Gets the string representation from a `Date` which is the format a `date` input uses. `yyyy-mm-dd`<!-- -->. Uses UTC methods to ensure consistent output regardless of timezone.
-
-Used to convert a javascript date object into the required string format expected by the expression builder.
-
-
-</td></tr>
-<tr><td>
-
-[formatDateTimeString(date)](./expression-builder.formatdatetimestring.md)
-
-
-</td><td>
-
-**_(BETA)_** Gets the string representation from a `Date` which is the format a `datetime-local` input uses. `yyyy-mm-ddThh:mm:ss`<!-- -->. Uses UTC methods to ensure consistent output regardless of timezone.
-
-Used to convert a javascript date object into the required string format expected by the expression builder.
-
-
-</td></tr>
-</tbody></table>
-
-## Namespaces
-
-<table><thead><tr><th>
-
-Namespace
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[Config](./expression-builder.config.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[Types](./expression-builder.types.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Variables
-
-<table><thead><tr><th>
-
-Variable
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[styles](./expression-builder.styles.md)
-
-
-</td><td>
-
-**_(ALPHA)_** \*
-
-
-</td></tr>
-<tr><td>
-
-[template](./expression-builder.template.md)
-
-
-</td><td>
-
-**_(ALPHA)_** \*
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,16 +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; [styles](./expression-builder.styles.md)
-
-## styles variable
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-\*
-
-**Signature:**
-
-```typescript
-styles: import("@microsoft/fast-element").ElementStyles
-```

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

@@ -1,16 +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; [template](./expression-builder.template.md)
-
-## template variable
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-\*
-
-**Signature:**
-
-```typescript
-template: import("@microsoft/fast-element").ViewTemplate<ExpressionBuilder, any>
-```

package/docs/api/expression-builder.types._operator.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; [\_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 = {
-    applyTo: FieldTypes['type'][];
-    optgroup?: string | null;
-    type: string;
-    label?: string;
-    tooltip?: string;
-    valueType?: FieldTypes;
-};
-```
-**References:** [FieldTypes](./expression-builder.types.fieldtypes.md)
-

package/docs/api/expression-builder.types.binaryoperator.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; [BinaryOperator](./expression-builder.types.binaryoperator.md)
-
-## Types.BinaryOperator 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 one value. Example `greater_than` \*
-
-**Signature:**
-
-```typescript
-export type BinaryOperator = {
-    nbInputs: 1;
-} & _Operator;
-```
-**References:** [\_Operator](./expression-builder.types._operator.md)
-

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

@@ -1,19 +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; [CheckboxInput](./expression-builder.types.checkboxinput.md)
-
-## Types.CheckboxInput 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 boolean-type input, which has a boolean value and a checkbox. \*
-
-**Signature:**
-
-```typescript
-export type CheckboxInput = {
-    input: 'checkbox';
-    type: 'boolean';
-};
-```

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

@@ -1,29 +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; [Combinator](./expression-builder.types.combinator.md)
-
-## Types.Combinator 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 Combinator = {
-    type: string;
-    maxRules: 1 | 2 | 'many';
-    invisible?: boolean;
-    label?: string;
-    description?: string;
-    allowedFields?: Field['fieldId'][];
-    allowedOperators?: Operator['type'][];
-    validator?: (group: Group) => string | null;
-    allowLiterals?: boolean;
-    forceFieldOnly?: boolean;
-};
-```
-**References:** [Field](./expression-builder.types.field.md)<!-- -->, [Operator](./expression-builder.types.operator.md)<!-- -->, [Group](./expression-builder.types.group.md)
-

package/docs/api/expression-builder.types.config.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; [Config](./expression-builder.types.config.md)
-
-## Types.Config 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 Config = {
-    operators: Operator[];
-    fields: Field[];
-    combinators: Combinator[];
-    model?: Group;
-    maxNesting?: number;
-    partialRuleValidationWarning?: boolean;
-};
-```
-**References:** [Operator](./expression-builder.types.operator.md)<!-- -->, [Field](./expression-builder.types.field.md)<!-- -->, [Combinator](./expression-builder.types.combinator.md)<!-- -->, [Group](./expression-builder.types.group.md)
-

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

@@ -1,48 +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; [CustomElements](./expression-builder.types.customelements.md)
-
-## Types.CustomElements 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.
-> 
-
-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.
-
-**Signature:**
-
-```typescript
-export type CustomElements = {
-    checkbox?: string;
-    text?: string;
-    number?: string;
-    date?: string;
-    datetimeLocal?: string;
-    select?: string;
-    option?: string;
-    optgroup?: string;
-    button?: string;
-    radio?: {
-        input: string;
-        group: string;
-    };
-};
-```

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

@@ -1,32 +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; [CustomStyles](./expression-builder.types.customstyles.md)
-
-## Types.CustomStyles 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.
-> 
-
-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
-
-**Signature:**
-
-```typescript
-export type CustomStyles = {
-    rule?: string;
-    value?: string;
-    field?: string;
-    operator?: string;
-    group?: string;
-};
-```

package/docs/api/expression-builder.types.dateinput.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; [DateInput](./expression-builder.types.dateinput.md)
-
-## Types.DateInput 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 date input, which has s string value and a date field input \*
-
-**Signature:**
-
-```typescript
-export type DateInput = {
-    input: 'date';
-    type: 'date';
-    validation?: (x: unknown) => string | null;
-};
-```

package/docs/api/expression-builder.types.datetimeinput.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; [DateTimeInput](./expression-builder.types.datetimeinput.md)
-
-## Types.DateTimeInput 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 datetime input, which has s string value and a datetime field input \*
-
-**Signature:**
-
-```typescript
-export type DateTimeInput = {
-    input: 'datetime-local';
-    type: 'date-time';
-    validation?: (x: unknown) => string | null;
-};
-```

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

@@ -1,24 +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; [Field](./expression-builder.types.field.md)
-
-## Types.Field 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 Field = {
-    optgroup?: string | null;
-    defaultValue?: any;
-    fieldId: string;
-    label: string;
-    operators?: string[];
-} & FieldTypes;
-```
-**References:** [FieldTypes](./expression-builder.types.fieldtypes.md)
-

package/docs/api/expression-builder.types.fieldtypes.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; [FieldTypes](./expression-builder.types.fieldtypes.md)
-
-## Types.FieldTypes 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.
-> 
-
-Union of all input types \*
-
-**Signature:**
-
-```typescript
-export type FieldTypes = TextInput | NumberInput | CheckboxInput | SelectInput | DateInput | DateTimeInput;
-```
-**References:** [TextInput](./expression-builder.types.textinput.md)<!-- -->, [NumberInput](./expression-builder.types.numberinput.md)<!-- -->, [CheckboxInput](./expression-builder.types.checkboxinput.md)<!-- -->, [SelectInput](./expression-builder.types.selectinput.md)<!-- -->, [DateInput](./expression-builder.types.dateinput.md)<!-- -->, [DateTimeInput](./expression-builder.types.datetimeinput.md)
-

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

@@ -1,49 +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; [Group](./expression-builder.types.group.md)
-
-## Types.Group 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 group forms the overall model of the expression builder, and is recursive to itself allowing for a nested tree.
-
-**Signature:**
-
-```typescript
-export type Group = {
-    combinator: Combinator;
-    children: (Rule | Group)[];
-};
-```
-**References:** [Combinator](./expression-builder.types.combinator.md)<!-- -->, [Rule](./expression-builder.types.rule.md)<!-- -->, [Group](./expression-builder.types.group.md)
-
-## Example
-
-
-```
-RULE 1
-FIELD : PROFILE_AGE
-OPERATOR : GREATER_THAN
-VALUE : 18
-
-COMBINATOR : OR
-
-GROUP 2
-   RULE 2
-   FIELD : PARENT_ROLE
-   OPERATOR : ONE_OF
-   VALUE : GIVES_PERMISSION
-
-   COMBINATOR : AND
-
-   RULE 3
-   FIELD : GRANTS_CHILD_ACCESS
-   OPERATOR : EQUALS
-   VALUE : true
-
-If you're constructing a boolean expression then this rule could be used to restrict users who are 17 or younger, but
-allowing parents who have specific rights to be able to grant access too.
-```
-