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

package/dist/foundation-forms.d.ts

@@ -16,6 +16,8 @@ import { KVStorage } from '@genesislcap/foundation-comms';
 import { Layout } from '@jsonforms/core';
 import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
 import { Logger } from '@genesislcap/foundation-logger';
+import type { Message } from '@genesislcap/foundation-comms';
+import type { MessageError } from '@genesislcap/foundation-comms';
 import { OwnPropsOfControl } from '@jsonforms/core';
 import { RankedTester } from '@jsonforms/core';
 import { RuleEffect } from '@jsonforms/core';
@@ -443,6 +445,31 @@ export declare const controlWrapperTemplate: (options: ControlWrapperOptions) =>
  */
 export declare const createExpressions: (payload: any) => Expressions;
 
+/**
+ * Detail payload for the `csv-imported` event fired by {@link Form} when CSV data is
+ * successfully imported into bulk insert rows.
+ * @public
+ */
+export declare type CsvImportedEventDetail = {
+    /**
+     * Number of rows actually appended to the form data.
+     */
+    rowCount: number;
+    /**
+     * Number of rows present in the source CSV file (may exceed `rowCount` if truncated
+     * by `bulkInsertMaxItems`).
+     */
+    totalRowsInFile: number;
+    /**
+     * CSV columns that could not be matched to a schema field.
+     */
+    unmappedColumns: string[];
+    /**
+     * The name of the imported CSV file.
+     */
+    fileName: string;
+};
+
 /**
  * Result of mapping CSV data to schema fields.
  * @public
@@ -458,6 +485,22 @@ export declare interface CsvMappingResult {
     unmappedColumns: string[];
 }
 
+/**
+ * Detail payload for the `csv-parse-error` event fired by {@link Form} when CSV import
+ * parsing or mapping fails.
+ * @public
+ */
+export declare type CsvParseErrorEventDetail = {
+    /**
+     * Human-readable descriptions of what went wrong.
+     */
+    errors: string[];
+    /**
+     * The name of the CSV file that failed to import.
+     */
+    fileName: string;
+};
+
 /**
  * Result of parsing a CSV file.
  * @public
@@ -477,6 +520,30 @@ export declare interface CsvParseResult {
     errors: string[];
 }
 
+/**
+ * Detail payload for the `csv-template-downloaded` event fired by {@link Form} after a
+ * CSV template file has been generated and downloaded.
+ * @public
+ */
+export declare type CsvTemplateDownloadedEventDetail = {
+    /**
+     * The name of the downloaded file.
+     */
+    fileName: string;
+};
+
+/**
+ * Detail payload for the `csv-template-error` event fired by {@link Form} when a CSV
+ * template cannot be generated.
+ * @public
+ */
+export declare type CsvTemplateErrorEventDetail = {
+    /**
+     * Description of why the template could not be generated.
+     */
+    error: string;
+};
+
 declare class DispatchRenderer extends FASTElement {
     jsonforms: any;
     jsonformsChanged(): void;
@@ -536,7 +603,7 @@ export declare function extractFieldsFromUiSchema(uiSchema: UiSchema): Array<{
  * @public
  *
  * @fires change - Fired when built criteria (`value`) updates
- * @fires submit - Fired when filter values are submitted
+ * @fires submit - Fired when filter values are submitted. detail: `FilterSubmitEventDetail`
  */
 export declare class Filters extends Filters_base {
     kvStorage: KVStorage;
@@ -1041,26 +1108,37 @@ export declare const filtersLogger: Logger;
  */
 export declare const filtersRenderers: any[];
 
+/**
+ * Detail payload for the `submit` event fired by `Filters` when filter values are submitted.
+ * @public
+ */
+export declare type FilterSubmitEventDetail = {
+    /**
+     * The filter form data that was submitted.
+     */
+    payload: Record<string, unknown>;
+};
+
 /**
  * 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
  * @public
  *
- * @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 - 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
+ * @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
- * @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
+ * @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`
  */
 export declare class Form extends Form_base {
     /**
@@ -1330,7 +1408,7 @@ export declare class Form extends Form_base {
     /**
      * @internal
      */
-    onChange(event: CustomEvent): void;
+    onChange(event: CustomEvent<FormDataChangeEventDetail>): void;
     /**
      * @internal
      */
@@ -1759,6 +1837,31 @@ declare const Form_base: (new (...args: any[]) => {
     focus(options?: FocusOptions): void;
 }) & typeof FoundationElement;
 
+/**
+ * Detail payload for the `data-change` event fired by {@link Form} and `JSONForms` whenever
+ * the bound form data changes.
+ * @public
+ */
+export declare type FormDataChangeEventDetail = {
+    /**
+     * The current form data.
+     */
+    data: Record<string, unknown>;
+    /**
+     * Validation errors produced by JSON Forms/Ajv for the current data.
+     */
+    errors: ErrorObject[];
+    /**
+     * Additional errors merged in from custom `validateFn`s and server-side field errors.
+     */
+    additionalErrors: ErrorObject[];
+    /**
+     * The instance path that triggered this change, when known (e.g. from a single-field edit).
+     * Omitted on full re-initializations (e.g. schema swap, reset).
+     */
+    path?: string;
+};
+
 /** @internal */
 export declare const foundationFormStyles: ElementStyles;
 
@@ -2195,6 +2298,67 @@ export declare type RendererEntry = {
  */
 export declare const renderers: any[];
 
+/**
+ * Detail payload for the `row-status-changed` event fired by {@link Form} whenever the
+ * submission status of one or all bulk insert rows changes.
+ * @public
+ */
+export declare type RowStatusChangedEventDetail = {
+    /**
+     * The full map of row index to submission status.
+     */
+    statuses: Map<number, BulkRowStatus>;
+    /**
+     * The index of the row that changed. Omitted when all rows changed at once
+     * (e.g. when submission starts).
+     */
+    index?: number;
+    /**
+     * The new status of the row at `index`. Omitted together with `index`.
+     */
+    status?: BulkRowStatus;
+};
+
+/**
+ * Detail payload for the `row-submit-failure` event fired by {@link Form} when a single
+ * bulk insert row fails to submit.
+ * @public
+ */
+export declare type RowSubmitFailureEventDetail = {
+    /**
+     * The index of the row that failed.
+     */
+    index: number;
+    /**
+     * The row's data.
+     */
+    item: Record<string, unknown>;
+    /**
+     * The errors returned from the server or local validation.
+     */
+    errors: MessageError[];
+};
+
+/**
+ * Detail payload for the `row-submit-success` event fired by {@link Form} when a single
+ * bulk insert row is submitted successfully.
+ * @public
+ */
+export declare type RowSubmitSuccessEventDetail = {
+    /**
+     * The index of the row that succeeded.
+     */
+    index: number;
+    /**
+     * The row's data.
+     */
+    item: Record<string, unknown>;
+    /**
+     * The server response for this row.
+     */
+    response: Message;
+};
+
 declare type Rule = {
     condition: SchemaBasedCondition;
     effect: RuleEffect;
@@ -2350,6 +2514,54 @@ export declare type StringRendererOptions = {
     changeOnInput?: boolean;
 };
 
+/**
+ * Detail payload for the `submit` event fired by {@link Form} before a submission
+ * request is sent.
+ * @public
+ */
+export declare type SubmitEventDetail = {
+    /**
+     * The form data being submitted. Shape depends on the consumer's JSON schema.
+     */
+    payload: Record<string, unknown>;
+    /**
+     * Client-side validation errors collected so far. Empty when the payload is valid.
+     */
+    errors: ErrorObject[];
+};
+
+/**
+ * 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).
+ * @public
+ */
+export declare type SubmitFailureEventDetail = {
+    /**
+     * The form data that failed to submit.
+     */
+    payload: Record<string, unknown>;
+    /**
+     * The errors returned from the server or local validation.
+     */
+    errors: MessageError[];
+};
+
+/**
+ * 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.
+ * @public
+ */
+export declare type SubmitPartialSuccessEventDetail = {
+    /**
+     * The full bulk insert form data (all rows) that was submitted.
+     */
+    payload: Record<string, unknown>;
+    /**
+     * The aggregated per-row results.
+     */
+    results: BulkSubmitResult;
+};
+
 /**
  * The UI schema, which is passed to JSON Forms, describes the general layout of a form and is just a regular JSON object.
  * It describes the form by means of different UI schema elements, which can often be categorized into either Controls or Layouts.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-forms",
   "description": "Genesis Foundation Forms",
-  "version": "14.483.3-alpha-7a2e689.0",
+  "version": "14.484.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -59,13 +59,13 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/genx": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/rollup-builder": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/ts-builder": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/uvu-playwright-builder": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/vite-builder": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/webpack-builder": "14.483.3-alpha-7a2e689.0",
+    "@genesislcap/foundation-testing": "14.484.0",
+    "@genesislcap/genx": "14.484.0",
+    "@genesislcap/rollup-builder": "14.484.0",
+    "@genesislcap/ts-builder": "14.484.0",
+    "@genesislcap/uvu-playwright-builder": "14.484.0",
+    "@genesislcap/vite-builder": "14.484.0",
+    "@genesislcap/webpack-builder": "14.484.0",
     "@types/json-schema": "^7.0.11",
     "@types/papaparse": "^5.3.14"
   },
@@ -82,12 +82,12 @@
     }
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/foundation-criteria": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/foundation-logger": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/foundation-notifications": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/foundation-ui": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/foundation-utils": "14.483.3-alpha-7a2e689.0",
+    "@genesislcap/foundation-comms": "14.484.0",
+    "@genesislcap/foundation-criteria": "14.484.0",
+    "@genesislcap/foundation-logger": "14.484.0",
+    "@genesislcap/foundation-notifications": "14.484.0",
+    "@genesislcap/foundation-ui": "14.484.0",
+    "@genesislcap/foundation-utils": "14.484.0",
     "@json-schema-tools/dereferencer": "^1.6.1",
     "@jsonforms/core": "^3.2.1",
     "@microsoft/fast-components": "2.30.6",
@@ -109,5 +109,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "a42f1a2c0cea394164712c9abdeb96f58775d5e7"
+  "gitHead": "1ec7b2318e2447c2cd3ad877666b6fd1f3b87c05"
 }