@genesislcap/foundation-forms 9.0.1-alpha-b5c5eb7.0

package/dist/foundation-forms.api.json

@@ -0,0 +1,723 @@
+{
+  "metadata": {
+    "toolPackage": "@microsoft/api-extractor",
+    "toolVersion": "7.34.4",
+    "schemaVersion": 1011,
+    "oldestForwardsCompatibleVersion": 1001,
+    "tsdocConfig": {
+      "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+      "noStandardTags": true,
+      "tagDefinitions": [
+        {
+          "tagName": "@alpha",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@beta",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@defaultValue",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@decorator",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@deprecated",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@eventProperty",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@example",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@experimental",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@inheritDoc",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@internal",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@label",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@link",
+          "syntaxKind": "inline",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@override",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@packageDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@param",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@privateRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@public",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@readonly",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@remarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@returns",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@sealed",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@see",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@throws",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@typeParam",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@virtual",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@betaDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@internalRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@preapproved",
+          "syntaxKind": "modifier"
+        }
+      ],
+      "supportForTags": {
+        "@alpha": true,
+        "@beta": true,
+        "@defaultValue": true,
+        "@decorator": true,
+        "@deprecated": true,
+        "@eventProperty": true,
+        "@example": true,
+        "@experimental": true,
+        "@inheritDoc": true,
+        "@internal": true,
+        "@label": true,
+        "@link": true,
+        "@override": true,
+        "@packageDocumentation": true,
+        "@param": true,
+        "@privateRemarks": true,
+        "@public": true,
+        "@readonly": true,
+        "@remarks": true,
+        "@returns": true,
+        "@sealed": true,
+        "@see": true,
+        "@throws": true,
+        "@typeParam": true,
+        "@virtual": true,
+        "@betaDocumentation": true,
+        "@internalRemarks": true,
+        "@preapproved": true
+      },
+      "reportUnsupportedHtmlElements": false
+    }
+  },
+  "kind": "Package",
+  "canonicalReference": "@genesislcap/foundation-forms!",
+  "docComment": "",
+  "name": "@genesislcap/foundation-forms",
+  "preserveMemberOrder": false,
+  "members": [
+    {
+      "kind": "EntryPoint",
+      "canonicalReference": "@genesislcap/foundation-forms!",
+      "name": "",
+      "preserveMemberOrder": false,
+      "members": [
+        {
+          "kind": "Class",
+          "canonicalReference": "@genesislcap/foundation-forms!Form:class",
+          "docComment": "/**\n * 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\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class Form extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "FoundationElement",
+              "canonicalReference": "@microsoft/fast-foundation!FoundationElement:class"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/form.ts",
+          "releaseTag": "Beta",
+          "isAbstract": false,
+          "name": "Form",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-forms!Form#data:member",
+              "docComment": "/**\n * Initial data for the form\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "data: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{}"
+                },
+                {
+                  "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!Form#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!Form#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!Form#readonly:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "readonly",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-forms!Form#renderers:member",
+              "docComment": "/**\n * Allows to provide set of renderers used by the form. 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!Form#resourceName:member",
+              "docComment": "/**\n * Name of the backend resource which will provide metadata used to generate form and later used for submitting data\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!Form#uischema:member",
+              "docComment": "/**\n * UI schema used to define configuration of the layout and elements in the form 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
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-forms!genesisErrorTranslator:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "genesisErrorTranslator: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ErrorTranslator",
+              "canonicalReference": "@jsonforms/core!ErrorTranslator:type"
+            }
+          ],
+          "fileUrlPath": "src/utils/translation.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "genesisErrorTranslator",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-forms!logger:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "logger: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@genesislcap/foundation-utils\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Logger",
+              "canonicalReference": "@genesislcap/foundation-utils!Logger:interface"
+            }
+          ],
+          "fileUrlPath": "src/form.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "logger",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-forms!mustMatch:var",
+          "docComment": "/**\n * Ensures the value of the current field (the one the validator is on) matches the one of the target field.\n *\n * @param target - any other field\n *\n * @returns a validator function that will be run by the smart form during the client-side validation stage\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "mustMatch: "
+            },
+            {
+              "kind": "Content",
+              "text": "(target: string) => (data: any, path: any, label: any) => {\n    instancePath: string;\n    message: string;\n    schemaPath: string;\n    keyword: string;\n    params: {};\n}[]"
+            }
+          ],
+          "fileUrlPath": "src/utils/validation.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "mustMatch",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!RendererEntry:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type RendererEntry = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    renderer: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ViewTemplate",
+              "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "DispatchRenderer",
+              "canonicalReference": "@genesislcap/foundation-forms!~DispatchRenderer:class"
+            },
+            {
+              "kind": "Content",
+              "text": ", any>;\n    tester: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RankedTester",
+              "canonicalReference": "@jsonforms/core!RankedTester:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    mapper: (state: "
+            },
+            {
+              "kind": "Reference",
+              "text": "JsonFormsState",
+              "canonicalReference": "@jsonforms/core!JsonFormsState:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", ownProps: "
+            },
+            {
+              "kind": "Reference",
+              "text": "OwnPropsOfControl",
+              "canonicalReference": "@jsonforms/core!OwnPropsOfControl:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Reference",
+              "text": "StatePropsOfControl",
+              "canonicalReference": "@jsonforms/core!StatePropsOfControl:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "RendererEntry",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 14
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type UiSchema = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "UiSchemaElementType",
+              "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementType:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    elements: "
+            },
+            {
+              "kind": "Reference",
+              "text": "UiSchemaElement",
+              "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElement:type"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "UiSchema",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElement:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type UiSchemaElement = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "UiSchemaElementType",
+              "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementType:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    scope: string;\n    label?: string;\n    options?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "UiSchemaElementOptions",
+              "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "UiSchemaElement",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementOptions:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type UiSchemaElementOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    allOptionsResourceName?: string;\n    valueField?: string;\n    labelField?: string;\n    textarea?: boolean;\n    data?: any[];\n    i18n?: {\n        [key: string]: any;\n    };\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "UiSchemaElementOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementType:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type UiSchemaElementType = "
+            },
+            {
+              "kind": "Content",
+              "text": "'Control' | 'VerticalLayout' | any"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "UiSchemaElementType",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        }
+      ]
+    }
+  ]
+}