@genesislcap/expression-builder 14.248.0

package/dist/expression-builder.api.json

@@ -0,0 +1,212 @@
+{
+  "metadata": {
+    "toolPackage": "@microsoft/api-extractor",
+    "toolVersion": "7.34.9",
+    "schemaVersion": 1011,
+    "oldestForwardsCompatibleVersion": 1001,
+    "tsdocConfig": {
+      "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+      "noStandardTags": true,
+      "tagDefinitions": [
+        {
+          "tagName": "@alpha",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@beta",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@defaultValue",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@decorator",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@deprecated",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@eventProperty",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@example",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@experimental",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@inheritDoc",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@internal",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@label",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@link",
+          "syntaxKind": "inline",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@override",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@packageDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@param",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@privateRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@public",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@readonly",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@remarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@returns",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@sealed",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@see",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@throws",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@typeParam",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@virtual",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@betaDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@internalRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@preapproved",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@tagname",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@fires",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        }
+      ],
+      "supportForTags": {
+        "@alpha": true,
+        "@beta": true,
+        "@defaultValue": true,
+        "@decorator": true,
+        "@deprecated": true,
+        "@eventProperty": true,
+        "@example": true,
+        "@experimental": true,
+        "@inheritDoc": true,
+        "@internal": true,
+        "@label": true,
+        "@link": true,
+        "@override": true,
+        "@packageDocumentation": true,
+        "@param": true,
+        "@privateRemarks": true,
+        "@public": true,
+        "@readonly": true,
+        "@remarks": true,
+        "@returns": true,
+        "@sealed": true,
+        "@see": true,
+        "@throws": true,
+        "@typeParam": true,
+        "@virtual": true,
+        "@betaDocumentation": true,
+        "@internalRemarks": true,
+        "@preapproved": true,
+        "@tagname": true,
+        "@fires": true
+      },
+      "reportUnsupportedHtmlElements": false
+    }
+  },
+  "kind": "Package",
+  "canonicalReference": "@genesislcap/expression-builder!",
+  "docComment": "",
+  "name": "@genesislcap/expression-builder",
+  "preserveMemberOrder": false,
+  "members": [
+    {
+      "kind": "EntryPoint",
+      "canonicalReference": "@genesislcap/expression-builder!",
+      "name": "",
+      "preserveMemberOrder": false,
+      "members": [
+        {
+          "kind": "Namespace",
+          "canonicalReference": "@genesislcap/expression-builder!Config:namespace",
+          "docComment": "",
+          "excerptTokens": [],
+          "fileUrlPath": "src/index.ts",
+          "releaseTag": "None",
+          "name": "Config",
+          "preserveMemberOrder": false,
+          "members": []
+        },
+        {
+          "kind": "Namespace",
+          "canonicalReference": "@genesislcap/expression-builder!Types:namespace",
+          "docComment": "",
+          "excerptTokens": [],
+          "fileUrlPath": "src/index.ts",
+          "releaseTag": "None",
+          "name": "Types",
+          "preserveMemberOrder": false,
+          "members": []
+        }
+      ]
+    }
+  ]
+}

package/dist/expression-builder.d.ts

@@ -0,0 +1,322 @@
+import { ElementStyles } from '@microsoft/fast-element';
+import { GenesisElement } from '@genesislcap/web-core';
+import { ViewTemplate } from '@microsoft/fast-element';
+
+/** @alpha */
+declare const BASE_LOGICAL_COMBINATORS: Combinator[];
+
+/** @alpha **/
+declare const BASE_OPERATORS: Operator[];
+
+/** @alpha **/
+declare type BinaryOperator = {
+    nbInputs: 1;
+} & _Operator;
+
+/** @alpha **/
+declare type CheckboxInput = {
+    input: 'checkbox';
+    type: 'boolean';
+};
+
+/** @alpha **/
+declare type Combinator = {
+    type: string;
+    maxRules: 1 | 2 | 'many';
+    label?: string;
+    description?: string;
+    allowedFields?: Field['fieldId'][];
+    allowedOperators?: Operator['type'][];
+    validator?: (group: Group) => string | null;
+    allowLiterals?: boolean;
+    forceFieldOnly?: boolean;
+};
+
+declare namespace Config {
+    export {
+        BASE_LOGICAL_COMBINATORS,
+        LOGICAL_COMBINATORS,
+        BASE_OPERATORS
+    }
+}
+export { Config }
+
+/** @alpha **/
+declare type Config_2 = {
+    operators: Operator[];
+    fields: Field[];
+    combinators: Combinator[];
+    /** Model to hydrate */
+    model?: Group;
+    /** If set and more than 0, is a 1-indexed config for the nesting of groups */
+    maxNesting?: number;
+};
+
+/** @alpha **/
+declare type CustomElements = {
+    /** Custom element tag for checkbox inputs */
+    checkbox?: string;
+    /** Custom element tag for text inputs */
+    text?: string;
+    /** Custom element tag for number inputs */
+    number?: string;
+    /** Custom element tag for date inputs */
+    date?: string;
+    /** Custom element tag for datetime-local inputs */
+    datetimeLocal?: string;
+    /** Custom element tag for select inputs */
+    select?: string;
+    /** Custom element tag for option elements */
+    option?: string;
+    /** Custom element tag for button elements */
+    button?: string;
+    /** Custom element tag for radio and radio group elements
+     * Assume that the radio group still exposes change event and value attribute */
+    radio?: {
+        input: string;
+        group: string;
+    };
+};
+
+/** @alpha **/
+declare type CustomStyles = {
+    /** Additional CSS for expression rule component */
+    rule?: string;
+    /** Additional CSS for rule value component */
+    value?: string;
+    /** Additional CSS for rule field component */
+    field?: string;
+    /** Additional CSS for rule operator component */
+    operator?: string;
+    /** Additional CSS for expression group component */
+    group?: string;
+};
+
+/** @alpha **/
+declare type DateInput = {
+    input: 'date';
+    type: 'date';
+    validation?: (x: unknown) => string | null;
+};
+
+/** @alpha **/
+declare type DateTimeInput = {
+    input: 'datetime-local';
+    type: 'date-time';
+    validation?: (x: unknown) => string | null;
+};
+
+/** @alpha **/
+export declare class ExpressionBuilder extends GenesisElement implements MetadataProvider {
+    config: Config_2;
+    styles?: Styles;
+    model: ModelGroup | null;
+    private ruleCount;
+    private groupCount;
+    /** @internal */
+    configChanged(_: Config_2, newConfig: Config_2): void;
+    /** @internal */
+    modelChanged(_: Config_2, newModel: ModelGroup): void;
+    /**
+     * @alpha
+     * Dispatches the provided model to the DOM.
+     *
+     * @remarks
+     * Override this to change the shape of model the component returns
+     */
+    protected dispatchChangeEvent(group: Group): void;
+    /** @internal */
+    getConfig(): Config_2;
+    /** @internal */
+    getGroupId(): string;
+    /** @internal */
+    getRuleId(): string;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private handleAddGroup;
+    private _handleAddGroup;
+    private handleAddRule;
+    private _handleAddRule;
+    private handleDeleteGroup;
+    private _handleDeleteGroup;
+    private handleDeleteRule;
+    private _handleDeleteRule;
+    private handleUpdateGroupData;
+    private _handleUpdateGroupData;
+    private handleUpdateRuleData;
+    private _handleUpdateRuleData;
+}
+
+/** @alpha **/
+declare type Field = {
+    optgroup?: string | null;
+    data?: any;
+    defaultValue?: any;
+    fieldId: string;
+    label: string;
+    operators?: string[];
+} & FieldTypes;
+
+/** @alpha **/
+declare type FieldTypes = TextInput | NumberInput | CheckboxInput | SelectInput | DateInput | DateTimeInput;
+
+/**
+ * Gets the string representation from a `Date` which is the format a `date` input uses.
+ * `yyyy-mm-dd`
+ * @alpha
+ */
+export declare const formatDateString: (date: Date) => string;
+
+/**
+ * Gets the string representation from a `Date` which is the format a `datetime-local` input uses.
+ * `yyyy-mm-ddThh:mm:ss`
+ * @alpha
+ */
+export declare const formatDateTimeString: (date: Date) => string;
+
+/** @alpha **/
+declare type Group = {
+    combinator: Combinator;
+    children: (Rule | Group)[];
+};
+
+/** @internal **/
+declare type GroupMetadata = {
+    groupId: string;
+    level: number;
+    config: Config_2;
+};
+
+/** @internal **/
+declare type GroupStructure = Omit<Group, 'children'> & {
+    children: (ModelRule | ModelGroup)[];
+};
+
+/** @alpha */
+declare const LOGICAL_COMBINATORS: Combinator[];
+
+/** @internal */
+declare interface MetadataProvider {
+    getGroupId(): string;
+    getRuleId(): string;
+    getConfig(): Config_2;
+}
+
+/** @internal **/
+declare type ModelGroup = GroupMetadata & GroupStructure;
+
+/** @internal **/
+declare type ModelRule = Rule & RuleMetadata;
+
+/** @alpha **/
+declare type NumberInput = {
+    input: 'number';
+    type: 'int' | 'short' | 'double' | 'long' | 'bigdecimal';
+    validation?: (x: unknown) => string | null;
+};
+
+/** @alpha **/
+declare type Operator = UniraryOperator | BinaryOperator | TernararyOperator | VariadicOperator;
+
+/** @alpha **/
+declare type _Operator = {
+    applyTo: FieldTypes['type'][];
+    optgroup?: string | null;
+    type: string;
+};
+
+/** @alpha **/
+declare type Rule = {
+    field: Field | null;
+} & ({
+    operator: null;
+} | {
+    operator: UniraryOperator;
+} | {
+    operator: BinaryOperator;
+    value: any;
+} | {
+    operator: TernararyOperator;
+    value: [any, any];
+} | {
+    operator: VariadicOperator;
+    value: any[];
+});
+
+/** @internal **/
+declare type RuleMetadata = {
+    ruleId: string;
+    config: Config_2;
+};
+
+/** @alpha **/
+declare type SelectInput = {
+    input: 'select';
+    type: 'enum';
+    values: Record<string, string | number>;
+};
+
+/** @alpha **/
+declare type Styles = {
+    /** Custom element tags for HTML elements */
+    customElements?: CustomElements;
+    /** Custom styles for components */
+    customStyles?: CustomStyles;
+};
+
+/** @alpha **/
+export declare const styles: ElementStyles;
+
+/** @alpha **/
+export declare const template: ViewTemplate<ExpressionBuilder, any>;
+
+/** @alpha **/
+declare type TernararyOperator = {
+    nbInputs: 2;
+} & _Operator;
+
+/** @alpha **/
+declare type TextInput = {
+    type: 'string';
+    input: 'text';
+    validation?: (x: unknown) => string | null;
+};
+
+declare namespace Types {
+    export {
+        CustomElements,
+        CustomStyles,
+        Styles,
+        Config_2 as Config,
+        _Operator,
+        UniraryOperator,
+        BinaryOperator,
+        TernararyOperator,
+        VariadicOperator,
+        Operator,
+        TextInput,
+        NumberInput,
+        CheckboxInput,
+        SelectInput,
+        DateInput,
+        DateTimeInput,
+        FieldTypes,
+        Field,
+        Combinator,
+        Rule,
+        Group
+    }
+}
+export { Types }
+
+/** @alpha **/
+declare type UniraryOperator = {
+    nbInputs: 0;
+} & _Operator;
+
+/** @alpha **/
+declare type VariadicOperator = {
+    nbInputs: 'many';
+} & _Operator;
+
+export { }

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.9"
+    }
+  ]
+}

package/docs/.gitattributes

@@ -0,0 +1,2 @@
+*.md -diff
+*.md linguist-generated

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

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

package/docs/api/expression-builder.md

@@ -0,0 +1,13 @@
+<!-- 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
+
+## Namespaces
+
+|  Namespace | Description |
+|  --- | --- |
+|  [Config](./expression-builder.config.md) |  |
+|  [Types](./expression-builder.types.md) |  |
+

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

@@ -0,0 +1,6 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Types](./expression-builder.types.md)
+
+## Types namespace
+

package/docs/api/index.md

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