@genesislcap/foundation-forms 14.408.0 → 14.409.0

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

@@ -1,440 +0,0 @@
-## API Report File for "@genesislcap/foundation-forms"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { Controller } from '@microsoft/fast-element';
-import { DatasourceOptions } from '@genesislcap/foundation-comms';
-import { DOMContainer } from '@genesislcap/foundation-utils';
-import { ElementStyles } from '@microsoft/fast-element';
-import { ErrorObject } from 'ajv';
-import { ErrorTranslator } from '@jsonforms/core';
-import { Expression } from '@genesislcap/foundation-criteria';
-import { FASTElement } from '@microsoft/fast-element';
-import { FilterMode } from '@genesislcap/foundation-ui';
-import { FoundationElement } from '@microsoft/fast-foundation';
-import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
-import { JsonFormsState } from '@jsonforms/core';
-import { JSONSchema7 } from 'json-schema';
-import { KVStorage } from '@genesislcap/foundation-comms';
-import { Layout } from '@jsonforms/core';
-import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
-import { Logger } from '@genesislcap/foundation-logger';
-import { OwnPropsOfControl } from '@jsonforms/core';
-import { RankedTester } from '@jsonforms/core';
-import { RuleEffect } from '@jsonforms/core';
-import { SchemaBasedCondition } from '@jsonforms/core';
-import { StatePropsOfControl } from '@jsonforms/core';
-import { UISchemaElement } from '@jsonforms/core';
-import { ViewTemplate } from '@microsoft/fast-element';
-
-// @public
-export type ArrayRendererOptions = {
-    childUiSchema?: UiSchema | ChildUiSchemaResolver;
-    addLabel?: string;
-    deleteLabel?: string;
-    border?: boolean;
-    canDelete?: (item: any) => boolean;
-    canAdd?: boolean | ((array: any[]) => boolean);
-    gridView?: 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)
-export const comboboxRendererStyles: (prefix?: string) => string;
-
-// Warning: (ae-internal-missing-underscore) The name "CommitPayload" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export type CommitPayload = {
-    DETAILS: any;
-    APPROVAL_MESSAGE?: string;
-};
-
-// @public
-export type ConnectedRenderersOptions = {
-    async?: boolean;
-    allOptionsResourceName?: string;
-    datasourceConfig?: DatasourceOptions;
-    valueField?: string;
-    labelField?: string;
-    data?: any[];
-    allowCustomOptions?: boolean;
-    filterMode?: FilterMode;
-    labelRowFormatter?: (any: any) => string;
-};
-
-// Warning: (ae-forgotten-export) The symbol "Expressions" needs to be exported by the entry point index.d.ts
-// Warning: (ae-internal-missing-underscore) The name "createExpressions" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @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
-export class Filters extends Filters_base {
-    // (undocumented)
-    allSavedFilters: any[];
-    // @internal (undocumented)
-    clearFiltersData(): void;
-    // (undocumented)
-    connectedCallback(): Promise<void>;
-    data: any;
-    // @internal (undocumented)
-    deepClone(): Node;
-    // (undocumented)
-    deleteFilter(): Promise<void>;
-    // (undocumented)
-    filterName: string;
-    // (undocumented)
-    filterNameChanged(oldValue: string, newValue: string): void;
-    jsonSchema: JSONSchema7;
-    // (undocumented)
-    kvStorage: KVStorage;
-    // (undocumented)
-    loadAllSavedFilters(): Promise<void>;
-    // (undocumented)
-    loadFilterData(filterKey: string): Promise<void>;
-    // @internal (undocumented)
-    onChange(event: CustomEvent): void;
-    prefix: string;
-    renderers: RendererEntry[];
-    resourceName: string;
-    // (undocumented)
-    saveFilter(): Promise<void>;
-    // @internal (undocumented)
-    searchFilters(): Promise<void>;
-    showFilterPersistenceControls: boolean;
-    uischema: UiSchema;
-    value: string;
-    // @internal (undocumented)
-    valueChanged(): void;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "filtersLogger" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const filtersLogger: Logger;
-
-// @public
-export const filtersRenderers: any[];
-
-// Warning: (ae-forgotten-export) The symbol "Form_base" needs to be exported by the entry point index.d.ts
-//
-// @public
-export class Form extends Form_base {
-    additionalRenderers: RendererEntry[];
-    // @internal (undocumented)
-    additionalRenderersChanged(): void;
-    // @internal
-    approvalMessage: string;
-    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;
-    jsonSchema: JSONSchema7;
-    // @internal
-    mergedRenderers: RendererEntry[];
-    // @internal (undocumented)
-    onChange(event: CustomEvent): void;
-    prefix: string;
-    readonly: boolean;
-    renderers: RendererEntry[];
-    // @internal (undocumented)
-    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)
-    submitting: boolean;
-    // @internal
-    submitWithApproval(): Promise<void>;
-    uischema: UiSchema;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "foundationFormStyles" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const foundationFormStyles: ElementStyles;
-
-// Warning: (ae-internal-missing-underscore) The name "foundationFormTemplate" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @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)
-export const genesisErrorTranslator: ErrorTranslator;
-
-// Warning: (ae-internal-missing-underscore) The name "GenesisType" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export enum GenesisType {
-    // (undocumented)
-    BIGDECIMAL = "BIGDECIMAL",
-    // (undocumented)
-    BOOLEAN = "BOOLEAN",
-    // (undocumented)
-    DATE = "DATE",
-    // (undocumented)
-    DATETIME = "DATETIME",
-    // (undocumented)
-    DOUBLE = "DOUBLE",
-    // (undocumented)
-    ENUM = "ENUM",
-    // (undocumented)
-    INT = "INT",
-    // (undocumented)
-    LONG = "LONG",
-    // (undocumented)
-    RAW = "RAW",
-    // (undocumented)
-    SHORT = "SHORT",
-    // (undocumented)
-    STRING = "STRING"
-}
-
-// @public
-export const getAnyOfErrorMessage: (errors: Array<any> | undefined, schema: any, controlPath: string | undefined, uiCustomMsg?: string) => string;
-
-// Warning: (ae-internal-missing-underscore) The name "getPrefixedForm" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const getPrefixedForm: (prefix: any) => ViewTemplate<Form, any>;
-
-// @public
-export type GroupRendererOptions = CategorizationRendererOptions;
-
-// @public
-export type LabelPlacementOptions = {
-    labelPlacement?: LabelPlacementType;
-};
-
-// @public
-export type LabelPlacementType = 'top' | 'left';
-
-export { Layout }
-
-// Warning: (ae-internal-missing-underscore) The name "logger" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const logger: Logger;
-
-// @public
-export function mapCsvToSchema(csvRows: Record<string, string>[], schema: JSONSchema7 | undefined, uiSchema?: UiSchema): CsvMappingResult;
-
-// @beta (undocumented)
-export const MulticolumnDropdownControlRendererEntry: any;
-
-// Warning: (ae-forgotten-export) The symbol "DispatchRenderer" needs to be exported by the entry point index.d.ts
-//
-// @beta
-export const MulticolumnDropdownControlRendererTemplate: (prefix?: string) => ViewTemplate<DispatchRenderer, any>;
-
-// @public
-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;
-};
-
-// @public
-export const mustMatch: (target: string) => (data: any, path: any, label: any) => {
-    instancePath: string;
-    message: string;
-    schemaPath: string;
-    keyword: string;
-    params: {};
-}[];
-
-// @public
-export type NumberRendererOptions = {
-    withoutFormatting?: boolean;
-    formatOptions?: Intl.NumberFormatOptions;
-    autocomplete?: string;
-};
-
-// @public
-export function parseCsv(content: string): CsvParseResult;
-
-// @public
-export type RendererEntry = {
-    renderer: ViewTemplate<DispatchRenderer, any>;
-    tester: RankedTester;
-    mapper: (state: JsonFormsState, ownProps: OwnPropsOfControl) => StatePropsOfControl;
-};
-
-// @public
-export const renderers: any[];
-
-// @public
-export type StandardRendererOptions = {
-    readonly?: boolean;
-    hidden?: boolean;
-    validateFn?: (data: any, path: string, label: string) => ErrorObject[];
-    i18n?: {
-        [key: string]: any;
-    };
-    tooltip?: string;
-    tabIndex?: number;
-};
-
-// @public
-export type StepperOrientationOptions = {
-    orientation?: StepperOrientationType;
-};
-
-// @public
-export type StepperOrientationType = 'vertical' | 'horizontal';
-
-// @public
-export type StepperRendererOptions = CategorizationRendererOptions;
-
-// @public
-export type StringRendererOptions = {
-    isPassword?: boolean;
-    textarea?: boolean;
-    autocomplete?: string;
-};
-
-// @public
-export type UiSchema = {
-    type: UiSchemaElementType;
-    elements: UiSchemaElement[];
-    options?: UiSchemaOptions;
-};
-
-export { UISchemaElement }
-
-// @public
-export type UiSchemaElement = {
-    type: UiSchemaElementType;
-    scope: string;
-    label?: string;
-    placeholder?: string;
-    options?: UiSchemaElementOptions;
-    rule?: Rule;
-};
-
-// @public
-export type UiSchemaElementOptions = ConnectedRenderersOptions | NumberRendererOptions | ArrayRendererOptions | CategorizationRendererOptions | GroupRendererOptions | StepperRendererOptions | StringRendererOptions | StandardRendererOptions;
-
-// @public
-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:487:3 - (ae-forgotten-export) The symbol "Rule" needs to be exported by the entry point index.d.ts
-
-// (No @packageDocumentation comment for this package)
-
-```