From 7a6e2204a152bd1791e4c16de3d5be22d2594c5e Mon Sep 17 00:00:00 2001 From: "patrick.oneil" Date: Thu, 28 Nov 2024 11:32:26 +0000 Subject: [PATCH 01/12] PTL-1546 adding auto generated docs --- .../011_criteria/11_foundation-criteria.mdx | 42 ++++++++++++++ ...tion-criteria.createformcriteriabuilder.md | 15 +++++ ...foundation-criteria.criteriabuilder.and.md | 14 +++++ ...undation-criteria.criteriabuilder.build.md | 25 ++++++++ .../foundation-criteria.criteriabuilder.md | 33 +++++++++++ ...foundation-criteria.criteriabuilder.not.md | 14 +++++ .../foundation-criteria.criteriabuilder.or.md | 14 +++++ ...undation-criteria.criteriabuilder.reset.md | 18 ++++++ ...criteria.criteriabuilder.withexpression.md | 27 +++++++++ ...riteriasegmentedcontrol.criteriaoptions.md | 14 +++++ ...iteriasegmentedcontrol.itemclickhandler.md | 25 ++++++++ ...ation-criteria.criteriasegmentedcontrol.md | 58 +++++++++++++++++++ ....criteriasegmentedcontrol.selectedlabel.md | 14 +++++ ...iasegmentedcontrol.selectedlabelchanged.md | 18 ++++++ ...criteria.criteriasegmentedcontrol.value.md | 14 +++++ ...a.criteriasegmentedcontrol.valuechanged.md | 18 ++++++ ...riteria.expressionbuilder._constructor_.md | 30 ++++++++++ ...dation-criteria.expressionbuilder.build.md | 14 +++++ .../foundation-criteria.expressionbuilder.md | 39 +++++++++++++ ...on-criteria.expressionbuilder.withfield.md | 25 ++++++++ ...on-criteria.expressionbuilder.withgroup.md | 25 ++++++++ ...n-criteria.expressionbuilder.withparams.md | 25 ++++++++ ...iteria.expressionbuilder.withserialiser.md | 25 ++++++++ ...on-criteria.expressionbuilder.withvalue.md | 25 ++++++++ ...teria.expressionbuilder.withvaluegetter.md | 25 ++++++++ .../foundation-criteria.expressionconfig.md | 18 ++++++ ...foundation-criteria.expressionconfigmap.md | 20 +++++++ .../foundation-criteria.join._constructor_.md | 23 ++++++++ .../docs/api/foundation-criteria.join.and.md | 18 ++++++ .../api/foundation-criteria.join.equal.md | 18 ++++++ .../foundation-criteria.join.greaterthan.md | 18 ++++++ ...dation-criteria.join.greaterthanorequal.md | 18 ++++++ .../api/foundation-criteria.join.lessthan.md | 18 ++++++ ...oundation-criteria.join.lessthanorequal.md | 18 ++++++ .../docs/api/foundation-criteria.join.md | 43 ++++++++++++++ .../docs/api/foundation-criteria.join.not.md | 18 ++++++ .../api/foundation-criteria.join.notequal.md | 18 ++++++ .../api/foundation-criteria.join.operator.md | 14 +++++ .../docs/api/foundation-criteria.join.or.md | 18 ++++++ .../docs/api/foundation-criteria.md | 32 ++++++++++ .../api/foundation-criteria.serialisers.md | 34 +++++++++++ .../011_criteria/docs/api/index.md | 21 +++++++ package-lock.json | 5 +- package.json | 4 +- plugins/api-docs/dist/manifest.js | 34 +++++++++++ plugins/api-docs/src/manifest.ts | 34 +++++++++++ 46 files changed, 1036 insertions(+), 4 deletions(-) create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/11_foundation-criteria.mdx create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.createformcriteriabuilder.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.and.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.build.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.not.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.or.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.reset.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.withexpression.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.criteriaoptions.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.itemclickhandler.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.selectedlabel.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.selectedlabelchanged.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.value.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.valuechanged.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder._constructor_.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.build.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withfield.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withgroup.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withparams.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withserialiser.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withvalue.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withvaluegetter.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionconfig.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionconfigmap.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join._constructor_.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.and.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.equal.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.greaterthan.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.greaterthanorequal.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.lessthan.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.lessthanorequal.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.not.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.notequal.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.operator.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.or.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.serialisers.md create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/api/index.md diff --git a/docs/001_develop/03_client-capabilities/011_criteria/11_foundation-criteria.mdx b/docs/001_develop/03_client-capabilities/011_criteria/11_foundation-criteria.mdx new file mode 100644 index 0000000000..ccefa9a909 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/11_foundation-criteria.mdx @@ -0,0 +1,42 @@ +--- +title: 'Foundation Criteria' +sidebar_label: 'Foundation Criteria' +id: foundation-criteria +keywords: [web, criteria, foundation criteria, frontend, ui] +tags: + - web + - criteria + - foundation criteria + - frontend + - ui +--- + +# Genesis Foundation UI Criteria Utils + + +## Installation + +To enable this module in your application, follow the steps below. + +1. Add `@genesislcap/foundation-criteria` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](../../../../../web/basics/package-json-basics/) page. + +```json +{ + ... + "dependencies": { + ... + "@genesislcap/foundation-criteria": "latest" + ... + }, + ... +} +``` + +## [API Docs](./docs/api/index.md) + +## 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 \ No newline at end of file diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.createformcriteriabuilder.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.createformcriteriabuilder.md new file mode 100644 index 0000000000..4924936a50 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.createformcriteriabuilder.md @@ -0,0 +1,15 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [createFormCriteriaBuilder](./foundation-criteria.createformcriteriabuilder.md) + +## createFormCriteriaBuilder variable + + +**Signature:** + +```typescript +createFormCriteriaBuilder: (criteriaBuilder: CriteriaBuilder) => (config: ExpressionConfig, formValue: any, formData: T) => void +``` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.and.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.and.md new file mode 100644 index 0000000000..d34af5a5a7 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.and.md @@ -0,0 +1,14 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) > [And](./foundation-criteria.criteriabuilder.and.md) + +## CriteriaBuilder.And property + +**Signature:** + +```typescript +And: (expression: ValidExpressionType, options?: ExpressionOptions) => this; +``` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.build.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.build.md new file mode 100644 index 0000000000..e1d970795e --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.build.md @@ -0,0 +1,25 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) > [build](./foundation-criteria.criteriabuilder.build.md) + +## CriteriaBuilder.build() method + +**Signature:** + +```typescript +build(outputFn?: (groups: GroupedExpressions) => string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| outputFn | (groups: GroupedExpressions) => string | _(Optional)_ | + +**Returns:** + +string + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.md new file mode 100644 index 0000000000..3fb277b999 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.md @@ -0,0 +1,33 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) + +## CriteriaBuilder class + +Builder class used to generate query criteria + +**Signature:** + +```typescript +export declare class CriteriaBuilder +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [And](./foundation-criteria.criteriabuilder.and.md) | | (expression: ValidExpressionType, options?: ExpressionOptions) => this | | +| [Not](./foundation-criteria.criteriabuilder.not.md) | | (expression: ValidExpressionType, options?: ExpressionOptions) => this | | +| [Or](./foundation-criteria.criteriabuilder.or.md) | | (expression: ValidExpressionType, options?: ExpressionOptions) => this | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [build(outputFn)](./foundation-criteria.criteriabuilder.build.md) | | | +| [reset()](./foundation-criteria.criteriabuilder.reset.md) | | | +| [withExpression(expression, options, groupJoin)](./foundation-criteria.criteriabuilder.withexpression.md) | | | + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.not.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.not.md new file mode 100644 index 0000000000..c5fc61539c --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.not.md @@ -0,0 +1,14 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) > [Not](./foundation-criteria.criteriabuilder.not.md) + +## CriteriaBuilder.Not property + +**Signature:** + +```typescript +Not: (expression: ValidExpressionType, options?: ExpressionOptions) => this; +``` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.or.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.or.md new file mode 100644 index 0000000000..bc96e9e833 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.or.md @@ -0,0 +1,14 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) > [Or](./foundation-criteria.criteriabuilder.or.md) + +## CriteriaBuilder.Or property + +**Signature:** + +```typescript +Or: (expression: ValidExpressionType, options?: ExpressionOptions) => this; +``` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.reset.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.reset.md new file mode 100644 index 0000000000..93748578c7 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.reset.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) > [reset](./foundation-criteria.criteriabuilder.reset.md) + +## CriteriaBuilder.reset() method + +**Signature:** + +```typescript +reset(): void; +``` +**Returns:** + +void + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.withexpression.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.withexpression.md new file mode 100644 index 0000000000..50e584fbfb --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriabuilder.withexpression.md @@ -0,0 +1,27 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) > [withExpression](./foundation-criteria.criteriabuilder.withexpression.md) + +## CriteriaBuilder.withExpression() method + +**Signature:** + +```typescript +withExpression(expression: ValidExpressionType, options?: ExpressionOptions, groupJoin?: Join): this; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| expression | ValidExpressionType | | +| options | ExpressionOptions | _(Optional)_ | +| groupJoin | [Join](./foundation-criteria.join.md) | _(Optional)_ | + +**Returns:** + +this + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.criteriaoptions.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.criteriaoptions.md new file mode 100644 index 0000000000..dee383e498 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.criteriaoptions.md @@ -0,0 +1,14 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) > [criteriaOptions](./foundation-criteria.criteriasegmentedcontrol.criteriaoptions.md) + +## CriteriaSegmentedControl.criteriaOptions property + +**Signature:** + +```typescript +criteriaOptions: CriteriaSegmentedControlOption[]; +``` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.itemclickhandler.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.itemclickhandler.md new file mode 100644 index 0000000000..ef952b2a62 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.itemclickhandler.md @@ -0,0 +1,25 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) > [itemClickHandler](./foundation-criteria.criteriasegmentedcontrol.itemclickhandler.md) + +## CriteriaSegmentedControl.itemClickHandler() method + +**Signature:** + +```typescript +itemClickHandler(label: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| label | string | | + +**Returns:** + +void + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.md new file mode 100644 index 0000000000..549f251d1b --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.md @@ -0,0 +1,58 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) + +## CriteriaSegmentedControl class + +Main class which defines the criteria segmented control component. + +**Signature:** + +```typescript +export declare class CriteriaSegmentedControl extends FASTElement +``` +**Extends:** FASTElement + +## Remarks + +Displays segmented criteria and dispatches events with the selected criteria. + +## Example + +Example of using the component: + +``` + +const toolbarOptions: CriteriaSegmentedControlOption[] = [ + { label: 'A', field: 'INSTRUMENT_ID', value: 'id1', serialiser: Serialisers.EQ }, + { label: 'B', field: 'INSTRUMENT_ID', value: 'id2', serialiser: Serialisers.EQ }, + { label: 'C', field: 'INSTRUMENT_ID', value: 'id3', serialiser: Serialisers.EQ }, +]; + + toolbarOptions} + :value=${sync((x) => x.criteriaFilter)} + > + + +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [criteriaOptions](./foundation-criteria.criteriasegmentedcontrol.criteriaoptions.md) | | CriteriaSegmentedControlOption\[\] | | +| [selectedLabel](./foundation-criteria.criteriasegmentedcontrol.selectedlabel.md) | | string | | +| [value](./foundation-criteria.criteriasegmentedcontrol.value.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [itemClickHandler(label)](./foundation-criteria.criteriasegmentedcontrol.itemclickhandler.md) | | | +| [selectedLabelChanged()](./foundation-criteria.criteriasegmentedcontrol.selectedlabelchanged.md) | | | +| [valueChanged()](./foundation-criteria.criteriasegmentedcontrol.valuechanged.md) | | | + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.selectedlabel.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.selectedlabel.md new file mode 100644 index 0000000000..5d7cf77909 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.selectedlabel.md @@ -0,0 +1,14 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) > [selectedLabel](./foundation-criteria.criteriasegmentedcontrol.selectedlabel.md) + +## CriteriaSegmentedControl.selectedLabel property + +**Signature:** + +```typescript +selectedLabel: string; +``` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.selectedlabelchanged.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.selectedlabelchanged.md new file mode 100644 index 0000000000..b906e4613e --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.selectedlabelchanged.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) > [selectedLabelChanged](./foundation-criteria.criteriasegmentedcontrol.selectedlabelchanged.md) + +## CriteriaSegmentedControl.selectedLabelChanged() method + +**Signature:** + +```typescript +selectedLabelChanged(): void; +``` +**Returns:** + +void + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.value.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.value.md new file mode 100644 index 0000000000..f5f05eea56 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.value.md @@ -0,0 +1,14 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) > [value](./foundation-criteria.criteriasegmentedcontrol.value.md) + +## CriteriaSegmentedControl.value property + +**Signature:** + +```typescript +value: string; +``` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.valuechanged.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.valuechanged.md new file mode 100644 index 0000000000..d1e1fb4916 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.criteriasegmentedcontrol.valuechanged.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) > [valueChanged](./foundation-criteria.criteriasegmentedcontrol.valuechanged.md) + +## CriteriaSegmentedControl.valueChanged() method + +**Signature:** + +```typescript +valueChanged(): void; +``` +**Returns:** + +void + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder._constructor_.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder._constructor_.md new file mode 100644 index 0000000000..14f3fa52dd --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder._constructor_.md @@ -0,0 +1,30 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) > [(constructor)](./foundation-criteria.expressionbuilder._constructor_.md) + +## ExpressionBuilder.(constructor) + +Constructs a new instance of the `ExpressionBuilder` class + +**Signature:** + +```typescript +constructor(opts?: Partial<{ + field: string; + value: unknown; + serialiser: Serialiser; + params: any; + valueGetter: (value: unknown) => string; + group: string; + }>); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| opts | Partial<{ field: string; value: unknown; serialiser: Serialiser; params: any; valueGetter: (value: unknown) => string; group: string; }> | _(Optional)_ | + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.build.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.build.md new file mode 100644 index 0000000000..5bfba724b5 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.build.md @@ -0,0 +1,14 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) > [build](./foundation-criteria.expressionbuilder.build.md) + +## ExpressionBuilder.build property + +**Signature:** + +```typescript +build: () => Expression; +``` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.md new file mode 100644 index 0000000000..04c2b5d8b2 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.md @@ -0,0 +1,39 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) + +## ExpressionBuilder class + + +**Signature:** + +```typescript +export declare class ExpressionBuilder +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(opts)](./foundation-criteria.expressionbuilder._constructor_.md) | | Constructs a new instance of the ExpressionBuilder class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [build](./foundation-criteria.expressionbuilder.build.md) | | () => Expression | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [withField(field)](./foundation-criteria.expressionbuilder.withfield.md) | | | +| [withGroup(group)](./foundation-criteria.expressionbuilder.withgroup.md) | | | +| [withParams(params)](./foundation-criteria.expressionbuilder.withparams.md) | | | +| [withSerialiser(serialiser)](./foundation-criteria.expressionbuilder.withserialiser.md) | | | +| [withValue(value)](./foundation-criteria.expressionbuilder.withvalue.md) | | | +| [withValueGetter(valueGetter)](./foundation-criteria.expressionbuilder.withvaluegetter.md) | | | + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withfield.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withfield.md new file mode 100644 index 0000000000..cf3e4d6f42 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withfield.md @@ -0,0 +1,25 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) > [withField](./foundation-criteria.expressionbuilder.withfield.md) + +## ExpressionBuilder.withField() method + +**Signature:** + +```typescript +withField(field: string): ExpressionBuilder; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| field | string | | + +**Returns:** + +[ExpressionBuilder](./foundation-criteria.expressionbuilder.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withgroup.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withgroup.md new file mode 100644 index 0000000000..0333ddc1ab --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withgroup.md @@ -0,0 +1,25 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) > [withGroup](./foundation-criteria.expressionbuilder.withgroup.md) + +## ExpressionBuilder.withGroup() method + +**Signature:** + +```typescript +withGroup(group: string): ExpressionBuilder; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| group | string | | + +**Returns:** + +[ExpressionBuilder](./foundation-criteria.expressionbuilder.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withparams.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withparams.md new file mode 100644 index 0000000000..e28e66fef9 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withparams.md @@ -0,0 +1,25 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) > [withParams](./foundation-criteria.expressionbuilder.withparams.md) + +## ExpressionBuilder.withParams() method + +**Signature:** + +```typescript +withParams(params: any): ExpressionBuilder; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | any | | + +**Returns:** + +[ExpressionBuilder](./foundation-criteria.expressionbuilder.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withserialiser.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withserialiser.md new file mode 100644 index 0000000000..092dc22762 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withserialiser.md @@ -0,0 +1,25 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) > [withSerialiser](./foundation-criteria.expressionbuilder.withserialiser.md) + +## ExpressionBuilder.withSerialiser() method + +**Signature:** + +```typescript +withSerialiser(serialiser: Serialiser): ExpressionBuilder; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| serialiser | Serialiser | | + +**Returns:** + +[ExpressionBuilder](./foundation-criteria.expressionbuilder.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withvalue.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withvalue.md new file mode 100644 index 0000000000..a0b7549e76 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withvalue.md @@ -0,0 +1,25 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) > [withValue](./foundation-criteria.expressionbuilder.withvalue.md) + +## ExpressionBuilder.withValue() method + +**Signature:** + +```typescript +withValue(value: unknown): ExpressionBuilder; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | unknown | | + +**Returns:** + +[ExpressionBuilder](./foundation-criteria.expressionbuilder.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withvaluegetter.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withvaluegetter.md new file mode 100644 index 0000000000..8156ac820e --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionbuilder.withvaluegetter.md @@ -0,0 +1,25 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) > [withValueGetter](./foundation-criteria.expressionbuilder.withvaluegetter.md) + +## ExpressionBuilder.withValueGetter() method + +**Signature:** + +```typescript +withValueGetter(valueGetter: (value: unknown) => string): ExpressionBuilder; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| valueGetter | (value: unknown) => string | | + +**Returns:** + +[ExpressionBuilder](./foundation-criteria.expressionbuilder.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionconfig.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionconfig.md new file mode 100644 index 0000000000..981660f05b --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionconfig.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [ExpressionConfig](./foundation-criteria.expressionconfig.md) + +## ExpressionConfig type + +Interface for fields to implement to generate expression criteria + +**Signature:** + +```typescript +export type ExpressionConfig = { + criteria: (value: V, filters: T) => ExpressionParams | Array>; +}; +``` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionconfigmap.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionconfigmap.md new file mode 100644 index 0000000000..535f8529f8 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.expressionconfigmap.md @@ -0,0 +1,20 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [ExpressionConfigMap](./foundation-criteria.expressionconfigmap.md) + +## ExpressionConfigMap type + +Maps form fields to expression configuration + +**Signature:** + +```typescript +export type ExpressionConfigMap = Partial<{ + [key in keyof T]: ExpressionConfig; +}>; +``` +**References:** [ExpressionConfig](./foundation-criteria.expressionconfig.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join._constructor_.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join._constructor_.md new file mode 100644 index 0000000000..50bd1a385d --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join._constructor_.md @@ -0,0 +1,23 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) > [(constructor)](./foundation-criteria.join._constructor_.md) + +## Join.(constructor) + +Constructs a new instance of the `Join` class + +**Signature:** + +```typescript +constructor(type: Operator); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | Operator | | + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.and.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.and.md new file mode 100644 index 0000000000..a88eb090f5 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.and.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) > [And](./foundation-criteria.join.and.md) + +## Join.And() method + +**Signature:** + +```typescript +static And(): Join; +``` +**Returns:** + +[Join](./foundation-criteria.join.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.equal.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.equal.md new file mode 100644 index 0000000000..fe86766b88 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.equal.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) > [Equal](./foundation-criteria.join.equal.md) + +## Join.Equal() method + +**Signature:** + +```typescript +static Equal(): Join; +``` +**Returns:** + +[Join](./foundation-criteria.join.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.greaterthan.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.greaterthan.md new file mode 100644 index 0000000000..885326a740 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.greaterthan.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) > [GreaterThan](./foundation-criteria.join.greaterthan.md) + +## Join.GreaterThan() method + +**Signature:** + +```typescript +static GreaterThan(): Join; +``` +**Returns:** + +[Join](./foundation-criteria.join.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.greaterthanorequal.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.greaterthanorequal.md new file mode 100644 index 0000000000..91f541410a --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.greaterthanorequal.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) > [GreaterThanOrEqual](./foundation-criteria.join.greaterthanorequal.md) + +## Join.GreaterThanOrEqual() method + +**Signature:** + +```typescript +static GreaterThanOrEqual(): Join; +``` +**Returns:** + +[Join](./foundation-criteria.join.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.lessthan.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.lessthan.md new file mode 100644 index 0000000000..50008ef131 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.lessthan.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) > [LessThan](./foundation-criteria.join.lessthan.md) + +## Join.LessThan() method + +**Signature:** + +```typescript +static LessThan(): Join; +``` +**Returns:** + +[Join](./foundation-criteria.join.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.lessthanorequal.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.lessthanorequal.md new file mode 100644 index 0000000000..4f1072db0e --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.lessthanorequal.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) > [LessThanOrEqual](./foundation-criteria.join.lessthanorequal.md) + +## Join.LessThanOrEqual() method + +**Signature:** + +```typescript +static LessThanOrEqual(): Join; +``` +**Returns:** + +[Join](./foundation-criteria.join.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.md new file mode 100644 index 0000000000..b85a332c32 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.md @@ -0,0 +1,43 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) + +## Join class + +Used to describe how Expressions are joined + +**Signature:** + +```typescript +export declare class Join +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(type)](./foundation-criteria.join._constructor_.md) | | Constructs a new instance of the Join class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [operator](./foundation-criteria.join.operator.md) | readonly | Operator | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [And()](./foundation-criteria.join.and.md) | static | | +| [Equal()](./foundation-criteria.join.equal.md) | static | | +| [GreaterThan()](./foundation-criteria.join.greaterthan.md) | static | | +| [GreaterThanOrEqual()](./foundation-criteria.join.greaterthanorequal.md) | static | | +| [LessThan()](./foundation-criteria.join.lessthan.md) | static | | +| [LessThanOrEqual()](./foundation-criteria.join.lessthanorequal.md) | static | | +| [Not()](./foundation-criteria.join.not.md) | static | | +| [NotEqual()](./foundation-criteria.join.notequal.md) | static | | +| [Or()](./foundation-criteria.join.or.md) | static | | + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.not.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.not.md new file mode 100644 index 0000000000..07ec06949f --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.not.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) > [Not](./foundation-criteria.join.not.md) + +## Join.Not() method + +**Signature:** + +```typescript +static Not(): Join; +``` +**Returns:** + +[Join](./foundation-criteria.join.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.notequal.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.notequal.md new file mode 100644 index 0000000000..6614f51ff7 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.notequal.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) > [NotEqual](./foundation-criteria.join.notequal.md) + +## Join.NotEqual() method + +**Signature:** + +```typescript +static NotEqual(): Join; +``` +**Returns:** + +[Join](./foundation-criteria.join.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.operator.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.operator.md new file mode 100644 index 0000000000..ef60cd56a6 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.operator.md @@ -0,0 +1,14 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) > [operator](./foundation-criteria.join.operator.md) + +## Join.operator property + +**Signature:** + +```typescript +get operator(): Operator; +``` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.or.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.or.md new file mode 100644 index 0000000000..6a13dad624 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.join.or.md @@ -0,0 +1,18 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Join](./foundation-criteria.join.md) > [Or](./foundation-criteria.join.or.md) + +## Join.Or() method + +**Signature:** + +```typescript +static Or(): Join; +``` +**Returns:** + +[Join](./foundation-criteria.join.md) + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.md new file mode 100644 index 0000000000..4bcb37ab76 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.md @@ -0,0 +1,32 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) + +## foundation-criteria package + +## Classes + +| Class | Description | +| --- | --- | +| [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) | Builder class used to generate query criteria | +| [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) | Main class which defines the criteria segmented control component. | +| [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) | | +| [Join](./foundation-criteria.join.md) | Used to describe how Expressions are joined | + +## Variables + +| Variable | Description | +| --- | --- | +| [createFormCriteriaBuilder](./foundation-criteria.createformcriteriabuilder.md) | | +| [Serialisers](./foundation-criteria.serialisers.md) | Functions to to serialise an Expression to a string | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [ExpressionConfig](./foundation-criteria.expressionconfig.md) | Interface for fields to implement to generate expression criteria | +| [ExpressionConfigMap](./foundation-criteria.expressionconfigmap.md) | Maps form fields to expression configuration | + diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.serialisers.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.serialisers.md new file mode 100644 index 0000000000..8b898c0665 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/foundation-criteria.serialisers.md @@ -0,0 +1,34 @@ +--- +format: md +--- + + +[Home](./index.md) > [@genesislcap/foundation-criteria](./foundation-criteria.md) > [Serialisers](./foundation-criteria.serialisers.md) + +## Serialisers variable + +Functions to to serialise an Expression to a string + +**Signature:** + +```typescript +Serialisers: { + AND: (e: Expression) => string; + OR: (e: Expression) => string; + NOT: (e: Expression) => string; + GT: (e: Expression) => string; + GE: (e: Expression) => string; + LT: (e: Expression) => string; + LE: (e: Expression) => string; + NE: (e: Expression) => string; + EQ: (e: Expression) => string; + equals: (e: Expression) => string; + equalsIgnoreCase: (e: Expression) => string; + contains: (e: Expression) => string; + fieldContains: (e: Expression) => string; + containsIgnoreCase: (e: Expression) => string; + dateIsEqual: (e: Expression) => string; + dateIsGreaterEqual: (e: Expression) => string; + dateIsLessEqual: (e: Expression) => string; +} +``` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/api/index.md b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/index.md new file mode 100644 index 0000000000..fc11a9043f --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/api/index.md @@ -0,0 +1,21 @@ + +# API documentation + +Welcome to the API documentation for this package. +- To view the API documentation, click on the package name link at the bottom of this page. +- The files are linked to each other in a tree structure. You can drill down to specific implementation details by following the links. A breadcrumb navigation area is displayed at the top of the file to help you navigate and see where you are in the structure. +- To return to the start page for this documentation, click on the **Home** link. +- To leave the API documentation and return to the main documentation, click on one of the links in the main documentation menu, displayed at the top of the page on a desktop or in the hamburger menu on mobile. + + + +[Home](./index.md) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [@genesislcap/foundation-criteria](./foundation-criteria.md) | | + diff --git a/package-lock.json b/package-lock.json index 5e31dd63fd..8fc39dca4c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -21,7 +21,7 @@ "@genesislcap/design-system-configurator": "14.217.6", "@genesislcap/documentation-components": "14.217.6", "@genesislcap/foundation-comms": "14.217.6", - "@genesislcap/foundation-criteria": "14.217.6", + "@genesislcap/foundation-criteria": "^14.217.6", "@genesislcap/foundation-entity-management": "14.217.6", "@genesislcap/foundation-fdc3": "14.217.6", "@genesislcap/foundation-filters": "14.217.6", @@ -4338,7 +4338,8 @@ }, "node_modules/@genesislcap/foundation-criteria": { "version": "14.217.6", - "license": "SEE LICENSE IN license.txt", + "resolved": "https://registry.npmjs.org/@genesislcap/foundation-criteria/-/foundation-criteria-14.217.6.tgz", + "integrity": "sha512-m38+6J9tIFXbJOGD2qxlKchSqG+x+7L1IizbzsGSng9q9rKgZQY3j41sxuld5vkwOQdVH27RhioVB5/8j8K1Jw==", "dependencies": { "@genesislcap/foundation-logger": "14.217.6", "@genesislcap/foundation-utils": "14.217.6", diff --git a/package.json b/package.json index 5b082707f7..730670f9ac 100644 --- a/package.json +++ b/package.json @@ -40,8 +40,9 @@ "@genesislcap/design-system-configurator": "14.217.6", "@genesislcap/documentation-components": "14.217.6", "@genesislcap/foundation-comms": "14.217.6", - "@genesislcap/foundation-criteria": "14.217.6", + "@genesislcap/foundation-criteria": "^14.217.6", "@genesislcap/foundation-entity-management": "14.217.6", + "@genesislcap/foundation-fdc3": "14.217.6", "@genesislcap/foundation-filters": "14.217.6", "@genesislcap/foundation-forms": "14.217.6", "@genesislcap/foundation-header": "14.217.6", @@ -53,7 +54,6 @@ "@genesislcap/foundation-reporting": "14.217.6", "@genesislcap/foundation-testing": "14.217.6", "@genesislcap/foundation-zero": "14.217.6", - "@genesislcap/foundation-fdc3": "14.217.6", "@genesislcap/g2plot-chart": "14.217.6", "@genesislcap/grid-pro": "14.217.6", "@genesislcap/grid-tabulator": "14.217.6", diff --git a/plugins/api-docs/dist/manifest.js b/plugins/api-docs/dist/manifest.js index 62edccf181..c78e99406b 100644 --- a/plugins/api-docs/dist/manifest.js +++ b/plugins/api-docs/dist/manifest.js @@ -332,5 +332,39 @@ exports.default = { ], }, }, + { + name: "@genesislcap/foundation-criteria", + enabled: true, + src: { + api_docs: "./docs/api", + readme: "./README.md", + }, + output: { + directory: "./docs/001_develop/03_client-capabilities/011_criteria/", + api_docs: "docs/api", + readme: "11_foundation-criteria.mdx", + keywords: [ + "web", + "criteria", + "foundation criteria", + "frontend", + "ui", + ], + tags: [ + "web", + "criteria", + "foundation criteria", + "frontend", + "ui", + ], + pages: [ + { + title: "Foundation Criteria", + sidebar_label: "Foundation Criteria", + id: "foundation-criteria", + }, + ], + }, + }, ], }; diff --git a/plugins/api-docs/src/manifest.ts b/plugins/api-docs/src/manifest.ts index 5bda2845e5..bffda30077 100644 --- a/plugins/api-docs/src/manifest.ts +++ b/plugins/api-docs/src/manifest.ts @@ -539,5 +539,39 @@ export default { ], }, }, + { + name: "@genesislcap/foundation-criteria", + enabled: true, + src: { + api_docs: "./docs/api", + readme: "./README.md", + }, + output: { + directory: "./docs/001_develop/03_client-capabilities/011_criteria/", + api_docs: "docs/api", + readme: "11_foundation-criteria.mdx", + keywords: [ + "web", + "criteria", + "foundation criteria", + "frontend", + "ui", + ], + tags: [ + "web", + "criteria", + "foundation criteria", + "frontend", + "ui", + ], + pages: [ + { + title: "Foundation Criteria", + sidebar_label: "Foundation Criteria", + id: "foundation-criteria", + }, + ], + }, + }, ], }; From 4442cf480c20fce33bfa409f5828df27f5d4040e Mon Sep 17 00:00:00 2001 From: "patrick.oneil" Date: Thu, 28 Nov 2024 13:49:48 +0000 Subject: [PATCH 02/12] PTL-1546 criteria builder page --- .../011_criteria/02_criteria-builder.mdx | 103 ++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx diff --git a/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx b/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx new file mode 100644 index 0000000000..d95ef30b86 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx @@ -0,0 +1,103 @@ +--- +title: 'Criteria builder' +sidebar_label: 'Criteria builder' +id: criteria-builder +keywords: [foundation, ui, comms, criteria, filtering] +tags: + - connected + - ui + - comms + - criteria + - filtering +--- + +The `CriteriaBuilder` is a utility class designed to generate query criteria in a Groovy expression format. These criteria can be used in requests to backend services. + +## Methods + +:::info + +The examples for these methods use a simple expression which checks `TRADE_ID` equals a certain value. + +```ts +const tradeIdEqualsExpression = new ExpressionBuilder() + .withField('TRADE_ID') + .withValue('TR1234') + .withSerialiser(Serialisers.EQ) + .build() +``` +::: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescriptionParamsReturn valueExample
withExpressionSets an expression in the criteriaValidExpressionType, ExpressionOptions, Join (default Join.And)CriteriaBuilder + ```ts + new CriteriaBuilder().withExpression(tradeIdEqualsExpression) + ``` +
AndSets an expression with an And clauseValidExpressionType, ExpressionOptionsCriteriaBuilder + ```ts + new CriteriaBuilder() + .And(tradeIdEqualsExpression) + ``` +
OrSets an expression with an Or clauseValidExpressionType, ExpressionOptionsCriteriaBuilder + ```ts + new CriteriaBuilder().OR(tradeIdEqualsExpression) + ``` +
NotSets an expression with a Not clauseValidExpressionType, ExpressionOptionsCriteriaBuilder + ```ts + new CriteriaBuilder().NOT(tradeIdEqualsExpression) + ``` +
BuildCreates a string representation of based on the set expressions in the objectnonestring + ```ts + new CriteriaBuilder() + .withExpression(tradeIdEqualsExpression) + .build(); + ``` +
+ From 045e47ad91cd6ccb9cdbd1f94fe7f0eb2d49fc40 Mon Sep 17 00:00:00 2001 From: "patrick.oneil" Date: Thu, 28 Nov 2024 14:06:21 +0000 Subject: [PATCH 03/12] PTL-1546 expression builder page --- .../011_criteria/02_criteria-builder.mdx | 2 +- .../011_criteria/03_expression-buillder.mdx | 91 +++++++++++++++++++ 2 files changed, 92 insertions(+), 1 deletion(-) create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx diff --git a/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx b/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx index d95ef30b86..ff8a91e4b8 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx @@ -11,7 +11,7 @@ tags: - filtering --- -The `CriteriaBuilder` is a utility class designed to generate query criteria in a Groovy expression format. These criteria can be used in requests to backend services. +The `CriteriaBuilder` is a utility class designed to build objects used in creating query criteria in a Groovy expression format. These criteria can be used in requests to backend services. ## Methods diff --git a/docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx b/docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx new file mode 100644 index 0000000000..5d6f654739 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx @@ -0,0 +1,91 @@ +--- +title: 'Expression builder' +sidebar_label: 'Expression builder' +id: expression-builder +keywords: [foundation, ui, comms, criteria, expression, filtering] +tags: + - connected + - ui + - comms + - expression + - filtering +--- + +The `ExpressionBuilder` is a utility class to build criteria objects that are used with the `CriteriaBuilder` + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescriptionParamsReturn valueExample
withFieldSets the field in the expression objectstringExpressionBuilder + ```ts + new ExpressionBuilder().withField('TRADE_ID') + ``` +
withValueSets the value the expression is tested againstunknown (can be string, boolean or number)ExpressionBuilder + ```ts + new ExpressionBuilder().withValue('TR_1234') //checking a string + new ExpressionBuilder().withValue(500) //checking a number + new ExpressionBuilder().withValue(boolean) //checking a boolean + ``` +
withSerialiserSets the serialiser type on the expressionSerialiserExpressionBuilder + ```ts + new ExpressionBuilder().withSerialiser(Serialiser.EQ) // testing equals + new ExpressionBuilder().withSerialiser(Serialiser.GT) // testing greater than + new ExpressionBuilder().withSerialiser(Serialiser.GE) // testing greater + new ExpressionBuilder().withSerialiser(Serialiser.LT) // testing less than + new ExpressionBuilder().withSerialiser(Serialiser.LE) // testing less + ``` +
withGroupToDo What does group dostringExpressionBuilder + ```ts + new ExpressionBuilder().withGroup('group') + ``` +
BuildCreates an Expression object based on the values sretnoneExpression + ```ts + new ExpressionBuilder().build(); + ``` +
From 8495a8814b7beed41ae55db2c2b58c459a34d42e Mon Sep 17 00:00:00 2001 From: "patrick.oneil" Date: Thu, 28 Nov 2024 14:24:12 +0000 Subject: [PATCH 04/12] PTL-1546 serialisers page --- .../011_criteria/05_serialisers.mdx | 190 ++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx diff --git a/docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx b/docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx new file mode 100644 index 0000000000..cd8589cbbb --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx @@ -0,0 +1,190 @@ +--- +title: 'Serialisers' +sidebar_label: 'Serialisers' +id: serialisers +keywords: [foundation, ui, comms, criteria, filtering, serialisers] +tags: + - connected + - ui + - comms + - criteria + - filtering + - serialisers +--- + +`Serialisers` are a set of utility functions for creating Groovy expressions for different operators e.g. greater han, less than, equals etc + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodDescriptionReturn valueExample
ANDCreates a groovy expression clause testing AND(e: Expression) => string + ```ts + Serialisers.AND + ``` +
ORCreates a groovy expression clause testing OR(e: Expression) => string + ```ts + Serialisers.OR + ``` +
NOTCreates a groovy expression clause testing NOT(e: Expression) => string + ```ts + Serialisers.NOT + ``` +
GTCreates a groovy expression clause testing greater than(e: Expression) => string + ```ts + Serialisers.GT + ``` +
GECreates a groovy expression clause testing greater(e: Expression) => string + ```ts + Serialisers.GE + ``` +
LTCreates a groovy expression clause testing less than(e: Expression) => string + ```ts + Serialisers.LT + ``` +
NECreates a groovy expression clause testing greater than(e: Expression) => string + ```ts + Serialisers.GT + ``` +
EQCreates a groovy expression clause testing equals(e: Expression) => string + ```ts + Serialisers.EQ + ``` +
equalsCreates a groovy expression clause testing equals(e: Expression) => string + ```ts + Serialisers.equals + ``` +
equalsIgnoreCaseCreates a groovy expression clause testing equalsIgnoreCase, used for testing string values ignoring case(e: Expression) => string + ```ts + Serialisers.equalsIgnoreCase + ``` +
containsCreates a groovy expression clause testing contains, used for testing a string contains a value(e: Expression) => string + ```ts + Serialisers.contains + ``` +
fieldContainsCreates a groovy expression clause testing fieldContains, used for testing a field contains a value(e: Expression) => string + ```ts + Serialisers.fieldContains + ``` +
containsIgnoreCaseCreates a groovy expression clause testing containsIgnoreCase, used for testing a field contains a value ignoring case(e: Expression) => string + ```ts + Serialisers.containsIgnoreCase + ``` +
dateIsEqualCreates a groovy expression clause testing dateIsEqual, used for testing a date matches a value(e: Expression) => string + ```ts + Serialisers.dateIsEqual + ``` +
dateIsGreaterEqualCreates a groovy expression clause testing dateIsGreaterEqual, used for testing a date matches or is greater than a value(e: Expression) => string + ```ts + Serialisers.dateIsEqual + ``` +
dateIsLessEqualCreates a groovy expression clause testing dateIsLessEqual, used for testing a date matches or is less than a value(e: Expression) => string + ```ts + Serialisers.dateIsEqual + ``` +
From 388e3ccb6d3eef56ad5adae38348bf02e416c613 Mon Sep 17 00:00:00 2001 From: "patrick.oneil" Date: Thu, 28 Nov 2024 16:52:51 +0000 Subject: [PATCH 05/12] PTL-1546 adding overview page --- .../011_criteria/01_overview.mdx | 230 ++++++++++++++++++ .../011_criteria/04_form-criteria-builder.mdx | 14 ++ .../011_criteria/11_foundation-criteria.mdx | 42 ---- .../011_criteria/docs/_category_.yml | 1 + .../011_criteria/index.mdx | 45 +++- plugins/api-docs/dist/manifest.js | 2 +- plugins/api-docs/src/manifest.ts | 2 +- 7 files changed, 285 insertions(+), 51 deletions(-) create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/04_form-criteria-builder.mdx delete mode 100644 docs/001_develop/03_client-capabilities/011_criteria/11_foundation-criteria.mdx create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/_category_.yml diff --git a/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx b/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx new file mode 100644 index 0000000000..16cd56bfbb --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx @@ -0,0 +1,230 @@ +--- +title: 'Criteria Overview' +sidebar_label: 'Criteria Overview' +id: form-criteria-overview +keywords: [foundation, ui, comms, criteria, filtering] +tags: + - connected + - ui + - comms + - criteria + - filtering +--- + +import { CollapsibleSlot } from '../../../../examples/ui/documentationBase'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +The FoundationUI framework has several components that communicate directly with the backend. The Grids, Charts components take a `resourceName` parameter which specifies the service. The `Connect` class snapshot and stream methods can also be used to get data from the backend. + +You can filter the responses by creating Groovy expressions to only see rows that match your use case. + +You can use `foundation-criteria` module to create expressions using the suite of helper functions. + +To add the package to your application, update your **package.json** + +```json +{ + "dependencies": { + "@genesislcap/foundation-criteria": "latest" + } +} +``` + +You can then import and make use of its helper classes and functions to construct simple or complex queries. + +## Elements using criteria + +Some elements in FoundationUI communicate directly with the backend to retrieve and display data. The data retrieved can be filtered using valid criteria Groovy expressions. + +### Chart and chart datasource + +The `rapid-g2plot-chart` component can be populated with data use the `chart-datasource` component. + +This example is a simple line chart which retrieves data from a **Price history** + + + + **tables-dictionary.kts** + ```kts + tables { + table(name = "PRICE_HISTORY", id = 11_000) { + field("TICKER", STRING) + field("DATE", DATE) + field("PRICE", LONG) + } + ... + } + ``` + + **data-server.kts** + ```kts + dataServer { + query("PRICE_HISTORY", TRADE) + ... + ``` + + +```ts +import { FoundationElement, html, customElement } from '@genesislcap/web-core'; +import { + CriteriaBuilder, + ExpressionBuilder, + Serialisers +} from '@genesislcap/foundation-criteria'; + +const tradeIdEqualsExpression = new ExpressionBuilder() + .withField('TICKER') + .withValue('GNYS') + .withSerialiser(Serialisers.EQ) + .build() + +const filterCriteria = new CriteriaBuilder() + .withExpression(tradeIdEqualsExpression) + .build(); + +@customElement({ + name: 'my-component', + template: html` + x.lineChartConfiguration} + > + + + + ` +}) +export class MyComponent extends FoundationElement { + lineChartConfiguration = { + xField: 'date', + yField: 'value', + seriesField: 'ticker' + } +} +``` + +The next two examples are based on the same backend resources. Click to the button to show. + + + +**tables-dictionary.kts** +```kts +tables { + table(name = "TRADE", id = 11_000) { + field("TICKER", STRING) + field("NOTIONAL", LONG) + field("STATUS", ENUM("Pending", "Approved", "Cancelled", "FurtherApproval")) + ... + } + ... +} +``` + +**data-server.kts** +```kts +dataServer { + query("ALL_TRADES", TRADE) + ... +} +``` + + +### Grid Pro and Grid datasource + +The `rapid-grid-pro` can be populated with data using the `grid-pro-datasource` component. In addition to `resourceName` attribute you can also set a `criteria` attribute. + +In this example we only want to see trades made against 'GNYS' ticker and with a status not equals to 'Cancelled' + +```ts +import { FoundationElement, html, customElement } from '@genesislcap/web-core'; +import { + CriteriaBuilder, + ExpressionBuilder, + Serialisers +} from '@genesislcap/foundation-criteria'; + +const tradeIdExpression = new ExpressionBuilder() + .withField('TICKER') + .withValue('GNYS') + .withSerialiser(Serialisers.EQ) + .build() + +const tradeStatusExpression = new ExpressionBuilder() + .withField('STATUS') + .withValue('Cancelled') + .withSerialiser(Serialisers.NOT) + .build() + +const filterCriteria = new CriteriaBuilder() + .withExpression(tradeIdExpression) + .withExpression(tradeStatusExpression) + .build(); + +@customElement({ + name: 'my-component', + template: html` + + filterCriteria} + > + + ` +}) +export class MyComponent extends FoundationElement { +} +``` + +### Entity management + +The `entity-management` component can use filter criteria via the `criteria` value in its `datasourceConfig` object. + +```ts + import { FoundationElement, html, customElement } from '@genesislcap/web-core'; + import { + CriteriaBuilder, + ExpressionBuilder, + Serialisers + } from '@genesislcap/foundation-criteria'; + + const tradeIdExpression = new ExpressionBuilder() + .withField('TICKER') + .withValue('GNYS') + .withSerialiser(Serialisers.EQ) + .build() + + const notionalExpression = new ExpressionBuilder() + .withField('NOTIONAL') + .withValue(1000) + .withSerialiser(Serialisers.GT) + .build() + + const filterCriteria = new CriteriaBuilder() + .withExpression(tradeIdExpression) + .withExpression(notionalExpression) + .build(); + + @customElement({ + name: 'my-component', + template: html` + ({ + resourceName: 'ALL_TRADES', + criteria: filterCriteria + })} + > + + ` + }) + export class MyComponent extends FoundationElement { + } +``` + +These examples are just scratching the surface of the `foundation-criteria` module. The following pages in this section go into more depth on the different Serialisers, Expressions and Criteria you can construct. diff --git a/docs/001_develop/03_client-capabilities/011_criteria/04_form-criteria-builder.mdx b/docs/001_develop/03_client-capabilities/011_criteria/04_form-criteria-builder.mdx new file mode 100644 index 0000000000..95d6f322c6 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/04_form-criteria-builder.mdx @@ -0,0 +1,14 @@ +--- +title: 'Form Criteria builder' +sidebar_label: 'Form Criteria builder' +id: form-criteria-builder +keywords: [foundation, ui, comms, criteria, filtering] +tags: + - connected + - ui + - comms + - criteria + - filtering +--- + +The `Form diff --git a/docs/001_develop/03_client-capabilities/011_criteria/11_foundation-criteria.mdx b/docs/001_develop/03_client-capabilities/011_criteria/11_foundation-criteria.mdx deleted file mode 100644 index ccefa9a909..0000000000 --- a/docs/001_develop/03_client-capabilities/011_criteria/11_foundation-criteria.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: 'Foundation Criteria' -sidebar_label: 'Foundation Criteria' -id: foundation-criteria -keywords: [web, criteria, foundation criteria, frontend, ui] -tags: - - web - - criteria - - foundation criteria - - frontend - - ui ---- - -# Genesis Foundation UI Criteria Utils - - -## Installation - -To enable this module in your application, follow the steps below. - -1. Add `@genesislcap/foundation-criteria` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](../../../../../web/basics/package-json-basics/) page. - -```json -{ - ... - "dependencies": { - ... - "@genesislcap/foundation-criteria": "latest" - ... - }, - ... -} -``` - -## [API Docs](./docs/api/index.md) - -## 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 \ No newline at end of file diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/_category_.yml b/docs/001_develop/03_client-capabilities/011_criteria/docs/_category_.yml new file mode 100644 index 0000000000..792b8d60e6 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/_category_.yml @@ -0,0 +1 @@ +className: 'hidden' \ No newline at end of file diff --git a/docs/001_develop/03_client-capabilities/011_criteria/index.mdx b/docs/001_develop/03_client-capabilities/011_criteria/index.mdx index 7d486809f0..ccefa9a909 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/index.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/index.mdx @@ -1,11 +1,42 @@ --- -title: 'Criteria' -sidebar_label: 'Criteria' -id: client-criteria -keywords: [crieria] +title: 'Foundation Criteria' +sidebar_label: 'Foundation Criteria' +id: foundation-criteria +keywords: [web, criteria, foundation criteria, frontend, ui] tags: -- criteria -sidebar_position: 11 + - web + - criteria + - foundation criteria + - frontend + - ui --- -Coming soon... +# Genesis Foundation UI Criteria Utils + + +## Installation + +To enable this module in your application, follow the steps below. + +1. Add `@genesislcap/foundation-criteria` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](../../../../../web/basics/package-json-basics/) page. + +```json +{ + ... + "dependencies": { + ... + "@genesislcap/foundation-criteria": "latest" + ... + }, + ... +} +``` + +## [API Docs](./docs/api/index.md) + +## 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 \ No newline at end of file diff --git a/plugins/api-docs/dist/manifest.js b/plugins/api-docs/dist/manifest.js index c78e99406b..6d7e806183 100644 --- a/plugins/api-docs/dist/manifest.js +++ b/plugins/api-docs/dist/manifest.js @@ -342,7 +342,7 @@ exports.default = { output: { directory: "./docs/001_develop/03_client-capabilities/011_criteria/", api_docs: "docs/api", - readme: "11_foundation-criteria.mdx", + readme: "index.mdx", keywords: [ "web", "criteria", diff --git a/plugins/api-docs/src/manifest.ts b/plugins/api-docs/src/manifest.ts index bffda30077..d134a734ac 100644 --- a/plugins/api-docs/src/manifest.ts +++ b/plugins/api-docs/src/manifest.ts @@ -549,7 +549,7 @@ export default { output: { directory: "./docs/001_develop/03_client-capabilities/011_criteria/", api_docs: "docs/api", - readme: "11_foundation-criteria.mdx", + readme: "index.mdx", keywords: [ "web", "criteria", From d940887909ab1eb5eb4f8374171433e998f655ec Mon Sep 17 00:00:00 2001 From: "patrick.oneil" Date: Thu, 28 Nov 2024 17:00:41 +0000 Subject: [PATCH 06/12] PTL-1546 adding overview page --- .../011_criteria/01_overview.mdx | 90 ++++++++++--------- 1 file changed, 48 insertions(+), 42 deletions(-) diff --git a/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx b/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx index 16cd56bfbb..46c4c4c578 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx @@ -39,11 +39,10 @@ Some elements in FoundationUI communicate directly with the backend to retrieve ### Chart and chart datasource -The `rapid-g2plot-chart` component can be populated with data use the `chart-datasource` component. +The `rapid-g2plot-chart` component can be populated with data using the `chart-datasource` component. -This example is a simple line chart which retrieves data from a **Price history** - + **tables-dictionary.kts** ```kts @@ -65,6 +64,8 @@ This example is a simple line chart which retrieves data from a **Price history* ``` +This example is a simple line chart which retrieves data from a **Price history** + ```ts import { FoundationElement, html, customElement } from '@genesislcap/web-core'; import { @@ -82,6 +83,7 @@ const tradeIdEqualsExpression = new ExpressionBuilder() const filterCriteria = new CriteriaBuilder() .withExpression(tradeIdEqualsExpression) .build(); +// filterCriteria is equal to '((TICKER == "GNYS"))' @customElement({ name: 'my-component', @@ -166,6 +168,8 @@ const filterCriteria = new CriteriaBuilder() .withExpression(tradeStatusExpression) .build(); +// filterCriteria is equal to '((TICKER == "GNYS" && STATUS ! "Cancelled")' + @customElement({ name: 'my-component', template: html` @@ -186,45 +190,47 @@ export class MyComponent extends FoundationElement { The `entity-management` component can use filter criteria via the `criteria` value in its `datasourceConfig` object. ```ts - import { FoundationElement, html, customElement } from '@genesislcap/web-core'; - import { - CriteriaBuilder, - ExpressionBuilder, - Serialisers - } from '@genesislcap/foundation-criteria'; - - const tradeIdExpression = new ExpressionBuilder() - .withField('TICKER') - .withValue('GNYS') - .withSerialiser(Serialisers.EQ) - .build() - - const notionalExpression = new ExpressionBuilder() - .withField('NOTIONAL') - .withValue(1000) - .withSerialiser(Serialisers.GT) - .build() - - const filterCriteria = new CriteriaBuilder() - .withExpression(tradeIdExpression) - .withExpression(notionalExpression) - .build(); - - @customElement({ - name: 'my-component', - template: html` - ({ - resourceName: 'ALL_TRADES', - criteria: filterCriteria - })} - > - - ` - }) - export class MyComponent extends FoundationElement { - } +import { FoundationElement, html, customElement } from '@genesislcap/web-core'; +import { + CriteriaBuilder, + ExpressionBuilder, + Serialisers +} from '@genesislcap/foundation-criteria'; + +const tradeIdExpression = new ExpressionBuilder() + .withField('TICKER') + .withValue('GNYS') + .withSerialiser(Serialisers.EQ) + .build() + +const notionalExpression = new ExpressionBuilder() + .withField('NOTIONAL') + .withValue(1000) + .withSerialiser(Serialisers.GT) + .build() + +const filterCriteria = new CriteriaBuilder() + .withExpression(tradeIdExpression) + .withExpression(notionalExpression) + .build(); + +// filterCriteria is equal to '((TICKER == "GNYS" && NOTIONAL > 1000))' + +@customElement({ + name: 'my-component', + template: html` + ({ + resourceName: 'ALL_TRADES', + criteria: filterCriteria + })} + > + + ` +}) +export class MyComponent extends FoundationElement { +} ``` These examples are just scratching the surface of the `foundation-criteria` module. The following pages in this section go into more depth on the different Serialisers, Expressions and Criteria you can construct. From e603bec8e61f2645a221e4b79a2ebeb481e1e916 Mon Sep 17 00:00:00 2001 From: patrickoneill-genesis <151527745+patrickoneill-genesis@users.noreply.github.com> Date: Fri, 29 Nov 2024 16:35:48 +0000 Subject: [PATCH 07/12] Update docs/001_develop/03_client-capabilities/011_criteria/index.mdx Co-authored-by: Matt Walker <43502076+matteematt@users.noreply.github.com> --- .../03_client-capabilities/011_criteria/index.mdx | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/001_develop/03_client-capabilities/011_criteria/index.mdx b/docs/001_develop/03_client-capabilities/011_criteria/index.mdx index ccefa9a909..77cc7db710 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/index.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/index.mdx @@ -33,10 +33,3 @@ To enable this module in your application, follow the steps below. ``` ## [API Docs](./docs/api/index.md) - -## 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 \ No newline at end of file From 5054230c29b1f4e8c17b11d66385ba3a5b1c147e Mon Sep 17 00:00:00 2001 From: "patrick.oneil" Date: Fri, 29 Nov 2024 16:57:52 +0000 Subject: [PATCH 08/12] PR comment changes --- .../011_criteria/01_overview.mdx | 2 - .../011_criteria/02_criteria-builder.mdx | 81 ++++---- .../011_criteria/03_expression-buillder.mdx | 87 +++++---- .../011_criteria/04_form-criteria-builder.mdx | 14 -- .../011_criteria/05_serialisers.mdx | 181 ++++++++++-------- 5 files changed, 200 insertions(+), 165 deletions(-) delete mode 100644 docs/001_develop/03_client-capabilities/011_criteria/04_form-criteria-builder.mdx diff --git a/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx b/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx index 46c4c4c578..39ceec8e85 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx @@ -12,8 +12,6 @@ tags: --- import { CollapsibleSlot } from '../../../../examples/ui/documentationBase'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; The FoundationUI framework has several components that communicate directly with the backend. The Grids, Charts components take a `resourceName` parameter which specifies the service. The `Connect` class snapshot and stream methods can also be used to get data from the backend. diff --git a/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx b/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx index ff8a91e4b8..bdbd2f66ba 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx @@ -2,16 +2,17 @@ title: 'Criteria builder' sidebar_label: 'Criteria builder' id: criteria-builder -keywords: [foundation, ui, comms, criteria, filtering] +keywords: [foundation, ui, comms, criteria, filtering, groovy] tags: - connected - ui - comms - criteria - filtering + - groovy --- -The `CriteriaBuilder` is a utility class designed to build objects used in creating query criteria in a Groovy expression format. These criteria can be used in requests to backend services. +The [CriteriaBuilder](./docs/api/foundation-criteria.criteriabuilder.md) is a utility class designed to build objects used in creating query criteria in a Groovy expression format. These criteria can be used in requests to backend services. ## Methods @@ -32,11 +33,11 @@ const tradeIdEqualsExpression = new ExpressionBuilder() - - - - - + + + + + @@ -45,58 +46,68 @@ const tradeIdEqualsExpression = new ExpressionBuilder() - + - + - + - + - +
MethodDescriptionParamsReturn valueExampleMethodDescriptionParamsReturn valueExample
Sets an expression in the criteria ValidExpressionType, ExpressionOptions, Join (default Join.And) CriteriaBuilder - ```ts - new CriteriaBuilder().withExpression(tradeIdEqualsExpression) - ``` - + +```ts +new CriteriaBuilder().withExpression(tradeIdEqualsExpression) +``` + +
And Sets an expression with an And clause ValidExpressionType, ExpressionOptions CriteriaBuilder - ```ts - new CriteriaBuilder() - .And(tradeIdEqualsExpression) - ``` - + +```ts +new CriteriaBuilder() + .And(tradeIdEqualsExpression) +``` + +
Or Sets an expression with an Or clause ValidExpressionType, ExpressionOptions CriteriaBuilder - ```ts - new CriteriaBuilder().OR(tradeIdEqualsExpression) - ``` - + +```ts +new CriteriaBuilder().OR(tradeIdEqualsExpression) +``` + +
Not Sets an expression with a Not clause ValidExpressionType, ExpressionOptions CriteriaBuilder - ```ts - new CriteriaBuilder().NOT(tradeIdEqualsExpression) - ``` - + +```ts +new CriteriaBuilder().NOT(tradeIdEqualsExpression) +``` + +
Build Creates a string representation of based on the set expressions in the object none string - ```ts - new CriteriaBuilder() - .withExpression(tradeIdEqualsExpression) - .build(); - ``` - + +```ts +new CriteriaBuilder() + .withExpression(tradeIdEqualsExpression) + .build(); +``` + +
diff --git a/docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx b/docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx index 5d6f654739..609cf48c3f 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx @@ -2,27 +2,28 @@ title: 'Expression builder' sidebar_label: 'Expression builder' id: expression-builder -keywords: [foundation, ui, comms, criteria, expression, filtering] +keywords: [foundation, ui, comms, criteria, expression, filtering, groovy] tags: - connected - ui - comms - expression - filtering + - groovy --- -The `ExpressionBuilder` is a utility class to build criteria objects that are used with the `CriteriaBuilder` +The [ExpressionBuilder](./docs/api/foundation-criteria.expressionbuilder.md) is a utility class to build criteria objects that are used with the `CriteriaBuilder` ## Methods - - - - - + + + + + @@ -31,61 +32,71 @@ The `ExpressionBuilder` is a utility class to build criteria objects that are us - + - + - + - + - +
MethodDescriptionParamsReturn valueExampleMethodDescriptionParamsReturn valueExample
Sets the field in the expression object string ExpressionBuilder - ```ts - new ExpressionBuilder().withField('TRADE_ID') - ``` - + + ```ts + new ExpressionBuilder().withField('TRADE_ID') + ``` + +
withValue Sets the value the expression is tested against unknown (can be string, boolean or number) ExpressionBuilder - ```ts - new ExpressionBuilder().withValue('TR_1234') //checking a string - new ExpressionBuilder().withValue(500) //checking a number - new ExpressionBuilder().withValue(boolean) //checking a boolean - ``` - + +```ts +new ExpressionBuilder().withValue('TR_1234') //checking a string +new ExpressionBuilder().withValue(500) //checking a number +new ExpressionBuilder().withValue(boolean) //checking a boolean +``` + +
withSerialiser Sets the serialiser type on the expression Serialiser ExpressionBuilder - ```ts - new ExpressionBuilder().withSerialiser(Serialiser.EQ) // testing equals - new ExpressionBuilder().withSerialiser(Serialiser.GT) // testing greater than - new ExpressionBuilder().withSerialiser(Serialiser.GE) // testing greater - new ExpressionBuilder().withSerialiser(Serialiser.LT) // testing less than - new ExpressionBuilder().withSerialiser(Serialiser.LE) // testing less - ``` - + +```ts +new ExpressionBuilder().withSerialiser(Serialiser.EQ) // testing equals +new ExpressionBuilder().withSerialiser(Serialiser.GT) // testing greater than +new ExpressionBuilder().withSerialiser(Serialiser.GE) // testing greater +new ExpressionBuilder().withSerialiser(Serialiser.LT) // testing less than +new ExpressionBuilder().withSerialiser(Serialiser.LE) // testing less +``` + +
withGroup ToDo What does group do string ExpressionBuilder - ```ts - new ExpressionBuilder().withGroup('group') - ``` - + +```ts +new ExpressionBuilder().withGroup('group') +``` + +
Build Creates an Expression object based on the values sret none Expression - ```ts - new ExpressionBuilder().build(); - ``` - + + ```ts + new ExpressionBuilder().build(); + ``` + +
diff --git a/docs/001_develop/03_client-capabilities/011_criteria/04_form-criteria-builder.mdx b/docs/001_develop/03_client-capabilities/011_criteria/04_form-criteria-builder.mdx deleted file mode 100644 index 95d6f322c6..0000000000 --- a/docs/001_develop/03_client-capabilities/011_criteria/04_form-criteria-builder.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: 'Form Criteria builder' -sidebar_label: 'Form Criteria builder' -id: form-criteria-builder -keywords: [foundation, ui, comms, criteria, filtering] -tags: - - connected - - ui - - comms - - criteria - - filtering ---- - -The `Form diff --git a/docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx b/docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx index cd8589cbbb..e55223ee53 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx @@ -2,7 +2,7 @@ title: 'Serialisers' sidebar_label: 'Serialisers' id: serialisers -keywords: [foundation, ui, comms, criteria, filtering, serialisers] +keywords: [foundation, ui, comms, criteria, filtering, serialisers, groovy] tags: - connected - ui @@ -10,19 +10,20 @@ tags: - criteria - filtering - serialisers + - groovy --- -`Serialisers` are a set of utility functions for creating Groovy expressions for different operators e.g. greater han, less than, equals etc +[Serialisers](./docs/api/foundation-criteria.serialisers.md) are a set of utility functions for creating Groovy expressions for different operators e.g. greater han, less than, equals etc ## Methods - - - - + + + + @@ -50,141 +51,169 @@ tags: - + - + - + - + - + - + - + - + - + - + - + - + - + - +
MethodDescriptionReturn valueExampleMethodDescriptionReturn valueExample
NOT Creates a groovy expression clause testing NOT (e: Expression) => string - ```ts - Serialisers.NOT - ``` - + +```ts +Serialisers.NOT +``` + +
GT Creates a groovy expression clause testing greater than (e: Expression) => string - ```ts - Serialisers.GT - ``` - + +```ts +Serialisers.GT +``` + +
GE Creates a groovy expression clause testing greater (e: Expression) => string - ```ts - Serialisers.GE - ``` - + + ```ts + Serialisers.GE + ``` + +
LT Creates a groovy expression clause testing less than (e: Expression) => string - ```ts - Serialisers.LT - ``` - + + ```ts + Serialisers.LT + ``` + +
NE Creates a groovy expression clause testing greater than (e: Expression) => string - ```ts - Serialisers.GT - ``` - + + ```ts + Serialisers.GT + ``` + +
EQ Creates a groovy expression clause testing equals (e: Expression) => string - ```ts - Serialisers.EQ - ``` - + +```ts +Serialisers.EQ +``` + +
equals Creates a groovy expression clause testing equals (e: Expression) => string - ```ts - Serialisers.equals - ``` - + +```ts +Serialisers.equals +``` + +
equalsIgnoreCase Creates a groovy expression clause testing equalsIgnoreCase, used for testing string values ignoring case (e: Expression) => string - ```ts - Serialisers.equalsIgnoreCase - ``` - + +```ts +Serialisers.equalsIgnoreCase +``` + +
contains Creates a groovy expression clause testing contains, used for testing a string contains a value (e: Expression) => string - ```ts - Serialisers.contains - ``` - + +```ts +Serialisers.contains +``` + +
fieldContains Creates a groovy expression clause testing fieldContains, used for testing a field contains a value (e: Expression) => string - ```ts - Serialisers.fieldContains - ``` - + +```ts +Serialisers.fieldContains +``` + +
containsIgnoreCase Creates a groovy expression clause testing containsIgnoreCase, used for testing a field contains a value ignoring case (e: Expression) => string - ```ts - Serialisers.containsIgnoreCase - ``` - + +```ts +Serialisers.containsIgnoreCase +``` + +
dateIsEqual Creates a groovy expression clause testing dateIsEqual, used for testing a date matches a value (e: Expression) => string - ```ts - Serialisers.dateIsEqual - ``` - + +```ts +Serialisers.dateIsEqual +``` + +
dateIsGreaterEqual Creates a groovy expression clause testing dateIsGreaterEqual, used for testing a date matches or is greater than a value (e: Expression) => string - ```ts - Serialisers.dateIsEqual - ``` - + +```ts +Serialisers.dateIsEqual +``` + +
dateIsLessEqual Creates a groovy expression clause testing dateIsLessEqual, used for testing a date matches or is less than a value (e: Expression) => string - ```ts - Serialisers.dateIsEqual - ``` - + +```ts +Serialisers.dateIsEqual +``` + +
From 73b5cb82ac46d4c8d880dc6f3fda231c4b6081a2 Mon Sep 17 00:00:00 2001 From: "patrick.oneil" Date: Sat, 30 Nov 2024 08:01:16 +0000 Subject: [PATCH 09/12] PR comment changes --- .../03_client-capabilities/011_criteria/index.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/001_develop/03_client-capabilities/011_criteria/index.mdx b/docs/001_develop/03_client-capabilities/011_criteria/index.mdx index 77cc7db710..ccefa9a909 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/index.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/index.mdx @@ -33,3 +33,10 @@ To enable this module in your application, follow the steps below. ``` ## [API Docs](./docs/api/index.md) + +## 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 \ No newline at end of file From 599af29fa57a653791d07589111aa69285e2f033 Mon Sep 17 00:00:00 2001 From: "patrick.oneil" Date: Mon, 2 Dec 2024 08:53:55 +0000 Subject: [PATCH 10/12] PR comment changes --- .../011_criteria/01_overview.mdx | 234 --------------- .../011_criteria/02_criteria-builder.mdx | 7 +- .../011_criteria/03_expression-buillder.mdx | 9 +- .../011_criteria/05_serialisers.mdx | 8 +- .../011_criteria/index.mdx | 282 +++++++++++++++--- .../004_system-channel-listener.mdx | 2 +- plugins/api-docs/dist/manifest.js | 16 +- plugins/api-docs/src/manifest.ts | 16 +- 8 files changed, 290 insertions(+), 284 deletions(-) delete mode 100644 docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx diff --git a/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx b/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx deleted file mode 100644 index 39ceec8e85..0000000000 --- a/docs/001_develop/03_client-capabilities/011_criteria/01_overview.mdx +++ /dev/null @@ -1,234 +0,0 @@ ---- -title: 'Criteria Overview' -sidebar_label: 'Criteria Overview' -id: form-criteria-overview -keywords: [foundation, ui, comms, criteria, filtering] -tags: - - connected - - ui - - comms - - criteria - - filtering ---- - -import { CollapsibleSlot } from '../../../../examples/ui/documentationBase'; - -The FoundationUI framework has several components that communicate directly with the backend. The Grids, Charts components take a `resourceName` parameter which specifies the service. The `Connect` class snapshot and stream methods can also be used to get data from the backend. - -You can filter the responses by creating Groovy expressions to only see rows that match your use case. - -You can use `foundation-criteria` module to create expressions using the suite of helper functions. - -To add the package to your application, update your **package.json** - -```json -{ - "dependencies": { - "@genesislcap/foundation-criteria": "latest" - } -} -``` - -You can then import and make use of its helper classes and functions to construct simple or complex queries. - -## Elements using criteria - -Some elements in FoundationUI communicate directly with the backend to retrieve and display data. The data retrieved can be filtered using valid criteria Groovy expressions. - -### Chart and chart datasource - -The `rapid-g2plot-chart` component can be populated with data using the `chart-datasource` component. - - - - - **tables-dictionary.kts** - ```kts - tables { - table(name = "PRICE_HISTORY", id = 11_000) { - field("TICKER", STRING) - field("DATE", DATE) - field("PRICE", LONG) - } - ... - } - ``` - - **data-server.kts** - ```kts - dataServer { - query("PRICE_HISTORY", TRADE) - ... - ``` - - -This example is a simple line chart which retrieves data from a **Price history** - -```ts -import { FoundationElement, html, customElement } from '@genesislcap/web-core'; -import { - CriteriaBuilder, - ExpressionBuilder, - Serialisers -} from '@genesislcap/foundation-criteria'; - -const tradeIdEqualsExpression = new ExpressionBuilder() - .withField('TICKER') - .withValue('GNYS') - .withSerialiser(Serialisers.EQ) - .build() - -const filterCriteria = new CriteriaBuilder() - .withExpression(tradeIdEqualsExpression) - .build(); -// filterCriteria is equal to '((TICKER == "GNYS"))' - -@customElement({ - name: 'my-component', - template: html` - x.lineChartConfiguration} - > - - - - ` -}) -export class MyComponent extends FoundationElement { - lineChartConfiguration = { - xField: 'date', - yField: 'value', - seriesField: 'ticker' - } -} -``` - -The next two examples are based on the same backend resources. Click to the button to show. - - - -**tables-dictionary.kts** -```kts -tables { - table(name = "TRADE", id = 11_000) { - field("TICKER", STRING) - field("NOTIONAL", LONG) - field("STATUS", ENUM("Pending", "Approved", "Cancelled", "FurtherApproval")) - ... - } - ... -} -``` - -**data-server.kts** -```kts -dataServer { - query("ALL_TRADES", TRADE) - ... -} -``` - - -### Grid Pro and Grid datasource - -The `rapid-grid-pro` can be populated with data using the `grid-pro-datasource` component. In addition to `resourceName` attribute you can also set a `criteria` attribute. - -In this example we only want to see trades made against 'GNYS' ticker and with a status not equals to 'Cancelled' - -```ts -import { FoundationElement, html, customElement } from '@genesislcap/web-core'; -import { - CriteriaBuilder, - ExpressionBuilder, - Serialisers -} from '@genesislcap/foundation-criteria'; - -const tradeIdExpression = new ExpressionBuilder() - .withField('TICKER') - .withValue('GNYS') - .withSerialiser(Serialisers.EQ) - .build() - -const tradeStatusExpression = new ExpressionBuilder() - .withField('STATUS') - .withValue('Cancelled') - .withSerialiser(Serialisers.NOT) - .build() - -const filterCriteria = new CriteriaBuilder() - .withExpression(tradeIdExpression) - .withExpression(tradeStatusExpression) - .build(); - -// filterCriteria is equal to '((TICKER == "GNYS" && STATUS ! "Cancelled")' - -@customElement({ - name: 'my-component', - template: html` - - filterCriteria} - > - - ` -}) -export class MyComponent extends FoundationElement { -} -``` - -### Entity management - -The `entity-management` component can use filter criteria via the `criteria` value in its `datasourceConfig` object. - -```ts -import { FoundationElement, html, customElement } from '@genesislcap/web-core'; -import { - CriteriaBuilder, - ExpressionBuilder, - Serialisers -} from '@genesislcap/foundation-criteria'; - -const tradeIdExpression = new ExpressionBuilder() - .withField('TICKER') - .withValue('GNYS') - .withSerialiser(Serialisers.EQ) - .build() - -const notionalExpression = new ExpressionBuilder() - .withField('NOTIONAL') - .withValue(1000) - .withSerialiser(Serialisers.GT) - .build() - -const filterCriteria = new CriteriaBuilder() - .withExpression(tradeIdExpression) - .withExpression(notionalExpression) - .build(); - -// filterCriteria is equal to '((TICKER == "GNYS" && NOTIONAL > 1000))' - -@customElement({ - name: 'my-component', - template: html` - ({ - resourceName: 'ALL_TRADES', - criteria: filterCriteria - })} - > - - ` -}) -export class MyComponent extends FoundationElement { -} -``` - -These examples are just scratching the surface of the `foundation-criteria` module. The following pages in this section go into more depth on the different Serialisers, Expressions and Criteria you can construct. diff --git a/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx b/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx index bdbd2f66ba..77d687912e 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/02_criteria-builder.mdx @@ -2,14 +2,19 @@ title: 'Criteria builder' sidebar_label: 'Criteria builder' id: criteria-builder -keywords: [foundation, ui, comms, criteria, filtering, groovy] +keywords: [foundation, ui, comms, resource, criteria, filtering, formatters, groovy, filtering, charts, grids] tags: - connected - ui - comms - criteria + - resource - filtering + - formatters - groovy + - filtering + - charts + - grids --- The [CriteriaBuilder](./docs/api/foundation-criteria.criteriabuilder.md) is a utility class designed to build objects used in creating query criteria in a Groovy expression format. These criteria can be used in requests to backend services. diff --git a/docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx b/docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx index 609cf48c3f..733e945e72 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/03_expression-buillder.mdx @@ -2,14 +2,19 @@ title: 'Expression builder' sidebar_label: 'Expression builder' id: expression-builder -keywords: [foundation, ui, comms, criteria, expression, filtering, groovy] +keywords: [foundation, ui, comms, resource, criteria, filtering, formatters, groovy, filtering, charts, grids] tags: - connected - ui - comms - - expression + - criteria + - resource - filtering + - formatters - groovy + - filtering + - charts + - grids --- The [ExpressionBuilder](./docs/api/foundation-criteria.expressionbuilder.md) is a utility class to build criteria objects that are used with the `CriteriaBuilder` diff --git a/docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx b/docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx index e55223ee53..c3a69ac638 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/05_serialisers.mdx @@ -2,15 +2,19 @@ title: 'Serialisers' sidebar_label: 'Serialisers' id: serialisers -keywords: [foundation, ui, comms, criteria, filtering, serialisers, groovy] +keywords: [foundation, ui, comms, resource, criteria, filtering, formatters, groovy, filtering, charts, grids] tags: - connected - ui - comms - criteria + - resource - filtering - - serialisers + - formatters - groovy + - filtering + - charts + - grids --- [Serialisers](./docs/api/foundation-criteria.serialisers.md) are a set of utility functions for creating Groovy expressions for different operators e.g. greater han, less than, equals etc diff --git a/docs/001_develop/03_client-capabilities/011_criteria/index.mdx b/docs/001_develop/03_client-capabilities/011_criteria/index.mdx index ccefa9a909..9ab9a231af 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/index.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/index.mdx @@ -1,42 +1,240 @@ ---- -title: 'Foundation Criteria' -sidebar_label: 'Foundation Criteria' -id: foundation-criteria -keywords: [web, criteria, foundation criteria, frontend, ui] -tags: - - web - - criteria - - foundation criteria - - frontend - - ui ---- - -# Genesis Foundation UI Criteria Utils - - -## Installation - -To enable this module in your application, follow the steps below. - -1. Add `@genesislcap/foundation-criteria` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](../../../../../web/basics/package-json-basics/) page. - -```json -{ - ... - "dependencies": { - ... - "@genesislcap/foundation-criteria": "latest" - ... - }, - ... -} -``` - -## [API Docs](./docs/api/index.md) - -## 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 \ No newline at end of file +--- +title: 'Criteria Overview' +sidebar_label: 'Criteria Overview' +id: form-criteria-overview +keywords: [foundation, ui, comms, resource, criteria, filtering, formatters, groovy, filtering, charts, grids] +tags: + - connected + - ui + - comms + - criteria + - resource + - filtering + - formatters + - groovy + - filtering + - charts + - grids +--- + +import { CollapsibleSlot } from '../../../../examples/ui/documentationBase'; + +The FoundationUI framework has several components that communicate directly with the backend. The Grids, Charts components take a `resourceName` parameter which specifies the service. The `Connect` class snapshot and stream methods can also be used to get data from the backend. + +You can filter the responses by creating Groovy expressions to only see rows that match your use case. + +You can use [foundation-criteria](./docs/index.mdx) module to create expressions using the suite of helper functions. + +To add the package to your application, update your **package.json** + +```json +{ + "dependencies": { + "@genesislcap/foundation-criteria": "latest" + } +} +``` + +You can then import and make use of its helper classes and functions to construct simple or complex queries. + +## Elements using criteria + +Some elements in FoundationUI communicate directly with the backend to retrieve and display data. The data retrieved can be filtered using valid criteria Groovy expressions. + +### Chart and chart datasource + +The `rapid-g2plot-chart` component can be populated with data using the `chart-datasource` component. + + + + + **tables-dictionary.kts** + ```kts + tables { + table(name = "PRICE_HISTORY", id = 11_000) { + field("TICKER", STRING) + field("DATE", DATE) + field("PRICE", LONG) + } + ... + } + ``` + + **data-server.kts** + ```kts + dataServer { + query("PRICE_HISTORY", TRADE) + ... + ``` + + +This example is a simple line chart which retrieves data from a **Price history** + +```ts +import { FoundationElement, html, customElement } from '@genesislcap/web-core'; +import { + CriteriaBuilder, + ExpressionBuilder, + Serialisers +} from '@genesislcap/foundation-criteria'; + +const tradeIdEqualsExpression = new ExpressionBuilder() + .withField('TICKER') + .withValue('GNYS') + .withSerialiser(Serialisers.EQ) + .build() + +const filterCriteria = new CriteriaBuilder() + .withExpression(tradeIdEqualsExpression) + .build(); +// filterCriteria is equal to '((TICKER == "GNYS"))' + +@customElement({ + name: 'my-component', + template: html` + x.lineChartConfiguration} + > + + + + ` +}) +export class MyComponent extends FoundationElement { + lineChartConfiguration = { + xField: 'date', + yField: 'value', + seriesField: 'ticker' + } +} +``` + +The next two examples are based on the same backend resources. Click to the button to show. + + + +**tables-dictionary.kts** +```kts +tables { + table(name = "TRADE", id = 11_000) { + field("TICKER", STRING) + field("NOTIONAL", LONG) + field("STATUS", ENUM("Pending", "Approved", "Cancelled", "FurtherApproval")) + ... + } + ... +} +``` + +**data-server.kts** +```kts +dataServer { + query("ALL_TRADES", TRADE) + ... +} +``` + + +### Grid Pro and Grid datasource + +The `rapid-grid-pro` can be populated with data using the `grid-pro-datasource` component. In addition to `resourceName` attribute you can also set a `criteria` attribute. + +In this example we only want to see trades made against 'GNYS' ticker and with a status not equals to 'Cancelled' + +```ts +import { FoundationElement, html, customElement } from '@genesislcap/web-core'; +import { + CriteriaBuilder, + ExpressionBuilder, + Serialisers +} from '@genesislcap/foundation-criteria'; + +const tradeIdExpression = new ExpressionBuilder() + .withField('TICKER') + .withValue('GNYS') + .withSerialiser(Serialisers.EQ) + .build() + +const tradeStatusExpression = new ExpressionBuilder() + .withField('STATUS') + .withValue('Cancelled') + .withSerialiser(Serialisers.NOT) + .build() + +const filterCriteria = new CriteriaBuilder() + .withExpression(tradeIdExpression) + .withExpression(tradeStatusExpression) + .build(); + +// filterCriteria is equal to '((TICKER == "GNYS" && STATUS ! "Cancelled")' + +@customElement({ + name: 'my-component', + template: html` + + filterCriteria} + > + + ` +}) +export class MyComponent extends FoundationElement { +} +``` + +### Entity management + +The `entity-management` component can use filter criteria via the `criteria` value in its `datasourceConfig` object. + +```ts +import { FoundationElement, html, customElement } from '@genesislcap/web-core'; +import { + CriteriaBuilder, + ExpressionBuilder, + Serialisers +} from '@genesislcap/foundation-criteria'; + +const tradeIdExpression = new ExpressionBuilder() + .withField('TICKER') + .withValue('GNYS') + .withSerialiser(Serialisers.EQ) + .build() + +const notionalExpression = new ExpressionBuilder() + .withField('NOTIONAL') + .withValue(1000) + .withSerialiser(Serialisers.GT) + .build() + +const filterCriteria = new CriteriaBuilder() + .withExpression(tradeIdExpression) + .withExpression(notionalExpression) + .build(); + +// filterCriteria is equal to '((TICKER == "GNYS" && NOTIONAL > 1000))' + +@customElement({ + name: 'my-component', + template: html` + ({ + resourceName: 'ALL_TRADES', + criteria: filterCriteria + })} + > + + ` +}) +export class MyComponent extends FoundationElement { +} +``` + +These examples are just scratching the surface of the `foundation-criteria` module. The following pages in this section go into more depth on the different Serialisers, Expressions and Criteria you can construct. diff --git a/docs/001_develop/03_client-capabilities/021_desktop-interoperability/004_system-channel-listener.mdx b/docs/001_develop/03_client-capabilities/021_desktop-interoperability/004_system-channel-listener.mdx index 31a4171cd8..faf58dccf7 100644 --- a/docs/001_develop/03_client-capabilities/021_desktop-interoperability/004_system-channel-listener.mdx +++ b/docs/001_develop/03_client-capabilities/021_desktop-interoperability/004_system-channel-listener.mdx @@ -193,7 +193,7 @@ This component has no attributes config - SystemChannelListenerConfig + [SystemChannelListenerConfig](./api) An array of objects which configure which context type and a handler for channel event payloads diff --git a/plugins/api-docs/dist/manifest.js b/plugins/api-docs/dist/manifest.js index f524f507e0..25a6a63c32 100644 --- a/plugins/api-docs/dist/manifest.js +++ b/plugins/api-docs/dist/manifest.js @@ -490,20 +490,34 @@ exports.default = { output: { directory: "./docs/001_develop/03_client-capabilities/011_criteria/", api_docs: "docs/api", - readme: "index.mdx", + readme: "./docs/index.mdx", keywords: [ "web", "criteria", + "connect", "foundation criteria", "frontend", "ui", + "resource", + "formatters", + "groovy", + "filtering", + "charts", + "grids", ], tags: [ "web", "criteria", + "connect", "foundation criteria", "frontend", "ui", + "resource", + "formatters", + "groovy", + "filtering", + "charts", + "grids", ], pages: [ { diff --git a/plugins/api-docs/src/manifest.ts b/plugins/api-docs/src/manifest.ts index 22816ba909..bd29090ab1 100644 --- a/plugins/api-docs/src/manifest.ts +++ b/plugins/api-docs/src/manifest.ts @@ -697,20 +697,34 @@ export default { output: { directory: "./docs/001_develop/03_client-capabilities/011_criteria/", api_docs: "docs/api", - readme: "index.mdx", + readme: "./docs/index.mdx", keywords: [ "web", "criteria", + "connect", "foundation criteria", "frontend", "ui", + "resource", + "formatters", + "groovy", + "filtering", + "charts", + "grids", ], tags: [ "web", "criteria", + "connect", "foundation criteria", "frontend", "ui", + "resource", + "formatters", + "groovy", + "filtering", + "charts", + "grids", ], pages: [ { From edb8da645aa792c30574ff038a14921961f458e3 Mon Sep 17 00:00:00 2001 From: "patrick.oneil" Date: Mon, 2 Dec 2024 09:29:52 +0000 Subject: [PATCH 11/12] PR comment changes --- .../011_criteria/docs/index.mdx | 49 +++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/index.mdx diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/index.mdx b/docs/001_develop/03_client-capabilities/011_criteria/docs/index.mdx new file mode 100644 index 0000000000..9438bba2da --- /dev/null +++ b/docs/001_develop/03_client-capabilities/011_criteria/docs/index.mdx @@ -0,0 +1,49 @@ +--- +title: 'Foundation Criteria' +sidebar_label: 'Foundation Criteria' +id: foundation-criteria +keywords: [web, criteria, connect, foundation criteria, frontend, ui, resource, formatters, groovy, filtering, charts, grids] +tags: + - web + - criteria + - connect + - foundation criteria + - frontend + - ui + - resource + - formatters + - groovy + - filtering + - charts + - grids +--- + +# Genesis Foundation UI Criteria Utils + + +## Installation + +To enable this module in your application, follow the steps below. + +1. Add `@genesislcap/foundation-criteria` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](../../../../../web/basics/package-json-basics/) page. + +```json +{ + ... + "dependencies": { + ... + "@genesislcap/foundation-criteria": "latest" + ... + }, + ... +} +``` + +## [API Docs](./docs/api/index.md) + +## 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 \ No newline at end of file From 8b45f0be5afd7ade4b4b18efd17bced8cfdace8f Mon Sep 17 00:00:00 2001 From: "patrick.oneil" Date: Mon, 2 Dec 2024 09:53:22 +0000 Subject: [PATCH 12/12] Removing broken link --- .../011_criteria/docs/index.mdx | 49 ------------------- .../011_criteria/index.mdx | 2 +- plugins/api-docs/dist/manifest.js | 2 +- plugins/api-docs/processedMap.js | 1 + plugins/api-docs/src/manifest.ts | 2 +- 5 files changed, 4 insertions(+), 52 deletions(-) delete mode 100644 docs/001_develop/03_client-capabilities/011_criteria/docs/index.mdx diff --git a/docs/001_develop/03_client-capabilities/011_criteria/docs/index.mdx b/docs/001_develop/03_client-capabilities/011_criteria/docs/index.mdx deleted file mode 100644 index 9438bba2da..0000000000 --- a/docs/001_develop/03_client-capabilities/011_criteria/docs/index.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: 'Foundation Criteria' -sidebar_label: 'Foundation Criteria' -id: foundation-criteria -keywords: [web, criteria, connect, foundation criteria, frontend, ui, resource, formatters, groovy, filtering, charts, grids] -tags: - - web - - criteria - - connect - - foundation criteria - - frontend - - ui - - resource - - formatters - - groovy - - filtering - - charts - - grids ---- - -# Genesis Foundation UI Criteria Utils - - -## Installation - -To enable this module in your application, follow the steps below. - -1. Add `@genesislcap/foundation-criteria` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](../../../../../web/basics/package-json-basics/) page. - -```json -{ - ... - "dependencies": { - ... - "@genesislcap/foundation-criteria": "latest" - ... - }, - ... -} -``` - -## [API Docs](./docs/api/index.md) - -## 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 \ No newline at end of file diff --git a/docs/001_develop/03_client-capabilities/011_criteria/index.mdx b/docs/001_develop/03_client-capabilities/011_criteria/index.mdx index 9ab9a231af..eaf210886e 100644 --- a/docs/001_develop/03_client-capabilities/011_criteria/index.mdx +++ b/docs/001_develop/03_client-capabilities/011_criteria/index.mdx @@ -23,7 +23,7 @@ The FoundationUI framework has several components that communicate directly with You can filter the responses by creating Groovy expressions to only see rows that match your use case. -You can use [foundation-criteria](./docs/index.mdx) module to create expressions using the suite of helper functions. +You can use `foundation-criteria` module to create expressions using the suite of helper functions. To add the package to your application, update your **package.json** diff --git a/plugins/api-docs/dist/manifest.js b/plugins/api-docs/dist/manifest.js index 25a6a63c32..bc0b5126e9 100644 --- a/plugins/api-docs/dist/manifest.js +++ b/plugins/api-docs/dist/manifest.js @@ -490,7 +490,7 @@ exports.default = { output: { directory: "./docs/001_develop/03_client-capabilities/011_criteria/", api_docs: "docs/api", - readme: "./docs/index.mdx", + readme: "./index.mdx", keywords: [ "web", "criteria", diff --git a/plugins/api-docs/processedMap.js b/plugins/api-docs/processedMap.js index 792c72c398..8919fd76da 100644 --- a/plugins/api-docs/processedMap.js +++ b/plugins/api-docs/processedMap.js @@ -23,4 +23,5 @@ module.exports = { "@genesislcap/foundation-testing": "14.217.6", "@genesislcap/foundation-utils": "14.217.6", "@genesislcap/foundation-store": "14.217.6", + "@genesislcap/foundation-criteria": "14.217.6", }; diff --git a/plugins/api-docs/src/manifest.ts b/plugins/api-docs/src/manifest.ts index bd29090ab1..ca48f36c4a 100644 --- a/plugins/api-docs/src/manifest.ts +++ b/plugins/api-docs/src/manifest.ts @@ -697,7 +697,7 @@ export default { output: { directory: "./docs/001_develop/03_client-capabilities/011_criteria/", api_docs: "docs/api", - readme: "./docs/index.mdx", + readme: "./index.mdx", keywords: [ "web", "criteria",