@genesislcap/foundation-forms 14.407.0 → 14.408.0-icon-renderer.3

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

@@ -1,13 +0,0 @@
-<!-- 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; [resourceName](./foundation-forms.form.resourcename.md)
-
-## Form.resourceName property
-
-Name of the backend resource which will provide metadata used to generate form and later used for submitting data
-
-**Signature:**
-
-```typescript
-resourceName: string;
-```

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

@@ -1,13 +0,0 @@
-<!-- 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.setapprovalmessage.md

@@ -1,13 +0,0 @@
-<!-- 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; [setApprovalMessage](./foundation-forms.form.setapprovalmessage.md)
-
-## Form.setApprovalMessage property
-
-When enabled, adds an APPROVAL\_MESSAGE field to the form schema. This field will be sent at root level alongside DETAILS when submitting.
-
-**Signature:**
-
-```typescript
-setApprovalMessage: boolean;
-```

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

@@ -1,56 +0,0 @@
-<!-- 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.form.uischema.md

@@ -1,50 +0,0 @@
-<!-- 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; [uischema](./foundation-forms.form.uischema.md)
-
-## Form.uischema property
-
-UI schema used to define configuration of the layout and elements in the form Check [UiSchema](./foundation-forms.uischema.md) for possible options
-
-**Signature:**
-
-```typescript
-uischema: UiSchema;
-```
-
-## Remarks
-
-If not provided will be autogenerated based on json schema or initial data
-
-## Example
-
-Here's a simple example:
-
-```
-const sampleUISchema = {
-  type: 'VerticalLayout',
-  elements: [
-    {
-      type: 'Control',
-      scope: '#/properties/QUANTITY',
-      label: 'Quantity',
-    },
-    {
-      type: 'Control',
-      scope: '#/properties/INSTRUMENT_ID',
-      options: {
-        allOptionsResourceName: 'INSTRUMENT',
-        valueField: 'INSTRUMENT_ID',
-        labelField: 'INSTRUMENT_ID',
-      },
-      label: 'Instrument',
-    },
-    {
-      type: 'Control',
-      scope: '#/properties/SIDE',
-      label: 'Side',
-    },
-  ],
-};
-```
-

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

@@ -1,104 +0,0 @@
-<!-- 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
-

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

@@ -1,96 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [getAnyOfErrorMessage](./foundation-forms.getanyoferrormessage.md)
-
-## getAnyOfErrorMessage() function
-
-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.
-
-**Signature:**
-
-```typescript
-getAnyOfErrorMessage: (errors: Array<any> | undefined, schema: any, controlPath: string | undefined, uiCustomMsg?: string) => string
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-errors
-
-
-</td><td>
-
-Array&lt;any&gt; \| undefined
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-schema
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-controlPath
-
-
-</td><td>
-
-string \| undefined
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-uiCustomMsg
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-

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

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [GroupRendererOptions](./foundation-forms.grouprendereroptions.md)
-
-## GroupRendererOptions type
-
-Configuration options available for group renderer.
-
-**Signature:**
-
-```typescript
-export type GroupRendererOptions = CategorizationRendererOptions;
-```
-**References:** [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)
-

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

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [LabelPlacementOptions](./foundation-forms.labelplacementoptions.md)
-
-## LabelPlacementOptions type
-
-Orientation options available for stepper renderer.
-
-**Signature:**
-
-```typescript
-export type LabelPlacementOptions = {
-    labelPlacement?: LabelPlacementType;
-};
-```
-**References:** [LabelPlacementType](./foundation-forms.labelplacementtype.md)
-

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [LabelPlacementType](./foundation-forms.labelplacementtype.md)
-
-## LabelPlacementType type
-
-Available aligment for labels.
-
-**Signature:**
-
-```typescript
-export type LabelPlacementType = 'top' | 'left';
-```

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

@@ -1,88 +0,0 @@
-<!-- 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
-