eidos-ui 1.2.0 → 2.0.0

package/dist/Table.types-Cl5gR8r9.d.cts

@@ -0,0 +1,183 @@
+import { ReactNode } from 'react';
+import { I as IconType } from './renderIcon-C2lEMMzb.cjs';
+import { B as ButtonColorProps, b as ButtonVariantProps } from './Button.types-DZRCVqyN.cjs';
+
+/**
+ * A field name of a row-data type, as a string-literal union.
+ *
+ * Shared by every data component that addresses row fields by name
+ * (`Table`, `DataGrid`) so the same concept is typed one way everywhere -
+ * `TableColumn.key`, `DataGridColumn.key`, `rowKey`, sort keys, and the
+ * filter/quick-filter schemas.
+ *
+ * Degrades to `string` for the untyped default (`Record<string, unknown>`),
+ * which is what keeps callers who never specify `T` compiling unchanged.
+ *
+ * `Extract<keyof T, string>` rather than `keyof T`: keys are compared against
+ * and rendered as strings throughout (`data-col-key`, React keys, filter
+ * state objects), so numeric and symbol keys are excluded deliberately.
+ *
+ * ## Why this only works when `T` has no index signature
+ *
+ * An index signature widens `keyof T` to `string`, at which point this
+ * resolves to `string` and every key-narrowing and per-key value type built
+ * on it silently degrades to the old, unchecked behaviour. That is exactly
+ * what `T extends Record<string, unknown>` used to force on consumers:
+ * TypeScript only grants *implicit* index signatures to object type aliases,
+ * so anyone modelling rows with an `interface` had to write
+ * `interface Row extends Record<string, unknown>` to satisfy it - and thereby
+ * opted out of all of this without knowing.
+ *
+ * Both components now constrain `T extends object` instead, so a plain
+ * interface is accepted and keeps its literal keys. Don't tighten that
+ * constraint back to `Record<string, unknown>`: it would not fail loudly, it
+ * would just quietly stop checking.
+ */
+type RowKey<T> = Extract<keyof T, string>;
+
+/** A secondary action inside a `type: 'split-button'` bulk action's dropdown. */
+interface BulkActionSplitOption<T> {
+    id: string;
+    label: string;
+    icon?: IconType;
+    disabled?: boolean;
+    /** Receives the full array of currently selected row objects. */
+    onClick: (selectedRows: T[]) => void;
+}
+interface BulkActionCommon<T> {
+    /** Only needs to be unique within this `bulkActions` array. */
+    id: string;
+    color?: ButtonColorProps;
+    disabled?: boolean | ((selectedRows: T[]) => boolean);
+    /** Primary action - fired on click for `'button'`, or on the primary (left) segment for `'split-button'`. */
+    onClick: (selectedRows: T[]) => void;
+}
+interface BulkActionButton<T> extends BulkActionCommon<T> {
+    /** @default 'button' */
+    type?: 'button';
+    /** Omit to render an icon-only button - `icon` becomes the sole icon in that case. */
+    label?: string;
+    icon?: IconType;
+    posIcon?: IconType;
+    variant?: ButtonVariantProps;
+}
+interface BulkActionSplitButton<T> extends BulkActionCommon<T> {
+    type: 'split-button';
+    /** Required - SplitButton always renders a primary label. */
+    label: string;
+    icon?: IconType;
+    /** SplitButton has no `text` variant. */
+    variant?: Exclude<ButtonVariantProps, 'text'>;
+    /** Secondary actions shown in the split-button's dropdown. */
+    options: BulkActionSplitOption<T>[];
+}
+type BulkAction<T> = BulkActionButton<T> | BulkActionSplitButton<T>;
+/** Members shared by every column variant, field-addressing or not. */
+interface TableColumnCommon {
+    label: string;
+    sortable?: boolean;
+    filterable?: boolean;
+    filterType?: 'text' | 'select' | 'date' | 'boolean';
+    filterOptions?: {
+        id: string;
+        value: string;
+        label: string;
+    }[];
+    dateFilterMode?: 'single' | 'multiple' | 'range';
+    width?: string;
+    align?: 'left' | 'center' | 'right';
+    /** Enables position:sticky on this column */
+    pin?: 'left' | 'right';
+}
+/**
+ * A column bound to the row field named by `key`, which is what lets `render`
+ * receive `T[K]` rather than `unknown`.
+ *
+ * Not used directly - `TableColumn` distributes this over `keyof T` so each
+ * entry correlates its own `key` with its own value type.
+ */
+interface TableValueColumn<T extends object, K extends RowKey<T>> extends TableColumnCommon {
+    key: K;
+    /** @default 'data' */
+    type?: 'data';
+    render?: (value: T[K], item: T) => ReactNode;
+}
+/**
+ * A column that renders from the whole row rather than one field - an icon or
+ * action cell, or a computed/composite value. `key` is free-form here because
+ * nothing reads `row[key]`: it's only an identity for React keys, sorting and
+ * `data-col-key`.
+ *
+ * `'icon'` and `'action'` carry their existing cell styling; `'custom'` styles
+ * like a normal data cell but takes a free-form key, which is the home for a
+ * derived column (previously expressible only by pointing `key` at a field
+ * that didn't exist).
+ */
+interface TableCustomColumn<T extends object> extends TableColumnCommon {
+    /** Free-form - must only be unique within `columns`. */
+    key: string;
+    type: 'icon' | 'action' | 'custom';
+    /** `value` is always `undefined`; render from `item`. */
+    render?: (value: undefined, item: T) => ReactNode;
+}
+/**
+ * One column definition. A union of two variants, discriminated on `type`:
+ *
+ * - **value column** (default, `type` omitted or `'data'`) - `key` must be a
+ *   field of `T`, and `render` receives that field's type instead of `unknown`.
+ * - **`type: 'icon' | 'action' | 'custom'`** - renders from the whole row;
+ *   `key` is free-form.
+ *
+ * With the untyped default `T`, `RowKey<T>` is `string` and `T[K]` is
+ * `unknown`, which is byte-identical to the pre-2.0 behaviour.
+ *
+ * Replaces `key: keyof T | string`, which looked constrained but wasn't:
+ * `keyof T` is assignable to `string`, so that union collapsed to plain
+ * `string` and checked nothing.
+ */
+type TableColumn<T extends object = Record<string, unknown>> = {
+    [K in RowKey<T>]: TableValueColumn<T, K>;
+}[RowKey<T>] | TableCustomColumn<T>;
+type FilterValue = string | string[] | boolean | {
+    start: string | null;
+    end: string | null;
+} | undefined;
+interface TableFilters {
+    [key: string]: FilterValue;
+}
+interface TableProps<T extends object = Record<string, unknown>> {
+    data: T[];
+    columns: TableColumn<T>[];
+    loading?: boolean;
+    emptyMessage?: string;
+    onRowClick?: (item: T) => void;
+    className?: string;
+    showFooter?: boolean;
+    totalItems?: number;
+    showPagination?: boolean;
+    pageSize?: number;
+    pageSizeOptions?: number[];
+    onSortChange?: (sortBy: RowKey<T>, sortDirection: 'asc' | 'desc') => void;
+    currentSort?: {
+        key: RowKey<T>;
+        direction: 'asc' | 'desc';
+    };
+    filters?: TableFilters;
+    onFiltersChange?: (filters: TableFilters) => void;
+    defaultFilters?: TableFilters;
+    showFilters?: boolean;
+    selectable?: boolean;
+    rowKey?: RowKey<T>;
+    selectedRows?: string[];
+    defaultSelectedRows?: string[];
+    onSelectionChange?: (selectedKeys: string[], selectedRows: T[]) => void;
+    bulkActions?: BulkAction<T>[];
+    density?: 'compact' | 'comfortable' | 'spacious';
+    showColumnVisibility?: boolean;
+    showExport?: boolean;
+    showDensity?: boolean;
+    draggableColumns?: boolean;
+    onColumnReorder?: (newColumns: TableColumn<T>[]) => void;
+}
+
+export type { BulkAction as B, FilterValue as F, RowKey as R, TableColumn as T, BulkActionButton as a, BulkActionSplitButton as b, BulkActionSplitOption as c, TableCustomColumn as d, TableFilters as e, TableProps as f, TableValueColumn as g };

package/dist/Table.types-jhPb7JNU.d.ts

@@ -0,0 +1,183 @@
+import { ReactNode } from 'react';
+import { I as IconType } from './renderIcon-C2lEMMzb.js';
+import { B as ButtonColorProps, b as ButtonVariantProps } from './Button.types-BH0CPyPx.js';
+
+/**
+ * A field name of a row-data type, as a string-literal union.
+ *
+ * Shared by every data component that addresses row fields by name
+ * (`Table`, `DataGrid`) so the same concept is typed one way everywhere -
+ * `TableColumn.key`, `DataGridColumn.key`, `rowKey`, sort keys, and the
+ * filter/quick-filter schemas.
+ *
+ * Degrades to `string` for the untyped default (`Record<string, unknown>`),
+ * which is what keeps callers who never specify `T` compiling unchanged.
+ *
+ * `Extract<keyof T, string>` rather than `keyof T`: keys are compared against
+ * and rendered as strings throughout (`data-col-key`, React keys, filter
+ * state objects), so numeric and symbol keys are excluded deliberately.
+ *
+ * ## Why this only works when `T` has no index signature
+ *
+ * An index signature widens `keyof T` to `string`, at which point this
+ * resolves to `string` and every key-narrowing and per-key value type built
+ * on it silently degrades to the old, unchecked behaviour. That is exactly
+ * what `T extends Record<string, unknown>` used to force on consumers:
+ * TypeScript only grants *implicit* index signatures to object type aliases,
+ * so anyone modelling rows with an `interface` had to write
+ * `interface Row extends Record<string, unknown>` to satisfy it - and thereby
+ * opted out of all of this without knowing.
+ *
+ * Both components now constrain `T extends object` instead, so a plain
+ * interface is accepted and keeps its literal keys. Don't tighten that
+ * constraint back to `Record<string, unknown>`: it would not fail loudly, it
+ * would just quietly stop checking.
+ */
+type RowKey<T> = Extract<keyof T, string>;
+
+/** A secondary action inside a `type: 'split-button'` bulk action's dropdown. */
+interface BulkActionSplitOption<T> {
+    id: string;
+    label: string;
+    icon?: IconType;
+    disabled?: boolean;
+    /** Receives the full array of currently selected row objects. */
+    onClick: (selectedRows: T[]) => void;
+}
+interface BulkActionCommon<T> {
+    /** Only needs to be unique within this `bulkActions` array. */
+    id: string;
+    color?: ButtonColorProps;
+    disabled?: boolean | ((selectedRows: T[]) => boolean);
+    /** Primary action - fired on click for `'button'`, or on the primary (left) segment for `'split-button'`. */
+    onClick: (selectedRows: T[]) => void;
+}
+interface BulkActionButton<T> extends BulkActionCommon<T> {
+    /** @default 'button' */
+    type?: 'button';
+    /** Omit to render an icon-only button - `icon` becomes the sole icon in that case. */
+    label?: string;
+    icon?: IconType;
+    posIcon?: IconType;
+    variant?: ButtonVariantProps;
+}
+interface BulkActionSplitButton<T> extends BulkActionCommon<T> {
+    type: 'split-button';
+    /** Required - SplitButton always renders a primary label. */
+    label: string;
+    icon?: IconType;
+    /** SplitButton has no `text` variant. */
+    variant?: Exclude<ButtonVariantProps, 'text'>;
+    /** Secondary actions shown in the split-button's dropdown. */
+    options: BulkActionSplitOption<T>[];
+}
+type BulkAction<T> = BulkActionButton<T> | BulkActionSplitButton<T>;
+/** Members shared by every column variant, field-addressing or not. */
+interface TableColumnCommon {
+    label: string;
+    sortable?: boolean;
+    filterable?: boolean;
+    filterType?: 'text' | 'select' | 'date' | 'boolean';
+    filterOptions?: {
+        id: string;
+        value: string;
+        label: string;
+    }[];
+    dateFilterMode?: 'single' | 'multiple' | 'range';
+    width?: string;
+    align?: 'left' | 'center' | 'right';
+    /** Enables position:sticky on this column */
+    pin?: 'left' | 'right';
+}
+/**
+ * A column bound to the row field named by `key`, which is what lets `render`
+ * receive `T[K]` rather than `unknown`.
+ *
+ * Not used directly - `TableColumn` distributes this over `keyof T` so each
+ * entry correlates its own `key` with its own value type.
+ */
+interface TableValueColumn<T extends object, K extends RowKey<T>> extends TableColumnCommon {
+    key: K;
+    /** @default 'data' */
+    type?: 'data';
+    render?: (value: T[K], item: T) => ReactNode;
+}
+/**
+ * A column that renders from the whole row rather than one field - an icon or
+ * action cell, or a computed/composite value. `key` is free-form here because
+ * nothing reads `row[key]`: it's only an identity for React keys, sorting and
+ * `data-col-key`.
+ *
+ * `'icon'` and `'action'` carry their existing cell styling; `'custom'` styles
+ * like a normal data cell but takes a free-form key, which is the home for a
+ * derived column (previously expressible only by pointing `key` at a field
+ * that didn't exist).
+ */
+interface TableCustomColumn<T extends object> extends TableColumnCommon {
+    /** Free-form - must only be unique within `columns`. */
+    key: string;
+    type: 'icon' | 'action' | 'custom';
+    /** `value` is always `undefined`; render from `item`. */
+    render?: (value: undefined, item: T) => ReactNode;
+}
+/**
+ * One column definition. A union of two variants, discriminated on `type`:
+ *
+ * - **value column** (default, `type` omitted or `'data'`) - `key` must be a
+ *   field of `T`, and `render` receives that field's type instead of `unknown`.
+ * - **`type: 'icon' | 'action' | 'custom'`** - renders from the whole row;
+ *   `key` is free-form.
+ *
+ * With the untyped default `T`, `RowKey<T>` is `string` and `T[K]` is
+ * `unknown`, which is byte-identical to the pre-2.0 behaviour.
+ *
+ * Replaces `key: keyof T | string`, which looked constrained but wasn't:
+ * `keyof T` is assignable to `string`, so that union collapsed to plain
+ * `string` and checked nothing.
+ */
+type TableColumn<T extends object = Record<string, unknown>> = {
+    [K in RowKey<T>]: TableValueColumn<T, K>;
+}[RowKey<T>] | TableCustomColumn<T>;
+type FilterValue = string | string[] | boolean | {
+    start: string | null;
+    end: string | null;
+} | undefined;
+interface TableFilters {
+    [key: string]: FilterValue;
+}
+interface TableProps<T extends object = Record<string, unknown>> {
+    data: T[];
+    columns: TableColumn<T>[];
+    loading?: boolean;
+    emptyMessage?: string;
+    onRowClick?: (item: T) => void;
+    className?: string;
+    showFooter?: boolean;
+    totalItems?: number;
+    showPagination?: boolean;
+    pageSize?: number;
+    pageSizeOptions?: number[];
+    onSortChange?: (sortBy: RowKey<T>, sortDirection: 'asc' | 'desc') => void;
+    currentSort?: {
+        key: RowKey<T>;
+        direction: 'asc' | 'desc';
+    };
+    filters?: TableFilters;
+    onFiltersChange?: (filters: TableFilters) => void;
+    defaultFilters?: TableFilters;
+    showFilters?: boolean;
+    selectable?: boolean;
+    rowKey?: RowKey<T>;
+    selectedRows?: string[];
+    defaultSelectedRows?: string[];
+    onSelectionChange?: (selectedKeys: string[], selectedRows: T[]) => void;
+    bulkActions?: BulkAction<T>[];
+    density?: 'compact' | 'comfortable' | 'spacious';
+    showColumnVisibility?: boolean;
+    showExport?: boolean;
+    showDensity?: boolean;
+    draggableColumns?: boolean;
+    onColumnReorder?: (newColumns: TableColumn<T>[]) => void;
+}
+
+export type { BulkAction as B, FilterValue as F, RowKey as R, TableColumn as T, BulkActionButton as a, BulkActionSplitButton as b, BulkActionSplitOption as c, TableCustomColumn as d, TableFilters as e, TableProps as f, TableValueColumn as g };