npm - @genesislcap/foundation-forms - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-forms 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (88) hide show

package/docs/api/foundation-forms.md DELETED Viewed

@@ -1,516 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md)
-## foundation-forms package
-## Classes
-<table><thead><tr><th>
-Class
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[Filters](./foundation-forms.filters.md)
-</td><td>
-Foundation filters component for automatically generated filters based on json schema obtained from the api, supplied initial data or supplied JSON schema. Allowing customisable filters elements using UI schema and set of custom renderers
-</td></tr>
-<tr><td>
-[Form](./foundation-forms.form.md)
-</td><td>
-Foundation form component for automatically generated forms based on json schema obtained from the api, supplied initial data or supplied JSON schema. Allowing customisable form elements using UI schema and set of custom renderers
-</td></tr>
-</tbody></table>
-## Functions
-<table><thead><tr><th>
-Function
-</th><th>
-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)
-</td><td>
-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>
-[MulticolumnDropdownControlRendererTemplate(prefix)](./foundation-forms.multicolumndropdowncontrolrenderertemplate.md)
-</td><td>
-**_(BETA)_** A JSON Forms renderer that uses the multicolumn-dropdown component.
-Activated when the uischema element has `columnDefinitions` set. Takes precedence over `ConnectedSelectControlRendererEntry` due to its higher rank.
-Options are typed via [MulticolumnDropdownRendererOptions](./foundation-forms.multicolumndropdownrendereroptions.md)<!-- -->.
-</td></tr>
-<tr><td>
-[mustMatch(target)](./foundation-forms.mustmatch.md)
-</td><td>
-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>
-## Variables
-<table><thead><tr><th>
-Variable
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[filtersRenderers](./foundation-forms.filtersrenderers.md)
-</td><td>
-Set of default renderers used by the foundation-filters.
-</td></tr>
-<tr><td>
-[MulticolumnDropdownControlRendererEntry](./foundation-forms.multicolumndropdowncontrolrendererentry.md)
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[renderers](./foundation-forms.renderers.md)
-</td><td>
-Set of default renderers used by the foundation-forms.
-</td></tr>
-</tbody></table>
-## Type Aliases
-<table><thead><tr><th>
-Type Alias
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[ArrayRendererOptions](./foundation-forms.arrayrendereroptions.md)
-</td><td>
-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>
-[CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)
-</td><td>
-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>
-[ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md)
-</td><td>
-Available configuration options for connected combobox/multiselect.
-</td></tr>
-<tr><td>
-[GroupRendererOptions](./foundation-forms.grouprendereroptions.md)
-</td><td>
-Configuration options available for group renderer.
-</td></tr>
-<tr><td>
-[LabelPlacementOptions](./foundation-forms.labelplacementoptions.md)
-</td><td>
-Orientation options available for stepper renderer.
-</td></tr>
-<tr><td>
-[LabelPlacementType](./foundation-forms.labelplacementtype.md)
-</td><td>
-Available aligment for labels.
-</td></tr>
-<tr><td>
-[MulticolumnDropdownRendererOptions](./foundation-forms.multicolumndropdownrendereroptions.md)
-</td><td>
-Configuration options for the multicolumn-dropdown renderer.
-Shares `allOptionsResourceName` with [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md) so the same reqrep/dataserver resource name field is reused. The renderer is activated when `columnDefinitions` is present (higher rank than the combobox renderer).
-</td></tr>
-<tr><td>
-[NumberRendererOptions](./foundation-forms.numberrendereroptions.md)
-</td><td>
-Configuration options available for number renderer.
-</td></tr>
-<tr><td>
-[RendererEntry](./foundation-forms.rendererentry.md)
-</td><td>
-Defines a renderer configuration in JSON forms. Allows to specify the renderer component, a tester function to determine renderer applicability, and a mapper function to connect JSON forms state to renderer's props.
-</td></tr>
-<tr><td>
-[StandardRendererOptions](./foundation-forms.standardrendereroptions.md)
-</td><td>
-Standard configuration options available for all renderers.
-</td></tr>
-<tr><td>
-[StepperOrientationOptions](./foundation-forms.stepperorientationoptions.md)
-</td><td>
-Orientation options available for stepper renderer.
-</td></tr>
-<tr><td>
-[StepperOrientationType](./foundation-forms.stepperorientationtype.md)
-</td><td>
-Available orientation for stepper renderer.
-</td></tr>
-<tr><td>
-[StepperRendererOptions](./foundation-forms.stepperrendereroptions.md)
-</td><td>
-Configuration options available for stepper renderer.
-</td></tr>
-<tr><td>
-[StringRendererOptions](./foundation-forms.stringrendereroptions.md)
-</td><td>
-Configuration options available for string renderer.
-</td></tr>
-<tr><td>
-[UiSchema](./foundation-forms.uischema.md)
-</td><td>
-The UI schema, which is passed to JSON Forms, describes the general layout of a form and is just a regular JSON object. It describes the form by means of different UI schema elements, which can often be categorized into either Controls or Layouts.
-</td></tr>
-<tr><td>
-[UiSchemaElement](./foundation-forms.uischemaelement.md)
-</td><td>
-A UiSchemaElement that displays property values in a user interface element.
-</td></tr>
-<tr><td>
-[UiSchemaElementOptions](./foundation-forms.uischemaelementoptions.md)
-</td><td>
-All configuration options that are available.
-</td></tr>
-<tr><td>
-[UiSchemaElementType](./foundation-forms.uischemaelementtype.md)
-</td><td>
-The layouts and control types, which allow you to customize the arrangement of forms.
-</td></tr>
-<tr><td>
-[UiSchemaOptions](./foundation-forms.uischemaoptions.md)
-</td><td>
-All configuration options that are available.
-</td></tr>
-</tbody></table>

package/docs/api/foundation-forms.multicolumndropdowncontrolrendererentry.md DELETED Viewed

@@ -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; [MulticolumnDropdownControlRendererEntry](./foundation-forms.multicolumndropdowncontrolrendererentry.md)
-## MulticolumnDropdownControlRendererEntry variable
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-MulticolumnDropdownControlRendererEntry: any
-```

package/docs/api/foundation-forms.multicolumndropdowncontrolrenderertemplate.md DELETED Viewed

@@ -1,82 +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; [MulticolumnDropdownControlRendererTemplate](./foundation-forms.multicolumndropdowncontrolrenderertemplate.md)
-## MulticolumnDropdownControlRendererTemplate() function
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-A JSON Forms renderer that uses the multicolumn-dropdown component.
-Activated when the uischema element has `columnDefinitions` set. Takes precedence over `ConnectedSelectControlRendererEntry` due to its higher rank.
-Options are typed via [MulticolumnDropdownRendererOptions](./foundation-forms.multicolumndropdownrendereroptions.md)<!-- -->.
-**Signature:**
-```typescript
-MulticolumnDropdownControlRendererTemplate: (prefix?: string) => import("@microsoft/fast-element").ViewTemplate<DispatchRenderer, any>
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-prefix
-</td><td>
-string
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
-**Returns:**
-import("@microsoft/fast-element").ViewTemplate&lt;DispatchRenderer, any&gt;
-## Example
-```ts
-{
-  type: 'Control',
-  scope: '#/properties/INSTRUMENT_ID',
-  label: 'Instrument',
-  options: <MulticolumnDropdownRendererOptions>{
-    allOptionsResourceName: 'ALL_INSTRUMENTS',
-    valueField: 'INSTRUMENT_ID',
-    labelField: 'NAME',
-    searchKey: ['INSTRUMENT_ID', 'NAME'],
-    columnDefinitions: [
-      { field: 'INSTRUMENT_ID', headerName: 'ID' },
-      { field: 'NAME', headerName: 'Name' },
-    ],
-  },
-}
-```

package/docs/api/foundation-forms.multicolumndropdownrendereroptions.md DELETED Viewed

@@ -1,25 +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; [MulticolumnDropdownRendererOptions](./foundation-forms.multicolumndropdownrendereroptions.md)
-## MulticolumnDropdownRendererOptions type
-Configuration options for the multicolumn-dropdown renderer.
-Shares `allOptionsResourceName` with [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md) so the same reqrep/dataserver resource name field is reused. The renderer is activated when `columnDefinitions` is present (higher rank than the combobox renderer).
-**Signature:**
-```typescript
-export type MulticolumnDropdownRendererOptions = Pick<ConnectedRenderersOptions, 'allOptionsResourceName' | 'valueField' | 'labelField'> & {
-    searchKey?: string | string[];
-    columnDefinitions: Record<string, unknown>[];
-    request?: Record<string, unknown>;
-    baseCriteria?: string;
-    advancedSearchReq?: boolean;
-    dropdownPlacement?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
-    dropdownWidth?: number;
-};
-```
-**References:** [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md)

package/docs/api/foundation-forms.mustmatch.md DELETED Viewed

@@ -1,62 +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; [mustMatch](./foundation-forms.mustmatch.md)
-## mustMatch() function
-Ensures the value of the current field (the one the validator is on) matches the one of the target field.
-**Signature:**
-```typescript
-mustMatch: (target: string) => (data: any, path: any, label: any) => {
-    instancePath: string;
-    message: string;
-    schemaPath: string;
-    keyword: string;
-    params: {};
-}[]
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-target
-</td><td>
-string
-</td><td>
-any other field
-</td></tr>
-</tbody></table>
-**Returns:**
-(data: any, path: any, label: any) =&gt; { instancePath: string; message: string; schemaPath: string; keyword: string; params: {}; }\[\]
-a validator function that will be run by the smart form during the client-side validation stage

package/docs/api/foundation-forms.numberrendereroptions.md DELETED Viewed

@@ -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; [NumberRendererOptions](./foundation-forms.numberrendereroptions.md)
-## NumberRendererOptions type
-Configuration options available for number renderer.
-**Signature:**
-```typescript
-export type NumberRendererOptions = {
-    withoutFormatting?: boolean;
-    formatOptions?: Intl.NumberFormatOptions;
-    autocomplete?: string;
-};
-```