@dcs-tech/ui 0.2.0 → 0.4.0

package/dist/types/components/DataTable/grouping/groupModel.d.ts

@@ -0,0 +1,82 @@
+import type { DataTableFilterCondition, DataTableFilterGroup, DataTableColumn, DataTableView, DataTableGroupPathItem } from '../types';
+export declare const DEFAULT_GROUP_DEPTH = 3;
+export type GroupValue = string | number | boolean | null;
+export interface GroupNode<R = any> {
+    key: string;
+    path: DataTableGroupPathItem[];
+    depth: number;
+    columnKey: string;
+    value: GroupValue;
+    label: string;
+    count: number;
+    aggregates?: Record<string, number | string>;
+    rows?: R[];
+    children?: GroupNode<R>[];
+}
+export type DisplayItem<R = any> = {
+    kind: 'group';
+    key: string;
+    node: GroupNode<R>;
+    expanded: boolean;
+    continued?: boolean;
+} | {
+    kind: 'row';
+    key: string;
+    row: R;
+    depth: number;
+} | {
+    kind: 'more';
+    key: string;
+    node: GroupNode<R>;
+    shown: number;
+    loading: boolean;
+    capped: boolean;
+} | {
+    kind: 'status';
+    key: string;
+    node: GroupNode<R>;
+    status: 'loading' | 'error';
+};
+export interface GroupLabels {
+    yes: string;
+    no: string;
+    groupEmpty: string;
+}
+export declare const pathKey: (path: Array<Pick<DataTableGroupPathItem, "key" | "value">>) => string;
+export declare function resolveGroupingConfig(config: Pick<DataTableView, 'grouping'>, opts: {
+    serverMode: boolean;
+    hasGroupsSource: boolean;
+    allowed: boolean;
+}): {
+    enabled: boolean;
+    maxDepth: number;
+    defaultLevels: string[];
+};
+export declare function groupableColumns<T>(columns: DataTableColumn<T>[], serverMode: boolean): DataTableColumn<T>[];
+export declare function offersGrouping(col: Pick<DataTableColumn, 'groupable' | 'type'>, serverMode: boolean): boolean;
+export declare function normalizeLevels(levels: readonly string[] | undefined, groupable: readonly string[], maxDepth: number): string[];
+export declare function groupValueOf<T>(col: DataTableColumn<T>, row: T): GroupValue;
+export declare function groupLabelOf<T>(col: DataTableColumn<T> | undefined, value: GroupValue, L: GroupLabels, given?: string | null): string;
+export declare function sortGroups<R>(nodes: GroupNode<R>[], desc: boolean): GroupNode<R>[];
+export declare function buildClientGroups<R, T>(rows: R[], levels: DataTableColumn<T>[], original: (r: R) => T, opts: {
+    labels: GroupLabels;
+    sortedDesc?: (key: string) => boolean | undefined;
+    parent?: DataTableGroupPathItem[];
+}): GroupNode<R>[];
+export declare function allGroupKeys<R>(nodes: GroupNode<R>[] | undefined, out?: string[]): string[];
+export declare function flattenGroups<R>(nodes: GroupNode<R>[], opts: {
+    expanded: ReadonlySet<string>;
+    levels: number;
+    rowKey: (r: R) => string;
+    loadState?: (node: GroupNode<R>) => {
+        status: 'loading' | 'error' | 'done';
+        rows?: R[];
+        loadingMore?: boolean;
+        capped?: boolean;
+    } | undefined;
+}): DisplayItem<R>[];
+export declare function pageOfItems<R>(items: DisplayItem<R>[], pageIndex: number, pageSize: number): DisplayItem<R>[];
+export declare function valueCondition<T>(id: string, key: string, col: DataTableColumn<T> | undefined, value: GroupValue): DataTableFilterCondition;
+export declare function valueOperators<T>(col: DataTableColumn<T>): string[];
+export declare function groupConditions<T>(path: DataTableGroupPathItem[], columns: DataTableColumn<T>[]): DataTableFilterCondition[];
+export declare function withGroupFilter<T>(group: DataTableFilterGroup, path: DataTableGroupPathItem[], columns: DataTableColumn<T>[]): DataTableFilterGroup;

package/dist/types/components/DataTable/grouping/useGrouping.d.ts

@@ -0,0 +1,39 @@
+import type { DataTableColumn, DataTableDataSource, DataTableQuery } from '../types';
+import { type GroupLabels, type GroupNode } from './groupModel';
+export declare function useGroupLevels(initial: string[]): {
+    levels: string[];
+    setLevels: (next: string[]) => void;
+    expanded: Set<string>;
+    toggle: (key: string) => void;
+    expand: (keys: string[]) => void;
+    collapseAll: () => void;
+};
+export declare const GROUP_ROWS_CAP = 1000;
+export interface GroupRowsEntry<T> {
+    status: 'loading' | 'error' | 'done';
+    rows: T[];
+    loadingMore?: boolean;
+    capped?: boolean;
+}
+export declare function useServerGroups<T>(opts: {
+    dataSource: DataTableDataSource<T> | undefined;
+    active: boolean;
+    query: DataTableQuery | null;
+    levels: string[];
+    columns: DataTableColumn<T>[];
+    expanded: ReadonlySet<string>;
+    labels: GroupLabels;
+    rowKey?: string;
+    tick: number;
+}): {
+    tree: GroupNode<T>[];
+    loadState: (node: GroupNode<T>) => GroupRowsEntry<T> | {
+        status: "error" | "loading" | "done";
+    } | undefined;
+    loadedRows: T[];
+    total: number;
+    loading: boolean;
+    error: boolean;
+    showAll: (node: GroupNode<T>) => void;
+    retry: (node: GroupNode<T> | null) => void;
+};

package/dist/types/components/DataTable/host.d.ts

@@ -0,0 +1,14 @@
+import type { DataTableAuthorize, DataTableExportOptions, DataTableGate } from './types';
+import { type TableFormat, type DataTableLabels } from './labels';
+export interface TableHost {
+    authorize: DataTableAuthorize;
+    exportOptions: DataTableExportOptions;
+    serverMode: boolean;
+    operators?: readonly string[];
+    labels: DataTableLabels;
+    format: TableFormat;
+}
+export declare const TableHostContext: import("react").Context<TableHost>;
+export declare function useTableHost(): TableHost;
+export declare function useLabels(): DataTableLabels;
+export declare function can(authorize: DataTableAuthorize | undefined, gate: DataTableGate, subject?: unknown): boolean;

package/dist/types/components/DataTable/index.d.ts

@@ -0,0 +1,18 @@
+export { default as DataTable } from './DataTable';
+export type { DataTableProps, DataTableView, DataTableColumn, DataTableColumnType, DataTableComponentProps, DataTableRowAction, DataTableFilterGroup, DataTableFilterCondition, DataTableActiveFilter, DataTableSingleRowView, DataTableSingleRowField, DataTableSingleRowAction, DataTableSelectionConfig, DataTableSelectionShow, DataTablePaginationConfig, DataTableSortingConfig, DataTableFilteringConfig, DataTableQuickFilter, DataTableQuickFilterMode, DataTableSavedFilter, DataTableSavedFilterIssue, DataTableViewPrefs, DataTableExportFormat, DataTableExportAction, DataTableExportTemplate, DataTableQuickExport, DataTableExportConfig, DataTableXlsxStyle, DataTablePdfConfig, DataTableExportGenerator, DataTableExportResult, DataTableExportResultStatus, DataTableExportGeneratorResult, DataTableFilenameContext, DataTableExportMeta, DataTableExportContext, DataTableExportSettings, DataTableExportPrefs, DataTableExportMetadata, DataTableExportSummary, DataTableExportSummaryTable, DataTableExportOptions, DataTableFileNameAs, DataTablePdfFonts, DataTablePdfPageSize, DataTablePdfOrientation, DataTablePdfFontSize, DataTablePdfMargins, DataTableSummaryConfig, DataTableSummaryCard, DataTableSummaryValueCard, DataTableSummaryRatioCard, DataTableSummaryBreakdownCard, DataTableSummaryTrendCard, DataTableSummaryFunnelCard, DataTableSummaryFunnelStep, DataTableSummaryValueTrend, DataTableSummaryPeriod, DataTableSummaryTrendChart, DataTableSummaryValueChart, DataTableSummaryRatioChart, DataTableSummaryAnyChart, DataTableSummaryCardRequest, DataTableSummaryPeriodCount, DataTableSummaryFigure, DataTableSummarySubline, DataTableSummaryStrip, DataTableSummaryChart, DataTableSummaryWidth, DataTableSummaryShow, DataTableSummaryPart, DataTableSummaryUserCard, DataTableSummaryPrefs, DataTableExportSummaryMode, DataTableSummaryPlacement, DataTableSummaryRequest, DataTableSummaryBucket, DataTableSummaryBreakdown, DataTableSummaryFigures, DataTableLicense, DataTableFlashColor, DataTableFlashColors, DataTableCellFlashStyle, DataTableCellStyle, DataTableLayout, DataTableCardFields, DataTableCardField, DataTableListFields, DataTableListField, DataTableRowMenuConfig, DataTableRowMenuItem, DataTableRowMenuBuiltIn, DataTableRowMenuIconAction, DataTableDetailMode, DataTableDetailContext, DataTableDetailRenderer, DataTableDisplayPrefs, DataTableDensity, DataTableFontSize, DataTableColumnWidth, DataTableActionDisplay, DataTableQuery, DataTableDataSource, DataTableRowsResult, DataTableAllRowsResult, DataTableCounts, DataTableInitialState, DataTableApi, DataTablePersistence, DataTableGate, DataTableAuthorize, DataTableManagePrefs, DataTableManageList, DataTableViewsPrefs, DataTableExportTemplatePrefs, DataTableBulkAction, DataTableBulkActionContext, DataTableBulkActionResult, DataTableBulkConfirm, DataTableSelection, DataTableColumnPinning, DataTablePinningConfig, DataTableKeyboardConfig, DataTableShortcut, DataTableVirtualizeConfig, DataTableGroupingConfig, DataTableGroupPathItem, DataTableGroupResult, DataTableGroupSummaryContext, DataTableViewState, DataTableSharedView, DataTableShareAudience, DataTableSharing, } from './types';
+export { isFilterGroup, CARD_FIELD_LIMITS, LIST_FIELD_LIMITS, SUMMARY_PLACEMENTS_MAX, SUMMARY_SHOWS, SUMMARY_STRIPS, SUMMARY_TREND_COUNTS, SUMMARY_TREND_COUNT_BOUNDS, SUMMARY_KIND_CHARTS, SUMMARY_USER_CARDS_MAX, SUMMARY_WIDTHS } from './types';
+export { DEFAULT_DATA_TABLE_LABELS } from './labels';
+export type { DataTableLabels, DataTableLabelKey } from './labels';
+export { localStorageAdapter, memoryAdapter } from './persistence/adapters';
+export { evaluateCondition, evaluateGroup, flattenActiveFilters, getOperatorsForType, operatorLabel, hasActiveConditions, removeConditionById } from './filters/filterEngine';
+export { createEmptyFilterGroup, generateId, getNestedValue } from './defaults';
+export { prepareExportRows, autoFormatValue } from './export/exportRows';
+export { defaultCardFields, normalizeCardFields, isCardFields, defaultListFields, normalizeListFields, isListFields } from './cards/cardFields';
+export { applyValueFilter, cellFilterValues, valueFilterKinds } from './menu/valueFilter';
+export type { DataTableCellFilterValue, DataTableValueFilterKind } from './menu/valueFilter';
+export { copyText, rowsToTsv } from './menu/clipboard';
+export { parseShortcut, formatShortcut, duplicateShortcuts, isTypingTarget } from './keyboard/shortcuts';
+export { groupConditions, withGroupFilter, groupableColumns, DEFAULT_GROUP_DEPTH } from './grouping/groupModel';
+export { SUMMARY_CONDITION_PREFIX, SUMMARY_PART_TOP, chartOf as summaryChartOf, summaryChartsFor, summaryConditionId, summaryRequest } from './summary/summaryModel';
+export { formatContextLine, formatMetadataLines, type ContextLineOptions } from './export/exportContext';
+export { quickFiltersStillOn } from './filters/quickFilterMatch';

package/dist/types/components/DataTable/keyboard/ShortcutsDialog.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+export interface ShortcutListEntry {
+    keys: string[];
+    label: string;
+}
+interface ShortcutsDialogProps {
+    builtIns: boolean;
+    grouping: boolean;
+    actions: ShortcutListEntry[];
+    table: ShortcutListEntry[];
+    onClose: () => void;
+}
+export declare function ShortcutsDialog({ builtIns, grouping, actions, table, onClose }: ShortcutsDialogProps): React.JSX.Element;
+export default ShortcutsDialog;

package/dist/types/components/DataTable/keyboard/shortcuts.d.ts

@@ -0,0 +1,22 @@
+export interface KeyChord {
+    key: string;
+    shift: boolean;
+    mod: boolean;
+    alt: boolean;
+}
+export declare function parseShortcut(text: string | undefined | null): KeyChord | null;
+export declare function chordOf(e: Pick<KeyboardEvent, 'key' | 'shiftKey' | 'ctrlKey' | 'metaKey' | 'altKey'>): KeyChord;
+export declare const chordId: (c: KeyChord) => string;
+export declare const sameChord: (a: KeyChord | null, b: KeyChord | null) => boolean;
+export declare function formatShortcut(text: string): string;
+export declare function isTypingTarget(target: EventTarget | null): boolean;
+export declare const BUILT_IN_KEYS: readonly string[];
+export interface DeclaredShortcut {
+    source: string;
+    key: string;
+}
+export declare function duplicateShortcuts(declared: DeclaredShortcut[]): Array<{
+    key: string;
+    sources: string[];
+}>;
+export declare function warnDuplicateShortcuts(tableName: string, declared: DeclaredShortcut[]): void;

package/dist/types/components/DataTable/keyboard/useGridKeyboard.d.ts

@@ -0,0 +1,48 @@
+import React, { type MutableRefObject, type RefObject } from 'react';
+import type { DisplayItem, GroupNode } from '../grouping/groupModel';
+import type { RowMenuModel } from '../menu/RowMenu';
+import type { RowMenuRequest } from '../rows/rowPress';
+import type { DataTableLayout, DataTableShortcut } from '../types';
+import type { ScrollApi } from '../virtual/useVirtualLines';
+export interface GridKeyboardHost<R = any, T = any> {
+    enabled: boolean;
+    shortcuts: boolean;
+    layout: DataTableLayout;
+    items: DisplayItem<R>[];
+    columns: string[];
+    activeKey: string | null;
+    activeCol: number;
+    setActive: (key: string | null, col: number) => void;
+    rowId: (row: R) => string;
+    original: (row: R) => T;
+    openRow: (row: R) => void;
+    toggleRow: (row: R) => void;
+    toggleGroup: (key: string) => void;
+    toggleGroupSelection: (node: GroupNode<R>) => boolean;
+    showAll: (node: GroupNode<R>) => void;
+    selectRange: (ids: string[], base: Record<string, boolean>) => void;
+    selectionSnapshot: () => Record<string, boolean>;
+    selectPage: () => void;
+    clearSelection: () => boolean;
+    openMenu: (row: R, at: RowMenuRequest) => void;
+    menuModel: (row: R, columnKey: string | null) => RowMenuModel | null;
+    tableShortcuts: DataTableShortcut<T>[];
+    runTableShortcut: (s: DataTableShortcut<T>, row: T | null) => void;
+    page: (delta: 1 | -1) => boolean;
+    openHelp: () => void;
+}
+export declare function useGridKeyboard<R, T>(host: GridKeyboardHost<R, T>, areaRef: RefObject<HTMLElement | null>, scrollApi: MutableRefObject<ScrollApi | null>): {
+    onKeyDown: (e: React.KeyboardEvent) => void;
+    onFocus: (e: React.FocusEvent) => void;
+    focusLine: (key: string | "first", col: number) => void;
+};
+export declare function useTableKeys<T>(opts: {
+    enabled: boolean;
+    shortcuts: boolean;
+    containerRef: RefObject<HTMLElement | null>;
+    areaRef: RefObject<HTMLElement | null>;
+    tableShortcuts: DataTableShortcut<T>[];
+    run: (s: DataTableShortcut<T>) => void;
+    openHelp: () => void;
+    refocus?: () => void;
+}): void;