@genesislcap/foundation-forms 14.408.0 → 14.409.0

package/docs/api/foundation-forms.csvmappingresult.mappedrows.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; [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

@@ -1,77 +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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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[];
-```

package/docs/api/foundation-forms.csvparseresult.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; [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

@@ -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; [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

@@ -1,74 +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; [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.filters.allsavedfilters.md

@@ -1,11 +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; [Filters](./foundation-forms.filters.md) &gt; [allSavedFilters](./foundation-forms.filters.allsavedfilters.md)
-
-## Filters.allSavedFilters property
-
-**Signature:**
-
-```typescript
-allSavedFilters: any[];
-```

package/docs/api/foundation-forms.filters.connectedcallback.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; [Filters](./foundation-forms.filters.md) &gt; [connectedCallback](./foundation-forms.filters.connectedcallback.md)
-
-## Filters.connectedCallback() method
-
-**Signature:**
-
-```typescript
-connectedCallback(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/foundation-forms.filters.data.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; [Filters](./foundation-forms.filters.md) &gt; [data](./foundation-forms.filters.data.md)
-
-## Filters.data property
-
-Initial data for the filters.
-
-**Signature:**
-
-```typescript
-data: any;
-```

package/docs/api/foundation-forms.filters.deletefilter.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; [Filters](./foundation-forms.filters.md) &gt; [deleteFilter](./foundation-forms.filters.deletefilter.md)
-
-## Filters.deleteFilter() method
-
-**Signature:**
-
-```typescript
-deleteFilter(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/foundation-forms.filters.filtername.md

@@ -1,11 +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; [Filters](./foundation-forms.filters.md) &gt; [filterName](./foundation-forms.filters.filtername.md)
-
-## Filters.filterName property
-
-**Signature:**
-
-```typescript
-filterName: string;
-```

package/docs/api/foundation-forms.filters.filternamechanged.md

@@ -1,64 +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; [Filters](./foundation-forms.filters.md) &gt; [filterNameChanged](./foundation-forms.filters.filternamechanged.md)
-
-## Filters.filterNameChanged() method
-
-**Signature:**
-
-```typescript
-filterNameChanged(oldValue: string, newValue: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-oldValue
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-newValue
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-forms.filters.jsonschema.md

@@ -1,18 +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; [Filters](./foundation-forms.filters.md) &gt; [jsonSchema](./foundation-forms.filters.jsonschema.md)
-
-## Filters.jsonSchema property
-
-Alternatively to providing [Form.resourceName](./foundation-forms.form.resourcename.md) you can hardcode the JSON schema on the client.
-
-**Signature:**
-
-```typescript
-jsonSchema: JSONSchema7;
-```
-
-## Remarks
-
-Use this when you want to avoid fetching metadata from the server but be aware that it could get out of sync if metadata changes on the server
-

package/docs/api/foundation-forms.filters.kvstorage.md

@@ -1,11 +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; [Filters](./foundation-forms.filters.md) &gt; [kvStorage](./foundation-forms.filters.kvstorage.md)
-
-## Filters.kvStorage property
-
-**Signature:**
-
-```typescript
-kvStorage: KVStorage;
-```

package/docs/api/foundation-forms.filters.loadallsavedfilters.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; [Filters](./foundation-forms.filters.md) &gt; [loadAllSavedFilters](./foundation-forms.filters.loadallsavedfilters.md)
-
-## Filters.loadAllSavedFilters() method
-
-**Signature:**
-
-```typescript
-loadAllSavedFilters(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/foundation-forms.filters.loadfilterdata.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; [Filters](./foundation-forms.filters.md) &gt; [loadFilterData](./foundation-forms.filters.loadfilterdata.md)
-
-## Filters.loadFilterData() method
-
-**Signature:**
-
-```typescript
-loadFilterData(filterKey: string): Promise<void>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-filterKey
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-