@hotelrank/raw-grids 1.0.0 → 1.0.1

package/dist/index.d.ts

@@ -10,28 +10,24 @@ import { ReactNode } from 'react';
 import { RefAttributes } from 'react';
 import { Store } from '@tanstack/store';
 
-export declare type ActionHeaderProps = {
-    backgroundColor?: string;
-    children?: default_2.ReactNode;
-    showActionColumn?: boolean;
-    width?: string;
-    showColumnVisibilityMenu?: boolean;
-    backgroundColorColumnVisibilityMenu?: string;
-    showSNo?: boolean;
-    indexChildren?: default_2.ReactNode;
-};
+declare interface ActionColumn<T> extends BaseColumn {
+    type: 'actions';
+    id: typeof ACTIONS_COLUMN_ID;
+    render: (row: T) => default_2.ReactNode;
+}
+
+export declare const ACTIONS_COLUMN_ID: "__actions__";
 
 export declare const addPreset: (pageKey: string, item: PresetItem) => void;
 
-export declare interface Column {
-    id: string;
-    label: string;
+declare interface BaseColumn {
+    label: string | default_2.ReactNode;
     minWidth?: number | string;
-    align?: 'left' | 'center' | 'right';
-    sortable?: boolean;
     backgroundColor?: string;
 }
 
+export declare type Column<T> = DataColumn<T> | ActionColumn<T> | VisibilityColumn;
+
 export declare interface ConfirmActionDialogProps {
     open: boolean;
     onClose: () => void;
@@ -56,35 +52,36 @@ export declare interface ConfirmDeleteDialogProps {
     isLoading?: boolean;
 }
 
-export declare function DataTable<T extends Record<string, unknown>>({ tableId, data: rowData, headers, loading, loadingChildren, skeletonLoading, emptyMessage, actions, page, pageSize, onPageChange, onPageSizeChange, density, totalCount, actionConfig, pageSizeOptions, onRowSelect, onRowSelectEvent, }: DataTableProps<T>): JSX_2.Element;
-
-export declare interface DataTableAction<T> {
-    icon: JSX.Element;
-    label: string;
-    onClick: (row: T) => void;
-    visible?: (row: T) => boolean;
-    colorScheme?: 'gray' | 'red' | 'orange' | 'yellow' | 'green' | 'teal' | 'blue' | 'cyan' | 'purple' | 'pink';
+declare interface DataColumn<T> extends BaseColumn {
+    type?: 'data';
+    id: keyof T & string;
+    align?: 'left' | 'center' | 'right';
+    sortable?: boolean;
+    sortAccessor?: SortAccessor<T>;
+    sortComparator?: SortComparator<T>;
+    render?: (row: T) => default_2.ReactNode;
 }
 
+export declare function DataTable<T>({ tableId, data: rowData, headers, loading, loadingChildren, skeletonLoading, emptyMessage, page, pageSize, onPageChange, onPageSizeChange, density, totalCount, pageSizeOptions, onRowSelect, onRowSelectEvent, enableColumnVisibility, }: DataTableProps<T>): JSX_2.Element;
+
 export declare interface DataTableProps<T> {
     tableId: string;
-    headers?: Column[];
-    data?: T[];
+    headers: Column<T>[];
+    data: T[];
     loading?: boolean;
     emptyMessage?: string;
-    actions?: DataTableAction<T>[];
     page?: number;
     pageSize?: number;
-    onPageChange?: (page: number) => void | undefined;
-    onPageSizeChange?: (size: number) => void | undefined;
+    onPageChange?: (page: number) => void;
+    onPageSizeChange?: (size: number) => void;
     density?: DensityType;
     totalCount?: number;
-    actionConfig?: ActionHeaderProps;
     loadingChildren?: JSX.Element;
     skeletonLoading?: boolean;
     pageSizeOptions?: number[];
     onRowSelect?: (row: T, event?: default_2.MouseEvent) => void;
     onRowSelectEvent?: 'left' | 'right';
+    enableColumnVisibility?: boolean;
 }
 
 export declare type DateTimeVariant = 'date' | 'time' | 'dateTime' | 'full' | 'relative' | 'short';
@@ -350,7 +347,7 @@ export declare class OptionsClientImpl implements OptionsClient {
     private store;
     private inflight;
     constructor(api: OptionsApi);
-    getRaw(key: string): OptionValue | undefined;
+    getRaw(key: string): OptionValue;
     getKey<T = any>(key: string): Promise<T | undefined>;
     getMultiKey<T = any>(keys: string[]): Promise<Record<string, T>>;
     subscribe(key: string, cb: Listener): () => void;
@@ -369,7 +366,7 @@ export declare function OptionsProvider({ client: { apiUrl }, children, }: {
 export declare class OptionsStore {
     private state;
     private listeners;
-    get(key: string): OptionValue | undefined;
+    get(key: string): OptionValue;
     set(option: OptionValue): void;
     setMany(options: OptionValue[]): void;
     subscribe(key: string, listener: Listener): () => void;
@@ -410,11 +407,9 @@ export declare const saveOrder: (pageKey: string, filters: string[]) => void;
 
 export declare const savePresets: (pageKey: string, items: PresetItem[]) => void;
 
-export declare const setActionsConfig: (actionsConfig: ActionHeaderProps) => void;
-
 export declare function setColumnWidth(columnId: string, width: number): void;
 
-export declare function setData(newData: any[], headers?: Column[]): void;
+export declare function setData(newData: any[], headers?: Column<any>[], enableColumnVisibility?: boolean): void;
 
 export declare function setTableId(tableId: string): void;
 
@@ -422,6 +417,12 @@ declare type SlotProps = {
     children: ReactNode;
 };
 
+declare type SortAccessor<T> = (row: T) => unknown;
+
+declare type SortComparator<T> = (a: T, b: T, direction: Exclude<SortDirection, null>) => number;
+
+declare type SortDirection = 'asc' | 'desc' | null;
+
 export declare type SortOrder = 'asc' | 'desc';
 
 export declare function StackedDateTime({ value, dateVariant, timeVariant, dateFormat, timeFormat, align, dateColor, dateFontSize, dateFontWeight, timeColor, timeFontSize, timeFontWeight, showTime, }: StackedDateTimeProps): JSX_2.Element;
@@ -445,18 +446,18 @@ declare interface StackedDateTimeProps {
 declare interface TableState {
     tableId: string;
     sortColumn: string | null;
-    sortDirection: 'asc' | 'desc';
+    sortDirection: 'asc' | 'desc' | null;
     visibility: Record<string, boolean>;
     columnWidths: Record<string, number>;
-    columnOrder: Column[];
+    columnOrder: Column<any>[];
     data: any[];
     sortableColumns: {
         id: string;
         label: string | default_2.ReactNode;
         sortable: boolean;
-        backgroundColor?: string;
+        minWidth?: number | string;
     }[];
-    actionsConfig?: ActionHeaderProps;
+    enableColumnVisibility: boolean;
 }
 
 export declare const tableStore: Store<TableState, (cb: TableState) => TableState>;
@@ -504,6 +505,13 @@ declare interface UsePaginationResult {
 
 export declare type ValueType = 'string' | 'number' | 'boolean' | 'array' | 'object';
 
+export declare const VISIBILITY_COLUMN_ID: "__visibility__";
+
+declare interface VisibilityColumn extends BaseColumn {
+    type: 'visibility';
+    id: typeof VISIBILITY_COLUMN_ID;
+}
+
 /**
  * Chakra v3 / Ark UI slot components do NOT expose `children` in their typings.
  * This wrapper intentionally loosens typing to make them library-safe.