gp-grid-react 0.1.6 → 0.2.0

package/dist/index.d.ts

@@ -1,12 +1,14 @@
-import React from "react";
+import React$1 from "react";
 
-//#region ../core/src/types.d.ts
+//#region ../core/src/types/basic.d.ts
 /** Cell data type primitive types */
 type CellDataType = "text" | "number" | "boolean" | "date" | "dateString" | "dateTime" | "dateTimeString" | "object";
 /** Cell value type */
 type CellValue = string | number | boolean | Date | object | null;
 /** Row type */
 type Row = unknown;
+/** Row ID type for transaction operations */
+type RowId = string | number;
 /** Sort direction type */
 type SortDirection = "asc" | "desc";
 /** Sort model type */
@@ -14,8 +16,21 @@ type SortModel = {
   colId: string;
   direction: SortDirection;
 };
-/** Filter model type */
-type FilterModel = Record<string, string>;
+/** Cell position */
+interface CellPosition {
+  row: number;
+  col: number;
+}
+/** Cell range */
+interface CellRange {
+  startRow: number;
+  startCol: number;
+  endRow: number;
+  endCol: number;
+}
+//#endregion
+//#region ../core/src/types/columns.d.ts
+/** Column definition */
 interface ColumnDefinition {
   field: string;
   colId?: string;
@@ -23,21 +38,68 @@ interface ColumnDefinition {
   width: number;
   headerName?: string;
   editable?: boolean;
+  /** Whether column is sortable. Default: true when sortingEnabled */
+  sortable?: boolean;
+  /** Whether column is filterable. Default: true */
+  filterable?: boolean;
   /** Renderer key for adapter lookup, or inline renderer function */
   cellRenderer?: string;
   editRenderer?: string;
   headerRenderer?: string;
 }
-interface CellPosition {
-  row: number;
-  col: number;
+//#endregion
+//#region ../core/src/types/filters.d.ts
+/** Text filter operators */
+type TextFilterOperator = "contains" | "notContains" | "equals" | "notEquals" | "startsWith" | "endsWith" | "blank" | "notBlank";
+/** Number filter operators (symbols for display) */
+type NumberFilterOperator = "=" | "!=" | ">" | "<" | ">=" | "<=" | "between" | "blank" | "notBlank";
+/** Date filter operators */
+type DateFilterOperator = "=" | "!=" | ">" | "<" | "between" | "blank" | "notBlank";
+/** Filter combination mode */
+type FilterCombination = "and" | "or";
+/** Text filter condition */
+interface TextFilterCondition {
+  type: "text";
+  operator: TextFilterOperator;
+  value?: string;
+  /** Selected distinct values for checkbox-style filtering */
+  selectedValues?: Set<string>;
+  /** Include blank values */
+  includeBlank?: boolean;
+  /** Operator connecting this condition to the next. Defaults to ColumnFilterModel.combination */
+  nextOperator?: FilterCombination;
 }
-interface CellRange {
-  startRow: number;
-  startCol: number;
-  endRow: number;
-  endCol: number;
+/** Number filter condition */
+interface NumberFilterCondition {
+  type: "number";
+  operator: NumberFilterOperator;
+  value?: number;
+  /** Second value for "between" operator */
+  valueTo?: number;
+  /** Operator connecting this condition to the next. Defaults to ColumnFilterModel.combination */
+  nextOperator?: FilterCombination;
+}
+/** Date filter condition */
+interface DateFilterCondition {
+  type: "date";
+  operator: DateFilterOperator;
+  value?: Date | string;
+  /** Second value for "between" operator */
+  valueTo?: Date | string;
+  /** Operator connecting this condition to the next. Defaults to ColumnFilterModel.combination */
+  nextOperator?: FilterCombination;
 }
+/** Union of filter condition types */
+type FilterCondition = TextFilterCondition | NumberFilterCondition | DateFilterCondition;
+/** Column filter model with multiple conditions */
+interface ColumnFilterModel {
+  conditions: FilterCondition[];
+  combination: FilterCombination;
+}
+/** Filter model type - maps column ID to filter */
+type FilterModel = Record<string, ColumnFilterModel>;
+//#endregion
+//#region ../core/src/types/data-source.d.ts
 /** Data source request */
 interface DataSourceRequest {
   /** Pagination */
@@ -59,10 +121,13 @@ interface DataSourceResponse<TData = Row> {
   /** Total rows */
   totalRows: number;
 }
+/** Data source interface */
 interface DataSource<TData = Row> {
   fetch(request: DataSourceRequest): Promise<DataSourceResponse<TData>>;
 }
-/** Slot lifecycle instructions */
+//#endregion
+//#region ../core/src/types/instructions.d.ts
+/** Create slot instruction */
 interface CreateSlotInstruction {
   type: "CREATE_SLOT";
   slotId: string;
@@ -85,7 +150,7 @@ interface MoveSlotInstruction {
   slotId: string;
   translateY: number;
 }
-/** Selection instructions */
+/** Set active cell instruction */
 interface SetActiveCellInstruction {
   type: "SET_ACTIVE_CELL";
   position: CellPosition | null;
@@ -95,7 +160,13 @@ interface SetSelectionRangeInstruction {
   type: "SET_SELECTION_RANGE";
   range: CellRange | null;
 }
-/** Edit instructions */
+/** Update visible range instruction - emitted when selection moves outside visible viewport */
+interface UpdateVisibleRangeInstruction {
+  type: "UPDATE_VISIBLE_RANGE";
+  start: number;
+  end: number;
+}
+/** Start edit instruction */
 interface StartEditInstruction {
   type: "START_EDIT";
   row: number;
@@ -113,7 +184,7 @@ interface CommitEditInstruction {
   col: number;
   value: CellValue;
 }
-/** Layout instructions */
+/** Set content size instruction */
 interface SetContentSizeInstruction {
   type: "SET_CONTENT_SIZE";
   width: number;
@@ -126,8 +197,32 @@ interface UpdateHeaderInstruction {
   column: ColumnDefinition;
   sortDirection?: SortDirection;
   sortIndex?: number;
+  /** Whether column is sortable */
+  sortable: boolean;
+  /** Whether column is filterable */
+  filterable: boolean;
+  /** Whether column has an active filter */
+  hasFilter: boolean;
 }
-/** Fill handle instructions */
+/** Open filter popup instruction */
+interface OpenFilterPopupInstruction {
+  type: "OPEN_FILTER_POPUP";
+  colIndex: number;
+  column: ColumnDefinition;
+  anchorRect: {
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+  };
+  distinctValues: CellValue[];
+  currentFilter?: ColumnFilterModel;
+}
+/** Close filter popup instruction */
+interface CloseFilterPopupInstruction {
+  type: "CLOSE_FILTER_POPUP";
+}
+/** Start fill instruction */
 interface StartFillInstruction {
   type: "START_FILL";
   sourceRange: CellRange;
@@ -165,14 +260,42 @@ interface DataErrorInstruction {
   type: "DATA_ERROR";
   error: string;
 }
+/** Rows added instruction */
+interface RowsAddedInstruction {
+  type: "ROWS_ADDED";
+  count: number;
+  totalRows: number;
+}
+/** Rows removed instruction */
+interface RowsRemovedInstruction {
+  type: "ROWS_REMOVED";
+  count: number;
+  totalRows: number;
+}
+/** Rows updated instruction */
+interface RowsUpdatedInstruction {
+  type: "ROWS_UPDATED";
+  count: number;
+}
+/** Transaction processed instruction */
+interface TransactionProcessedInstruction {
+  type: "TRANSACTION_PROCESSED";
+  added: number;
+  removed: number;
+  updated: number;
+}
 /** Union type of all instructions */
 type GridInstruction = /** Slot lifecycle */
 CreateSlotInstruction | DestroySlotInstruction | AssignSlotInstruction | MoveSlotInstruction
-/** Selection */ | SetActiveCellInstruction | SetSelectionRangeInstruction
+/** Selection */ | SetActiveCellInstruction | SetSelectionRangeInstruction | UpdateVisibleRangeInstruction
 /** Editing */ | StartEditInstruction | StopEditInstruction | CommitEditInstruction
 /** Layout */ | SetContentSizeInstruction | UpdateHeaderInstruction
+/** Filter popup */ | OpenFilterPopupInstruction | CloseFilterPopupInstruction
 /** Fill handle */ | StartFillInstruction | UpdateFillInstruction | CommitFillInstruction | CancelFillInstruction
-/** Data */ | DataLoadingInstruction | DataLoadedInstruction | DataErrorInstruction;
+/** Data */ | DataLoadingInstruction | DataLoadedInstruction | DataErrorInstruction
+/** Transactions */ | RowsAddedInstruction | RowsRemovedInstruction | RowsUpdatedInstruction | TransactionProcessedInstruction;
+//#endregion
+//#region ../core/src/types/renderers.d.ts
 /** Cell renderer params */
 interface CellRendererParams {
   /** Cell value */
@@ -213,35 +336,98 @@ interface HeaderRendererParams {
   sortDirection?: SortDirection;
   /** Sort index */
   sortIndex?: number;
+  /** Whether column is sortable */
+  sortable: boolean;
+  /** Whether column is filterable */
+  filterable: boolean;
+  /** Whether column has an active filter */
+  hasFilter: boolean;
   /** On sort */
   onSort: (direction: SortDirection | null, addToExisting: boolean) => void;
+  /** On filter click */
+  onFilterClick: () => void;
 }
 //#endregion
-//#region ../core/src/data-source.d.ts
-/**
- * Creates a client-side data source that holds all data in memory.
- * Sorting and filtering are performed client-side.
- * For large datasets (10k+ rows), sorting is automatically offloaded to a Web Worker.
- */
-declare function createClientDataSource<TData extends Row = Row>(data: TData[], options?: {
+//#region ../core/src/data-source/client-data-source.d.ts
+interface ClientDataSourceOptions<TData> {
   /** Custom field accessor for nested properties */
   getFieldValue?: (row: TData, field: string) => CellValue;
   /** Use Web Worker for sorting large datasets (default: true) */
   useWorker?: boolean;
-}): DataSource<TData>;
+}
+/**
+ * Creates a client-side data source that holds all data in memory.
+ * Sorting and filtering are performed client-side.
+ * For large datasets, sorting is automatically offloaded to a Web Worker.
+ */
+declare function createClientDataSource<TData extends Row = Row>(data: TData[], options?: ClientDataSourceOptions<TData>): DataSource<TData>;
+/**
+ * Convenience function to create a data source from an array.
+ * This provides backwards compatibility with the old `rowData` prop.
+ */
+declare function createDataSourceFromArray<TData extends Row = Row>(data: TData[]): DataSource<TData>;
+//#endregion
+//#region ../core/src/data-source/server-data-source.d.ts
 type ServerFetchFunction<TData> = (request: DataSourceRequest) => Promise<DataSourceResponse<TData>>;
 /**
  * Creates a server-side data source that delegates all operations to the server.
  * The fetch function receives sort/filter/pagination params to pass to the API.
  */
 declare function createServerDataSource<TData extends Row = Row>(fetchFn: ServerFetchFunction<TData>): DataSource<TData>;
+//#endregion
+//#region ../core/src/transaction-manager.d.ts
+interface TransactionResult {
+  added: number;
+  removed: number;
+  updated: number;
+}
+//#endregion
+//#region ../core/src/data-source/mutable-data-source.d.ts
+/** Callback for data change notifications */
+type DataChangeListener = (result: TransactionResult) => void;
 /**
- * Convenience function to create a data source from an array.
- * This provides backwards compatibility with the old `rowData` prop.
+ * Data source with mutation capabilities.
+ * Extends DataSource with add, remove, and update operations.
  */
-declare function createDataSourceFromArray<TData extends Row = Row>(data: TData[]): DataSource<TData>;
+interface MutableDataSource<TData = Row> extends DataSource<TData> {
+  /** Add rows to the data source. Queued and processed after debounce. */
+  addRows(rows: TData[]): void;
+  /** Remove rows by ID. Queued and processed after debounce. */
+  removeRows(ids: RowId[]): void;
+  /** Update a cell value. Queued and processed after debounce. */
+  updateCell(id: RowId, field: string, value: CellValue): void;
+  /** Update multiple fields on a row. Queued and processed after debounce. */
+  updateRow(id: RowId, data: Partial<TData>): void;
+  /** Force immediate processing of queued transactions. */
+  flushTransactions(): Promise<void>;
+  /** Check if there are pending transactions. */
+  hasPendingTransactions(): boolean;
+  /** Get distinct values for a field (for filter UI). */
+  getDistinctValues(field: string): CellValue[];
+  /** Get a row by ID. */
+  getRowById(id: RowId): TData | undefined;
+  /** Get total row count. */
+  getTotalRowCount(): number;
+  /** Subscribe to data change notifications. Returns unsubscribe function. */
+  subscribe(listener: DataChangeListener): () => void;
+}
+interface MutableClientDataSourceOptions<TData> {
+  /** Function to extract unique ID from row. Required. */
+  getRowId: (row: TData) => RowId;
+  /** Custom field accessor for nested properties. */
+  getFieldValue?: (row: TData, field: string) => CellValue;
+  /** Debounce time for transactions in ms. Default 50. Set to 0 for sync. */
+  debounceMs?: number;
+  /** Callback when transactions are processed. */
+  onTransactionProcessed?: (result: TransactionResult) => void;
+}
+/**
+ * Creates a mutable client-side data source with transaction support.
+ * Uses IndexedDataStore for efficient incremental operations.
+ */
+declare function createMutableClientDataSource<TData extends Row = Row>(data: TData[], options: MutableClientDataSourceOptions<TData>): MutableDataSource<TData>;
 //#endregion
-//#region src/Grid.d.ts
+//#region src/types.d.ts
 /** React cell renderer: A function that renders a cell */
 type ReactCellRenderer = (params: CellRendererParams) => React.ReactNode;
 /** React edit renderer: A function that renders the cell while in edit mode */
@@ -262,10 +448,8 @@ interface GridProps<TData extends Row = Row> {
   headerHeight?: number;
   /** Overscan: How many rows to render outside the viewport */
   overscan?: number;
-  /** Show filter row below headers: Default to false */
-  showFilters?: boolean;
-  /** Debounce time for filter input (ms): Default to 300 */
-  filterDebounce?: number;
+  /** Enable/disable sorting globally. Default: true */
+  sortingEnabled?: boolean;
   /** Enable dark mode styling: Default to false */
   darkMode?: boolean;
   /** Wheel scroll dampening factor when virtual scrolling is active (0-1): Default 0.1 */
@@ -283,12 +467,13 @@ interface GridProps<TData extends Row = Row> {
   /** Global header renderer */
   headerRenderer?: ReactHeaderRenderer;
 }
+//#endregion
+//#region src/Grid.d.ts
 /**
  * Grid component
  * @param props - Grid component props
  * @returns Grid React component
  */
-declare function Grid<TData extends Row = Row>(props: GridProps<TData>): React.ReactNode;
+declare function Grid<TData extends Row = Row>(props: GridProps<TData>): React$1.ReactNode;
 //#endregion
-export { type CellDataType, type CellPosition, type CellRange, type CellRendererParams, type CellValue, type ColumnDefinition, type DataSource, type DataSourceRequest, type DataSourceResponse, type EditRendererParams, type FilterModel, Grid, type GridInstruction, type GridProps, type HeaderRendererParams, type ReactCellRenderer, type ReactEditRenderer, type ReactHeaderRenderer, type Row, type SortDirection, type SortModel, createClientDataSource, createDataSourceFromArray, createServerDataSource };
-//# sourceMappingURL=index.d.ts.map
+export { type CellDataType, type CellPosition, type CellRange, type CellRendererParams, type CellValue, type ColumnDefinition, type DataSource, type DataSourceRequest, type DataSourceResponse, type EditRendererParams, type FilterModel, Grid, type GridInstruction, type GridProps, type HeaderRendererParams, type MutableDataSource, type ReactCellRenderer, type ReactEditRenderer, type ReactHeaderRenderer, type Row, type SortDirection, type SortModel, createClientDataSource, createDataSourceFromArray, createMutableClientDataSource, createServerDataSource };