@genesislcap/foundation-forms 14.483.3-alpha-7a2e689.0 → 14.484.0

package/dist/foundation-forms.api.json

@@ -956,6 +956,32 @@
           ],
           "name": "controlWrapperTemplate"
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!CsvImportedEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `csv-imported` event fired by {@link Form} when CSV data is successfully imported into bulk insert rows.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type CsvImportedEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    rowCount: number;\n    totalRowsInFile: number;\n    unmappedColumns: string[];\n    fileName: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "CsvImportedEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-forms!CsvMappingResult:interface",
@@ -1033,6 +1059,32 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!CsvParseErrorEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `csv-parse-error` event fired by {@link Form} when CSV import parsing or mapping fails.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type CsvParseErrorEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    errors: string[];\n    fileName: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "CsvParseErrorEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-forms!CsvParseResult:interface",
@@ -1137,6 +1189,58 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!CsvTemplateDownloadedEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `csv-template-downloaded` event fired by {@link Form} after a CSV template file has been generated and downloaded.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type CsvTemplateDownloadedEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    fileName: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "CsvTemplateDownloadedEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!CsvTemplateErrorEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `csv-template-error` event fired by {@link Form} when a CSV template cannot be generated.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type CsvTemplateErrorEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    error: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "CsvTemplateErrorEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-forms!downloadCsvTemplate:function(1)",
@@ -1201,7 +1305,7 @@
         {
           "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 * @fires change - Fired when built criteria (`value`) updates  @fires submit - Fired when filter values are submitted\n *\n * @public\n */\n",
+          "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 * @fires change - Fired when built criteria (`value`) updates  @fires submit - Fired when filter values are submitted. detail: `FilterSubmitEventDetail`\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1883,10 +1987,45 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!FilterSubmitEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `submit` event fired by `Filters` when filter values are submitted.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type FilterSubmitEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    payload: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, unknown>;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "FilterSubmitEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
         {
           "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 * @fires submit - Fired when the form is submitted (includes payload and validation errors)  @fires submit-failure - Fired when submit fails (server or client validation)  @fires submit-success - Fired when submit succeeds  @fires submit-partial-success - Fired when bulk submit partially succeeds  @fires reset-clicked - Fired reset button is clicked  @fires row-status-changed - Fired when row submit status changes  @fires bulk-submit-complete - Fired when bulk submit completes  @fires row-submit-failure - Fired when a single row submit fails  @fires row-submit-success - Fired when a single row submit succeeds  @fires data-change - Fired when form data changes  @fires csv-parse-error - Fired when CSV import parsing fails  @fires csv-imported - Fired when CSV data is imported successfully  @fires csv-template-error - Fired when CSV template cannot be generated  @fires csv-template-downloaded - Fired when CSV template is downloaded\n *\n * @public\n */\n",
+          "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 * @fires submit - Fired when the form is submitted (includes payload and validation errors). detail: `SubmitEventDetail`  @fires submit-failure - Fired when submit fails (server or client validation). detail: `SubmitFailureEventDetail`  @fires submit-success - Fired when submit succeeds  @fires submit-partial-success - Fired when bulk submit partially succeeds. detail: `SubmitPartialSuccessEventDetail`  @fires reset-clicked - Fired reset button is clicked  @fires row-status-changed - Fired when row submit status changes. detail: `RowStatusChangedEventDetail`  @fires bulk-submit-complete - Fired when bulk submit completes. detail: `BulkSubmitResult`  @fires row-submit-failure - Fired when a single row submit fails. detail: `RowSubmitFailureEventDetail`  @fires row-submit-success - Fired when a single row submit succeeds. detail: `RowSubmitSuccessEventDetail`  @fires data-change - Fired when form data changes. detail: `FormDataChangeEventDetail`  @fires csv-parse-error - Fired when CSV import parsing fails. detail: `CsvParseErrorEventDetail`  @fires csv-imported - Fired when CSV data is imported successfully. detail: `CsvImportedEventDetail`  @fires csv-template-error - Fired when CSV template cannot be generated. detail: `CsvTemplateErrorEventDetail`  @fires csv-template-downloaded - Fired when CSV template is downloaded. detail: `CsvTemplateDownloadedEventDetail`\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -2668,6 +2807,59 @@
           },
           "implementsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!FormDataChangeEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `data-change` event fired by {@link Form} and `JSONForms` whenever the bound form data changes.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type FormDataChangeEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    data: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, unknown>;\n    errors: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ErrorObject",
+              "canonicalReference": "ajv!ErrorObject:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n    additionalErrors: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ErrorObject",
+              "canonicalReference": "ajv!ErrorObject:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n    path?: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "FormDataChangeEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-forms!generateCsvTemplate:function(1)",
@@ -4164,6 +4356,147 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!RowStatusChangedEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `row-status-changed` event fired by {@link Form} whenever the submission status of one or all bulk insert rows changes.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type RowStatusChangedEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    statuses: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Map",
+              "canonicalReference": "!Map:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<number, "
+            },
+            {
+              "kind": "Reference",
+              "text": "BulkRowStatus",
+              "canonicalReference": "@genesislcap/foundation-forms!BulkRowStatus:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n    index?: number;\n    status?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "BulkRowStatus",
+              "canonicalReference": "@genesislcap/foundation-forms!BulkRowStatus:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "RowStatusChangedEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!RowSubmitFailureEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `row-submit-failure` event fired by {@link Form} when a single bulk insert row fails to submit.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type RowSubmitFailureEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    index: number;\n    item: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, unknown>;\n    errors: "
+            },
+            {
+              "kind": "Reference",
+              "text": "MessageError",
+              "canonicalReference": "@genesislcap/foundation-comms!MessageError:type"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "RowSubmitFailureEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!RowSubmitSuccessEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `row-submit-success` event fired by {@link Form} when a single bulk insert row is submitted successfully.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type RowSubmitSuccessEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    index: number;\n    item: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, unknown>;\n    response: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Message",
+              "canonicalReference": "@genesislcap/foundation-comms!Message:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "RowSubmitSuccessEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-forms!SegmentedRendererOptions:type",
@@ -4525,6 +4858,138 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!SubmitEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `submit` event fired by {@link Form} before a submission request is sent.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type SubmitEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    payload: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, unknown>;\n    errors: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ErrorObject",
+              "canonicalReference": "ajv!ErrorObject:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "SubmitEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!SubmitFailureEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `submit-failure` event fired by {@link Form} when a submission is rejected by client-side validation, bulk item-count limits, or the server (EVENT_NACK).\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type SubmitFailureEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    payload: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, unknown>;\n    errors: "
+            },
+            {
+              "kind": "Reference",
+              "text": "MessageError",
+              "canonicalReference": "@genesislcap/foundation-comms!MessageError:type"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "SubmitFailureEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-forms!SubmitPartialSuccessEventDetail:type",
+          "docComment": "/**\n * Detail payload for the `submit-partial-success` event fired by {@link Form} when a bulk insert submission has a mix of successful and failed rows.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type SubmitPartialSuccessEventDetail = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    payload: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, unknown>;\n    results: "
+            },
+            {
+              "kind": "Reference",
+              "text": "BulkSubmitResult",
+              "canonicalReference": "@genesislcap/foundation-forms!BulkSubmitResult:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "SubmitPartialSuccessEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type",