@genesislcap/expression-builder 14.260.1 → 14.260.2

package/dist/expression-builder.api.json

@@ -193,7 +193,344 @@
           "releaseTag": "None",
           "name": "Config",
           "preserveMemberOrder": false,
-          "members": []
+          "members": [
+            {
+              "kind": "Variable",
+              "canonicalReference": "@genesislcap/expression-builder!Config.BASE_LOGICAL_COMBINATORS:var",
+              "docComment": "/**\n * Basic `AND` and `OR` logical combinators which can be used in the model config.\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "BASE_LOGICAL_COMBINATORS: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Combinator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Combinator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                }
+              ],
+              "fileUrlPath": "src/config/combinators.ts",
+              "isReadonly": true,
+              "releaseTag": "Beta",
+              "name": "BASE_LOGICAL_COMBINATORS",
+              "variableTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "Variable",
+              "canonicalReference": "@genesislcap/expression-builder!Config.LOGICAL_COMBINATORS:var",
+              "docComment": "/**\n * A set of boolean logic combinators which configure the expression builder to produce boolean expressions.\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "LOGICAL_COMBINATORS: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Combinator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Combinator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                }
+              ],
+              "fileUrlPath": "src/config/combinators.ts",
+              "isReadonly": true,
+              "releaseTag": "Beta",
+              "name": "LOGICAL_COMBINATORS",
+              "variableTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "Variable",
+              "canonicalReference": "@genesislcap/expression-builder!Config.NULL_COMBINATOR:var",
+              "docComment": "/**\n * A combinator which has a null action.\n *\n * If configured as the only combinator then it configures the expression builder to only create a single rule.\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "NULL_COMBINATOR: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Combinator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Combinator:type"
+                }
+              ],
+              "fileUrlPath": "src/config/combinators.ts",
+              "isReadonly": true,
+              "releaseTag": "Beta",
+              "name": "NULL_COMBINATOR",
+              "variableTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ]
+        },
+        {
+          "kind": "Class",
+          "canonicalReference": "@genesislcap/expression-builder!ExpressionBuilder:class",
+          "docComment": "/**\n * 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.\n *\n * The basics required to work with this component:\n *\n * {@link ExpressionBuilder.config} property to configure and input data and models into the component.\n *\n * _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 {@link ExpressionBuilder.model} property.\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class ExpressionBuilder extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "GenesisElement",
+              "canonicalReference": "@microsoft/fast-element!FASTElement:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " implements "
+            },
+            {
+              "kind": "Reference",
+              "text": "MetadataProvider",
+              "canonicalReference": "@genesislcap/expression-builder!~MetadataProvider:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/main/expression-builder.ts",
+          "releaseTag": "Beta",
+          "isAbstract": false,
+          "name": "ExpressionBuilder",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/expression-builder!ExpressionBuilder#config:member",
+              "docComment": "/**\n * config - `Types.Config` the configuration which is required to be set for the expression builder. All properties are defined under this single object to enforce that they're kept in sync with one another.\n *\n * If you want to set the expression of the expression builder you should do it via the `model` property on this object.\n *\n * If you're using a child class of this component with a specific model implementation you likely *don't* want to set this property directly. See example 3.\n *\n * @example\n *\n * Configuring the basic elements required by an expression builder instance\n * ```ts\n * const config: Types.Config = {\n *    fields: ...,\n *    combinators: ...,\n *    operators: ...,\n * };\n * document.querySelector('expression-builder').config = config;\n * ```\n *\n * @example\n *\n * Configuring the basic elements required by an expression builder instance, as well as inputting a model to hydrate\n * ```ts\n * const config: Types.Config = {\n *    fields: ...,\n *    combinators: ...,\n *    operators: ...,\n *    model: ...,\n * };\n * document.querySelector('expression-builder').config = config;\n * ```\n *\n * @example\n *\n * You may create your own child of the expression builder which automatically defines some of the properties, such as creating a rule builder which defines boolean operators and combinators. In this case you should use your own property name, and on change apply the user and your configurations back to the config property.\n * ```ts\n * const config: MyTypes.RuleConfig = {\n *    operators: ...,\n * };\n * // In the implementation of RuleExpressionBuilder it should listen to ruleConfigChanged and\n * apply the missing combinators and opreators back to the config along with the user's configuration\n * document.querySelector('rule-expression-builder').ruleConfig = config;\n * ```\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "config: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Config",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Config_2:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "config",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/expression-builder!ExpressionBuilder#dispatchChangeEvent:member(1)",
+              "docComment": "/**\n * Dispatches the provided model to the DOM.\n *\n * @remarks\n *\n * Override this to change the shape of model the component returns\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected dispatchChangeEvent(group: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Group",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Group:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Beta",
+              "isProtected": true,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "group",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "dispatchChangeEvent"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/expression-builder!ExpressionBuilder#model:member",
+              "docComment": "/**\n * model - `Types.Group` the current model which completely describes the state of the component.\n *\n * *IMPORTANT* you should not set this yourself via this property directly, you should always set it via the model property on the {@link ExpressionBuilder.config} block.\n *\n * You may want to read from this variable to get the most up to date state, for example if you create a child component which has a model which isn't valid for every single state (e.g. requires a complete rule) you can check this underlying model to verify what field or operator is selected.\n *\n * @example\n * ```ts\n * const model = document.querySelector('expression-builder');\n * // Once you have the model you can read it to check the applied config. While the primary use should be checking the updated model via\n * the emited change event, you can use this to check more specific changes that a domain specific model might not.\n *\n * For example, imagine a RulExpressionBuilder which is an implementation specifically for a boolean logic expression. That component may not\n * model a non-complete rule (a rule without a field, and operator, and value). In that case when it emits the event the payload will only change\n * when the user has completely configured a new rule. But if you need to catch cases earlier when they've changed the field but before they've\n * changed the value you can check the model here.\n * ```\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "model: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ModelGroup",
+                  "canonicalReference": "@genesislcap/expression-builder!~ModelGroup:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "model",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/expression-builder!ExpressionBuilder#styles:member",
+              "docComment": "/**\n * styles - `Types.Styles` optional configuration which allows you to set custom element tag names to be used, as well as custom css to be inserted into the shadow DOM.\n *\n * @example\n *\n * Bare bones example of using a custom select component\n * ```ts\n * const styles: Types.Styles = {\n *  customElements: {\n *    select: 'rapid-select',\n *  },\n *  styles: {\n *    // If you want to customise your `rapid-select` then you can do it here. The select input\n *    // is used in the value, field, and operator component, so you should set the styles for all of them for real\n *    value: `\n *      rapid-select {\n *        max-width: 180px;\n *      }\n *    `\n *  }\n * }\n * document.querySelector('expression-builder').styles = styles;\n * ```\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "styles?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Styles",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Styles:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Beta",
+              "name": "styles",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": [
+            {
+              "startIndex": 3,
+              "endIndex": 4
+            }
+          ]
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/expression-builder!formatDateString:var",
+          "docComment": "/**\n * 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.\n *\n * Used to convert a javascript date object into the required string format expected by the expression builder.\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "formatDateString: "
+            },
+            {
+              "kind": "Content",
+              "text": "(date: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Date",
+              "canonicalReference": "!Date:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => string"
+            }
+          ],
+          "fileUrlPath": "src/utils/formatting.ts",
+          "isReadonly": true,
+          "releaseTag": "Beta",
+          "name": "formatDateString",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/expression-builder!formatDateTimeString:var",
+          "docComment": "/**\n * 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.\n *\n * Used to convert a javascript date object into the required string format expected by the expression builder.\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "formatDateTimeString: "
+            },
+            {
+              "kind": "Content",
+              "text": "(date: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Date",
+              "canonicalReference": "!Date:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => string"
+            }
+          ],
+          "fileUrlPath": "src/utils/formatting.ts",
+          "isReadonly": true,
+          "releaseTag": "Beta",
+          "name": "formatDateTimeString",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
         },
         {
           "kind": "Namespace",
@@ -204,7 +541,824 @@
           "releaseTag": "None",
           "name": "Types",
           "preserveMemberOrder": false,
-          "members": []
+          "members": [
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types._Operator:type",
+              "docComment": "/**\n * *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type _Operator = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    applyTo: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FieldTypes",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.FieldTypes:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "['type'][];\n    optgroup?: string | null;\n    type: string;\n    tooltip?: string;\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "_Operator",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.BinaryOperator:type",
+              "docComment": "/**\n * An operator which has one value. Example `greater_than` *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type BinaryOperator = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    nbInputs: 1;\n} & "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "_Operator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types._Operator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "BinaryOperator",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.CheckboxInput:type",
+              "docComment": "/**\n * Configuration for a boolean-type input, which has a boolean value and a checkbox. *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type CheckboxInput = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    input: 'checkbox';\n    type: 'boolean';\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "CheckboxInput",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.Combinator:type",
+              "docComment": "/**\n * *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type Combinator = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    type: string;\n    maxRules: 1 | 2 | 'many';\n    invisible?: boolean;\n    label?: string;\n    description?: string;\n    allowedFields?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Field",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Field:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "['fieldId'][];\n    allowedOperators?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Operator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Operator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "['type'][];\n    validator?: (group: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Group",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Group:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ") => string | null;\n    allowLiterals?: boolean;\n    forceFieldOnly?: boolean;\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "Combinator",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 8
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.Config:type",
+              "docComment": "/**\n * *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type Config = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    operators: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Operator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Operator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[];\n    fields: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Field",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Field:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[];\n    combinators: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Combinator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Combinator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[];\n    model?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Group",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Group:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n    maxNesting?: number;\n    partialRuleValidationWarning?: boolean;\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "Config",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 10
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.CustomElements:type",
+              "docComment": "/**\n * 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.\n *\n * `checkbox`: Custom element tag for checkbox inputs\n *\n * `text`: Custom element tag for text inputs\n *\n * `number`: Custom element tag for number inputs\n *\n * `date`: Custom element tag for date inputs\n *\n * `datetimeLocal`: Custom element tag for datetime-local inputs\n *\n * `select`: Custom element tag for select inputs\n *\n * `option`: Custom element tag for option elements\n *\n * `button`: Custom element tag for button elements\n *\n * `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.\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type CustomElements = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    checkbox?: string;\n    text?: string;\n    number?: string;\n    date?: string;\n    datetimeLocal?: string;\n    select?: string;\n    option?: string;\n    button?: string;\n    radio?: {\n        input: string;\n        group: string;\n    };\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "CustomElements",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.CustomStyles:type",
+              "docComment": "/**\n * 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.\n *\n * `rule`: Additional CSS for expression rule component\n *\n * `value`: Additional CSS for rule value component\n *\n * `field`: Additional CSS for rule field component\n *\n * `operator`: Additional CSS for rule operator component\n *\n * `group`: Additional CSS for expression group component\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type CustomStyles = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    rule?: string;\n    value?: string;\n    field?: string;\n    operator?: string;\n    group?: string;\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "CustomStyles",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.DateInput:type",
+              "docComment": "/**\n * Configuration for a date input, which has s string value and a date field input *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type DateInput = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    input: 'date';\n    type: 'date';\n    validation?: (x: unknown) => string | null;\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "DateInput",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.DateTimeInput:type",
+              "docComment": "/**\n * Configuration for a datetime input, which has s string value and a datetime field input *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type DateTimeInput = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    input: 'datetime-local';\n    type: 'date-time';\n    validation?: (x: unknown) => string | null;\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "DateTimeInput",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.Field:type",
+              "docComment": "/**\n * *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type Field = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    optgroup?: string | null;\n    defaultValue?: any;\n    fieldId: string;\n    label: string;\n    operators?: string[];\n} & "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FieldTypes",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.FieldTypes:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "Field",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.FieldTypes:type",
+              "docComment": "/**\n * Union of all input types *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type FieldTypes = "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "TextInput",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.TextInput:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "NumberInput",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.NumberInput:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CheckboxInput",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.CheckboxInput:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SelectInput",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.SelectInput:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "DateInput",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.DateInput:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "DateTimeInput",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.DateTimeInput:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "FieldTypes",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 12
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.Group:type",
+              "docComment": "/**\n * A group forms the overall model of the expression builder, and is recursive to itself allowing for a nested tree.\n *\n * @example\n * ```\n * RULE 1\n * FIELD : PROFILE_AGE\n * OPERATOR : GREATER_THAN\n * VALUE : 18\n *\n * COMBINATOR : OR\n *\n * GROUP 2\n *    RULE 2\n *    FIELD : PARENT_ROLE\n *    OPERATOR : ONE_OF\n *    VALUE : GIVES_PERMISSION\n *\n *    COMBINATOR : AND\n *\n *    RULE 3\n *    FIELD : GRANTS_CHILD_ACCESS\n *    OPERATOR : EQUALS\n *    VALUE : true\n *\n * If you're constructing a boolean expression then this rule could be used to restrict users who are 17 or younger, but\n * allowing parents who have specific rights to be able to grant access too.\n * ```\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type Group = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    combinator: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Combinator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Combinator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n    children: ("
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Rule",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Rule:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Group",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Group:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ")[];\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "Group",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 8
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.NumberInput:type",
+              "docComment": "/**\n * Configuration for a number-type input, which has a number value and a number input. *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type NumberInput = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    input: 'number';\n    type: 'int' | 'short' | 'double' | 'long' | 'bigdecimal';\n    validation?: (x: unknown) => string | null;\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "NumberInput",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.Operator:type",
+              "docComment": "/**\n * *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type Operator = "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "UniraryOperator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.UniraryOperator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BinaryOperator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.BinaryOperator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "TernararyOperator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.TernararyOperator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "VariadicOperator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.VariadicOperator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "Operator",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 8
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.Rule:type",
+              "docComment": "/**\n * A rule is a single constituent element of a larger expression, and is the smallest whole part of an expression.\n *\n * @example\n * ```\n * FIELD : PROFILE_AGE\n * OPERATOR : GREATER_THAN\n * VALUE : 18\n *\n * If you're constructing a boolean expression then this rule could be used to restrict users who are 17 or younger.\n * ```\n *\n * *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type Rule = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    field: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Field",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Field:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null;\n} & ({\n    operator: null;\n} | {\n    operator: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "UniraryOperator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.UniraryOperator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n} | {\n    operator: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BinaryOperator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.BinaryOperator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n    value: any;\n} | {\n    operator: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "TernararyOperator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.TernararyOperator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n    value: [any, any];\n} | {\n    operator: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "VariadicOperator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.VariadicOperator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n    value: any[];\n})"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "Rule",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 12
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.SelectInput:type",
+              "docComment": "/**\n * Configuration for an enum-type input, which as a string or number value, and uses a select input. *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type SelectInput = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    input: 'select';\n    type: 'enum';\n    values: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, string | number>;\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "SelectInput",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.Styles:type",
+              "docComment": "/**\n * Configuration items for the expression builder styles.\n *\n * `customElements`: optional `Types.CustomElements` block for overriding the html tags used in the expression builder\n *\n * `customStyles`: optional `Types.CustomStyles` block to configure custom css for components.\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type Styles = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    customElements?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CustomElements",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.CustomElements:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n    customStyles?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CustomStyles",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.CustomStyles:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "Styles",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 6
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.TernararyOperator:type",
+              "docComment": "/**\n * An operator which has two values. Example `between_inclusive` *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type TernararyOperator = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    nbInputs: 2;\n} & "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "_Operator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types._Operator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "TernararyOperator",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.TextInput:type",
+              "docComment": "/**\n * Configuration for a text-type input, which has a string value and a text input. *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type TextInput = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    type: 'string';\n    input: 'text';\n    validation?: (x: unknown) => string | null;\n}"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "TextInput",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.UniraryOperator:type",
+              "docComment": "/**\n * An operator which doesn't have any value. Example `is_null`\n *\n * *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type UniraryOperator = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    nbInputs: 0;\n} & "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "_Operator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types._Operator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "UniraryOperator",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@genesislcap/expression-builder!Types.VariadicOperator:type",
+              "docComment": "/**\n * An operator which can have any number of values where `NumVals >= 1`, defaulting to 1. Example `one_of`. *\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export type VariadicOperator = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n    nbInputs: 'many';\n} & "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "_Operator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types._Operator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "fileUrlPath": "src/types/public.types.ts",
+              "releaseTag": "Beta",
+              "name": "VariadicOperator",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            }
+          ]
         }
       ]
     }