@genesislcap/foundation-forms 14.397.2 → 14.398.0

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

@@ -0,0 +1,88 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [mapCsvToSchema](./foundation-forms.mapcsvtoschema.md)
+
+## mapCsvToSchema() function
+
+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.
+
+**Signature:**
+
+```typescript
+export declare function mapCsvToSchema(csvRows: Record<string, string>[], schema: JSONSchema7 | undefined, uiSchema?: UiSchema): CsvMappingResult;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+csvRows
+
+
+</td><td>
+
+Record&lt;string, string&gt;\[\]
+
+
+</td><td>
+
+The parsed CSV rows
+
+
+</td></tr>
+<tr><td>
+
+schema
+
+
+</td><td>
+
+JSONSchema7 \| undefined
+
+
+</td><td>
+
+The JSON schema defining the fields
+
+
+</td></tr>
+<tr><td>
+
+uiSchema
+
+
+</td><td>
+
+[UiSchema](./foundation-forms.uischema.md)
+
+
+</td><td>
+
+_(Optional)_ Optional UI schema to map labels to field names on import
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[CsvMappingResult](./foundation-forms.csvmappingresult.md)
+
+Mapped rows and list of unmapped columns
+

package/docs/api/foundation-forms.md

@@ -56,6 +56,28 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[downloadCsvTemplate(csvContent, fileName)](./foundation-forms.downloadcsvtemplate.md)
+
+
+</td><td>
+
+Triggers a download of the CSV template file in the browser.
+
+
+</td></tr>
+<tr><td>
+
+[generateCsvTemplate(schema, uiSchema, includeOptionalFields, includeBom)](./foundation-forms.generatecsvtemplate.md)
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+<tr><td>
+
 [getAnyOfErrorMessage(errors, schema, controlPath, uiCustomMsg)](./foundation-forms.getanyoferrormessage.md)
 
 
@@ -64,6 +86,17 @@ Description
 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.
 
 
+</td></tr>
+<tr><td>
+
+[mapCsvToSchema(csvRows, schema, uiSchema)](./foundation-forms.mapcsvtoschema.md)
+
+
+</td><td>
+
+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.
+
+
 </td></tr>
 <tr><td>
 
@@ -75,6 +108,54 @@ Computes a human-friendly anyOf error message for a given control path. Prefers
 Ensures the value of the current field (the one the validator is on) matches the one of the target field.
 
 
+</td></tr>
+<tr><td>
+
+[parseCsv(content)](./foundation-forms.parsecsv.md)
+
+
+</td><td>
+
+Parses a CSV string into headers and rows using PapaParse. Handles quoted fields, escaped quotes, empty values, and mixed line endings.
+
+
+</td></tr>
+</tbody></table>
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[CsvMappingResult](./foundation-forms.csvmappingresult.md)
+
+
+</td><td>
+
+Result of mapping CSV data to schema fields.
+
+
+</td></tr>
+<tr><td>
+
+[CsvParseResult](./foundation-forms.csvparseresult.md)
+
+
+</td><td>
+
+Result of parsing a CSV file.
+
+
 </td></tr>
 </tbody></table>
 
@@ -138,6 +219,61 @@ Description
 Configuration options available for array renderer.
 
 
+</td></tr>
+<tr><td>
+
+[BulkRowStatus](./foundation-forms.bulkrowstatus.md)
+
+
+</td><td>
+
+Tracks the submission status and result for a single row in bulk insert mode.
+
+
+</td></tr>
+<tr><td>
+
+[BulkRowSubmitStatus](./foundation-forms.bulkrowsubmitstatus.md)
+
+
+</td><td>
+
+Possible submission status values for a row in bulk insert mode.
+
+
+</td></tr>
+<tr><td>
+
+[BulkSubmitFailedItem](./foundation-forms.bulksubmitfaileditem.md)
+
+
+</td><td>
+
+Represents a failed bulk insert item result.
+
+
+</td></tr>
+<tr><td>
+
+[BulkSubmitResult](./foundation-forms.bulksubmitresult.md)
+
+
+</td><td>
+
+Result of a bulk insert submission containing successful and failed items.
+
+
+</td></tr>
+<tr><td>
+
+[BulkSubmitSuccessItem](./foundation-forms.bulksubmitsuccessitem.md)
+
+
+</td><td>
+
+Represents a successful bulk insert item result.
+
+
 </td></tr>
 <tr><td>
 
@@ -149,6 +285,17 @@ Configuration options available for array renderer.
 Configuration options available for categorization renderer.
 
 
+</td></tr>
+<tr><td>
+
+[ChildUiSchemaResolver](./foundation-forms.childuischemaresolver.md)
+
+
+</td><td>
+
+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.
+
+
 </td></tr>
 <tr><td>
 

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

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [parseCsv](./foundation-forms.parsecsv.md)
+
+## parseCsv() function
+
+Parses a CSV string into headers and rows using PapaParse. Handles quoted fields, escaped quotes, empty values, and mixed line endings.
+
+**Signature:**
+
+```typescript
+export declare function parseCsv(content: string): CsvParseResult;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+content
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The CSV content as a string
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[CsvParseResult](./foundation-forms.csvparseresult.md)
+
+The parsed result with headers, rows, and any errors
+

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

@@ -9,5 +9,5 @@ The layouts and control types, which allow you to customize the arrangement of f
 **Signature:**
 
 ```typescript
-export type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
+export type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'FormGridLayout' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
 ```

package/docs/api-report.md.api.md

@@ -31,18 +31,57 @@ import { ViewTemplate } from '@microsoft/fast-element';
 
 // @public
 export type ArrayRendererOptions = {
-    childUiSchema?: UiSchema;
+    childUiSchema?: UiSchema | ChildUiSchemaResolver;
     addLabel?: string;
     deleteLabel?: string;
     border?: boolean;
     canDelete?: (item: any) => boolean;
 };
 
+// @public
+export type BulkRowStatus = {
+    status: BulkRowSubmitStatus;
+    errors?: Array<{
+        CODE: string;
+        TEXT: string;
+    }>;
+    response?: any;
+};
+
+// @public
+export type BulkRowSubmitStatus = 'pending' | 'submitting' | 'success' | 'failed';
+
+// @public
+export type BulkSubmitFailedItem = {
+    item: any;
+    index: number;
+    errors: Array<{
+        CODE: string;
+        TEXT: string;
+    }>;
+};
+
+// @public
+export type BulkSubmitResult = {
+    successful: BulkSubmitSuccessItem[];
+    failed: BulkSubmitFailedItem[];
+};
+
+// @public
+export type BulkSubmitSuccessItem = {
+    item: any;
+    index: number;
+    response: any;
+};
+
 // @public
 export type CategorizationRendererOptions = {
     childElements?: UiSchema[];
 };
 
+// @public
+export type ChildUiSchemaResolver = (index: number, rowData: any, formData: any) => UiSchema;
+
 // Warning: (ae-internal-missing-underscore) The name "comboboxRendererStyles" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal (undocumented)
@@ -75,6 +114,31 @@ export type ConnectedRenderersOptions = {
 // @internal
 export const createExpressions: (payload: any) => Expressions;
 
+// @public
+export interface CsvMappingResult {
+    mappedRows: Record<string, any>[];
+    unmappedColumns: string[];
+}
+
+// @public
+export interface CsvParseResult {
+    errors: string[];
+    headers: string[];
+    rows: Record<string, string>[];
+}
+
+// @public
+export function downloadCsvTemplate(csvContent: string, fileName?: string): void;
+
+// Warning: (ae-internal-missing-underscore) The name "extractFieldsFromUiSchema" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export function extractFieldsFromUiSchema(uiSchema: UiSchema): Array<{
+    fieldName: string;
+    label?: string;
+    isHidden: boolean;
+}>;
+
 // Warning: (ae-forgotten-export) The symbol "Filters_base" needs to be exported by the entry point index.d.ts
 //
 // @public
@@ -137,14 +201,22 @@ export class Form extends Form_base {
     approvalMessageLabel: string;
     // @internal
     approvalModal: any;
+    bulkInsert: boolean;
+    bulkInsertMaxItems: number | undefined;
+    bulkInsertMinItems: number;
+    clearRowSubmitStatuses(): void;
     // @internal
     closeApprovalModal(): void;
     confirmationMessage: string;
+    // @internal
+    csvFileInput: HTMLInputElement;
     data: any;
     // @internal (undocumented)
     deepClone(): Node;
     // @internal (undocumented)
     disconnectedCallback(): void;
+    downloadCsvTemplate(): void;
+    handleCsvFileSelected(event: Event): Promise<void>;
     hideSubmit: boolean;
     // @internal
     get isSubmitHidden(): boolean;
@@ -160,11 +232,13 @@ export class Form extends Form_base {
     renderersChanged(): void;
     reset(clearData?: boolean): void;
     resourceName: string;
+    rowSubmitStatuses: Map<number, BulkRowStatus>;
     setApprovalMessage: boolean;
     // @internal (undocumented)
     _submit(): Promise<void>;
     // @internal (undocumented)
     submitPart(event: CustomEvent): void;
+    submitSingleRow(index: number): Promise<void>;
     // @internal (undocumented)
     submitted: boolean;
     // @internal (undocumented)
@@ -184,6 +258,9 @@ export const foundationFormStyles: ElementStyles;
 // @internal (undocumented)
 export const foundationFormTemplate: ViewTemplate<Form, any>;
 
+// @public
+export function generateCsvTemplate(schema: JSONSchema7 | undefined, uiSchema?: UiSchema, includeOptionalFields?: boolean, includeBom?: boolean): string;
+
 // Warning: (ae-internal-missing-underscore) The name "genesisErrorTranslator" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal (undocumented)
@@ -243,6 +320,9 @@ export { Layout }
 // @internal (undocumented)
 export const logger: Logger;
 
+// @public
+export function mapCsvToSchema(csvRows: Record<string, string>[], schema: JSONSchema7 | undefined, uiSchema?: UiSchema): CsvMappingResult;
+
 // @public
 export const mustMatch: (target: string) => (data: any, path: any, label: any) => {
     instancePath: string;
@@ -259,6 +339,9 @@ export type NumberRendererOptions = {
     autocomplete?: string;
 };
 
+// @public
+export function parseCsv(content: string): CsvParseResult;
+
 // @public
 export type RendererEntry = {
     renderer: ViewTemplate<DispatchRenderer, any>;
@@ -322,15 +405,15 @@ export type UiSchemaElement = {
 export type UiSchemaElementOptions = ConnectedRenderersOptions | NumberRendererOptions | ArrayRendererOptions | CategorizationRendererOptions | GroupRendererOptions | StepperRendererOptions | StringRendererOptions | StandardRendererOptions;
 
 // @public
-export type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
+export type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'FormGridLayout' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
 
 // @public
 export type UiSchemaOptions = StepperOrientationOptions | LabelPlacementOptions;
 
 // Warnings were encountered during analysis:
 //
-// src/types.ts:368:3 - (ae-forgotten-export) The symbol "Rule" needs to be exported by the entry point index.d.ts
-// src/types.ts:418:3 - (ae-forgotten-export) The symbol "DispatchRenderer" needs to be exported by the entry point index.d.ts
+// src/types.ts:378:3 - (ae-forgotten-export) The symbol "Rule" needs to be exported by the entry point index.d.ts
+// src/types.ts:428:3 - (ae-forgotten-export) The symbol "DispatchRenderer" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-forms",
   "description": "Genesis Foundation Forms",
-  "version": "14.397.2",
+  "version": "14.398.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -50,22 +50,23 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.397.2",
-    "@genesislcap/genx": "14.397.2",
-    "@genesislcap/rollup-builder": "14.397.2",
-    "@genesislcap/ts-builder": "14.397.2",
-    "@genesislcap/uvu-playwright-builder": "14.397.2",
-    "@genesislcap/vite-builder": "14.397.2",
-    "@genesislcap/webpack-builder": "14.397.2",
-    "@types/json-schema": "^7.0.11"
+    "@genesislcap/foundation-testing": "14.398.0",
+    "@genesislcap/genx": "14.398.0",
+    "@genesislcap/rollup-builder": "14.398.0",
+    "@genesislcap/ts-builder": "14.398.0",
+    "@genesislcap/uvu-playwright-builder": "14.398.0",
+    "@genesislcap/vite-builder": "14.398.0",
+    "@genesislcap/webpack-builder": "14.398.0",
+    "@types/json-schema": "^7.0.11",
+    "@types/papaparse": "^5.3.14"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.397.2",
-    "@genesislcap/foundation-criteria": "14.397.2",
-    "@genesislcap/foundation-logger": "14.397.2",
-    "@genesislcap/foundation-notifications": "14.397.2",
-    "@genesislcap/foundation-ui": "14.397.2",
-    "@genesislcap/foundation-utils": "14.397.2",
+    "@genesislcap/foundation-comms": "14.398.0",
+    "@genesislcap/foundation-criteria": "14.398.0",
+    "@genesislcap/foundation-logger": "14.398.0",
+    "@genesislcap/foundation-notifications": "14.398.0",
+    "@genesislcap/foundation-ui": "14.398.0",
+    "@genesislcap/foundation-utils": "14.398.0",
     "@json-schema-tools/dereferencer": "^1.6.1",
     "@jsonforms/core": "^3.2.1",
     "@microsoft/fast-components": "2.30.6",
@@ -75,7 +76,8 @@
     "ajv": "8.16.0",
     "change-case": "^4.1.2",
     "json-schema": "^0.4.0",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "papaparse": "^5.4.1"
   },
   "repository": {
     "type": "git",
@@ -86,5 +88,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "8e32dc60112b589e801fe0ea5bd0f6cd10edbdf7"
+  "gitHead": "d9c0d13f49958e386d339075078dc15561455c18"
 }