@economic/taco 2.25.1 → 2.26.1

package/dist/components/Table3/types.d.ts

@@ -1,238 +1,12 @@
-/// <reference types="react" />
-import { ColumnOrderState, ColumnSizingState, SortingState, VisibilityState, BuiltInSortingFn } from '@tanstack/react-table';
-import { MenuProps } from '../Menu/Menu';
-import { MenuItemProps } from '../Menu/components/Item';
-import { TableColumnFilter, TableColumnRendererControl, TableColumnRendererControlProps, TableColumnSort, TableFilterHandler, TableRef, TableRowClickHandler, TableRowGotoHandler, TableRowHeight, TableRowSelectHandler, TableServerLoadAllHandler, TableServerLoadPageHandler, TableSortHandler } from '../../primitives/Table/types';
-import { FontSize, ValueOf } from '../../types';
-export declare type Table3SortDirection = 'asc' | 'desc';
-export declare type Table3SortFn<TType = unknown> = ((rowA: TType, rowB: TType, columnId: string) => -1 | 0 | 1) | BuiltInSortingFn | 'auto';
-export declare type Table3ColumnRenderer<TValue = unknown, TType = unknown> = (value: TValue, row: TType) => JSX.Element | string | number | null;
-export declare type Table3ColumnFooterRenderer<TValue = unknown> = (values: TValue[]) => JSX.Element | string | number | null;
-export declare type Table3ColumnClassNameHandler<TType = unknown> = string | ((row: TType) => string | undefined);
-export declare type Table3ColumnAlignment = 'left' | 'center' | 'right';
-export declare type Table3ColumnDataType = 'auto' | 'number' | 'alphanumeric' | 'alphanumericCaseSensitive' | 'datetime' | 'boolean';
-export declare type Table3ColumnHeaderMenu = (props: Partial<MenuProps>) => JSX.Element;
-export declare type Table3ColumnControlProps = TableColumnRendererControlProps;
-export declare type Table3ColumnControlRenderer<TType = unknown> = TableColumnRendererControl<TType>;
-export declare type Table3ColumnProps<TType = unknown> = ValueOf<{
-    [K in keyof TType]: {
-        accessor: K;
-    } & {
-        align?: Table3ColumnAlignment;
-        className?: Table3ColumnClassNameHandler<TType>;
-        control?: Table3ColumnControlRenderer<TType>;
-        dataType?: Table3ColumnDataType;
-        defaultHidden?: boolean;
-        defaultWidth?: number | 'grow';
-        enableFiltering?: boolean;
-        enableHiding?: boolean;
-        enableOrdering?: boolean;
-        enablePrinting?: boolean;
-        enableResizing?: boolean;
-        enableSearch?: boolean;
-        enableSorting?: boolean;
-        enableTruncate?: boolean;
-        filters?: Table3FilterComparator[];
-        footer?: Table3ColumnFooterRenderer;
-        header: string;
-        headerClassName?: string;
-        menu?: Table3ColumnHeaderMenu;
-        minWidth?: number;
-        renderer?: Table3ColumnRenderer<TType[K], TType>;
-        sort?: Table3SortDirection;
-        sortFn?: Table3SortFn<TType>;
-        tooltip?: string;
-    };
-}>;
-export declare type Table3GroupProps = {
-    id: string;
-    header: string;
-    colSpan?: number;
-    children: (JSX.Element | boolean | null | undefined)[];
-};
-export declare type DeprecatedRowDensity = 'compact' | 'normal' | 'comfortable' | 'spacious';
-export declare type Table3RowHeight = TableRowHeight;
-export declare type Table3RowClickHandler<TType = unknown> = TableRowClickHandler<TType>;
-export declare type Table3RowDragHandler<TType = unknown> = (rows: TType[], showPlaceholder: (string: any) => void, setDataTransfer: (data: string) => void) => void;
-export declare type Table3RowDropHandler<TType = any> = (event: React.DragEvent, row: TType) => void;
-export declare type Table3RowExpansionRenderer<TType = unknown> = (row: TType) => (() => JSX.Element) | null;
-export declare type Table3RowSelectionHandler<TType = unknown> = TableRowSelectHandler<TType>;
-export declare type Table3RowActionRenderer<TType = unknown> = (row: TType) => JSX.Element | null;
-export declare type Table3Preset = 'display' | 'editable' | 'card';
-export declare type Table3Settings = {
-    columnFreezingIndex?: number;
-    columnOrder?: ColumnOrderState;
-    columnSizing?: ColumnSizingState;
-    columnVisibility?: VisibilityState;
-    excludeUnmatchedRecordsInSearch?: boolean;
-    fontSize?: FontSize;
-    rowHeight?: Table3RowHeight;
-    showWarningWhenPrintingLargeDataset?: boolean;
-    sorting?: SortingState;
-};
-export declare type Table3SettingsHandler = (settings: Table3Settings) => void | Promise<void>;
-export declare enum Table3FilterComparator {
-    Contains = 0,
-    DoesNotContain = 1,
-    IsEqualTo = 2,
-    IsNotEqualTo = 3,
-    IsGreaterThan = 4,
-    IsLessThan = 5,
-    IsBetween = 6,
-    IsEmpty = 7,
-    IsNotEmpty = 8,
-    IsLessThanOrEqualTo = 9,
-    IsGreaterThanOrEqualTo = 10,
-    HasAnyOf = 11,
-    HasAllOf = 12,
-    HasNoneOf = 13
-}
-export declare type Table3FilterValue = {
-    comparator: Table3FilterComparator | null;
-    value: any;
-};
-export declare type Table3Filter = {
-    id: string | null;
-    value: Table3FilterValue;
-};
-export declare type ColumnFilter = TableColumnFilter;
-export declare type Table3FilterHandler = TableFilterHandler;
-export declare type Table3LoadPageHandler = TableServerLoadPageHandler;
-export declare type Table3LoadAllHandler = TableServerLoadAllHandler;
-export declare type Table3RowGotoHandler = TableRowGotoHandler;
-export declare type Table3ColumnSort = TableColumnSort;
-export declare type Table3SortHandler = TableSortHandler;
-export declare type RowErrors = Record<string, string>;
-export declare type Table3CellValidationHandler<TType = unknown> = (cellValue: any, cellId: string, row: TType) => Promise<RowErrors | undefined | void>;
-export declare type Table3RowValidationHandler<TType = unknown> = (row: TType) => Promise<RowErrors | undefined | void>;
-export declare type TableStrategy = {
-    renderBody: () => JSX.Element | JSX.Element[] | null;
-    scrollToIndex: (index: number, options?: {
-        align: 'start' | 'center' | 'end' | 'auto';
-    }) => void;
-};
-export declare type Table3ShortcutHandlerFn<TType = unknown> = (row: TType) => void;
-export declare type Table3ShortcutHandlerObject<TType = unknown> = {
-    handler: Table3ShortcutHandlerFn<TType>;
-    meta?: boolean;
-    shift?: boolean;
-};
-export declare type Table3Shortcuts<TType = unknown> = Record<string, Table3ShortcutHandlerFn<TType> | Table3ShortcutHandlerObject<TType>>;
-export declare type Table3SaveHandler<TType = unknown> = (data: TType) => Promise<void>;
-export declare type Table3Options = {
-    enableColumnFreezing: boolean;
-    enableColumnHiding: boolean;
-    enableColumnOrdering: boolean;
-    enableColumnResizing: boolean;
-    enableFontSize: boolean;
-    enableFooter: boolean;
-    enablePrinting: boolean;
-    enableRowDrag: boolean;
-    enableRowDrop: boolean;
-    enableRowExpansion: boolean;
-    enableRowGoto: boolean;
-    enableRowHeight: boolean;
-    enableRowSelection: boolean;
-    enableRowSelectionSingle: boolean;
-    enableEditing: boolean;
-    enableFiltering: boolean;
-    enableSearch: boolean;
-    enableSorting: boolean;
-};
-export declare type Table3CustomSettingRenderer = (props: Table3Settings) => React.ReactElement<MenuItemProps> | null;
-export declare type Table3CommonProps<TType = unknown> = Partial<Table3Options> & {
-    actionsForRow?: Table3RowActionRenderer<TType>[];
-    actionsForRowLength?: number;
-    autoFocus?: boolean;
-    children: (JSX.Element | boolean | null | undefined)[];
-    customSettings?: Table3CustomSettingRenderer[];
-    data: TType[];
-    defaultColumnFreezingIndex?: number;
-    defaultCurrentRowIndex?: number;
-    defaultSettings?: Table3Settings;
-    emptyState?: () => JSX.Element | null;
-    expandedRowRenderer?: Table3RowExpansionRenderer<TType>;
-    id: string;
-    onChangeSettings?: Table3SettingsHandler;
-    onRowClick?: Table3RowClickHandler<TType>;
-    onRowDrag?: Table3RowDragHandler<TType>;
-    onRowDrop?: Table3RowDropHandler<TType>;
-    onRowGoto?: Table3RowGotoHandler;
-    onRowSelect?: Table3RowSelectionHandler<TType>;
-    onFilter?: Table3FilterHandler;
-    onSave?: Table3SaveHandler<TType>;
-    onSort?: Table3SortHandler;
-    onCellValidate?: Table3CellValidationHandler<TType>;
-    onRowValidate?: Table3RowValidationHandler<TType>;
-    preset?: Table3Preset;
-    shortcuts?: Table3Shortcuts<TType>;
-    toolbarLeft?: JSX.Element;
-    toolbarRight?: JSX.Element;
-    rowIdentifier?: string;
-};
-interface Table3ClientProps<TType = unknown> extends Table3CommonProps<TType> {
-    length?: never;
-    loadPage?: never;
-    loadAll?: never;
-    pageSize?: never;
-}
-interface Table3ServerProps<TType = unknown> extends Table3CommonProps<TType> {
-    length: number | undefined;
-    loadPage: Table3LoadPageHandler;
-    loadAll: Table3LoadAllHandler;
-    pageSize?: number;
-}
-export declare type Table3Props<TType = unknown> = Table3ClientProps<TType> | Table3ServerProps<TType>;
-export declare type Table3Ref = TableRef & {
-    instance: {
-        toggleEditing: (enabled: boolean | undefined) => void;
-    };
+import { TableProps } from '../../primitives/Table/types';
+export declare type TableEditingSaveHandler<TType = unknown> = (row: TType) => Promise<void>;
+export declare type TableEditingValidatorFn<TType = unknown> = (row: TType) => Promise<Partial<Record<keyof TType, string>> | undefined> | Partial<Record<keyof TType, string>> | undefined;
+export declare type Table3Props<TType = unknown> = TableProps<TType> & {
+    enableEditing?: boolean;
+    onSave?: TableEditingSaveHandler<TType>;
+    validator?: TableEditingValidatorFn<TType>;
 };
 export declare type Table3Texts = {
-    columns: {
-        actions: {
-            tooltip: string;
-        };
-        drag: {
-            tooltip: string;
-        };
-        expansion: {
-            collapse: string;
-            collapseAll: string;
-            expand: string;
-            expandAll: string;
-        };
-        menu: {
-            editFilter: string;
-            filter: string;
-            freezeFirstColumn: string;
-            freezeUptoColumn: string;
-            gotoRow: string;
-            hideColumn: string;
-            unfreezeColumns: string;
-            sorting: string;
-            sortingOrder: {
-                ascending: string;
-                descending: string;
-                unsorted: string;
-            };
-        };
-        resize: {
-            tooltip: string;
-        };
-        select: {
-            deselect: string;
-            deselectAll: string;
-            select: string;
-            selectAll: string;
-        };
-    };
-    columnSettings: {
-        button: string;
-        noResults: string;
-        search: string;
-        tooltip: string;
-    };
     editing: {
         actions: {
             tooltip: string;
@@ -245,6 +19,12 @@ export declare type Table3Texts = {
                 tooltip: string;
             };
         };
+        clearChangesConfirmationDialog: {
+            title: string;
+            description: string;
+            cancel: string;
+            confirm: string;
+        };
         rowIndicator: {
             rowWillMove: string;
             rowWillBeHidden: string;
@@ -256,124 +36,21 @@ export declare type Table3Texts = {
             progress: string;
             complete: string;
         };
-        clearChangesConfirmationDialog: {
-            title: string;
-            description: string;
-            cancel: string;
-            confirm: string;
-        };
-    };
-    filters: {
-        button: string;
-        buttons: {
-            addFilter: string;
-            clearFilters: string;
-        };
-        comparators: {
-            contains: string;
-            doesNotContain: string;
-            isEqualTo: string;
-            isNotEqualTo: string;
-            isGreaterThan: string;
-            isLessThan: string;
-            isBetween: string;
-            isEmpty: string;
-            isNotEmpty: string;
-            isBefore: string;
-            isAfter: string;
-            isLessThanOrEqualTo: string;
-            isGreaterThanOrEqualTo: string;
-            isOnOrBefore: string;
-            isOnOrAfter: string;
-            hasAnyOf: string;
-            hasAllOf: string;
-            hasNoneOf: string;
-        };
-        conditions: {
-            and: string;
-            where: string;
-        };
-        emptyFilter: {
-            condition: string;
-            value: string;
-        };
-        hiddenColumn: string;
-        hiddenGroupedColumn: string;
-        tooltip: string;
-        total: string;
-    };
-    fontSize: {
-        tooltip: string;
-        sizes: {
-            small: string;
-            medium: string;
-            large: string;
-        };
-    };
-    footer: {
-        summary: {
-            count: string;
-            records: string;
-            selected: string;
-        };
-    };
-    print: {
-        error: string;
-        loading: string;
-        tooltip: string;
-        warningDialog: {
-            title: string;
-            description: string;
-            checkboxVisibilityLabel: string;
-            cancelButtonText: string;
-            printButtonText: string;
-        };
-        settingsDialog: {
-            title: string;
-            size: string;
-            sizeA5: string;
-            sizeA4: string;
-            sizeA3: string;
-            sizeLetter: string;
-            sizeLegal: string;
-            orientation: string;
-            orientationLandscape: string;
-            orientationPortrait: string;
-            rows: string;
-            rowsAll: string;
-            rowsSelected: string;
-            layout: string;
-            layoutSplitGroups: string;
-        };
-    };
-    rowHeight: {
-        tooltip: string;
-        sizes: {
-            short: string;
-            medium: string;
-            tall: string;
-            extraTall: string;
-        };
-    };
-    search: {
-        excludeUnmatchedResults: string;
-        placeholder: string;
-    };
-    otherOptions: {
-        tooltip: string;
-    };
-    validation: {
-        index: string;
-        alert: {
-            unsavedEntries: (count?: number) => string;
-            incompleteAndHavntBeenSaved: (count?: number) => string;
-        };
-        resetFiltersDialog: {
-            title: string;
-            description: string;
-            cancel: string;
-            confirm: string;
+        validation: {
+            alert: {
+                titleOne: string;
+                titlePlural: string;
+                messageOne: string;
+                messagePlural: string;
+                messageRow: string;
+                messageAnd: string;
+            };
+            resetFiltersDialog: {
+                title: string;
+                description: string;
+                cancel: string;
+                confirm: string;
+            };
         };
     };
 };
-export {};

package/dist/components/Table3/useTable3.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { RowData } from '@tanstack/react-table';
+import { TableRef } from '../../primitives/Table/types';
+import { useTableEditing } from './features/useTableEditing';
+import { Table3Props } from './types';
+declare module '@tanstack/table-core' {
+    interface TableMeta<TData extends RowData> {
+        editing: ReturnType<typeof useTableEditing>;
+    }
+}
+export declare function useTable3<TType>(props: Table3Props<TType>, ref: React.Ref<TableRef>): import("../../primitives/Table/Core/useTable").useTableReturnValue<TType>;

package/dist/components/Table3/util/editing.d.ts

@@ -1,10 +1,2 @@
-export declare const focussableNodeNames: string[];
-export declare const focusableSelector: string;
-export declare const hasChanged: (value: any, newValue: any) => boolean;
-export declare const willRowMoveAfterSorting: (value: any, cell: any, rowIndex: any, rows: any, desc: any) => boolean;
-export declare class LastCellIndex {
-    _value: string | null | undefined;
-    get value(): string | null | undefined;
-    set value(val: string | null | undefined);
-}
-export declare function getColumnIndex(element: Element): string | null | undefined;
+import { Cell as ReactTableCell } from '@tanstack/react-table';
+export declare function willRowMove<TType = unknown>(cell: ReactTableCell<TType, unknown>, change: unknown, rowIndex: number): "search" | "filter" | "sorting" | undefined;