@genesislcap/foundation-forms 14.4.0 → 14.5.0

package/dist/esm/utils/filters.js

@@ -0,0 +1,84 @@
+import { ExpressionBuilder, Serialisers } from '@genesislcap/foundation-criteria';
+const hour = 23;
+const minute = 59;
+const sec = 999;
+/**
+ * Creates a expressions/criteria from given payload
+ * @public
+ */
+export const createExpressions = (payload) => {
+    const expressions = {
+        options: [],
+        dateOptions: [],
+        numberOptions: [],
+    };
+    for (const [key, value] of Object.entries(payload)) {
+        if ((value && !value.type) || (value && value.max) || (value && value.min)) {
+            if (Array.isArray(value)) {
+                const optionsExpressions = value.map((item) => {
+                    return new ExpressionBuilder()
+                        .withField(key)
+                        .withValue(item)
+                        .withSerialiser(Serialisers.EQ)
+                        .build();
+                });
+                expressions.options = [...optionsExpressions, ...expressions.options];
+            }
+            else if (value && (value.min || value.max)) {
+                if (value.type == 'number') {
+                    expressions.numberOptions = [
+                        ...dateNumberExpressions(key, value, 'number'),
+                        ...expressions.numberOptions,
+                    ];
+                }
+                if (value.type == 'date') {
+                    expressions.dateOptions = [
+                        ...dateNumberExpressions(key, value, 'date'),
+                        ...expressions.dateOptions,
+                    ];
+                }
+            }
+            else {
+                const stringOptions = new ExpressionBuilder()
+                    .withField(key)
+                    .withValue(value)
+                    .withSerialiser(Serialisers.EQ)
+                    .build();
+                expressions.options = [stringOptions, ...expressions.options];
+            }
+        }
+    }
+    return expressions;
+};
+const dateNumberExpressions = (key, value, type) => {
+    let startDay;
+    let endDay;
+    if (type == 'date') {
+        startDay = value.min ? convertTimestampToDate(value.min) : undefined;
+        endDay = value.max ? convertTimestampToDate(value.max) : undefined;
+    }
+    const expressions = [];
+    const startExpression = value.min
+        ? new ExpressionBuilder()
+            .withField(key)
+            .withValue(startDay !== null && startDay !== void 0 ? startDay : value.min)
+            .withSerialiser(startDay ? Serialisers.dateIsGreaterEqual : Serialisers.GE)
+            .build()
+        : undefined;
+    const endExpression = value.max
+        ? new ExpressionBuilder()
+            .withField(key)
+            .withValue(endDay !== null && endDay !== void 0 ? endDay : value.max)
+            .withSerialiser(endDay ? Serialisers.dateIsLessEqual : Serialisers.LE)
+            .build()
+        : undefined;
+    startExpression ? expressions.push(startExpression) : '';
+    endExpression ? expressions.push(endExpression) : '';
+    return expressions;
+};
+const convertTimestampToDate = (timestamp) => {
+    const months = (new Date(timestamp).getUTCMonth() + 1).toString().padStart(2, '0');
+    const days = new Date(timestamp).getUTCDate().toString().padStart(2, '0');
+    const year = new Date(timestamp).getUTCFullYear().toString();
+    return [year, months, days].join('');
+};

package/dist/esm/utils/index.js

@@ -1,2 +1,3 @@
+export * from './filters';
 export * from './translation';
 export * from './validation';

package/dist/foundation-forms.api.json

@@ -172,6 +172,369 @@
       "name": "",
       "preserveMemberOrder": false,
       "members": [
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-forms!createExpressions:var",
+          "docComment": "/**\n * Creates a expressions/criteria from given payload\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "createExpressions: "
+            },
+            {
+              "kind": "Content",
+              "text": "(payload: any) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "Expressions",
+              "canonicalReference": "@genesislcap/foundation-forms!~Expressions:type"
+            }
+          ],
+          "fileUrlPath": "src/utils/filters.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "createExpressions",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
+        {
+          "kind": "Class",
+          "canonicalReference": "@genesislcap/foundation-forms!Filters:class",
+          "docComment": "/**\n * 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\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class Filters extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "FoundationElement",
+              "canonicalReference": "@microsoft/fast-foundation!FoundationElement:class"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/filters/filters.ts",
+          "releaseTag": "Beta",
+          "isAbstract": false,
+          "name": "Filters",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-forms!Filters#clearFiltersData:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "clearFiltersData(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "clearFiltersData"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-forms!Filters#data:member",
+              "docComment": "/**\n * Initial data for the filters\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "data: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "data",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-forms!Filters#disconnectedCallback:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "disconnectedCallback(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "disconnectedCallback"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-forms!Filters#jsonSchema:member",
+              "docComment": "/**\n * Alternatively to providing {@link Form.resourceName} you can hardcode the JSON schema on the client.\n *\n * @remarks\n *\n * Use this when you want to avoid fetching metadata from the server but be aware that it could get out of sync if metadata changes on the server\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "jsonSchema: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "JSONSchema7",
+                  "canonicalReference": "@types/json-schema!JSONSchema7:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "jsonSchema",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-forms!Filters#renderers:member",
+              "docComment": "/**\n * Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "renderers: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RendererEntry",
+                  "canonicalReference": "@genesislcap/foundation-forms!RendererEntry:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "renderers",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-forms!Filters#resourceName:member",
+              "docComment": "/**\n * Name of the backend resource which will provide metadata used to generate filters\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "resourceName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "resourceName",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-forms!Filters#uischema:member",
+              "docComment": "/**\n * UI schema used to define configuration of the layout and elements in the filters Check {@link UiSchemaElement} for possible options\n *\n * @remarks\n *\n * If not provided will be autogenerated based on json schema or initial data\n *\n * @example\n *\n * Here's a simple example:\n * ```\n * const sampleUISchema = {\n *   type: 'VerticalLayout',\n *   elements: [\n *     {\n *       type: 'Control',\n *       scope: '#/properties/QUANTITY',\n *       label: 'Quantity',\n *     },\n *     {\n *       type: 'Control',\n *       scope: '#/properties/INSTRUMENT_ID',\n *       options: {\n *         allOptionsResourceName: 'INSTRUMENT',\n *         valueField: 'INSTRUMENT_ID',\n *         labelField: 'INSTRUMENT_ID',\n *       },\n *       label: 'Instrument',\n *     },\n *     {\n *       type: 'Control',\n *       scope: '#/properties/SIDE',\n *       label: 'Side',\n *     },\n *   ],\n * };\n * ```\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "uischema: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "UISchemaElement",
+                  "canonicalReference": "@jsonforms/core!UISchemaElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "uischema",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-forms!Filters#value:member",
+              "docComment": "/**\n * Created criteria based on the given data that can be used to filter the data\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "value: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "value",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-forms!Filters#valueChanged:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "valueChanged(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "valueChanged"
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-forms!filtersRenderers:var",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "filtersRenderers: "
+            },
+            {
+              "kind": "Content",
+              "text": "any[]"
+            }
+          ],
+          "fileUrlPath": "src/filters/filters.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "filtersRenderers",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-forms!Form:class",

package/dist/foundation-forms.d.ts

@@ -1,5 +1,6 @@
 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';
@@ -11,6 +12,12 @@ import { StatePropsOfControl } from '@jsonforms/core';
 import { UISchemaElement } from '@jsonforms/core';
 import { ViewTemplate } from '@microsoft/fast-element';
 
+/**
+ * Creates a expressions/criteria from given payload
+ * @public
+ */
+export declare const createExpressions: (payload: any) => Expressions;
+
 declare class DispatchRenderer extends FASTElement {
     jsonforms: any;
     jsonformsChanged(): void;
@@ -28,6 +35,108 @@ declare class DispatchRenderer extends FASTElement {
     disconnectedCallback(): void;
 }
 
+declare type Expressions = {
+    options: Expression[];
+    numberOptions: Expression[];
+    dateOptions: Expression[];
+};
+
+/**
+ * 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
+ * @beta
+ */
+export declare class Filters extends FoundationElement {
+    /**
+     * Name of the backend resource which will provide metadata
+     * used to generate filters
+     * @public
+     */
+    resourceName: string;
+    private resourceNameChanged;
+    clearFiltersData(): void;
+    /**
+     * UI schema used to define configuration of the layout and elements in the filters
+     * Check {@link UiSchemaElement} for possible options
+     *
+     * @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',
+     *     },
+     *   ],
+     * };
+     * ```
+     * @public
+     */
+    uischema: UISchemaElement;
+    /**
+     * Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs
+     * @public
+     */
+    renderers: RendererEntry[];
+    /**
+     * Alternatively to providing {@link Form.resourceName} you can hardcode the JSON schema on the client.
+     * @public
+     * @remarks
+     * Use this when you want to avoid fetching metadata from the server but
+     * be aware that it could get out of sync if metadata changes on the server
+     */
+    jsonSchema: JSONSchema7;
+    private connect;
+    /**
+     * Initial data for the filters
+     * @public
+     */
+    data: any;
+    /**
+     * Created criteria based on the given data that can be used to filter the data
+     * @public
+     */
+    value: string;
+    valueChanged(): void;
+    /**
+     * @internal
+     */
+    searchFilters(): void;
+    /**
+     * @internal
+     */
+    onChange(event: CustomEvent): void;
+    disconnectedCallback(): void;
+}
+
+/** @internal */
+export declare const filtersLogger: Logger;
+
+/** @public */
+export declare const filtersRenderers: any[];
+
 /**
  * Foundation form component for automatically generated forms based on json schema
  * obtained from the api, supplied initial data or supplied JSON schema.

package/docs/api/foundation-forms.createexpressions.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; [createExpressions](./foundation-forms.createexpressions.md)
+
+## createExpressions variable
+
+Creates a expressions/criteria from given payload
+
+**Signature:**
+
+```typescript
+createExpressions: (payload: any) => Expressions
+```

package/docs/api/foundation-forms.filters.clearfiltersdata.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; [clearFiltersData](./foundation-forms.filters.clearfiltersdata.md)
+
+## Filters.clearFiltersData() 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
+clearFiltersData(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-forms.filters.data.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; [data](./foundation-forms.filters.data.md)
+
+## Filters.data property
+
+Initial data for the filters
+
+**Signature:**
+
+```typescript
+data: any;
+```

package/docs/api/foundation-forms.filters.disconnectedcallback.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; [disconnectedCallback](./foundation-forms.filters.disconnectedcallback.md)
+
+## Filters.disconnectedCallback() 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
+disconnectedCallback(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-forms.filters.jsonschema.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; [jsonSchema](./foundation-forms.filters.jsonschema.md)
+
+## Filters.jsonSchema property
+
+Alternatively to providing [Form.resourceName](./foundation-forms.form.resourcename.md) you can hardcode the JSON schema on the client.
+
+**Signature:**
+
+```typescript
+jsonSchema: JSONSchema7;
+```
+
+## Remarks
+
+Use this when you want to avoid fetching metadata from the server but be aware that it could get out of sync if metadata changes on the server
+