npm - @genesislcap/foundation-criteria - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-criteria 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

package/README.md CHANGED Viewed

@@ -1,29 +1,25 @@
-# Genesis Foundation UI Criteria Utils
+# @genesislcap/foundation-criteria
+Documentation for this package is published on the Genesis docs site:
-## Installation
+**Docs: [Criteria](https://docs.genesis.global/docs/develop/client-capabilities/criteria/)**
-To enable this module in your application, follow the steps below.
+## Installation
-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](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 ```json
 {
-  ...
   "dependencies": {
-    ...
     "@genesislcap/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
+Genesis low-code platform

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-criteria",
   "description": "Genesis Foundation UI Criteria Utils",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -51,17 +51,17 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0"
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.408.0",
-    "@genesislcap/foundation-utils": "14.408.0",
+    "@genesislcap/foundation-logger": "14.409.0",
+    "@genesislcap/foundation-utils": "14.409.0",
     "@microsoft/fast-element": "1.14.0"
   },
   "repository": {
@@ -72,5 +72,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

package/docs/api/foundation-criteria.createformcriteriabuilder.md DELETED Viewed

@@ -1,51 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [createFormCriteriaBuilder](./foundation-criteria.createformcriteriabuilder.md)
-## createFormCriteriaBuilder() function
-**Signature:**
-```typescript
-createFormCriteriaBuilder: <T>(criteriaBuilder: CriteriaBuilder) => (config: ExpressionConfig, formValue: any, formData: T) => void
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-criteriaBuilder
-</td><td>
-[CriteriaBuilder](./foundation-criteria.criteriabuilder.md)
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-(config: [ExpressionConfig](./foundation-criteria.expressionconfig.md)<!-- -->, formValue: any, formData: T) =&gt; void

package/docs/api/foundation-criteria.criteriabuilder.and.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) &gt; [And](./foundation-criteria.criteriabuilder.and.md)
-## CriteriaBuilder.And property
-**Signature:**
-```typescript
-And: (expression: ValidExpressionType, options?: ExpressionOptions) => this;
-```

package/docs/api/foundation-criteria.criteriabuilder.build.md DELETED Viewed

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) &gt; [build](./foundation-criteria.criteriabuilder.build.md)
-## CriteriaBuilder.build() method
-**Signature:**
-```typescript
-build(outputFn?: (groups: GroupedExpressions) => string): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-outputFn
-</td><td>
-(groups: GroupedExpressions) =&gt; string
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
-**Returns:**
-string

package/docs/api/foundation-criteria.criteriabuilder.md DELETED Viewed

@@ -1,146 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaBuilder](./foundation-criteria.criteriabuilder.md)
-## CriteriaBuilder class
-Builder class used to generate query criteria
-**Signature:**
-```typescript
-export declare class CriteriaBuilder
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[And](./foundation-criteria.criteriabuilder.and.md)
-</td><td>
-</td><td>
-(expression: ValidExpressionType, options?: ExpressionOptions) =&gt; this
-</td><td>
-</td></tr>
-<tr><td>
-[Not](./foundation-criteria.criteriabuilder.not.md)
-</td><td>
-</td><td>
-(expression: ValidExpressionType, options?: ExpressionOptions) =&gt; this
-</td><td>
-</td></tr>
-<tr><td>
-[Or](./foundation-criteria.criteriabuilder.or.md)
-</td><td>
-</td><td>
-(expression: ValidExpressionType, options?: ExpressionOptions) =&gt; this
-</td><td>
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[build(outputFn)](./foundation-criteria.criteriabuilder.build.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[reset()](./foundation-criteria.criteriabuilder.reset.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[withExpression(expression, options, groupJoin)](./foundation-criteria.criteriabuilder.withexpression.md)
-</td><td>
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-criteria.criteriabuilder.not.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) &gt; [Not](./foundation-criteria.criteriabuilder.not.md)
-## CriteriaBuilder.Not property
-**Signature:**
-```typescript
-Not: (expression: ValidExpressionType, options?: ExpressionOptions) => this;
-```

package/docs/api/foundation-criteria.criteriabuilder.or.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) &gt; [Or](./foundation-criteria.criteriabuilder.or.md)
-## CriteriaBuilder.Or property
-**Signature:**
-```typescript
-Or: (expression: ValidExpressionType, options?: ExpressionOptions) => this;
-```

package/docs/api/foundation-criteria.criteriabuilder.reset.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) &gt; [reset](./foundation-criteria.criteriabuilder.reset.md)
-## CriteriaBuilder.reset() method
-**Signature:**
-```typescript
-reset(): void;
-```
-**Returns:**
-void

package/docs/api/foundation-criteria.criteriabuilder.withexpression.md DELETED Viewed

@@ -1,82 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaBuilder](./foundation-criteria.criteriabuilder.md) &gt; [withExpression](./foundation-criteria.criteriabuilder.withexpression.md)
-## CriteriaBuilder.withExpression() method
-**Signature:**
-```typescript
-withExpression(expression: ValidExpressionType, options?: ExpressionOptions, groupJoin?: Join): this;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-expression
-</td><td>
-ValidExpressionType
-</td><td>
-</td></tr>
-<tr><td>
-options
-</td><td>
-ExpressionOptions
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-groupJoin
-</td><td>
-[Join](./foundation-criteria.join.md)
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
-**Returns:**
-this

package/docs/api/foundation-criteria.criteriasegmentedcontrol.criteriaoptions.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) &gt; [criteriaOptions](./foundation-criteria.criteriasegmentedcontrol.criteriaoptions.md)
-## CriteriaSegmentedControl.criteriaOptions property
-**Signature:**
-```typescript
-criteriaOptions: CriteriaSegmentedControlOption[];
-```

package/docs/api/foundation-criteria.criteriasegmentedcontrol.itemclickhandler.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) &gt; [itemClickHandler](./foundation-criteria.criteriasegmentedcontrol.itemclickhandler.md)
-## CriteriaSegmentedControl.itemClickHandler() method
-**Signature:**
-```typescript
-itemClickHandler(label: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-label
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-criteria.criteriasegmentedcontrol.md DELETED Viewed

@@ -1,171 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [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 },
-];
- <criteria-segmented-control
-   :criteriaOptions=${() => toolbarOptions}
-   :value=${sync((x) => x.criteriaFilter)}
- >
-   <label slot="label">Filter by instrument name</label>
- </criteria-segmented-control>
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[criteriaOptions](./foundation-criteria.criteriasegmentedcontrol.criteriaoptions.md)
-</td><td>
-</td><td>
-CriteriaSegmentedControlOption\[\]
-</td><td>
-</td></tr>
-<tr><td>
-[selectedLabel](./foundation-criteria.criteriasegmentedcontrol.selectedlabel.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[value](./foundation-criteria.criteriasegmentedcontrol.value.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[itemClickHandler(label)](./foundation-criteria.criteriasegmentedcontrol.itemclickhandler.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[selectedLabelChanged()](./foundation-criteria.criteriasegmentedcontrol.selectedlabelchanged.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[valueChanged()](./foundation-criteria.criteriasegmentedcontrol.valuechanged.md)
-</td><td>
-</td><td>
-</td></tr>
-</tbody></table>