@genesislcap/foundation-forms 14.397.2 → 14.398.0

package/dist/foundation-forms.d.ts

@@ -31,9 +31,11 @@ export declare type ArrayRendererOptions = {
     /**
      * ChildUiSchema allows you to pass a UiSchema for a particular element,
      * which can then be multiplied many times by the renderer.
+     * For dynamic per-row schema (e.g. dropdown criteria based on another field in that row),
+     * pass a function that receives (index, rowData, formData) and returns the UiSchema.
      * @public
      */
-    childUiSchema?: UiSchema;
+    childUiSchema?: UiSchema | ChildUiSchemaResolver;
     /**
      * By default the label is 'Add another'
      * To override it, set this property with your desired add message.
@@ -108,6 +110,90 @@ export declare type ArrayRendererOptions = {
     canDelete?: (item: any) => boolean;
 };
 
+/**
+ * Tracks the submission status and result for a single row in bulk insert mode.
+ * @public
+ */
+export declare type BulkRowStatus = {
+    /**
+     * The current submission status of the row.
+     */
+    status: BulkRowSubmitStatus;
+    /**
+     * Error messages if the row failed to submit.
+     */
+    errors?: Array<{
+        CODE: string;
+        TEXT: string;
+    }>;
+    /**
+     * Server response if the row was successfully submitted.
+     */
+    response?: any;
+};
+
+/**
+ * Possible submission status values for a row in bulk insert mode.
+ * @public
+ */
+export declare type BulkRowSubmitStatus = 'pending' | 'submitting' | 'success' | 'failed';
+
+/**
+ * Represents a failed bulk insert item result.
+ * @public
+ */
+export declare type BulkSubmitFailedItem = {
+    /**
+     * The original item data that failed to submit.
+     */
+    item: any;
+    /**
+     * The index of the item in the original array.
+     */
+    index: number;
+    /**
+     * The errors returned from the server or client validation.
+     */
+    errors: Array<{
+        CODE: string;
+        TEXT: string;
+    }>;
+};
+
+/**
+ * Result of a bulk insert submission containing successful and failed items.
+ * @public
+ */
+export declare type BulkSubmitResult = {
+    /**
+     * Array of successfully submitted items with their responses.
+     */
+    successful: BulkSubmitSuccessItem[];
+    /**
+     * Array of items that failed to submit with their errors.
+     */
+    failed: BulkSubmitFailedItem[];
+};
+
+/**
+ * Represents a successful bulk insert item result.
+ * @public
+ */
+export declare type BulkSubmitSuccessItem = {
+    /**
+     * The original item data that was submitted.
+     */
+    item: any;
+    /**
+     * The index of the item in the original array.
+     */
+    index: number;
+    /**
+     * The server response for this item.
+     */
+    response: any;
+};
+
 /**
  * Configuration options available for categorization renderer.
  * @public
@@ -120,6 +206,13 @@ export declare type CategorizationRendererOptions = {
     childElements?: UiSchema[];
 };
 
+/**
+ * Resolver for dynamic per-row UI schema in array/bulk-insert mode.
+ * Receives the row index, that row's data, and the full form data.
+ * @public
+ */
+export declare type ChildUiSchemaResolver = (index: number, rowData: any, formData: any) => UiSchema;
+
 /** @internal */
 export declare const comboboxRendererStyles: (prefix?: string) => string;
 
@@ -192,6 +285,40 @@ export declare type ConnectedRenderersOptions = {
  */
 export declare const createExpressions: (payload: any) => Expressions;
 
+/**
+ * Result of mapping CSV data to schema fields.
+ * @public
+ */
+export declare interface CsvMappingResult {
+    /**
+     * The mapped rows with values converted to appropriate types.
+     */
+    mappedRows: Record<string, any>[];
+    /**
+     * CSV columns that could not be matched to schema fields.
+     */
+    unmappedColumns: string[];
+}
+
+/**
+ * Result of parsing a CSV file.
+ * @public
+ */
+export declare interface CsvParseResult {
+    /**
+     * The header names from the first row of the CSV.
+     */
+    headers: string[];
+    /**
+     * The parsed data rows as key-value objects.
+     */
+    rows: Record<string, string>[];
+    /**
+     * Any errors encountered during parsing.
+     */
+    errors: string[];
+}
+
 declare class DispatchRenderer extends FASTElement {
     jsonforms: any;
     jsonformsChanged(): void;
@@ -211,6 +338,15 @@ declare class DispatchRenderer extends FASTElement {
     disconnectedCallback(): void;
 }
 
+/**
+ * Triggers a download of the CSV template file in the browser.
+ * @param csvContent - The CSV content to download
+ * @param fileName - The name for the downloaded file (default: 'template.csv')
+ * @remarks Browser-only; uses document and URL.createObjectURL. Will throw in Node.js.
+ * @public
+ */
+export declare function downloadCsvTemplate(csvContent: string, fileName?: string): void;
+
 declare type Expressions = {
     options: Expression[];
     arrayOptions: Expression[];
@@ -218,6 +354,18 @@ declare type Expressions = {
     dateOptions: Expression[];
 };
 
+/**
+ * Extracts field names from a UI schema in the order they appear.
+ * @param uiSchema - The UI schema to extract fields from
+ * @returns Array of field info with name, label, and hidden status
+ * @internal
+ */
+export declare function extractFieldsFromUiSchema(uiSchema: UiSchema): Array<{
+    fieldName: string;
+    label?: string;
+    isHidden: boolean;
+}>;
+
 /**
  * Foundation filters component for automatically generated filters based on json schema
  * obtained from the api, supplied initial data or supplied JSON schema.
@@ -731,6 +879,16 @@ export declare class Form extends Form_base {
      */
     resourceName: string;
     private resourceNameChanged;
+    /**
+     * Initializes the data with default empty items for bulk insert mode.
+     * @internal
+     */
+    private initializeBulkInsertData;
+    /**
+     * Transforms the JSON schema to support bulk insert mode by wrapping it in an array.
+     * @internal
+     */
+    private transformSchemaForBulkInsert;
     /**
      * Optional confirmation message to display before form submission.
      * If set, a confirmation dialog will be shown when the user clicks submit.
@@ -753,6 +911,11 @@ export declare class Form extends Form_base {
      * @internal
      */
     approvalModal: any;
+    /**
+     * Reference to the CSV file input element for bulk import.
+     * @internal
+     */
+    csvFileInput: HTMLInputElement;
     /**
      * Stores the approval message entered by the user.
      * @internal
@@ -861,10 +1024,75 @@ export declare class Form extends Form_base {
      * @public
      */
     hideSubmit: boolean;
+    /**
+     * When enabled, transforms the form into bulk insert mode where multiple records can be added.
+     * The JSON schema will be wrapped as an array, and each item will be submitted separately.
+     * @public
+     */
+    bulkInsert: boolean;
+    /**
+     * Minimum number of items required in bulk insert mode.
+     * @public
+     */
+    bulkInsertMinItems: number;
+    /**
+     * Maximum number of items allowed in bulk insert mode. If not set, no maximum is enforced.
+     * @public
+     */
+    bulkInsertMaxItems: number | undefined;
+    /**
+     * Stores the original schema before bulk insert transformation.
+     * @internal
+     */
+    private originalDetailsSchema;
+    /**
+     * User-provided UI schema for bulk insert mode, stored separately.
+     * @internal
+     */
+    private userProvidedUiSchema;
+    /**
+     * Tracks the submission status for each row in bulk insert mode.
+     * Key is the row index, value is the status object.
+     * @public
+     */
+    rowSubmitStatuses: Map<number, BulkRowStatus>;
     /**
      * @internal
      */
     _submit(): Promise<void>;
+    /**
+     * Handles bulk insert submission by iterating through items and submitting each separately.
+     * Updates rowSubmitStatuses to provide row-level feedback.
+     * @internal
+     */
+    private _submitBulk;
+    /**
+     * Updates the submit status for a specific row and triggers reactivity.
+     * @param index - The row index
+     * @param status - The new status object
+     * @internal
+     */
+    private updateRowStatus;
+    /**
+     * Clears all row submit statuses, typically called when resetting the form.
+     * @public
+     */
+    clearRowSubmitStatuses(): void;
+    /**
+     * Submits a single row in bulk insert mode.
+     * @param index - The index of the row to submit
+     * @returns Promise that resolves when submission is complete
+     * @public
+     */
+    submitSingleRow(index: number): Promise<void>;
+    /**
+     * Filters item data to only include fields defined in the UI schema.
+     * This ensures we don't submit default values for fields not shown in the UI.
+     * @param item - The item data to filter
+     * @returns Filtered item data containing only UI schema fields
+     * @internal
+     */
+    private filterDataByUiSchema;
     /**
      * Builds the commit payload for the form submission.
      * @internal
@@ -911,6 +1139,25 @@ export declare class Form extends Form_base {
      * @internal
      */
     submitWithApproval(): Promise<void>;
+    /**
+     * Handles CSV file selection for bulk import.
+     * Parses the CSV content and appends it to existing form items.
+     * @param event - The file input change event
+     * @public
+     */
+    handleCsvFileSelected(event: Event): Promise<void>;
+    /**
+     * Clears the CSV file input to allow re-selection of the same file.
+     * @internal
+     */
+    private clearCsvFileInput;
+    /**
+     * Downloads a CSV template file with headers and sample data based on the schema.
+     * If a UI schema is provided, it will be used to determine which fields to include
+     * and in what order. Hidden fields will be excluded from the template.
+     * @public
+     */
+    downloadCsvTemplate(): void;
 }
 
 declare const Form_base: (new (...args: any[]) => {
@@ -1286,6 +1533,19 @@ export declare const foundationFormStyles: ElementStyles;
 /** @internal */
 export declare const foundationFormTemplate: ViewTemplate<Form, any>;
 
+/**
+ * Generates a CSV template string with headers and sample data based on JSON schema.
+ * If a UI schema is provided, it will be used to determine which fields to include
+ * and in what order. Hidden fields in the UI schema will be excluded.
+ * @param schema - The JSON schema defining the fields
+ * @param uiSchema - Optional UI schema to determine field order and visibility
+ * @param includeOptionalFields - Whether to include optional fields when no UI schema (default: true)
+ * @param includeBom - Whether to prepend UTF-8 BOM for Excel compatibility (default: true)
+ * @returns The CSV template string with headers and one sample row
+ * @public
+ */
+export declare function generateCsvTemplate(schema: JSONSchema7 | undefined, uiSchema?: UiSchema, includeOptionalFields?: boolean, includeBom?: boolean): string;
+
 /**
  * @internal
  */
@@ -1313,6 +1573,8 @@ export declare enum GenesisType {
 /**
  * Computes a human-friendly anyOf error message for a given control path.
  * Prefers UI schema custom message, then JSON schema errorMessage.anyOf, then a constructed fallback.
+ *
+ * @public
  */
 export declare const getAnyOfErrorMessage: (errors: Array<any> | undefined, schema: any, controlPath: string | undefined, uiCustomMsg?: string) => string;
 
@@ -1348,6 +1610,18 @@ export { Layout }
 /** @internal */
 export declare const logger: Logger;
 
+/**
+ * Maps CSV rows to schema fields with case-insensitive matching.
+ * When uiSchema is provided, CSV headers can also match UI schema labels.
+ * Converts values to appropriate types based on schema definition.
+ * @param csvRows - The parsed CSV rows
+ * @param schema - The JSON schema defining the fields
+ * @param uiSchema - Optional UI schema to map labels to field names on import
+ * @returns Mapped rows and list of unmapped columns
+ * @public
+ */
+export declare function mapCsvToSchema(csvRows: Record<string, string>[], schema: JSONSchema7 | undefined, uiSchema?: UiSchema): CsvMappingResult;
+
 /**
  * Ensures the value of the current field (the one the validator is on) matches the one of the target field.
  * @param target - any other field
@@ -1386,6 +1660,15 @@ export declare type NumberRendererOptions = {
     autocomplete?: string;
 };
 
+/**
+ * Parses a CSV string into headers and rows using PapaParse.
+ * Handles quoted fields, escaped quotes, empty values, and mixed line endings.
+ * @param content - The CSV content as a string
+ * @returns The parsed result with headers, rows, and any errors
+ * @public
+ */
+export declare function parseCsv(content: string): CsvParseResult;
+
 /**
  * Defines a renderer configuration in JSON forms.
  * Allows to specify the renderer component,
@@ -1575,7 +1858,7 @@ export declare type UiSchemaElementOptions = ConnectedRenderersOptions | NumberR
  * The layouts and control types, which allow you to customize the arrangement of forms.
  * @public
  */
-export declare type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
+export declare type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'FormGridLayout' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
 
 /**
  * All configuration options that are available.

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

@@ -10,12 +10,12 @@ Configuration options available for array renderer.
 
 ```typescript
 export type ArrayRendererOptions = {
-    childUiSchema?: UiSchema;
+    childUiSchema?: UiSchema | ChildUiSchemaResolver;
     addLabel?: string;
     deleteLabel?: string;
     border?: boolean;
     canDelete?: (item: any) => boolean;
 };
 ```
-**References:** [UiSchema](./foundation-forms.uischema.md)
+**References:** [UiSchema](./foundation-forms.uischema.md)<!-- -->, [ChildUiSchemaResolver](./foundation-forms.childuischemaresolver.md)
 

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [BulkRowStatus](./foundation-forms.bulkrowstatus.md)
+
+## BulkRowStatus type
+
+Tracks the submission status and result for a single row in bulk insert mode.
+
+**Signature:**
+
+```typescript
+export type BulkRowStatus = {
+    status: BulkRowSubmitStatus;
+    errors?: Array<{
+        CODE: string;
+        TEXT: string;
+    }>;
+    response?: any;
+};
+```
+**References:** [BulkRowSubmitStatus](./foundation-forms.bulkrowsubmitstatus.md)
+

package/docs/api/foundation-forms.bulkrowsubmitstatus.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; [BulkRowSubmitStatus](./foundation-forms.bulkrowsubmitstatus.md)
+
+## BulkRowSubmitStatus type
+
+Possible submission status values for a row in bulk insert mode.
+
+**Signature:**
+
+```typescript
+export type BulkRowSubmitStatus = 'pending' | 'submitting' | 'success' | 'failed';
+```

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [BulkSubmitFailedItem](./foundation-forms.bulksubmitfaileditem.md)
+
+## BulkSubmitFailedItem type
+
+Represents a failed bulk insert item result.
+
+**Signature:**
+
+```typescript
+export type BulkSubmitFailedItem = {
+    item: any;
+    index: number;
+    errors: Array<{
+        CODE: string;
+        TEXT: string;
+    }>;
+};
+```

package/docs/api/foundation-forms.bulksubmitresult.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; [BulkSubmitResult](./foundation-forms.bulksubmitresult.md)
+
+## BulkSubmitResult type
+
+Result of a bulk insert submission containing successful and failed items.
+
+**Signature:**
+
+```typescript
+export type BulkSubmitResult = {
+    successful: BulkSubmitSuccessItem[];
+    failed: BulkSubmitFailedItem[];
+};
+```
+**References:** [BulkSubmitSuccessItem](./foundation-forms.bulksubmitsuccessitem.md)<!-- -->, [BulkSubmitFailedItem](./foundation-forms.bulksubmitfaileditem.md)
+

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [BulkSubmitSuccessItem](./foundation-forms.bulksubmitsuccessitem.md)
+
+## BulkSubmitSuccessItem type
+
+Represents a successful bulk insert item result.
+
+**Signature:**
+
+```typescript
+export type BulkSubmitSuccessItem = {
+    item: any;
+    index: number;
+    response: any;
+};
+```

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [ChildUiSchemaResolver](./foundation-forms.childuischemaresolver.md)
+
+## ChildUiSchemaResolver type
+
+Resolver for dynamic per-row UI schema in array/bulk-insert mode. Receives the row index, that row's data, and the full form data.
+
+**Signature:**
+
+```typescript
+export type ChildUiSchemaResolver = (index: number, rowData: any, formData: any) => UiSchema;
+```
+**References:** [UiSchema](./foundation-forms.uischema.md)
+

package/docs/api/foundation-forms.csvmappingresult.mappedrows.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; [CsvMappingResult](./foundation-forms.csvmappingresult.md) &gt; [mappedRows](./foundation-forms.csvmappingresult.mappedrows.md)
+
+## CsvMappingResult.mappedRows property
+
+The mapped rows with values converted to appropriate types.
+
+**Signature:**
+
+```typescript
+mappedRows: Record<string, any>[];
+```

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

@@ -0,0 +1,77 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [CsvMappingResult](./foundation-forms.csvmappingresult.md)
+
+## CsvMappingResult interface
+
+Result of mapping CSV data to schema fields.
+
+**Signature:**
+
+```typescript
+export interface CsvMappingResult 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[mappedRows](./foundation-forms.csvmappingresult.mappedrows.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Record&lt;string, any&gt;\[\]
+
+
+</td><td>
+
+The mapped rows with values converted to appropriate types.
+
+
+</td></tr>
+<tr><td>
+
+[unmappedColumns](./foundation-forms.csvmappingresult.unmappedcolumns.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+CSV columns that could not be matched to schema fields.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-forms.csvmappingresult.unmappedcolumns.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; [CsvMappingResult](./foundation-forms.csvmappingresult.md) &gt; [unmappedColumns](./foundation-forms.csvmappingresult.unmappedcolumns.md)
+
+## CsvMappingResult.unmappedColumns property
+
+CSV columns that could not be matched to schema fields.
+
+**Signature:**
+
+```typescript
+unmappedColumns: string[];
+```

package/docs/api/foundation-forms.csvparseresult.errors.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; [CsvParseResult](./foundation-forms.csvparseresult.md) &gt; [errors](./foundation-forms.csvparseresult.errors.md)
+
+## CsvParseResult.errors property
+
+Any errors encountered during parsing.
+
+**Signature:**
+
+```typescript
+errors: string[];
+```

package/docs/api/foundation-forms.csvparseresult.headers.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; [CsvParseResult](./foundation-forms.csvparseresult.md) &gt; [headers](./foundation-forms.csvparseresult.headers.md)
+
+## CsvParseResult.headers property
+
+The header names from the first row of the CSV.
+
+**Signature:**
+
+```typescript
+headers: string[];
+```