@genesislcap/foundation-entity-management 14.408.0 → 14.409.0

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

@@ -1,543 +0,0 @@
-## API Report File for "@genesislcap/foundation-entity-management"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { Auth } from '@genesislcap/foundation-comms';
-import { AvailableOption } from '@genesislcap/foundation-ui';
-import { CellEditRequestEvent } from '@ag-grid-community/core';
-import { ColDef } from '@ag-grid-community/core';
-import { Connect } from '@genesislcap/foundation-comms';
-import { Constructable } from '@genesislcap/web-core';
-import { Container } from '@genesislcap/web-core';
-import { Controller } from '@microsoft/fast-element';
-import { DatasourceOptions } from '@genesislcap/foundation-comms';
-import { DatasourceType } from '@genesislcap/grid-pro';
-import { DOMContainer } from '@genesislcap/foundation-utils';
-import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
-import { FoundationRouterConfiguration } from '@genesislcap/foundation-ui';
-import { GenesisElement } from '@genesislcap/web-core';
-import { GridOptions } from '@ag-grid-community/core';
-import { GridProCaseType } from '@genesislcap/grid-pro';
-import { GridProGenesisDatasource } from '@genesislcap/foundation-zero-grid-pro';
-import { GridProStatusBarConfig } from '@genesislcap/grid-pro';
-import { InterfaceSymbol } from '@microsoft/fast-foundation';
-import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
-import { Logger } from '@genesislcap/foundation-logger';
-import { MessageError } from '@genesislcap/foundation-comms';
-import type { MetadataDetail } from '@genesislcap/foundation-comms';
-import { Modal } from '@genesislcap/foundation-ui';
-import { NotificationStructure } from '@genesislcap/foundation-notifications';
-import { PartialFASTElementDefinition } from '@microsoft/fast-element';
-import { RendererEntry } from '@genesislcap/foundation-forms';
-import { SelectedOption } from '@genesislcap/foundation-ui';
-import { SelectionChangedEvent } from '@ag-grid-community/core';
-import { Session } from '@genesislcap/foundation-comms';
-import { UiSchema } from '@genesislcap/foundation-forms';
-import { UiSchemaElement } from '@genesislcap/foundation-forms';
-import { UiSchemaElementType } from '@genesislcap/foundation-forms';
-import { UiSchemaOptions } from '@genesislcap/foundation-forms';
-import { ViewTemplate } from '@microsoft/fast-element';
-import { ViewTemplate as ViewTemplate_2 } from '@genesislcap/web-core';
-import { ZeroGridPro } from '@genesislcap/foundation-zero-grid-pro';
-
-// @public (undocumented)
-export enum ActionsMenuStyle {
-    // (undocumented)
-    ActionsHorizontal = "actions-horizontal",
-    // (undocumented)
-    ActionsVertical = "actions-vertical",
-    // (undocumented)
-    Default = "default"
-}
-
-// @public (undocumented)
-export type AdditionalEntry = string | UiSchema | {
-    type: 'Control';
-    scope: string;
-    label?: string;
-    options?: {
-        readonly?: boolean;
-        hidden?: boolean;
-        allOptionsResourceName?: string;
-        valueField?: string;
-        labelField?: string;
-    };
-};
-
-// @public (undocumented)
-export const buttonCellRenderer: (title: any, clickHandler: any, contentTemplate: any, tooltip?: string) => ColDef;
-
-// @public (undocumented)
-export interface ConfirmSubmit {
-    // (undocumented)
-    message: string;
-    // (undocumented)
-    state: 'enabled' | 'disabled';
-}
-
-// @public (undocumented)
-export enum CrudAction {
-    // (undocumented)
-    Create = "create",
-    // (undocumented)
-    Delete = "delete",
-    // (undocumented)
-    Read = "read",
-    // (undocumented)
-    Update = "update"
-}
-
-// @public (undocumented)
-export enum CrudMenuPosition {
-    // (undocumented)
-    Action = "action",
-    // (undocumented)
-    Bottom = "bottom",
-    // (undocumented)
-    Column = "column",
-    // (undocumented)
-    None = "none",
-    // (undocumented)
-    Top = "top"
-}
-
-// @public (undocumented)
-export interface CustomAction {
-    // (undocumented)
-    action: {
-        type: 'event';
-        event: string;
-        hasForm: boolean;
-        defaultValues?: DefaultValues;
-        uiSchema?: UiSchema;
-    } | {
-        type: 'callback';
-        callback: (rowData: any) => void;
-    };
-    // (undocumented)
-    appearance?: string;
-    // (undocumented)
-    confirmSubmit?: ConfirmSubmit;
-    disabled?: (rowData: any) => boolean;
-    // (undocumented)
-    icon?: string;
-    // (undocumented)
-    name: string;
-    // (undocumented)
-    position?: CrudMenuPosition;
-    // (undocumented)
-    requiresSelection?: boolean;
-    // (undocumented)
-    setApprovalMessage?: boolean;
-    // (undocumented)
-    tooltip?: string;
-}
-
-// @public (undocumented)
-export interface CustomActionError {
-    // (undocumented)
-    errors: {
-        message?: string;
-        CODE: string;
-        TEXT: string;
-    }[];
-}
-
-// @public (undocumented)
-export interface CustomActionState {
-    // (undocumented)
-    event: string;
-    // (undocumented)
-    name: string;
-    // (undocumented)
-    rowData: any;
-}
-
-// @public
-export type DatasourceConfiguration = Omit<DatasourceOptions, 'resourceName'>;
-
-// @public (undocumented)
-export type DefaultValue = string | number | boolean | null | RecordTypeValue;
-
-// @public (undocumented)
-export interface DefaultValues {
-    // (undocumented)
-    [key: string]: DefaultValue;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "DynamicTemplate" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const DynamicTemplate: ViewTemplate_2<MainApplication>;
-
-// @public (undocumented)
-export const ENTITY_NAME: InterfaceSymbol<string>;
-
-// Warning: (ae-forgotten-export) The symbol "EntityManagement_base" needs to be exported by the entry point index.d.ts
-//
-// @public
-export class EntityManagement extends EntityManagement_base {
-    // @internal
-    activeCustomAction: CustomActionState | null;
-    // @internal
-    aiCriteriaSearchFieldMetadata: MetadataDetail[];
-    approvalMessageLabel: string;
-    // @internal
-    asyncAdd: boolean;
-    // @internal
-    asyncRemove: boolean;
-    // @internal
-    asyncUpdate: boolean;
-    // @internal (undocumented)
-    closeFiltersModal(): void;
-    // @internal (undocumented)
-    closeModal(): void;
-    columns: ColDef[];
-    confirmationMessage: string;
-    // @internal (undocumented)
-    confirmDelete(): Promise<void>;
-    // @internal
-    protected connect: Connect;
-    // @internal
-    connectedCallback(): Promise<void>;
-    // @internal
-    createEntity(): void;
-    createEvent: string;
-    createFormUiSchema: UiSchema;
-    crudActionMenuName: string;
-    crudMenuPosition: CrudMenuPosition;
-    crudMenuStyle: ActionsMenuStyle;
-    // @internal
-    crudMenuWrapper: any;
-    // @internal
-    get currentConfirmationMessage(): string;
-    // @internal
-    get currentFormData(): Record<string, any>;
-    // @internal
-    get currentFormResourceName(): string;
-    // @internal
-    get currentFormUiSchema(): UiSchema | null;
-    // @internal
-    get currentSetApprovalMessage(): boolean;
-    // @internal
-    customActionFormData: Record<string, any>;
-    customActions: CustomAction[];
-    set datasourceConfig(config: DatasourceConfiguration);
-    get datasourceConfig(): DatasourceConfiguration;
-    // @internal (undocumented)
-    _datasourceConfig: DatasourceConfiguration;
-    datasourceType: DatasourceType;
-    // @internal
-    deepClone(): Node;
-    defaultEntityValues: Record<string, unknown>;
-    deleteColumnState(resetToDefault?: boolean): Promise<void>;
-    // @internal
-    deleteEntity(e: CustomEvent): Promise<void>;
-    deleteEvent: string;
-    // @internal (undocumented)
-    disconnectedCallback(): Promise<void>;
-    // @internal (undocumented)
-    downloadCsvData(): Promise<void>;
-    // @internal
-    editedEntity: Record<string, unknown>;
-    // @internal
-    editEntity({ detail }: CustomEvent): Promise<void>;
-    // @internal (undocumented)
-    editEntityModal: Modal;
-    // @internal (undocumented)
-    editModalVisible: boolean;
-    // @internal
-    emitCrud(action: 'create' | 'edit' | 'delete'): void;
-    enableAiCriteriaSearch: boolean;
-    enableCellFlashing: boolean;
-    enableCsvExport: {
-        buttonName?: string;
-        fileName?: string;
-    } | null;
-    enableFilterBar: boolean;
-    enableFilters: boolean;
-    enableRowFlashing: boolean;
-    enableSearchBar: boolean;
-    entityLabel: string;
-    // @internal (undocumented)
-    entityListRef: List;
-    errorNotificationConfig: NotificationStructure['config'];
-    // @internal
-    filtersCriteria: string;
-    // @internal (undocumented)
-    filtersModal: Modal;
-    filtersModalPosition: 'centre' | 'left' | 'right';
-    // @internal
-    get filtersModalTitle(): string;
-    // @internal
-    filtersModalVisible: boolean;
-    filtersUiSchema: UiSchema;
-    formRenderers: RendererEntry[];
-    // @internal
-    formResourceName: string;
-    // @internal (undocumented)
-    formUiSchema: UiSchema;
-    // @internal
-    getActiveCustomAction(): CustomAction | null;
-    // @internal
-    getCustomActionsByPosition(position: CrudMenuPosition): CustomAction[];
-    // @internal
-    getTitleBasedOnActionOrType(actionOrType: CrudAction | ModalFormType): string;
-    gridAutosizing: boolean;
-    gridOptions: GridOptions;
-    // @internal
-    gridVisible: boolean;
-    // @internal
-    handleCustomActionClick(actionName: string): Promise<void>;
-    // @internal
-    handleNotify(type: ModalFormType | CrudAction.Delete, requestError?: MessageError[]): void;
-    // @internal
-    hasContentInSlot(slotName: string): boolean;
-    // @internal
-    get hasSelectedEntity(): boolean;
-    headerCaseType: GridProCaseType;
-    // @internal (undocumented)
-    get headerTemplate(): ViewTemplate<EntityManagement, any>;
-    hideDelete: boolean;
-    hideEdit: boolean;
-    // @internal
-    isCustomActionDisabled(customAction: CustomAction, rowData?: any): boolean;
-    // @internal (undocumented)
-    get isServerSideDatasource(): boolean;
-    // @internal
-    get modalFormTitle(): string;
-    // @internal
-    modalFormType: ModalFormType;
-    modalPosition: 'centre' | 'left' | 'right';
-    persistColumnStateKey: string;
-    persistFilterModelKey: string;
-    prefix: string;
-    readEvent: string;
-    readEventFn: (entity: any) => any;
-    // @internal (undocumented)
-    readonly: boolean;
-    resourceName: string;
-    rowSelection: string;
-    searchBarConfig: AvailableOption[];
-    // @internal (undocumented)
-    searchChanged(event: CustomEvent<Array<SelectedOption>>): void;
-    // @internal
-    selectedEntity: Record<string, unknown>;
-    // @internal
-    selectionChanged(event: CustomEvent<SelectionChangedEvent>): void;
-    setApprovalMessage: boolean;
-    setDSConfigWithoutUpdatingBaseCriteria(config: DatasourceConfiguration): void;
-    // @internal
-    get shouldHideDeleteInColumn(): boolean;
-    // @internal
-    get shouldHideEditInColumn(): boolean;
-    showFilterPersistenceControls: boolean;
-    sizeColumnsToContent: boolean;
-    sizeColumnsToFit: boolean;
-    statusBarConfig: GridProStatusBarConfig;
-    // @internal
-    submitEntityChanges(): Promise<void>;
-    // @internal (undocumented)
-    submitting: boolean;
-    title: string;
-    updateEvent: string;
-    updateFormUiSchema: UiSchema;
-}
-
-// @public
-export const getErrorFormat: (err: any) => string;
-
-// Warning: (ae-forgotten-export) The symbol "List_base" needs to be exported by the entry point index.d.ts
-//
-// @public (undocumented)
-export class List extends List_base {
-    // (undocumented)
-    actionButtonsConfig: any[];
-    // (undocumented)
-    asyncAdd: boolean;
-    // (undocumented)
-    asyncRemove: boolean;
-    // (undocumented)
-    asyncUpdate: boolean;
-    // (undocumented)
-    columns: ColDef[];
-    // (undocumented)
-    protected connect: Connect;
-    // (undocumented)
-    connectedCallback(): void;
-    // (undocumented)
-    createEvent: string;
-    // (undocumented)
-    get criteria(): string;
-    // (undocumented)
-    customActions: CustomAction[];
-    // (undocumented)
-    datasource: GridProGenesisDatasource;
-    // (undocumented)
-    datasourceConfig: DatasourceConfiguration;
-    // (undocumented)
-    datasourceType: DatasourceType;
-    // (undocumented)
-    delete(e: any): Promise<void>;
-    // (undocumented)
-    deleteEvent: string;
-    // (undocumented)
-    get disablePolling(): boolean;
-    // (undocumented)
-    disconnectedCallback(): Promise<void>;
-    // (undocumented)
-    enableCellFlashing: boolean;
-    // (undocumented)
-    enableFilterBar: boolean;
-    // (undocumented)
-    enableRowFlashing: boolean;
-    // (undocumented)
-    get fields(): string;
-    // (undocumented)
-    grid: ZeroGridPro;
-    gridAutosizing: boolean;
-    // (undocumented)
-    gridOptions: GridOptions;
-    // (undocumented)
-    handleCellEditRequest(event: CustomEvent<CellEditRequestEvent>): Promise<void>;
-    // (undocumented)
-    handleRowClicked(e: CustomEvent): void;
-    // (undocumented)
-    handleRowContextMenu(e: CustomEvent): void;
-    // (undocumented)
-    handleRowDblClicked(e: CustomEvent): void;
-    // (undocumented)
-    handleRowSelected(e: CustomEvent): void;
-    // (undocumented)
-    handleSelectionChanged(e: CustomEvent<SelectionChangedEvent>): void;
-    // (undocumented)
-    headerCaseType: GridProCaseType;
-    // (undocumented)
-    hideDelete: boolean;
-    // (undocumented)
-    hideEdit: boolean;
-    // (undocumented)
-    get isServerSideDatasource(): boolean;
-    // (undocumented)
-    get isSnapshot(): boolean;
-    // (undocumented)
-    get maxRows(): number;
-    // (undocumented)
-    get maxView(): number;
-    // (undocumented)
-    get movingView(): boolean;
-    // (undocumented)
-    get orderBy(): string;
-    // (undocumented)
-    persistColumnStateKey: string;
-    // (undocumented)
-    persistFilterModelKey: string;
-    // (undocumented)
-    get pollingInterval(): number;
-    // (undocumented)
-    get pollTriggerEvents(): string[];
-    prefix: string;
-    // (undocumented)
-    get request(): any;
-    // (undocumented)
-    get requestAutoSetup(): boolean;
-    // (undocumented)
-    resourceName: string;
-    // (undocumented)
-    get reverse(): boolean;
-    // (undocumented)
-    rowSelection: string;
-    sizeColumnsToContent: boolean;
-    sizeColumnsToFit: boolean;
-    // (undocumented)
-    statusBarConfig: GridProStatusBarConfig;
-    // (undocumented)
-    title: string;
-    // (undocumented)
-    updateEvent: string;
-    // (undocumented)
-    get viewNumber(): number;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "LoadingTemplate" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const LoadingTemplate: ViewTemplate_2<MainApplication>;
-
-// @public (undocumented)
-export const logger: Logger;
-
-// @public (undocumented)
-export class MainApplication extends GenesisElement {
-    // Warning: (ae-forgotten-export) The symbol "MainRouterConfig" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    config: MainRouterConfig;
-    // (undocumented)
-    connect: Connect;
-    // (undocumented)
-    connectedCallback(): void;
-    // (undocumented)
-    container: Container;
-    // (undocumented)
-    loadRemotes(): Promise<void>;
-    // (undocumented)
-    onLuminanceToggle(): void;
-    // (undocumented)
-    provider: HTMLElement;
-    // (undocumented)
-    ready: boolean;
-    // (undocumented)
-    selectTemplate(): ViewTemplate<MainApplication, any>;
-    // (undocumented)
-    session: Session;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "MainTemplate" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const MainTemplate: ViewTemplate_2<MainApplication>;
-
-// @public
-export function mapDefaultValues(defaultValues: Record<string, any>, rowData: any): Record<string, any>;
-
-// @public (undocumented)
-export enum ModalFormType {
-    // (undocumented)
-    Create = "create",
-    // (undocumented)
-    Read = "read",
-    // (undocumented)
-    Update = "update"
-}
-
-// @public (undocumented)
-export interface RecordTypeValue {
-    // (undocumented)
-    mapping?: string;
-    // (undocumented)
-    type: 'record';
-}
-
-// @public (undocumented)
-export const RESOURCE_NAME: InterfaceSymbol<string>;
-
-// @alpha
-export class SmartFormModal extends EntityManagement {
-    // (undocumented)
-    gridVisible: boolean;
-}
-
-export { UiSchema }
-
-export { UiSchemaElement }
-
-export { UiSchemaElementType }
-
-export { UiSchemaOptions }
-
-// (No @packageDocumentation comment for this package)
-
-```