@gp-grid/core 0.7.2 → 0.8.0

package/README.md

@@ -1,4 +1,4 @@
-# gp-grid-core 🏁 🏎️
+# @gp-grid/core 🏁 🏎️
 
 <div align="center">
     <a href="https://www.gp-grid.io">
@@ -31,12 +31,12 @@ A framework-agnostic TypeScript library for building high-performance data grids
 
 ## Available implementations
 
-- [**gp-grid-react**](https://www.npmjs.com/package/gp-grid-react) | Official
-- [**gp-grid-vue**](https://www.npmjs.com/package/gp-grid-vue) | Official
+- [**@gp-grid/react**](https://www.npmjs.com/package/@gp-grid/react) | Official
+- [**@gp-grid/vue**](https://www.npmjs.com/package/@gp-grid/vue) | Official
 
 ## Philosophy
 
-**gp-grid-core** is built on three core principles:
+**@gp-grid/core** is built on three core principles:
 
 ### 1. Slot-Based Virtual Scrolling
 
@@ -66,7 +66,7 @@ Data fetching is abstracted through a `DataSource` interface, supporting both:
 npm/pnpm/yarn
 
 ```bash
-pnpm add gp-grid-core
+pnpm add @gp-grid/core
 ```
 
 ## Architecture Overview
@@ -81,7 +81,7 @@ The main orchestrator class that manages:
 - Sort and filter state
 
 ```typescript
-import { GridCore, createClientDataSource } from "gp-grid-core";
+import { GridCore, createClientDataSource } from "@gp-grid/core";
 
 const dataSource = createClientDataSource(myData);
 
@@ -150,7 +150,7 @@ The core emits these instruction types:
 For datasets that can be loaded entirely in memory. Sorting and filtering are performed client-side.
 
 ```typescript
-import { createClientDataSource } from "gp-grid-core";
+import { createClientDataSource } from "@gp-grid/core";
 
 interface Person {
   id: number;
@@ -191,7 +191,7 @@ import {
   createServerDataSource,
   DataSourceRequest,
   DataSourceResponse,
-} from "gp-grid-core";
+} from "@gp-grid/core";
 
 interface Person {
   id: number;
@@ -310,7 +310,7 @@ interface HeaderRendererParams {
 
 ## Creating a Framework Adapter
 
-To integrate gp-grid-core with any UI framework:
+To integrate @gp-grid/core with any UI framework:
 
 1. **Subscribe to instructions** using `onBatchInstruction()`
 2. **Maintain UI state** by processing instructions
@@ -320,7 +320,7 @@ To integrate gp-grid-core with any UI framework:
 ### Example: Minimal Adapter Pattern
 
 ```typescript
-import { GridCore, GridInstruction } from "gp-grid-core";
+import { GridCore, GridInstruction } from "@gp-grid/core";
 
 class MyGridAdapter {
   private core: GridCore;

package/dist/index.d.ts

@@ -57,6 +57,21 @@ interface FillHandleState {
   /** Target column */
   targetCol: number;
 }
+/** Event emitted when a cell value is changed via editing or fill drag */
+interface CellValueChangedEvent<TData = Row> {
+  /** Stable row ID (from getRowId) */
+  rowId: RowId;
+  /** Column index */
+  colIndex: number;
+  /** Column field name */
+  field: string;
+  /** Previous cell value */
+  oldValue: CellValue;
+  /** New cell value */
+  newValue: CellValue;
+  /** The full row data object */
+  rowData: TData;
+}
 /** The slot is the virtualized row, this represents the state of the slot */
 interface SlotState {
   /** Slot ID */
@@ -514,6 +529,8 @@ interface GridCoreOptions<TData = Row> {
   getRowId?: (row: TData) => RowId;
   /** Row/column/cell highlighting configuration */
   highlighting?: HighlightingOptions<TData>;
+  /** Called when a cell value is changed via editing or fill drag. Requires getRowId. */
+  onCellValueChanged?: (event: CellValueChangedEvent<TData>) => void;
 }
 //#endregion
 //#region src/types/input.d.ts
@@ -1111,6 +1128,8 @@ declare class GridCore<TData extends Row = Row> {
   private headerHeight;
   private overscan;
   private sortingEnabled;
+  private getRowId?;
+  private onCellValueChanged?;
   private scrollTop;
   private scrollLeft;
   private viewportWidth;
@@ -1137,6 +1156,7 @@ declare class GridCore<TData extends Row = Row> {
   private virtualContentHeight;
   private scrollRatio;
   private isDestroyed;
+  private _isDataLoading;
   constructor(options: GridCoreOptions<TData>);
   /**
    * Initialize the grid and load initial data.
@@ -1171,6 +1191,7 @@ declare class GridCore<TData extends Row = Row> {
   getEditState(): EditState | null;
   getCellValue(row: number, col: number): CellValue;
   setCellValue(row: number, col: number, value: CellValue): void;
+  private clearSelectionIfInvalid;
   private computeColumnPositions;
   private emitContentSize;
   private emitHeaders;
@@ -1222,6 +1243,12 @@ declare class GridCore<TData extends Row = Row> {
    * Refresh data from the data source.
    */
   refresh(): Promise<void>;
+  /**
+   * Fast-path refresh for transaction-based mutations.
+   * Only re-fetches the visible window instead of all rows.
+   * Use this when data was mutated via MutableDataSource transactions.
+   */
+  refreshFromTransaction(): Promise<void>;
   /**
    * Refresh slot display without refetching data.
    * Useful after in-place data modifications like fill operations.
@@ -1254,6 +1281,8 @@ declare class GridCore<TData extends Row = Row> {
   setRow(index: number, data: TData): void;
   /**
    * Update the data source and refresh.
+   * Preserves grid state (sort, filter, scroll position).
+   * Cancels any active edit and clamps selection to valid range.
    */
   setDataSource(dataSource: DataSource<TData>): Promise<void>;
   /**
@@ -1678,6 +1707,11 @@ declare class IndexedDataStore<TData extends Row = Row> {
    * Get total row count (unfiltered).
    */
   getTotalRowCount(): number;
+  /**
+   * Get all rows as a new array.
+   * Used for direct data access when bypassing store's query system.
+   */
+  getAllRows(): TData[];
   /**
    * Get visible row count (after filtering).
    */
@@ -1968,10 +2002,15 @@ interface MutableClientDataSourceOptions<TData> {
   debounceMs?: number;
   /** Callback when transactions are processed. */
   onTransactionProcessed?: (result: TransactionResult) => void;
+  /** Use Web Worker for sorting large datasets (default: true) */
+  useWorker?: boolean;
+  /** Options for parallel sorting (only used when useWorker is true) */
+  parallelSort?: ParallelSortOptions | false;
 }
 /**
  * Creates a mutable client-side data source with transaction support.
  * Uses IndexedDataStore for efficient incremental operations.
+ * For large datasets, sorting is automatically offloaded to a Web Worker.
  */
 declare function createMutableClientDataSource<TData extends Row = Row>(data: TData[], options: MutableClientDataSourceOptions<TData>): MutableDataSource<TData>;
 //#endregion
@@ -2063,5 +2102,4 @@ interface GridState<TData = Row> {
   hoverPosition: CellPosition | null;
 }
 //#endregion
-export { type AssignSlotInstruction, type BatchInstructionListener, type CancelFillInstruction, type CellDataType, type CellPosition, type CellRange, type CellRendererParams, type CellValue, type CloseFilterPopupInstruction, type ColumnDefinition, type ColumnFilterModel, type CommitEditInstruction, type CommitFillInstruction, type ContainerBounds, type CreateSlotInstruction, type DataChangeListener, type DataErrorInstruction, type DataLoadedInstruction, type DataLoadingInstruction, type DataSource, type DataSourceRequest, type DataSourceResponse, type DateFilterCondition, type DateFilterOperator, type DestroySlotInstruction, type Direction, type DragMoveResult, type DragState, EditManager, type EditManagerOptions, type EditRendererParams, type EditState, type FillHandleState, FillManager, type FilterCombination, type FilterCondition, type FilterModel, type FilterPopupState, GridCore, type GridCoreOptions, type GridInstruction, type GridState, type HeaderData, type HeaderRendererParams, type HighlightContext, HighlightManager, type HighlightingOptions, IndexedDataStore, type IndexedDataStoreOptions, InputHandler, type InputHandlerDeps, type InputResult, type InstructionListener, type KeyEventData, type KeyboardResult, type MoveSlotInstruction, type MultiColumnSortedChunk, type MutableClientDataSourceOptions, type MutableDataSource, type NumberFilterCondition, type NumberFilterOperator, type OpenFilterPopupInstruction, ParallelSortManager, type ParallelSortOptions, type PointerEventData, type Row, type RowId, type RowSortCache, type RowsAddedInstruction, type RowsRemovedInstruction, type RowsUpdatedInstruction, SelectionManager, type SelectionState, type SetActiveCellInstruction, type SetContentSizeInstruction, type SetHoverPositionInstruction, type SetSelectionRangeInstruction, type SlotData, type BatchInstructionListener$1 as SlotPoolBatchListener, SlotPoolManager, type SlotPoolManagerOptions, type SlotState, type SortDirection, type SortModel, type SortedChunk, type StartEditInstruction, type StartFillInstruction, type StopEditInstruction, type TextFilterCondition, type TextFilterOperator, type Transaction, TransactionManager, type TransactionManagerOptions, type TransactionProcessedInstruction, type TransactionResult, type UpdateFillInstruction, type UpdateHeaderInstruction, WorkerPool, type WorkerPoolOptions, buildCellClasses, calculateColumnPositions, calculateScaledColumnPositions, cellStyles, compareValues, computeValueHash, containerStyles, createClientDataSource, createDataSourceFromArray, createMutableClientDataSource, createServerDataSource, detectBoundaryCollisions, evaluateColumnFilter, evaluateDateCondition, evaluateNumberCondition, evaluateTextCondition, filtersStyles, findColumnAtX, getFieldValue, getTotalWidth, gridStyles, headerStyles, injectStyles, isCellActive, isCellEditing, isCellInFillPreview, isCellSelected, isColumnInSelectionRange, isRowInSelectionRange, isRowVisible, isSameDay, kWayMerge, kWayMergeMultiColumn, rowPassesFilter, scrollbarStyles, setFieldValue, statesStyles, stringToSortableNumber, variablesStyles };
-//# sourceMappingURL=index.d.ts.map
+export { type AssignSlotInstruction, type BatchInstructionListener, type CancelFillInstruction, type CellDataType, type CellPosition, type CellRange, type CellRendererParams, type CellValue, type CellValueChangedEvent, type CloseFilterPopupInstruction, type ColumnDefinition, type ColumnFilterModel, type CommitEditInstruction, type CommitFillInstruction, type ContainerBounds, type CreateSlotInstruction, type DataChangeListener, type DataErrorInstruction, type DataLoadedInstruction, type DataLoadingInstruction, type DataSource, type DataSourceRequest, type DataSourceResponse, type DateFilterCondition, type DateFilterOperator, type DestroySlotInstruction, type Direction, type DragMoveResult, type DragState, EditManager, type EditManagerOptions, type EditRendererParams, type EditState, type FillHandleState, FillManager, type FilterCombination, type FilterCondition, type FilterModel, type FilterPopupState, GridCore, type GridCoreOptions, type GridInstruction, type GridState, type HeaderData, type HeaderRendererParams, type HighlightContext, HighlightManager, type HighlightingOptions, IndexedDataStore, type IndexedDataStoreOptions, InputHandler, type InputHandlerDeps, type InputResult, type InstructionListener, type KeyEventData, type KeyboardResult, type MoveSlotInstruction, type MultiColumnSortedChunk, type MutableClientDataSourceOptions, type MutableDataSource, type NumberFilterCondition, type NumberFilterOperator, type OpenFilterPopupInstruction, ParallelSortManager, type ParallelSortOptions, type PointerEventData, type Row, type RowId, type RowSortCache, type RowsAddedInstruction, type RowsRemovedInstruction, type RowsUpdatedInstruction, SelectionManager, type SelectionState, type SetActiveCellInstruction, type SetContentSizeInstruction, type SetHoverPositionInstruction, type SetSelectionRangeInstruction, type SlotData, type BatchInstructionListener$1 as SlotPoolBatchListener, SlotPoolManager, type SlotPoolManagerOptions, type SlotState, type SortDirection, type SortModel, type SortedChunk, type StartEditInstruction, type StartFillInstruction, type StopEditInstruction, type TextFilterCondition, type TextFilterOperator, type Transaction, TransactionManager, type TransactionManagerOptions, type TransactionProcessedInstruction, type TransactionResult, type UpdateFillInstruction, type UpdateHeaderInstruction, WorkerPool, type WorkerPoolOptions, buildCellClasses, calculateColumnPositions, calculateScaledColumnPositions, cellStyles, compareValues, computeValueHash, containerStyles, createClientDataSource, createDataSourceFromArray, createMutableClientDataSource, createServerDataSource, detectBoundaryCollisions, evaluateColumnFilter, evaluateDateCondition, evaluateNumberCondition, evaluateTextCondition, filtersStyles, findColumnAtX, getFieldValue, getTotalWidth, gridStyles, headerStyles, injectStyles, isCellActive, isCellEditing, isCellInFillPreview, isCellSelected, isColumnInSelectionRange, isRowInSelectionRange, isRowVisible, isSameDay, kWayMerge, kWayMergeMultiColumn, rowPassesFilter, scrollbarStyles, setFieldValue, statesStyles, stringToSortableNumber, variablesStyles };