@genesislcap/expression-builder 14.408.0 → 14.409.0

package/README.md

@@ -1,3 +1,25 @@
-# Genesis Foundation Expressions
+# @genesislcap/expression-builder
 
-TODO
+Documentation for this package is published on the Genesis docs site:
+
+**Docs: [Expression builder](https://docs.genesis.global/docs/develop/client-capabilities/expression-builder/)**
+
+## Installation
+
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
+
+```json
+{
+  "dependencies": {
+    "@genesislcap/expression-builder": "latest"
+  }
+}
+```
+
+## License
+
+Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
+
+### Licensed components
+
+Genesis low-code platform

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/expression-builder",
   "description": "Genesis Foundation Expression Builder",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/expression-builder.d.ts",
@@ -38,16 +38,16 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0"
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0"
   },
   "dependencies": {
-    "@genesislcap/web-core": "14.408.0",
+    "@genesislcap/web-core": "14.409.0",
     "rfdc": "1.4.1"
   },
   "repository": {
@@ -59,5 +59,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

package/docs/api/expression-builder.config.base_logical_combinators.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; [Config](./expression-builder.config.md) &gt; [BASE\_LOGICAL\_COMBINATORS](./expression-builder.config.base_logical_combinators.md)
-
-## Config.BASE\_LOGICAL\_COMBINATORS variable
-
-> 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.
-> 
-
-Basic `AND` and `OR` logical combinators which can be used in the model config.
-
-**Signature:**
-
-```typescript
-BASE_LOGICAL_COMBINATORS: Combinator[]
-```

package/docs/api/expression-builder.config.base_operators.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; [Config](./expression-builder.config.md) &gt; [BASE\_OPERATORS](./expression-builder.config.base_operators.md)
-
-## Config.BASE\_OPERATORS 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
-BASE_OPERATORS: Operator[]
-```

package/docs/api/expression-builder.config.logical_combinators.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; [Config](./expression-builder.config.md) &gt; [LOGICAL\_COMBINATORS](./expression-builder.config.logical_combinators.md)
-
-## Config.LOGICAL\_COMBINATORS variable
-
-> 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 set of boolean logic combinators which configure the expression builder to produce boolean expressions.
-
-**Signature:**
-
-```typescript
-LOGICAL_COMBINATORS: Combinator[]
-```

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

@@ -1,67 +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; [Config](./expression-builder.config.md)
-
-## Config namespace
-
-## Variables
-
-<table><thead><tr><th>
-
-Variable
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[BASE\_LOGICAL\_COMBINATORS](./expression-builder.config.base_logical_combinators.md)
-
-
-</td><td>
-
-**_(BETA)_** Basic `AND` and `OR` logical combinators which can be used in the model config.
-
-
-</td></tr>
-<tr><td>
-
-[BASE\_OPERATORS](./expression-builder.config.base_operators.md)
-
-
-</td><td>
-
-**_(ALPHA)_** \*
-
-
-</td></tr>
-<tr><td>
-
-[LOGICAL\_COMBINATORS](./expression-builder.config.logical_combinators.md)
-
-
-</td><td>
-
-**_(BETA)_** A set of boolean logic combinators which configure the expression builder to produce boolean expressions.
-
-
-</td></tr>
-<tr><td>
-
-[NULL\_COMBINATOR](./expression-builder.config.null_combinator.md)
-
-
-</td><td>
-
-**_(BETA)_** A combinator which has a null action.
-
-If configured as the only combinator then it configures the expression builder to only create a single rule.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/expression-builder.config.null_combinator.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; [Config](./expression-builder.config.md) &gt; [NULL\_COMBINATOR](./expression-builder.config.null_combinator.md)
-
-## Config.NULL\_COMBINATOR variable
-
-> 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 combinator which has a null action.
-
-If configured as the only combinator then it configures the expression builder to only create a single rule.
-
-**Signature:**
-
-```typescript
-NULL_COMBINATOR: Combinator
-```

package/docs/api/expression-builder.expressionbuilder.config.md

@@ -1,61 +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; [ExpressionBuilder](./expression-builder.expressionbuilder.md) &gt; [config](./expression-builder.expressionbuilder.config.md)
-
-## ExpressionBuilder.config property
-
-> 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.
-> 
-
-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.
-
-If you want to set the expression of the expression builder you should do it via the `model` property on this object.
-
-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.
-
-**Signature:**
-
-```typescript
-config: Config;
-```
-
-## Example 1
-
-Configuring the basic elements required by an expression builder instance
-
-```ts
-const config: Types.Config = {
-   fields: ...,
-   combinators: ...,
-   operators: ...,
-};
-document.querySelector('expression-builder').config = config;
-```
-
-## Example 2
-
-Configuring the basic elements required by an expression builder instance, as well as inputting a model to hydrate
-
-```ts
-const config: Types.Config = {
-   fields: ...,
-   combinators: ...,
-   operators: ...,
-   model: ...,
-};
-document.querySelector('expression-builder').config = config;
-```
-
-## Example 3
-
-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.
-
-```ts
-const config: MyTypes.RuleConfig = {
-   operators: ...,
-};
-// In the implementation of RuleExpressionBuilder it should listen to ruleConfigChanged and
-apply the missing combinators and opreators back to the config along with the user's configuration
-document.querySelector('rule-expression-builder').ruleConfig = config;
-```
-

package/docs/api/expression-builder.expressionbuilder.dispatchchangeevent.md

@@ -1,59 +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; [ExpressionBuilder](./expression-builder.expressionbuilder.md) &gt; [dispatchChangeEvent](./expression-builder.expressionbuilder.dispatchchangeevent.md)
-
-## ExpressionBuilder.dispatchChangeEvent() method
-
-> 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.
-> 
-
-Dispatches the provided model to the DOM.
-
-**Signature:**
-
-```typescript
-protected dispatchChangeEvent(group: Group): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-group
-
-
-</td><td>
-
-[Group](./expression-builder.types.group.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Remarks
-
-Override this to change the shape of model the component returns
-

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

@@ -1,152 +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; [ExpressionBuilder](./expression-builder.expressionbuilder.md)
-
-## ExpressionBuilder class
-
-> 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.
-> 
-
-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.
-
-**Signature:**
-
-```typescript
-export declare class ExpressionBuilder extends GenesisElement implements MetadataProvider 
-```
-**Extends:** GenesisElement
-
-**Implements:** MetadataProvider
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[config](./expression-builder.expressionbuilder.config.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Config
-
-
-</td><td>
-
-**_(BETA)_** 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.
-
-If you want to set the expression of the expression builder you should do it via the `model` property on this object.
-
-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.
-
-
-</td></tr>
-<tr><td>
-
-[model](./expression-builder.expressionbuilder.model.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ModelGroup \| null
-
-
-</td><td>
-
-**_(BETA)_** model - `Types.Group` the current model which completely describes the state of the component.
-
-\*IMPORTANT\* you should not set this yourself via this property directly, you should always set it via the model property on the [ExpressionBuilder.config](./expression-builder.expressionbuilder.config.md) block.
-
-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.
-
-
-</td></tr>
-<tr><td>
-
-[styles?](./expression-builder.expressionbuilder.styles.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Styles](./expression-builder.types.styles.md)
-
-
-</td><td>
-
-**_(BETA)_** _(Optional)_ 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.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[dispatchChangeEvent(group)](./expression-builder.expressionbuilder.dispatchchangeevent.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-**_(BETA)_** Dispatches the provided model to the DOM.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/expression-builder.expressionbuilder.model.md

@@ -1,35 +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; [ExpressionBuilder](./expression-builder.expressionbuilder.md) &gt; [model](./expression-builder.expressionbuilder.model.md)
-
-## ExpressionBuilder.model property
-
-> 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.
-> 
-
-model - `Types.Group` the current model which completely describes the state of the component.
-
-\*IMPORTANT\* you should not set this yourself via this property directly, you should always set it via the model property on the [ExpressionBuilder.config](./expression-builder.expressionbuilder.config.md) block.
-
-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.
-
-**Signature:**
-
-```typescript
-model: ModelGroup | null;
-```
-
-## Example
-
-
-```ts
-const model = document.querySelector('expression-builder');
-// 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
-the emited change event, you can use this to check more specific changes that a domain specific model might not.
-
-For example, imagine a RulExpressionBuilder which is an implementation specifically for a boolean logic expression. That component may not
-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
-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
-changed the value you can check the model here.
-```
-

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

@@ -1,39 +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; [ExpressionBuilder](./expression-builder.expressionbuilder.md) &gt; [styles](./expression-builder.expressionbuilder.styles.md)
-
-## ExpressionBuilder.styles property
-
-> 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.
-> 
-
-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.
-
-**Signature:**
-
-```typescript
-styles?: Styles;
-```
-
-## Example
-
-Bare bones example of using a custom select component
-
-```ts
-const styles: Types.Styles = {
- customElements: {
-   select: 'rapid-select',
- },
- styles: {
-   // If you want to customise your `rapid-select` then you can do it here. The select input
-   // is used in the value, field, and operator component, so you should set the styles for all of them for real
-   value: `
-     rapid-select {
-       max-width: 180px;
-     }
-   `
- }
-}
-document.querySelector('expression-builder').styles = styles;
-```
-

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

@@ -1,57 +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; [formatDateString](./expression-builder.formatdatestring.md)
-
-## formatDateString() function
-
-> 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.
-> 
-
-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.
-
-**Signature:**
-
-```typescript
-formatDateString: (date: Date) => string
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-date
-
-
-</td><td>
-
-Date
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-

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

@@ -1,57 +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; [formatDateTimeString](./expression-builder.formatdatetimestring.md)
-
-## formatDateTimeString() function
-
-> 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.
-> 
-
-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.
-
-**Signature:**
-
-```typescript
-formatDateTimeString: (date: Date) => string
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-date
-
-
-</td><td>
-
-Date
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-