@genesislcap/grid-tabulator 14.303.0 → 14.303.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/grid-tabulator",
   "description": "Genesis Foundation Grid Tabulator",
-  "version": "14.303.0",
+  "version": "14.303.1",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -39,20 +39,20 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.303.0",
-    "@genesislcap/genx": "14.303.0",
-    "@genesislcap/rollup-builder": "14.303.0",
-    "@genesislcap/ts-builder": "14.303.0",
-    "@genesislcap/uvu-playwright-builder": "14.303.0",
-    "@genesislcap/vite-builder": "14.303.0",
-    "@genesislcap/webpack-builder": "14.303.0",
+    "@genesislcap/foundation-testing": "14.303.1",
+    "@genesislcap/genx": "14.303.1",
+    "@genesislcap/rollup-builder": "14.303.1",
+    "@genesislcap/ts-builder": "14.303.1",
+    "@genesislcap/uvu-playwright-builder": "14.303.1",
+    "@genesislcap/vite-builder": "14.303.1",
+    "@genesislcap/webpack-builder": "14.303.1",
     "@types/tabulator-tables": "6.2.6"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.303.0",
-    "@genesislcap/foundation-logger": "14.303.0",
-    "@genesislcap/foundation-ui": "14.303.0",
-    "@genesislcap/foundation-utils": "14.303.0",
+    "@genesislcap/foundation-comms": "14.303.1",
+    "@genesislcap/foundation-logger": "14.303.1",
+    "@genesislcap/foundation-ui": "14.303.1",
+    "@genesislcap/foundation-utils": "14.303.1",
     "@microsoft/fast-colors": "5.3.1",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
@@ -73,5 +73,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "1495670cf431019b7a29589f6ab7b80c0ec31945"
+  "gitHead": "f1685d21651cfe332605360143595a9bb603b129"
 }

package/docs/api-report.md

@@ -1,621 +0,0 @@
-## API Report File for "@genesislcap/grid-tabulator"
-
-> 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 { CellComponent } from 'tabulator-tables';
-import { ColumnDefinition as ColumnDefinition_2 } from 'tabulator-tables';
-import { Connect } from '@genesislcap/foundation-comms';
-import type { Container } from '@microsoft/fast-foundation';
-import { Controller } from '@microsoft/fast-element';
-import { CSSVarTokenMap } from '@genesislcap/foundation-ui';
-import { Datasource } from '@genesislcap/foundation-comms';
-import { DatasourceStatus } from '@genesislcap/foundation-comms';
-import { DatasourceStatusChangedEvent } from '@genesislcap/foundation-comms';
-import { DOMContainer } from '@genesislcap/foundation-utils';
-import { DownloadOptions } from 'tabulator-tables';
-import { ElementStyles } from '@microsoft/fast-element';
-import { FilterParams } from 'tabulator-tables';
-import type { Formatter } from 'tabulator-tables';
-import { FormatterParams as FormatterParams_2 } from 'tabulator-tables';
-import { FoundationElement } from '@microsoft/fast-foundation';
-import { FoundationElementRegistry } from '@microsoft/fast-foundation';
-import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
-import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
-import { Logger } from '@genesislcap/foundation-logger';
-import { Options as Options_2 } from 'tabulator-tables';
-import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
-import { RowRangeLookup } from 'tabulator-tables';
-import { TabulatorFull } from 'tabulator-tables';
-import { ViewTemplate } from '@microsoft/fast-element';
-
-// Warning: (ae-incompatible-release-tags) The symbol "actionFormatter" is marked as @public, but its signature references "ActionFormatterParams" which is marked as @alpha
-//
-// @public
-export function actionFormatter<T = any>(cell: any, formatterParams?: ActionFormatterParams<T>): string;
-
-// @alpha
-export interface ActionFormatterParams<T = any> {
-    // (undocumented)
-    actionButtonStyle?: string;
-    // (undocumented)
-    actionClick?: (rowData: T) => void;
-    // (undocumented)
-    actionName?: string;
-    // (undocumented)
-    appearance?: string;
-    // (undocumented)
-    contentTemplate?: string;
-    // (undocumented)
-    dataTestId?: ((rowData: T) => string) | string;
-    // (undocumented)
-    isDisabled?: (rowData: T) => boolean;
-    // (undocumented)
-    prefix?: string;
-    // (undocumented)
-    uniqueFieldName?: string;
-}
-
-// Warning: (ae-incompatible-release-tags) The symbol "actionsMenuFormatter" is marked as @public, but its signature references "ActionsMenuFormatterParams" which is marked as @alpha
-//
-// @public
-export function actionsMenuFormatter<T = any>(cell: any, formatterParams?: ActionsMenuFormatterParams<T>): string;
-
-// @alpha
-export interface ActionsMenuFormatterParams<T = any> {
-    // (undocumented)
-    actions?: Array<{
-        name: string;
-        callback: (rowData: T) => void;
-        isDisabled?: (rowData: T) => boolean;
-    }>;
-    // (undocumented)
-    buttonAppearance?: string;
-    // (undocumented)
-    dataTestId?: ((rowData: T) => string) | string;
-    // (undocumented)
-    isVertical?: boolean;
-    // (undocumented)
-    menuName?: string;
-    // (undocumented)
-    prefix?: string;
-}
-
-// Warning: (ae-incompatible-release-tags) The symbol "booleanFormatter" is marked as @public, but its signature references "BooleanFormatterParams" which is marked as @alpha
-//
-// @public
-export function booleanFormatter<T = any>(cell: any, formatterParams?: BooleanFormatterParams<T>): string;
-
-// @alpha
-export interface BooleanFormatterParams<T = any> {
-    // (undocumented)
-    dataTestId?: ((rowData: T) => string) | string;
-    // (undocumented)
-    isDisabled?: (rowData: T) => boolean;
-    // (undocumented)
-    prefix?: string;
-}
-
-export { CellComponent }
-
-// @public
-export type CellRendererFunc = (params: CellRendererParams) => HTMLElement | string;
-
-// @public
-export interface CellRendererParams {
-    [key: string]: any;
-    cell?: CellComponent;
-    data?: any;
-    formatterParams?: FormatterParams_2;
-    value?: any;
-}
-
-// @alpha
-export type ColumnDefinition = {
-    formatter?: Formatter | FormatterTypes;
-    formatterParams?: FormatterParams;
-} & Omit<ColumnDefinition_2, 'formatter' | 'formatterParams'>;
-
-// @alpha
-export function convertToKebabCase(str: string): string;
-
-// @alpha
-export const criteriaDelimiter = ";";
-
-// @alpha
-export const criteriaJoin = " && ";
-
-// @public
-export function dateTimeValueFormatter({ value }: any): string;
-
-// @public
-export function dateValueFormatter({ value }: any): string;
-
-// @alpha
-export const DEBOUNCED_RESIZE_TIME = 400;
-
-// @public
-export const defaultGridTabulatorConfig: {
-    shadowOptions: any;
-};
-
-// Warning: (ae-incompatible-release-tags) The symbol "editableFormatter" is marked as @public, but its signature references "EditableFormatterParams" which is marked as @alpha
-//
-// @public
-export function editableFormatter<T = any>(cell: any, formatterParams?: EditableFormatterParams<T>): string;
-
-// @alpha
-export interface EditableFormatterParams<T = any> {
-    // (undocumented)
-    cssClass?: string;
-    // (undocumented)
-    data?: T;
-    // (undocumented)
-    dataTestId?: ((rowData: T) => string) | string;
-    // (undocumented)
-    field?: string;
-    // (undocumented)
-    icon?: string;
-    // (undocumented)
-    nullText?: string;
-    // (undocumented)
-    prefix?: string;
-    // (undocumented)
-    value?: any;
-}
-
-// @alpha
-export const EDITED_COLUMN_FIELD = "__EDITED_FIELD__";
-
-// @alpha
-export const ERROR_COLUMN_FIELD = "__ERROR_FIELD__";
-
-// @public
-export function formatDateExtra(epoch: number): string;
-
-// @alpha
-export type FormatterParams = FormatterParams_2 | ActionFormatterParams | ActionsMenuFormatterParams | BooleanFormatterParams | EditableFormatterParams | SelectFormatterParams | TextFormatterParams;
-
-// @alpha
-export const formatters: {
-    action: typeof actionFormatter;
-    actionsMenu: typeof actionsMenuFormatter;
-    boolean: typeof booleanFormatter;
-    editable: typeof editableFormatter;
-    select: typeof selectFormatter;
-    text: typeof textFormatter;
-};
-
-// @alpha
-export enum FormatterTypes {
-    action = "action",
-    actionsMenu = "actionsMenu",
-    boolean = "boolean",
-    editable = "editable",
-    select = "select",
-    text = "text"
-}
-
-// @alpha
-export const foundationGridTabulator: (overrideDefinition?: OverrideFoundationElementDefinition<    {
-shadowOptions: any;
-baseName: string;
-styles: ElementStyles;
-template: ViewTemplate<any, any>;
-}>) => FoundationElementRegistry<    {
-shadowOptions: any;
-baseName: string;
-styles: ElementStyles;
-template: ViewTemplate<any, any>;
-}, typeof GridTabulator>;
-
-// @public
-export const foundationGridTabulatorComponents: {
-    foundationDateEditor: (overrideDefinition?: OverrideFoundationElementDefinition<    {
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<DateEditor, any>;
-    }>) => FoundationElementRegistry<    {
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<DateEditor, any>;
-    }, DateEditor>;
-    foundationNumberEditor: (overrideDefinition?: OverrideFoundationElementDefinition<    {
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<NumberEditor, any>;
-    }>) => FoundationElementRegistry<    {
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<NumberEditor, any>;
-    }, NumberEditor>;
-    foundationSelectEditor: (overrideDefinition?: OverrideFoundationElementDefinition<    {
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<SelectEditor, any>;
-    }>) => FoundationElementRegistry<    {
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<SelectEditor, any>;
-    }, SelectEditor>;
-    foundationStringEditor: (overrideDefinition?: OverrideFoundationElementDefinition<    {
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<StringEditor, any>;
-    }>) => FoundationElementRegistry<    {
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<StringEditor, any>;
-    }, StringEditor>;
-    foundationMultiselectEditor: (overrideDefinition?: OverrideFoundationElementDefinition<    {
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<MultiselectEditor, any>;
-    }>) => FoundationElementRegistry<    {
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<MultiselectEditor, any>;
-    }, MultiselectEditor>;
-    foundationGridTabulatorColumn: (overrideDefinition?: OverrideFoundationElementDefinition<    {
-    baseName: string;
-    }>) => FoundationElementRegistry<    {
-    baseName: string;
-    }, typeof GridTabulatorColumn>;
-    foundationGridTabulatorCell: (overrideDefinition?: OverrideFoundationElementDefinition<    {
-    baseName: string;
-    }>) => FoundationElementRegistry<    {
-    baseName: string;
-    }, typeof GridTabulatorCell>;
-    foundationGridTabulator: (overrideDefinition?: OverrideFoundationElementDefinition<    {
-    shadowOptions: any;
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<any, any>;
-    }>) => FoundationElementRegistry<    {
-    shadowOptions: any;
-    baseName: string;
-    styles: ElementStyles;
-    template: ViewTemplate<any, any>;
-    }, GridTabulator>;
-    register(container?: Container, ...rest: any[]): void;
-};
-
-// @public
-export function getColumnType(metadataType: string): string;
-
-// @alpha
-export function getDataTestId<T = any>(dataTestId: ((rowData: T) => string) | string | undefined, rowData: T): string | undefined;
-
-// @public
-export function getFilterByFieldType(type: string): string;
-
-// @public
-export function getFilterParamsByFieldType(type: string): FilterParams;
-
-// @public
-export enum GridCSSVars {
-}
-
-// Warning: (ae-forgotten-export) The symbol "GridTabulator_base" needs to be exported by the entry point index.d.ts
-//
-// @alpha (undocumented)
-export class GridTabulator extends GridTabulator_base {
-    // (undocumented)
-    autoCellRendererByType: boolean;
-    // (undocumented)
-    classNames: string;
-    // @public
-    clearFilters(): void;
-    // @public
-    columnComponentName: string;
-    // (undocumented)
-    connectedCallback(): void;
-    // (undocumented)
-    disconnectedCallback(): void;
-    // @public
-    downloadDataAs(type: 'csv' | 'json' | 'html', fileName: string, params?: DownloadOptions, filter?: RowRangeLookup): void;
-    enableCellFlashing: boolean;
-    enableRowFlashing: boolean;
-    // (undocumented)
-    grid: TabulatorFull | undefined;
-    gridAutosizingEnabled: boolean;
-    // (undocumented)
-    gridDiv: HTMLDivElement;
-    // (undocumented)
-    gridFontFace: string;
-    // Warning: (ae-incompatible-release-tags) The symbol "gridOptions" is marked as @public, but its signature references "Options" which is marked as @alpha
-    //
-    // @public
-    get gridOptions(): Options;
-    // Warning: (ae-incompatible-release-tags) The symbol "gridOptions" is marked as @public, but its signature references "Options" which is marked as @alpha
-    set gridOptions(options: Options);
-    // Warning: (ae-incompatible-release-tags) The symbol "headerCaseType" is marked as @public, but its signature references "GridTabulatorCaseType" which is marked as @alpha
-    //
-    // @public
-    headerCaseType: GridTabulatorCaseType;
-    // (undocumented)
-    onlyTemplateColDefs: boolean;
-    // (undocumented)
-    persistColumnStateKey: string;
-    persistFilterModelKey: string;
-    // @public
-    redraw(): void;
-    // @public
-    refreshCells(): void;
-    // (undocumented)
-    restoreGridState(): void;
-    // (undocumented)
-    rowData: any[];
-    // (undocumented)
-    rowDataChanged(oldValue: any, newValue: any): void;
-    // (undocumented)
-    rowHeight: number;
-    // (undocumented)
-    saveGridState(): void;
-    // @public
-    setFilter(column: string, operator: string, value: string, filterParams?: FilterParams): void;
-    showHeaderFilters: boolean;
-    // (undocumented)
-    get statePersistanceEnabled(): boolean;
-    // (undocumented)
-    theme: string;
-    // (undocumented)
-    themeChanged(oldValue: string, newValue: string): void;
-}
-
-// @alpha
-export type GridTabulatorCaseType = 'camelCase' | 'capitalCase' | 'constantCase' | 'dotCase' | 'headerCase' | 'noCase' | 'paramCase' | 'pascalCase' | 'pathCase' | 'sentenceCase' | 'snakeCase';
-
-// @public
-export class GridTabulatorCell extends FoundationElement {
-    // (undocumented)
-    connectedCallback(): void;
-    // (undocumented)
-    destroy(): void;
-    // (undocumented)
-    getElement(): HTMLElement;
-    // (undocumented)
-    init(params: CellRendererParams): void;
-    // (undocumented)
-    refresh(params: CellRendererParams): boolean;
-    // (undocumented)
-    renderer: CellRendererFunc;
-    // (undocumented)
-    rendererParams: CellRendererParams;
-    // (undocumented)
-    slottedRenderer: HTMLElement[];
-    // (undocumented)
-    slottedRendererChanged(): void;
-}
-
-// @public
-export enum GridTabulatorCellEditorTypes {
-    // (undocumented)
-    date = "date",
-    // (undocumented)
-    multiselect = "multiselect",
-    // (undocumented)
-    number = "number",
-    // (undocumented)
-    select = "select",
-    // (undocumented)
-    string = "string"
-}
-
-// @public
-export enum GridTabulatorCellRendererTypes {
-    // (undocumented)
-    action = "action",
-    // (undocumented)
-    actionsMenu = "actionsMenu",
-    // (undocumented)
-    boolean = "boolean",
-    // (undocumented)
-    editable = "editable",
-    // (undocumented)
-    select = "select",
-    // (undocumented)
-    text = "text"
-}
-
-// Warning: (ae-forgotten-export) The symbol "GridTabulatorClientSideDatasource_base" needs to be exported by the entry point index.d.ts
-//
-// @alpha
-export class GridTabulatorClientSideDatasource extends GridTabulatorClientSideDatasource_base {
-    // (undocumented)
-    auth: Auth;
-    // (undocumented)
-    connect: Connect;
-    // (undocumented)
-    connectedCallback(): void;
-    // (undocumented)
-    criteria: string;
-    // (undocumented)
-    criteriaChanged(oldCriteria: string, newCriteria: string): void;
-    // (undocumented)
-    datasource: Datasource;
-    // (undocumented)
-    datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus): void;
-    // (undocumented)
-    deepClone(): Node;
-    deferredColumnStates: any[];
-    // (undocumented)
-    deferredGridOptions: Options_2;
-    // @public
-    destroy(): void;
-    // (undocumented)
-    disconnectedCallback(): void;
-    // (undocumented)
-    fields: string;
-    handleErrors(errors: string | any[]): void;
-    // @public
-    init(): Promise<void>;
-    // (undocumented)
-    isSnapshot: boolean;
-    keepColDefsOnClearRowData: boolean;
-    // @internal
-    loadResourceData(withFullInit?: boolean): Promise<void>;
-    // (undocumented)
-    maxRows: number;
-    // (undocumented)
-    maxView: number;
-    // (undocumented)
-    movingView: boolean;
-    // (undocumented)
-    orderBy: string;
-    // (undocumented)
-    pollingInterval: number;
-    refreshRows(): void;
-    // (undocumented)
-    removeFilter(fieldName: string): void;
-    // (undocumented)
-    request: any;
-    // (undocumented)
-    resourceName: string;
-    // (undocumented)
-    resourceNameChanged(oldValue: string, newValue: string): void;
-    // @public
-    restart(): void;
-    // (undocumented)
-    restartOnReconnection: boolean;
-    // (undocumented)
-    reverse: boolean;
-    rowDataMapper: Function;
-    rowIdAttr: any;
-    // (undocumented)
-    setFilter(fieldName: string, newFilter: string): void;
-}
-
-// Warning: (ae-forgotten-export) The symbol "GridTabulatorColumn_base" needs to be exported by the entry point index.d.ts
-//
-// @public
-export class GridTabulatorColumn extends GridTabulatorColumn_base {
-    // (undocumented)
-    deepClone(): Node;
-    // (undocumented)
-    definition: Partial<ColumnDefinition_2>;
-    // (undocumented)
-    slottedCell: HTMLElement[];
-    // (undocumented)
-    slottedCellChanged(): void;
-}
-
-// @alpha
-export const gridTabulatorErrorNames: {
-    datasource: string;
-};
-
-// @alpha
-export const gridTabulatorEventNames: {
-    error: string;
-    datasourceErrorClose: string;
-};
-
-// @public
-export const gridTabulatorShadowOptions: ShadowRootInit;
-
-// @public
-export const gridTabulatorStyles: ElementStyles;
-
-// @public
-export const gridTabulatorTemplate: ViewTemplate;
-
-// @public
-export enum GridTabulatorTheme {
-    // (undocumented)
-    default = "default-theme",
-    // (undocumented)
-    rapid = "rapid-theme"
-}
-
-// @public
-export const logger: Logger;
-
-// @alpha
-export function mergeAndDedupColDefWithColumnState(colDefs: any[], columnState: any[]): any[];
-
-// @alpha
-export type Options = {
-    formatters?: Record<string, Formatter>;
-    columns?: ColumnDefinition[];
-} & Omit<Options_2, 'formatters'>;
-
-// @public
-export interface RowDataTransaction<TData = any> {
-    add?: TData[] | null;
-    addIndex?: number | null;
-    remove?: TData[] | null;
-    update?: TData[] | null;
-}
-
-// Warning: (ae-incompatible-release-tags) The symbol "selectFormatter" is marked as @public, but its signature references "SelectFormatterParams" which is marked as @alpha
-//
-// @public
-export function selectFormatter<T = any>(cell: any, formatterParams: SelectFormatterParams<T>): string;
-
-// @alpha
-export interface SelectFormatterParams<T = any> {
-    // (undocumented)
-    dataTestId?: ((rowData: T) => string) | string;
-    // (undocumented)
-    nullText?: string;
-    // (undocumented)
-    onChange?: (value: string, rowData: T) => void;
-    // Warning: (ae-forgotten-export) The symbol "SelectOption" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    options: SelectOption<T>[];
-    // (undocumented)
-    prefix?: string;
-}
-
-// @public
-export const tabulatorExternalStockStyles: ElementStyles;
-
-// @public
-export const tabulatorThemeSimpleCSS: ElementStyles;
-
-// Warning: (ae-incompatible-release-tags) The symbol "textFormatter" is marked as @public, but its signature references "TextFormatterParams" which is marked as @alpha
-//
-// @public
-export function textFormatter<T = any>(cell: any, formatterParams?: TextFormatterParams<T>): string;
-
-// @alpha
-export interface TextFormatterParams<T = any> {
-    // (undocumented)
-    dataTestId?: ((rowData: T) => string) | string;
-    // (undocumented)
-    nullText?: string;
-    // (undocumented)
-    prefix?: string;
-    // (undocumented)
-    specialColor?: string;
-    // (undocumented)
-    specialFontWeight?: string;
-    // (undocumented)
-    specialValue?: any;
-}
-
-// @public
-export const themeFontsId: (themeName: string) => string;
-
-// @public
-export const themeTokenMapClassname: (themeName: string) => string;
-
-// @public
-export const themeTokenMapCSS: (themeName: string, tokenMap: CSSVarTokenMap<any>) => ElementStyles;
-
-// Warnings were encountered during analysis:
-//
-// src/grid-tabulator.components.ts:24:47 - (ae-forgotten-export) The symbol "DateEditor" needs to be exported by the entry point index.d.ts
-// src/grid-tabulator.components.ts:24:47 - (ae-forgotten-export) The symbol "NumberEditor" needs to be exported by the entry point index.d.ts
-// src/grid-tabulator.components.ts:24:47 - (ae-forgotten-export) The symbol "SelectEditor" needs to be exported by the entry point index.d.ts
-// src/grid-tabulator.components.ts:24:47 - (ae-forgotten-export) The symbol "StringEditor" needs to be exported by the entry point index.d.ts
-// src/grid-tabulator.components.ts:24:47 - (ae-forgotten-export) The symbol "MultiselectEditor" needs to be exported by the entry point index.d.ts
-// src/grid-tabulator.components.ts:24:47 - (ae-incompatible-release-tags) The symbol "foundationGridTabulator" is marked as @public, but its signature references "GridTabulator" which is marked as @alpha
-
-// (No @packageDocumentation comment for this package)
-
-```