@genesislcap/foundation-forms 14.397.2 → 14.398.0

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

@@ -0,0 +1,96 @@
+<!-- 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)
+
+## CsvParseResult interface
+
+Result of parsing a CSV file.
+
+**Signature:**
+
+```typescript
+export interface CsvParseResult 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[errors](./foundation-forms.csvparseresult.errors.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+Any errors encountered during parsing.
+
+
+</td></tr>
+<tr><td>
+
+[headers](./foundation-forms.csvparseresult.headers.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+The header names from the first row of the CSV.
+
+
+</td></tr>
+<tr><td>
+
+[rows](./foundation-forms.csvparseresult.rows.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Record&lt;string, string&gt;\[\]
+
+
+</td><td>
+
+The parsed data rows as key-value objects.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-forms.csvparseresult.rows.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; [rows](./foundation-forms.csvparseresult.rows.md)
+
+## CsvParseResult.rows property
+
+The parsed data rows as key-value objects.
+
+**Signature:**
+
+```typescript
+rows: Record<string, string>[];
+```

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

@@ -0,0 +1,74 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [downloadCsvTemplate](./foundation-forms.downloadcsvtemplate.md)
+
+## downloadCsvTemplate() function
+
+Triggers a download of the CSV template file in the browser.
+
+**Signature:**
+
+```typescript
+export declare function downloadCsvTemplate(csvContent: string, fileName?: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+csvContent
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The CSV content to download
+
+
+</td></tr>
+<tr><td>
+
+fileName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The name for the downloaded file (default: 'template.csv')
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+
+## Remarks
+
+Browser-only; uses document and URL.createObjectURL. Will throw in Node.js.
+

package/docs/api/foundation-forms.form.bulkinsert.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; [Form](./foundation-forms.form.md) &gt; [bulkInsert](./foundation-forms.form.bulkinsert.md)
+
+## Form.bulkInsert property
+
+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.
+
+**Signature:**
+
+```typescript
+bulkInsert: boolean;
+```

package/docs/api/foundation-forms.form.bulkinsertmaxitems.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; [Form](./foundation-forms.form.md) &gt; [bulkInsertMaxItems](./foundation-forms.form.bulkinsertmaxitems.md)
+
+## Form.bulkInsertMaxItems property
+
+Maximum number of items allowed in bulk insert mode. If not set, no maximum is enforced.
+
+**Signature:**
+
+```typescript
+bulkInsertMaxItems: number | undefined;
+```

package/docs/api/foundation-forms.form.bulkinsertminitems.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; [Form](./foundation-forms.form.md) &gt; [bulkInsertMinItems](./foundation-forms.form.bulkinsertminitems.md)
+
+## Form.bulkInsertMinItems property
+
+Minimum number of items required in bulk insert mode.
+
+**Signature:**
+
+```typescript
+bulkInsertMinItems: number;
+```

package/docs/api/foundation-forms.form.clearrowsubmitstatuses.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; [Form](./foundation-forms.form.md) &gt; [clearRowSubmitStatuses](./foundation-forms.form.clearrowsubmitstatuses.md)
+
+## Form.clearRowSubmitStatuses() method
+
+Clears all row submit statuses, typically called when resetting the form.
+
+**Signature:**
+
+```typescript
+clearRowSubmitStatuses(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-forms.form.downloadcsvtemplate.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; [Form](./foundation-forms.form.md) &gt; [downloadCsvTemplate](./foundation-forms.form.downloadcsvtemplate.md)
+
+## Form.downloadCsvTemplate() method
+
+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.
+
+**Signature:**
+
+```typescript
+downloadCsvTemplate(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-forms.form.handlecsvfileselected.md

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [Form](./foundation-forms.form.md) &gt; [handleCsvFileSelected](./foundation-forms.form.handlecsvfileselected.md)
+
+## Form.handleCsvFileSelected() method
+
+Handles CSV file selection for bulk import. Parses the CSV content and appends it to existing form items.
+
+**Signature:**
+
+```typescript
+handleCsvFileSelected(event: Event): Promise<void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+event
+
+
+</td><td>
+
+Event
+
+
+</td><td>
+
+The file input change event
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;void&gt;
+

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

@@ -73,6 +73,63 @@ string
 Label for the approval message field in the approval dialog.
 
 
+</td></tr>
+<tr><td>
+
+[bulkInsert](./foundation-forms.form.bulkinsert.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+<tr><td>
+
+[bulkInsertMaxItems](./foundation-forms.form.bulkinsertmaxitems.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number \| undefined
+
+
+</td><td>
+
+Maximum number of items allowed in bulk insert mode. If not set, no maximum is enforced.
+
+
+</td></tr>
+<tr><td>
+
+[bulkInsertMinItems](./foundation-forms.form.bulkinsertminitems.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+Minimum number of items required in bulk insert mode.
+
+
 </td></tr>
 <tr><td>
 
@@ -225,6 +282,25 @@ string
 Name of the backend resource which will provide metadata used to generate form and later used for submitting data
 
 
+</td></tr>
+<tr><td>
+
+[rowSubmitStatuses](./foundation-forms.form.rowsubmitstatuses.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Map&lt;number, [BulkRowStatus](./foundation-forms.bulkrowstatus.md)<!-- -->&gt;
+
+
+</td><td>
+
+Tracks the submission status for each row in bulk insert mode. Key is the row index, value is the status object.
+
+
 </td></tr>
 <tr><td>
 
@@ -286,6 +362,48 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[clearRowSubmitStatuses()](./foundation-forms.form.clearrowsubmitstatuses.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Clears all row submit statuses, typically called when resetting the form.
+
+
+</td></tr>
+<tr><td>
+
+[downloadCsvTemplate()](./foundation-forms.form.downloadcsvtemplate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+<tr><td>
+
+[handleCsvFileSelected(event)](./foundation-forms.form.handlecsvfileselected.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Handles CSV file selection for bulk import. Parses the CSV content and appends it to existing form items.
+
+
+</td></tr>
+<tr><td>
+
 [reset(clearData)](./foundation-forms.form.reset.md)
 
 
@@ -297,6 +415,20 @@ Description
 Reset the form state
 
 
+</td></tr>
+<tr><td>
+
+[submitSingleRow(index)](./foundation-forms.form.submitsinglerow.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Submits a single row in bulk insert mode.
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-forms.form.rowsubmitstatuses.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; [Form](./foundation-forms.form.md) &gt; [rowSubmitStatuses](./foundation-forms.form.rowsubmitstatuses.md)
+
+## Form.rowSubmitStatuses property
+
+Tracks the submission status for each row in bulk insert mode. Key is the row index, value is the status object.
+
+**Signature:**
+
+```typescript
+rowSubmitStatuses: Map<number, BulkRowStatus>;
+```

package/docs/api/foundation-forms.form.submitsinglerow.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; [Form](./foundation-forms.form.md) &gt; [submitSingleRow](./foundation-forms.form.submitsinglerow.md)
+
+## Form.submitSingleRow() method
+
+Submits a single row in bulk insert mode.
+
+**Signature:**
+
+```typescript
+submitSingleRow(index: number): Promise<void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+index
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The index of the row to submit
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;void&gt;
+
+Promise that resolves when submission is complete
+

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

@@ -0,0 +1,104 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [generateCsvTemplate](./foundation-forms.generatecsvtemplate.md)
+
+## generateCsvTemplate() function
+
+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.
+
+**Signature:**
+
+```typescript
+export declare function generateCsvTemplate(schema: JSONSchema7 | undefined, uiSchema?: UiSchema, includeOptionalFields?: boolean, includeBom?: boolean): string;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><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 determine field order and visibility
+
+
+</td></tr>
+<tr><td>
+
+includeOptionalFields
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether to include optional fields when no UI schema (default: true)
+
+
+</td></tr>
+<tr><td>
+
+includeBom
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether to prepend UTF-8 BOM for Excel compatibility (default: true)
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+string
+
+The CSV template string with headers and one sample row
+