@genesislcap/expression-builder 14.260.1 → 14.260.2

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

@@ -0,0 +1,20 @@
+<!-- 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

@@ -0,0 +1,18 @@
+<!-- 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

@@ -0,0 +1,45 @@
+<!-- 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

@@ -0,0 +1,20 @@
+<!-- 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>;
+};
+```

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

@@ -0,0 +1,25 @@
+<!-- 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

@@ -0,0 +1,20 @@
+<!-- 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

@@ -0,0 +1,20 @@
+<!-- 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

@@ -0,0 +1,22 @@
+<!-- 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

@@ -0,0 +1,20 @@
+<!-- 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-report.md

@@ -8,24 +8,24 @@ import { ElementStyles } from '@microsoft/fast-element';
 import { GenesisElement } from '@genesislcap/web-core';
 import { ViewTemplate } from '@microsoft/fast-element';
 
-// @alpha (undocumented)
+// @beta
 const BASE_LOGICAL_COMBINATORS: Combinator[];
 
 // @alpha (undocumented)
 const BASE_OPERATORS: Operator[];
 
-// @alpha (undocumented)
+// @beta
 type BinaryOperator = {
     nbInputs: 1;
 } & _Operator;
 
-// @alpha (undocumented)
+// @beta
 type CheckboxInput = {
     input: 'checkbox';
     type: 'boolean';
 };
 
-// @alpha (undocumented)
+// @beta (undocumented)
 type Combinator = {
     type: string;
     maxRules: 1 | 2 | 'many';
@@ -49,7 +49,7 @@ declare namespace Config {
 }
 export { Config }
 
-// @alpha (undocumented)
+// @beta (undocumented)
 type Config_2 = {
     operators: Operator[];
     fields: Field[];
@@ -59,7 +59,7 @@ type Config_2 = {
     partialRuleValidationWarning?: boolean;
 };
 
-// @alpha (undocumented)
+// @beta
 type CustomElements = {
     checkbox?: string;
     text?: string;
@@ -75,7 +75,7 @@ type CustomElements = {
     };
 };
 
-// @alpha (undocumented)
+// @beta
 type CustomStyles = {
     rule?: string;
     value?: string;
@@ -84,14 +84,14 @@ type CustomStyles = {
     group?: string;
 };
 
-// @alpha (undocumented)
+// @beta
 type DateInput = {
     input: 'date';
     type: 'date';
     validation?: (x: unknown) => string | null;
 };
 
-// @alpha (undocumented)
+// @beta
 type DateTimeInput = {
     input: 'datetime-local';
     type: 'date-time';
@@ -100,15 +100,14 @@ type DateTimeInput = {
 
 // Warning: (ae-forgotten-export) The symbol "MetadataProvider" needs to be exported by the entry point index.d.ts
 //
-// @alpha (undocumented)
+// @beta
 export class ExpressionBuilder extends GenesisElement implements MetadataProvider {
-    // (undocumented)
     config: Config_2;
     // @internal (undocumented)
     configChanged(_: Config_2, newConfig: Config_2): void;
-    // (undocumented)
+    // @internal (undocumented)
     connectedCallback(): void;
-    // (undocumented)
+    // @internal (undocumented)
     disconnectedCallback(): void;
     protected dispatchChangeEvent(group: Group): void;
     // @internal (undocumented)
@@ -118,57 +117,53 @@ export class ExpressionBuilder extends GenesisElement implements MetadataProvide
     // @internal (undocumented)
     getRuleId(): string;
     // Warning: (ae-forgotten-export) The symbol "ModelGroup" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
     model: ModelGroup | null;
     // @internal (undocumented)
     modelChanged(_: Config_2, newModel: ModelGroup): void;
-    // (undocumented)
     styles?: Styles;
 }
 
-// @alpha (undocumented)
+// @beta (undocumented)
 type Field = {
     optgroup?: string | null;
-    data?: any;
     defaultValue?: any;
     fieldId: string;
     label: string;
     operators?: string[];
 } & FieldTypes;
 
-// @alpha (undocumented)
+// @beta
 type FieldTypes = TextInput | NumberInput | CheckboxInput | SelectInput | DateInput | DateTimeInput;
 
-// @alpha
+// @beta
 export const formatDateString: (date: Date) => string;
 
-// @alpha
+// @beta
 export const formatDateTimeString: (date: Date) => string;
 
-// @alpha (undocumented)
+// @beta
 type Group = {
     combinator: Combinator;
     children: (Rule | Group)[];
 };
 
-// @alpha (undocumented)
+// @beta
 const LOGICAL_COMBINATORS: Combinator[];
 
-// @alpha (undocumented)
+// @beta
 const NULL_COMBINATOR: Combinator;
 
-// @alpha (undocumented)
+// @beta
 type NumberInput = {
     input: 'number';
     type: 'int' | 'short' | 'double' | 'long' | 'bigdecimal';
     validation?: (x: unknown) => string | null;
 };
 
-// @alpha (undocumented)
+// @beta (undocumented)
 type Operator = UniraryOperator | BinaryOperator | TernararyOperator | VariadicOperator;
 
-// @alpha (undocumented)
+// @beta (undocumented)
 type _Operator = {
     applyTo: FieldTypes['type'][];
     optgroup?: string | null;
@@ -176,7 +171,7 @@ type _Operator = {
     tooltip?: string;
 };
 
-// @alpha (undocumented)
+// @beta
 type Rule = {
     field: Field | null;
 } & ({
@@ -194,14 +189,14 @@ type Rule = {
     value: any[];
 });
 
-// @alpha (undocumented)
+// @beta
 type SelectInput = {
     input: 'select';
     type: 'enum';
     values: Record<string, string | number>;
 };
 
-// @alpha (undocumented)
+// @beta
 type Styles = {
     customElements?: CustomElements;
     customStyles?: CustomStyles;
@@ -213,12 +208,12 @@ export const styles: ElementStyles;
 // @alpha (undocumented)
 export const template: ViewTemplate<ExpressionBuilder, any>;
 
-// @alpha (undocumented)
+// @beta
 type TernararyOperator = {
     nbInputs: 2;
 } & _Operator;
 
-// @alpha (undocumented)
+// @beta
 type TextInput = {
     type: 'string';
     input: 'text';
@@ -252,12 +247,12 @@ declare namespace Types {
 }
 export { Types }
 
-// @alpha (undocumented)
+// @beta
 type UniraryOperator = {
     nbInputs: 0;
 } & _Operator;
 
-// @alpha (undocumented)
+// @beta
 type VariadicOperator = {
     nbInputs: 'many';
 } & _Operator;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/expression-builder",
   "description": "Genesis Foundation Expression Builder",
-  "version": "14.260.1",
+  "version": "14.260.2",
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/expression-builder.d.ts",
@@ -59,5 +59,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "440fc2e296a21758cba55081875cc67b94707596"
+  "gitHead": "74542c54a01f7e6bfc1902d5d26ea8475dffe0cb"
 }