@genesislcap/foundation-forms 14.4.0 → 14.5.0

package/docs/api/foundation-forms.filters.md

@@ -0,0 +1,37 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Filters](./foundation-forms.filters.md)
+
+## Filters class
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Foundation filters component for automatically generated filters based on json schema obtained from the api, supplied initial data or supplied JSON schema. Allowing customisable filters elements using UI schema and set of custom renderers
+
+**Signature:**
+
+```typescript
+export declare class Filters extends FoundationElement 
+```
+**Extends:** FoundationElement
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [data](./foundation-forms.filters.data.md) |  | any | Initial data for the filters |
+|  [jsonSchema](./foundation-forms.filters.jsonschema.md) |  | JSONSchema7 | Alternatively to providing [Form.resourceName](./foundation-forms.form.resourcename.md) you can hardcode the JSON schema on the client. |
+|  [renderers](./foundation-forms.filters.renderers.md) |  | [RendererEntry](./foundation-forms.rendererentry.md)<!-- -->\[\] | Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs |
+|  [resourceName](./foundation-forms.filters.resourcename.md) |  | string | Name of the backend resource which will provide metadata used to generate filters |
+|  [uischema](./foundation-forms.filters.uischema.md) |  | UISchemaElement | UI schema used to define configuration of the layout and elements in the filters Check [UiSchemaElement](./foundation-forms.uischemaelement.md) for possible options |
+|  [value](./foundation-forms.filters.value.md) |  | string | Created criteria based on the given data that can be used to filter the data |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [clearFiltersData()](./foundation-forms.filters.clearfiltersdata.md) |  | **_(BETA)_** |
+|  [disconnectedCallback()](./foundation-forms.filters.disconnectedcallback.md) |  | **_(BETA)_** |
+|  [valueChanged()](./foundation-forms.filters.valuechanged.md) |  | **_(BETA)_** |
+

package/docs/api/foundation-forms.filters.renderers.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Filters](./foundation-forms.filters.md) &gt; [renderers](./foundation-forms.filters.renderers.md)
+
+## Filters.renderers property
+
+Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs
+
+**Signature:**
+
+```typescript
+renderers: RendererEntry[];
+```

package/docs/api/foundation-forms.filters.resourcename.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Filters](./foundation-forms.filters.md) &gt; [resourceName](./foundation-forms.filters.resourcename.md)
+
+## Filters.resourceName property
+
+Name of the backend resource which will provide metadata used to generate filters
+
+**Signature:**
+
+```typescript
+resourceName: string;
+```

package/docs/api/foundation-forms.filters.uischema.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Filters](./foundation-forms.filters.md) &gt; [uischema](./foundation-forms.filters.uischema.md)
+
+## Filters.uischema property
+
+UI schema used to define configuration of the layout and elements in the filters Check [UiSchemaElement](./foundation-forms.uischemaelement.md) for possible options
+
+**Signature:**
+
+```typescript
+uischema: UISchemaElement;
+```
+
+## Remarks
+
+If not provided will be autogenerated based on json schema or initial data
+
+## Example
+
+Here's a simple example:
+
+```
+const sampleUISchema = {
+  type: 'VerticalLayout',
+  elements: [
+    {
+      type: 'Control',
+      scope: '#/properties/QUANTITY',
+      label: 'Quantity',
+    },
+    {
+      type: 'Control',
+      scope: '#/properties/INSTRUMENT_ID',
+      options: {
+        allOptionsResourceName: 'INSTRUMENT',
+        valueField: 'INSTRUMENT_ID',
+        labelField: 'INSTRUMENT_ID',
+      },
+      label: 'Instrument',
+    },
+    {
+      type: 'Control',
+      scope: '#/properties/SIDE',
+      label: 'Side',
+    },
+  ],
+};
+```
+

package/docs/api/foundation-forms.filters.value.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Filters](./foundation-forms.filters.md) &gt; [value](./foundation-forms.filters.value.md)
+
+## Filters.value property
+
+Created criteria based on the given data that can be used to filter the data
+
+**Signature:**
+
+```typescript
+value: string;
+```

package/docs/api/foundation-forms.filters.valuechanged.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Filters](./foundation-forms.filters.md) &gt; [valueChanged](./foundation-forms.filters.valuechanged.md)
+
+## Filters.valueChanged() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+valueChanged(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-forms.filtersrenderers.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [filtersRenderers](./foundation-forms.filtersrenderers.md)
+
+## filtersRenderers variable
+
+
+**Signature:**
+
+```typescript
+filtersRenderers: any[]
+```

package/docs/api/foundation-forms.md

@@ -8,12 +8,15 @@
 
 |  Class | Description |
 |  --- | --- |
+|  [Filters](./foundation-forms.filters.md) | **_(BETA)_** Foundation filters component for automatically generated filters based on json schema obtained from the api, supplied initial data or supplied JSON schema. Allowing customisable filters elements using UI schema and set of custom renderers |
 |  [Form](./foundation-forms.form.md) | **_(BETA)_** Foundation form component for automatically generated forms based on json schema obtained from the api, supplied initial data or supplied JSON schema. Allowing customisable form elements using UI schema and set of custom renderers |
 
 ## Variables
 
 |  Variable | Description |
 |  --- | --- |
+|  [createExpressions](./foundation-forms.createexpressions.md) | Creates a expressions/criteria from given payload |
+|  [filtersRenderers](./foundation-forms.filtersrenderers.md) |  |
 |  [genesisErrorTranslator](./foundation-forms.genesiserrortranslator.md) |  |
 |  [mustMatch](./foundation-forms.mustmatch.md) | Ensures the value of the current field (the one the validator is on) matches the one of the target field. |
 |  [renderers](./foundation-forms.renderers.md) |  |

package/docs/api-report.md

@@ -6,6 +6,7 @@
 
 import { ErrorObject } from 'ajv';
 import { ErrorTranslator } from '@jsonforms/core';
+import { Expression } from '@genesislcap/foundation-criteria';
 import { FASTElement } from '@microsoft/fast-element';
 import { FoundationElement } from '@microsoft/fast-foundation';
 import { JsonFormsState } from '@jsonforms/core';
@@ -17,6 +18,45 @@ import { StatePropsOfControl } from '@jsonforms/core';
 import { UISchemaElement } from '@jsonforms/core';
 import { ViewTemplate } from '@microsoft/fast-element';
 
+// Warning: (ae-forgotten-export) The symbol "Expressions" needs to be exported by the entry point index.d.ts
+//
+// @public
+export const createExpressions: (payload: any) => Expressions;
+
+// @beta
+export class Filters extends FoundationElement {
+    // (undocumented)
+    clearFiltersData(): void;
+    // @public
+    data: any;
+    // (undocumented)
+    disconnectedCallback(): void;
+    // @public
+    jsonSchema: JSONSchema7;
+    // @internal (undocumented)
+    onChange(event: CustomEvent): void;
+    // @public
+    renderers: RendererEntry[];
+    // @public
+    resourceName: string;
+    // @internal (undocumented)
+    searchFilters(): void;
+    // @public
+    uischema: UISchemaElement;
+    // @public
+    value: string;
+    // (undocumented)
+    valueChanged(): void;
+}
+
+// Warning: (ae-internal-missing-underscore) The name "filtersLogger" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal (undocumented)
+export const filtersLogger: Logger;
+
+// @public (undocumented)
+export const filtersRenderers: any[];
+
 // @beta
 export class Form extends FoundationElement {
     // @public

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-forms",
   "description": "Genesis Foundation Forms",
-  "version": "14.4.0",
+  "version": "14.5.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -48,7 +48,7 @@
     "test:unit:watch": "watchlist src test -- npm run test:unit"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "^14.4.0",
+    "@genesislcap/foundation-testing": "^14.5.0",
     "@microsoft/api-documenter": "^7.19.13",
     "@microsoft/api-extractor": "^7.31.1",
     "@module-federation/dashboard-plugin": "2.3.0",
@@ -100,8 +100,9 @@
     "webpack-merge": "^5.7.3"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "^14.4.0",
-    "@genesislcap/foundation-utils": "^14.4.0",
+    "@genesislcap/foundation-comms": "^14.5.0",
+    "@genesislcap/foundation-criteria": "^14.5.0",
+    "@genesislcap/foundation-utils": "^14.5.0",
     "@jsonforms/core": "^3.0.0",
     "@microsoft/fast-components": "^2.21.3",
     "@microsoft/fast-element": "^1.7.0",
@@ -121,5 +122,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "faee66c559ee8763ae7bd4cc448b768d86391a41"
+  "gitHead": "0b69be3bb6826011ac8571a7bbb414cdb147c29a"
 }