@jielga/tmdatagrid 2.0.0-beta.8 → 2.0.0

package/src/{tmdatagrid/useTMDataGrid.tsx → useTMDataGrid.tsx}

@@ -1,7 +1,12 @@
-import { useCreateStore } from "@tanstack/react-store";
+import { useCreateStore, useSelector } from "@tanstack/react-store";
+import { shallow } from "@tanstack/store";
 import {
+  type AccessorFn,
+  type AccessorFnColumnDef,
+  type AccessorKeyColumnDef,
   aggregationFns,
   type ColumnDef,
+  type ColumnHelper,
   columnFacetingFeature,
   columnFilteringFeature,
   columnGroupingFeature,
@@ -18,11 +23,17 @@ import {
   createFilteredRowModel,
   createGroupedRowModel,
   createPaginatedRowModel,
+  type DeepKeys,
+  type DeepValue,
+  type DisplayColumnDef,
   filterFns,
+  type GroupColumnDef,
   globalFilteringFeature,
+  type IdentifiedColumnDef,
   metaHelper,
   type Row,
   type RowData,
+  rowAggregationFeature,
   rowExpandingFeature,
   rowPaginationFeature,
   rowPinningFeature,
@@ -52,7 +63,7 @@ import {
   type TMDataGridEditApi,
   type TMDataGridEditCommitArgs,
   type TMDataGridSaveDraftsArgs,
-  type TMDataGridSaveDraftsResult,
+  type TMDataGridSaveDraftsResponse,
   type TMDataGridEditEngineContext,
   type TMDataGridColumnEditOptions,
   type TMDataGridEditMode,
@@ -68,6 +79,11 @@ import {
 } from "./core/filterOperators";
 import { getColumnDefaultOperator, isControlColumn } from "./core/columnUtils";
 import type { TMDataGridColumnFilterOptions } from "./core/filterControls";
+import {
+  resolveFilterOptions,
+  type TMDataGridFiltersOptions,
+  type TMDataGridFiltersSettings,
+} from "./core/filterSurface";
 import {
   createFuzzyRankedSortedRowModel,
   fuzzyGlobalFilterFn,
@@ -100,23 +116,34 @@ import {
   stabilizeControlledState,
   withoutUndefinedSlices,
 } from "./core/controlledState";
-import type { TMDataGridCellRange } from "./core/cellRange";
 import {
-  createSelectColumn,
-  SELECT_COLUMN_ID,
-} from "./components/TMDataGridSelectColumn";
+  beginControlledStateSync,
+  deferControlledStateSyncPublishes,
+  endControlledStateSync,
+} from "./core/controlledStateSync";
+import { registerDeletedRows } from "./core/deletedRows";
 import {
-  createGroupColumn,
-  GROUP_COLUMN_ID,
-} from "./components/TMDataGridGroupColumn";
+  withPageReset,
+  type TMDataGridQueryTable,
+} from "./core/pageReset";
+import type { TMDataGridCellRange } from "./core/cellRange";
 import {
-  createDetailsColumn,
-  DETAILS_COLUMN_ID,
-} from "./components/TMDataGridDetailsColumn";
+  resolveExportOptions,
+  type TMDataGridExportOptions,
+  type TMDataGridExportPickerRequest,
+  type TMDataGridExportSettings,
+  type TMDataGridExportValueGetter,
+} from "./core/export";
+import { SELECT_COLUMN_ID } from "./components/TMDataGridSelectColumn";
+import { GROUP_COLUMN_ID } from "./components/TMDataGridGroupColumn";
+import { DETAILS_COLUMN_ID } from "./components/TMDataGridDetailsColumn";
+import { EDIT_COLUMN_ID } from "./components/TMDataGridEditColumn";
 import {
+  createDetailsColumn,
   createEditColumn,
-  EDIT_COLUMN_ID,
-} from "./components/TMDataGridEditColumn";
+  createGroupColumn,
+  createSelectColumn,
+} from "./components/generatedColumns";
 import {
   createRowNumberColumn,
   ROW_NUMBER_COLUMN_ID,
@@ -138,8 +165,11 @@ const PERSIST_DEBOUNCE_MS = 200;
  * `type` and `options` are read by both stages, so one declaration of each
  * feeds the filter panel and the cell editor, which is why they sit outside
  * both namespaces.
+ *
+ * `TData` types the row that `options` and `edit.enabled` callbacks receive.
+ * `createTMDataGridColumnHelper<TData>()` fills it in.
  */
-export type TMDataGridColumnMeta = {
+export type TMDataGridColumnMeta<TData extends RowData = TMDataGridRowData> = {
   /** Name shown in menus and the column manager. Falls back to a string header. */
   label?: string;
   /**
@@ -154,7 +184,7 @@ export type TMDataGridColumnMeta = {
    * function of the table, column and, for editors, the row. See
    * {@link TMDataGridOptionsSource}.
    */
-  options?: TMDataGridOptionsSource;
+  options?: TMDataGridOptionsSource<TData>;
   /** Share of the leftover width this column claims. Defaults to `1`. */
   flex?: number;
   align?: "left" | "right" | "center";
@@ -171,8 +201,8 @@ export type TMDataGridColumnMeta = {
    */
   enableOrdering?: boolean;
   /**
-   * How this column filters: the operator a fresh filter starts with, and the
-   * value control the filter panel renders for it.
+   * How this column filters: which operators it offers, the operator a fresh
+   * filter starts with, and the value control the filter panel renders for it.
    *
    * ```tsx
    * meta: {
@@ -198,7 +228,26 @@ export type TMDataGridColumnMeta = {
    *
    * See {@link TMDataGridColumnEditOptions}.
    */
-  edit?: TMDataGridColumnEditOptions;
+  edit?: TMDataGridColumnEditOptions<TData>;
+  /**
+   * `false` leaves the column out of every export and out of Ctrl+C - for a
+   * column of buttons, or one whose value means nothing outside the grid.
+   * Defaults to `true`.
+   */
+  enableExport?: boolean;
+  /**
+   * The value an export writes for this column, in place of
+   * `row.getValue(column.id)`. The export otherwise writes the value, never
+   * what the cell renders, so this is where a status code becomes its label
+   * or a nested object becomes one field.
+   *
+   * ```tsx
+   * meta: {
+   *   exportValue: ({ value }) => STATUS_LABELS[value as Status],
+   * }
+   * ```
+   */
+  exportValue?: TMDataGridExportValueGetter;
 };
 
 /** Grid-wide configuration passed through `options.meta`. */
@@ -231,6 +280,7 @@ export const tmDataGridFeatures = tableFeatures({
   columnResizingFeature,
   columnFacetingFeature,
   columnGroupingFeature,
+  rowAggregationFeature,
   // Registered for grouping's sake rather than for tree data: the grouped row
   // model builds the parent rows, and this is what flattens the expanded ones
   // back into the flat list the body virtualizes.
@@ -270,8 +320,57 @@ export type TMDataGridTable<TData extends RowData> = Table<
   TData
 >;
 
-export function createTMDataGridColumnHelper<TData extends RowData>() {
-  return createColumnHelper<TMDataGridFeatures, TData>();
+/** A column definition with `meta` typed against the row type. */
+type WithRowTypedMeta<TDef, TData extends RowData> = TDef extends unknown
+  ? Omit<TDef, "meta"> & { meta?: TMDataGridColumnMeta<TData> }
+  : never;
+
+/**
+ * TanStack's column helper with `meta` typed against `TData`, so the
+ * `meta.options` and `meta.edit.enabled` callbacks receive
+ * `Row<TMDataGridFeatures, TData>`.
+ */
+export type TMDataGridColumnHelper<TData extends RowData> = {
+  accessor: <
+    TAccessor extends AccessorFn<TData> | DeepKeys<TData>,
+    TValue extends TAccessor extends AccessorFn<TData, infer TReturn>
+      ? TReturn
+      : TAccessor extends DeepKeys<TData>
+        ? DeepValue<TData, TAccessor>
+        : never,
+  >(
+    accessor: TAccessor,
+    column: WithRowTypedMeta<
+      TAccessor extends AccessorFn<TData>
+        ? DisplayColumnDef<TMDataGridFeatures, TData, TValue>
+        : IdentifiedColumnDef<TMDataGridFeatures, TData, TValue>,
+      TData
+    >,
+  ) => TAccessor extends AccessorFn<TData>
+    ? AccessorFnColumnDef<TMDataGridFeatures, TData, TValue>
+    : AccessorKeyColumnDef<TMDataGridFeatures, TData, TValue>;
+  columns: ColumnHelper<TMDataGridFeatures, TData>["columns"];
+  display: (
+    column: WithRowTypedMeta<DisplayColumnDef<TMDataGridFeatures, TData>, TData>,
+  ) => DisplayColumnDef<TMDataGridFeatures, TData, unknown>;
+  group: (
+    column: WithRowTypedMeta<
+      GroupColumnDef<TMDataGridFeatures, TData, unknown>,
+      TData
+    >,
+  ) => GroupColumnDef<TMDataGridFeatures, TData, unknown>;
+};
+
+export function createTMDataGridColumnHelper<
+  TData extends RowData,
+>(): TMDataGridColumnHelper<TData> {
+  // Same runtime helper. The features object registers one meta type for
+  // every table, so the row-typed meta exists only in this signature; the
+  // grid calls the callbacks with the rows of the table they belong to.
+  return createColumnHelper<
+    TMDataGridFeatures,
+    TData
+  >() as unknown as TMDataGridColumnHelper<TData>;
 }
 
 /** What the `renderDetails` render prop is handed for an expanded row. */
@@ -294,6 +393,9 @@ const DEFAULT_DETAILS_EST_HEIGHT = 160;
 /** Rows kept mounted on each side of the viewport. See `overscan`. */
 const DEFAULT_OVERSCAN = 6;
 
+/** One empty array, so a selector answering "none" never changes identity. */
+const EMPTY_IDS: ReadonlyArray<string> = [];
+
 /**
  * Chrome state that is *not* table state: which panels are open, and which
  * column opened the filter panel. Kept in a TanStack Store so consumers can
@@ -301,9 +403,20 @@ const DEFAULT_OVERSCAN = 6;
  */
 export type TMDataGridUiState = {
   filterPanelOpen: boolean;
-  columnsPanelOpen: boolean;
-  /** Column whose filter row should be focused when the panel opens. */
+  /**
+   * Column whose *panel* row should take the focus. Cleared once the row has
+   * taken it, so pointing at the same column twice focuses twice.
+   */
   filterPanelColumnId: string | null;
+  /**
+   * Column whose *header filter* control should take the focus, under
+   * `filters.inHeader`. Cleared once taken, like the one above.
+   *
+   * Its own slot rather than a second reader of `filterPanelColumnId`: a grid
+   * can have header filters and a panel at once, and two controls racing to
+   * answer one id means whichever mounted last wins the caret.
+   */
+  headerFilterColumnId: string | null;
   /**
    * Column being dragged by its header, if any. Held here rather than read from
    * `dataTransfer`, which browsers keep unreadable until the drop.
@@ -342,13 +455,33 @@ export type TMDataGridUiState = {
    * describe different places.
    */
   cellRange: TMDataGridCellRange | null;
+  /**
+   * The export column picker, while it is open: which rows it exports and the
+   * options of the item that opened it. `null` while closed. Held here rather
+   * than in the menu item, which unmounts with the dropdown the moment it is
+   * clicked.
+   */
+  exportPicker: TMDataGridExportPickerRequest | null;
 };
 
 export type TMDataGridUiActions = {
   openFilterPanel: (columnId?: string | null) => void;
   closeFilterPanel: () => void;
-  setColumnsPanelOpen: (open: boolean) => void;
-  toggleColumnsPanel: () => void;
+  /** Opens the export column picker for `request`. See `TMDataGrid.Menu.Export`'s `columns="custom"`. */
+  openExportPicker: (request: TMDataGridExportPickerRequest) => void;
+  closeExportPicker: () => void;
+  /**
+   * Points at a column's row in the filter panel without opening anything.
+   * `openFilterPanel` does this as well as opening; this is the half a panel
+   * that is already showing needs.
+   */
+  focusPanelFilter: (columnId: string | null) => void;
+  /**
+   * Points at a column's header filter control - what `openColumnFilter` does
+   * under `filters.inHeader`, where there is no panel to open. The header row
+   * scrolls the column into view and focuses it.
+   */
+  focusHeaderFilter: (columnId: string | null) => void;
   startColumnDrag: (columnId: string) => void;
   endColumnDrag: () => void;
   /**
@@ -393,13 +526,28 @@ export type TMDataGridApi<TData extends RowData> = {
   ui: TMDataGridUiStore;
   /**
    * The edit engine - open forms, dirty/error projections, and the verbs
-   * (`begin`, `commit`, `cancel`, `submitAll`). `edit.getForm(rowId)` hands
-   * out the same TanStack Form the inline editors write through, so a drawer
-   * or detail panel can share a row's draft. Inert until `editing` is set.
+   * (`begin`, `commit`, `cancel`, `saveDrafts`). `edit.getForm(rowId)` hands
+   * out the same TanStack Form the inline editors write through while a row
+   * is open, so a drawer or detail panel can share a row's draft; a
+   * committed row has no form until `begin` reopens it. Inert until
+   * `editing` is set.
    */
   edit: TMDataGridEditApi<TData>;
   /** Table-level feature switches, re-read from options on every render. */
   features: TMDataGridFeatureFlags;
+  /**
+   * Where the filter controls live, the `filters` option with its defaults
+   * filled in. On the api rather than in a component's props because the
+   * pills, the column menu and `openColumnFilter` all have to agree with the
+   * table about which surface is on.
+   */
+  filters: TMDataGridFiltersSettings;
+  /**
+   * How the grid exports, the `exportOptions` option with its defaults filled
+   * in. Read by `useTMDataGridExport`, the `TMDataGrid.Menu.Export*` items and
+   * the cell-range menu, so every export of the grid agrees on the format.
+   */
+  exportOptions: TMDataGridExportSettings;
   /** Every string the chrome renders, `labels` merged over the English defaults. */
   labels: TMDataGridLabels;
   /** The detail renderer, when row details are on. See `renderDetails`. */
@@ -588,31 +736,21 @@ export type TMDataGridEditingOptions<TData extends RowData> =
            *
            * Rows still open are not in the payload and stay open. Returning
            * nothing saves the whole store and throwing saves none of it;
-           * return a {@link TMDataGridSaveDraftsResult} to save part of it.
+           * return a {@link TMDataGridSaveDraftsResponse} to save part of it.
            */
           onSaveDrafts?: (
             args: TMDataGridSaveDraftsArgs<TData>,
           ) =>
             | void
-            | TMDataGridSaveDraftsResult
-            | Promise<void | TMDataGridSaveDraftsResult>;
-          /**
-           * @deprecated Renamed to {@link onSaveDrafts} - it fires when the
-           * draft store is saved, not when a row commits into it. Still
-           * honoured; removed in a later beta.
-           */
-          onCommitDrafts?: (
-            args: TMDataGridSaveDraftsArgs<TData>,
-          ) =>
-            | void
-            | TMDataGridSaveDraftsResult
-            | Promise<void | TMDataGridSaveDraftsResult>;
+            | TMDataGridSaveDraftsResponse
+            | Promise<void | TMDataGridSaveDraftsResponse>;
           /**
-           * Keep parked entry rows pinned in the sticky entry block until
-           * the draft store is saved. Off by default: a parked row joins the
-           * scrolling flow above the body rows instead - the block a row is
-           * *typed* into is always sticky, but parked rows scroll, so
-           * entering many cannot fill the viewport with sticky chrome.
+           * Keep committed entry rows pinned in the sticky entry block until
+           * the draft store is saved, out of the body's sort. Off by default:
+           * a committed row joins the body rows instead, sorted and filtered
+           * with them - the block a row is *typed* into is always sticky, but
+           * committed rows scroll, so entering many cannot fill the viewport
+           * with sticky chrome.
            */
           newRowsSticky?: boolean;
         }
@@ -621,8 +759,6 @@ export type TMDataGridEditingOptions<TData extends RowData> =
           draft?: false;
           /** Only `draft: true` has a store to save - see the other branch. */
           onSaveDrafts?: never;
-          /** @deprecated See {@link onSaveDrafts}. */
-          onCommitDrafts?: never;
           /** Parked entry rows exist only under `draft: true` - see there. */
           newRowsSticky?: never;
         }
@@ -688,12 +824,55 @@ export type UseTMDataGridOptions<TData extends RowData> = Omit<
    * no extra flag.
    */
   enablePagination?: boolean;
+  /**
+   * Sends the grid back to the first page whenever the query changes - a
+   * column filter, the quick search, the sort or the grouping. On by
+   * default. TanStack's own `autoResetPageIndex` is switched off by the
+   * grid: it fires on any change to the `data` array, which under
+   * `editing.draft` is every commit.
+   *
+   * Server-side, `pageIndex` is a position in a result set the grid does not
+   * own: narrowing the query leaves it pointing past the last page, and the
+   * next request comes back empty. The reset is applied in the same event as
+   * the change, so one request goes out, for the first page of the new query.
+   */
+  resetPageOnQueryChange?: boolean;
   /**
    * The row-number gutter: a generated lane, outermost left, numbering the
    * rows of the current view - sorted, filtered, continuing across pages,
    * with group rows unnumbered. Off by default.
    */
   enableRowNumbers?: boolean;
+  /**
+   * Where the grid puts its filter controls - a popup over the rows, a sidebar
+   * beside them, controls in the header row, or nowhere at all so you place
+   * `TMDataGrid.FilterPanel` yourself.
+   *
+   * ```tsx
+   * useTMDataGrid({ data, columns, filters: { surface: "sidebar", inHeader: true } });
+   * ```
+   *
+   * Defaults to `{ surface: "popup" }` - the floating panel the grid has
+   * always shown. See {@link TMDataGridFiltersOptions}.
+   *
+   * Read field by field, so a literal is fine here - unlike `labels` or
+   * `persist`, this one does not have to be referentially stable.
+   */
+  filters?: TMDataGridFiltersOptions;
+  /**
+   * How the grid exports: the file format, the file name and whether the
+   * column labels go in as the first row. Defaults to `csvExcelFormat()`,
+   * `"export"` and `true`. See {@link TMDataGridExportOptions}.
+   *
+   * ```tsx
+   * useTMDataGrid({ data, columns, exportOptions: { format: csvFormat(), fileName: "employees" } });
+   * ```
+   *
+   * Read field by field like `filters`, so a literal is fine. A `format`
+   * built inline is rebuilt every render, which costs nothing but a small
+   * object; keep it at module scope when that bothers you.
+   */
+  exportOptions?: TMDataGridExportOptions;
   /**
    * How the quick search (`TMDataGrid.Search`) matches. `"fuzzy"` - the
    * default - forgives typos and skipped characters, and while it is the
@@ -957,6 +1136,7 @@ export function useTMDataGrid<TData extends RowData>({
   labels: labelsOverride,
   enableColumnOrdering,
   enablePagination,
+  resetPageOnQueryChange,
   enableRowNumbers,
   selectionMode,
   showSelectedBackground,
@@ -964,6 +1144,8 @@ export function useTMDataGrid<TData extends RowData>({
   onHighlightedRowChange,
   cellSelection,
   onFocusedCellChange,
+  filters: filterOptions,
+  exportOptions: exportOptionsOverride,
   editing,
   renderDetails,
   renderDetailsEstHeight = DEFAULT_DETAILS_EST_HEIGHT,
@@ -995,6 +1177,50 @@ export function useTMDataGrid<TData extends RowData>({
   // Resolved on the override's identity, so a module-scope dictionary costs one
   // merge for the lifetime of the grid.
   const labels = useMemo(() => mergeLabels(labelsOverride), [labelsOverride]);
+  // Field by field for the same reason as `filters` below.
+  const {
+    format: exportFormat,
+    fileName: exportFileName,
+    includeHeaders: exportIncludeHeaders,
+    columns: exportColumns,
+  } = exportOptionsOverride ?? {};
+  const exportOptions = useMemo(
+    () =>
+      resolveExportOptions({
+        format: exportFormat,
+        fileName: exportFileName,
+        includeHeaders: exportIncludeHeaders,
+        columns: exportColumns,
+      }),
+    [exportFormat, exportFileName, exportIncludeHeaders, exportColumns],
+  );
+  // Unpacked before the memo, so the api is keyed on the five fields rather
+  // than on the object's identity - which is what lets `filters` be written as
+  // a literal, the way it reads best, without republishing every render.
+  const {
+    surface: filterSurface,
+    sidebarSide: filterSidebarSide,
+    sidebarWidth: filterSidebarWidth,
+    defaultOpen: filtersDefaultOpen,
+    inHeader: filtersInHeader,
+  } = filterOptions ?? {};
+  const filters = useMemo(
+    () =>
+      resolveFilterOptions({
+        surface: filterSurface,
+        sidebarSide: filterSidebarSide,
+        sidebarWidth: filterSidebarWidth,
+        defaultOpen: filtersDefaultOpen,
+        inHeader: filtersInHeader,
+      }),
+    [
+      filterSurface,
+      filterSidebarSide,
+      filterSidebarWidth,
+      filtersDefaultOpen,
+      filtersInHeader,
+    ],
+  );
 
   const pinningEnabled = options.enableColumnPinning !== false;
   const selectColumnEnabled = features.selectColumn;
@@ -1169,12 +1395,129 @@ export function useTMDataGrid<TData extends RowData>({
     [],
   );
 
+  // The edit engine. Built once per mount; everything it needs later - the
+  // table, the mode, the consumer's callbacks - is read through a ref updated
+  // every render, so forms created at `begin()` always call the latest
+  // `onEditCommit` (the onHighlightedRowChangeRef pattern, applied wholesale).
+  // Created ahead of the table because the table's `data` reads its store;
+  // the ref is filled in once the table exists, and the engine only reads it
+  // inside verbs, never while being built.
+  const editContextRef = useRef<TMDataGridEditEngineContext>(null as never);
+  // The engine is erased; the row type comes back on the way out, which is
+  // what makes `edit.addRow(values)` check against `TData`.
+  const [engine] = useState(() =>
+    createEditEngine(() => editContextRef.current),
+  );
+  const edit = engine as unknown as TMDataGridEditApi<TData>;
+
+  // The rows as shown. Under `editing.draft` a committed row is a row like any
+  // other to the table: its draft replaces the consumer's record and a
+  // committed entry row is prepended, so sorting, filtering, grouping and
+  // aggregates all read the draft store's values. Rows still being typed
+  // into are not here - their values are undecided, and re-sorting under a
+  // caret is not something anyone wants. `newRowsSticky` keeps committed
+  // entry rows in the entry block, so those stay out too.
+  //
+  // Everything is keyed on identities the engine keeps stable while nothing
+  // is decided, so a keystroke in an open editor never rebuilds the model.
+  // `committedValues` rather than `committedRowIds`: the snapshot outlives a
+  // reopen, so a parked row being edited again keeps its place until the
+  // next commit or a cancel decides otherwise.
+  const editCommittedValues = useSelector(
+    edit.store,
+    (state) => state.committedValues,
+  );
+  const newRowsSticky = features.editNewRowsSticky;
+  const editCreatedIds = useSelector(
+    edit.store,
+    (state) =>
+      newRowsSticky
+        ? EMPTY_IDS
+        : state.newRows
+            .filter((newRow) => newRow.committed)
+            .map((newRow) => newRow.tempId),
+    { compare: shallow },
+  );
+  // Read through a ref, not listed as a dependency: an inline `getRowId` is
+  // a fresh function every render, and the merged array must keep its
+  // identity across renders or the table rebuilds its row models on each.
+  const consumerGetRowIdRef = useRef(options.getRowId);
+  consumerGetRowIdRef.current = options.getRowId;
+  const shown = useMemo(() => {
+    const consumerGetRowId = consumerGetRowIdRef.current;
+    const idOf = new Map<object, string>();
+    const created: Array<TData> = [];
+    for (const tempId of editCreatedIds) {
+      const values = editCommittedValues[tempId];
+      if (values === undefined) continue;
+      idOf.set(values, tempId);
+      created.push(values as TData);
+    }
+    const snapshots = Object.keys(editCommittedValues).length;
+    if (snapshots === 0) return { rows: options.data, idOf };
+    // Every snapshot may stand in for a record; only the created ones are
+    // known not to. The rest are looked up by the record's own id.
+    const rows =
+      snapshots === created.length
+        ? options.data
+        : options.data.map((record, index) => {
+            const rowId =
+              consumerGetRowId?.(record, index, undefined) ?? String(index);
+            const values = editCommittedValues[rowId];
+            if (values === undefined) return record;
+            idOf.set(values, rowId);
+            return values as TData;
+          });
+    return {
+      rows: created.length === 0 ? rows : [...created, ...rows],
+      idOf,
+    };
+  }, [options.data, editCommittedValues, editCreatedIds]);
+  const shownIdOfRef = useRef(shown.idOf);
+  shownIdOfRef.current = shown.idOf;
+  // A stable id resolver over the merged rows. A draft answers the id of the
+  // record it stands in for - the consumer's `getRowId` never sees a draft
+  // object, so an editable id field cannot rename the row - and a created
+  // row answers its temp id. Everything else is the consumer's own, or
+  // TanStack's index fallback.
+  const shownGetRowId = useCallback(
+    (record: TData, index: number, parent?: Row<TMDataGridFeatures, TData>) =>
+      shownIdOfRef.current.get(record) ??
+      consumerGetRowIdRef.current?.(record, index, parent) ??
+      (parent !== undefined ? `${parent.id}.${index}` : String(index)),
+    [],
+  );
+
+  // Filled immediately after the call below. The query-change wrappers close
+  // over it rather than over `table`, since they are built as part of the
+  // options the table is constructed from.
+  const tableRef = useRef<TMDataGridTable<TData>>(null as never);
+  // A narrower query invalidates the page the grid is on - see pageReset.ts.
+  // On by default everywhere: TanStack's own `autoResetPageIndex` is switched
+  // off below, since it also fires on every draft commit.
+  const resetPage = resetPageOnQueryChange ?? true;
+  const getQueryTable = useCallback(
+    () => tableRef.current as unknown as TMDataGridQueryTable,
+    [],
+  );
+
+  // The sync of `state` into the table's atoms happens inside this call, in
+  // the render body, and publishing from there makes React warn about the
+  // consumer's component - see controlledStateSync.ts.
+  beginControlledStateSync();
   const table = useTable({
     // The grid paints a running drag itself, one style write per frame - see
     // the resize preview in TMDataGridTable - and takes the width into state
     // once, when the pointer is released. `"onChange"` publishes a width on
     // every pointer move instead, which re-renders the grid for each of them.
     columnResizeMode: "onEnd",
+    // TanStack resets both whenever the `data` array's identity changes, and
+    // the rows as shown are a new array on every draft commit (see `shown`),
+    // so a commit on page 3 would land on page 1 with every details panel
+    // closed. Off here; the page reset the grid does want - on a query
+    // change - is its own, below. A consumer's explicit option still wins.
+    autoResetExpanded: false,
+    autoResetPageIndex: false,
     enableSorting: true,
     enableColumnResizing: true,
     // The quick search's matcher. Fuzzy by default (Q4); `"contains"` keeps
@@ -1191,6 +1534,41 @@ export function useTMDataGrid<TData extends RowData>({
     // `"reorder"` to keep the column and have it moved to the front instead.
     groupedColumnMode: "remove",
     ...options,
+    // The query slices, wrapped so a change also takes the grid back to the
+    // first page - see pageReset.ts. Spread conditionally: the keys carry a
+    // `makeStateUpdater` default, and an explicit `undefined` would overwrite
+    // it and leave the slice unwritable.
+    ...(resetPage
+      ? {
+          onColumnFiltersChange: withPageReset(
+            "columnFilters",
+            options.onColumnFiltersChange as never,
+            getQueryTable,
+          ) as TableOptions<
+            TMDataGridFeatures,
+            TData
+          >["onColumnFiltersChange"],
+          onGlobalFilterChange: withPageReset(
+            "globalFilter",
+            options.onGlobalFilterChange as never,
+            getQueryTable,
+          ) as TableOptions<TMDataGridFeatures, TData>["onGlobalFilterChange"],
+          onSortingChange: withPageReset(
+            "sorting",
+            options.onSortingChange as never,
+            getQueryTable,
+          ) as TableOptions<TMDataGridFeatures, TData>["onSortingChange"],
+          onGroupingChange: withPageReset(
+            "grouping",
+            options.onGroupingChange as never,
+            getQueryTable,
+          ) as TableOptions<TMDataGridFeatures, TData>["onGroupingChange"],
+        }
+      : {}),
+    // The rows as shown - see `shown` above. The consumer's own array passes
+    // through untouched while nothing is committed.
+    data: shown.rows,
+    getRowId: shownGetRowId,
     // Row details ride on `expanded`, the same state the tree uses - but a data
     // row answers `getCanExpand()` false, since TanStack's fallback is
     // `subRows.length > 0`. `() => true` is the right answer for a group row
@@ -1209,6 +1587,20 @@ export function useTMDataGrid<TData extends RowData>({
       (typeof options.enableRowPinning === "function"
         ? options.enableRowPinning(row)
         : options.enableRowPinning === true),
+    // A deletion-marked row is not selectable: it is on its way out, and a
+    // bulk action over the selection must not see it. TanStack reads the
+    // predicate on every call, so the mark is checked live against the
+    // engine. Only under `editing.draft`, the one place marks exist; the
+    // consumer's own option keeps the final say, predicate form included.
+    ...(editDraft
+      ? {
+          enableRowSelection: (row: Row<TMDataGridFeatures, TData>) =>
+            !engine.isRowDeleted(row.id) &&
+            (typeof options.enableRowSelection === "function"
+              ? options.enableRowSelection(row)
+              : options.enableRowSelection !== false),
+        }
+      : {}),
     features: tmDataGridFeatures,
     columns: columns as TableOptions<TMDataGridFeatures, TData>["columns"],
     // The stabilized controlled state; `undefined` when nothing is controlled.
@@ -1230,14 +1622,14 @@ export function useTMDataGrid<TData extends RowData>({
       columnPinning: {
         // The generated columns are structurally pinned, so they are re-applied
         // on top of anything restored from storage.
-        left: [
+        start: [
           ...(rowNumbersEnabled && pinningEnabled ? [ROW_NUMBER_COLUMN_ID] : []),
           ...(selectColumnEnabled && pinningEnabled ? [SELECT_COLUMN_ID] : []),
           ...(groupColumnEnabled && pinningEnabled ? [GROUP_COLUMN_ID] : []),
           ...(detailsColumnEnabled && pinningEnabled ? [DETAILS_COLUMN_ID] : []),
           ...(
-            persistedState.columnPinning?.left ??
-            options.initialState?.columnPinning?.left ??
+            persistedState.columnPinning?.start ??
+            options.initialState?.columnPinning?.start ??
             []
           ).filter(
             (id) =>
@@ -1249,10 +1641,10 @@ export function useTMDataGrid<TData extends RowData>({
         ],
         // The edit lane mirrors the generated columns on the left: structurally
         // pinned, outermost, re-applied over anything restored.
-        right: [
+        end: [
           ...(
-            persistedState.columnPinning?.right ??
-            options.initialState?.columnPinning?.right ??
+            persistedState.columnPinning?.end ??
+            options.initialState?.columnPinning?.end ??
             []
           ).filter((id) => id !== EDIT_COLUMN_ID),
           ...(editColumnEnabled && pinningEnabled ? [EDIT_COLUMN_ID] : []),
@@ -1266,12 +1658,11 @@ export function useTMDataGrid<TData extends RowData>({
       },
     },
   }, selectSettledState);
+  endControlledStateSync();
+  tableRef.current = table as unknown as TMDataGridTable<TData>;
+  deferControlledStateSyncPublishes(table.store);
 
-  // The edit engine. Built once per mount; everything it needs later - the
-  // table, the mode, the consumer's callbacks - is read through a ref updated
-  // every render, so forms created at `begin()` always call the latest
-  // `onEditCommit` (the onHighlightedRowChangeRef pattern, applied wholesale).
-  const editContextRef = useRef<TMDataGridEditEngineContext>(null as never);
+  // The engine's view of this render - see the engine's creation above.
   editContextRef.current = {
     table: table as unknown as TMDataGridTable<TMDataGridRowData>,
     editMode: editMode ?? "cell",
@@ -1284,23 +1675,14 @@ export function useTMDataGrid<TData extends RowData>({
       editing?.isRowEditable as TMDataGridEditEngineContext["isRowEditable"],
     onEditCommit:
       editing?.onCommit as TMDataGridEditEngineContext["onEditCommit"],
-    // The deprecated name still works; the new one wins if both are set.
-    onSaveDrafts: (editing?.onSaveDrafts ??
-      editing?.onCommitDrafts) as TMDataGridEditEngineContext["onSaveDrafts"],
+    onSaveDrafts:
+      editing?.onSaveDrafts as TMDataGridEditEngineContext["onSaveDrafts"],
     newRowDefaults:
       editing?.newRowDefaults as TMDataGridEditEngineContext["newRowDefaults"],
     onRowAdd: editing?.onRowAdd as TMDataGridEditEngineContext["onRowAdd"],
     onRowDelete:
       editing?.onRowDelete as TMDataGridEditEngineContext["onRowDelete"],
   };
-  // The engine is erased; the row type comes back on the way out, which is
-  // what makes `edit.addRow(values)` check against `TData`.
-  const [edit] = useState(
-    () =>
-      createEditEngine(
-        () => editContextRef.current,
-      ) as unknown as TMDataGridEditApi<TData>,
-  );
 
   // Switching either axis mid-flight drops every draft: the policies disagree
   // about what an open form means, and carrying one across is how a row
@@ -1315,6 +1697,29 @@ export function useTMDataGrid<TData extends RowData>({
     edit.cancelAll();
   }, [editMode, editDraft, edit]);
 
+  // A refetch that drops a record takes the engine's state for it along -
+  // see forgetMissingRows. Not where the grid does not own the result set:
+  // there a row missing from `data` is on another page or filtered away
+  // server-side, not gone, and its draft has to wait for Save. Keyed on the
+  // rows as shown, which is what the core row model is built from.
+  // Through the ref, not `table`: `useTable` hands out a fresh copy of the
+  // table every render, and listing it would run this on every one.
+  const editingOn = editing !== undefined;
+  const serverSideRows =
+    options.manualPagination === true || options.manualFiltering === true;
+  useEffect(() => {
+    if (!editingOn || serverSideRows) return;
+    engine.forgetMissingRows(tableRef.current.getCoreRowModel().rowsById);
+  }, [shown.rows, editingOn, serverSideRows, engine]);
+
+  // Readers that hold the table and nothing else - `exportGrid` - still
+  // leave a deletion-marked row out. Keyed on
+  // the store, which every copy of the table shares, so once is enough.
+  useEffect(
+    () => registerDeletedRows(tableRef.current, engine.isRowDeleted),
+    [engine],
+  );
+
   // Editing without stable ids points every draft at whatever record slides
   // into that index after a sort. Loud, once, in development.
   useEffect(() => {
@@ -1341,42 +1746,16 @@ export function useTMDataGrid<TData extends RowData>({
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
 
-  // Two things have to happen whenever `grouping` changes.
-  //
-  // One: the tree column appears with the first grouped column and goes away
-  // with the last, so an ungrouped grid looks exactly as it did before grouping
+  // The tree column appears with the first grouped column and goes away with
+  // the last, so an ungrouped grid looks exactly as it did before grouping
   // existed. Driven from a subscription rather than by rebuilding the column
   // array, because the array is what the table is built from - deriving it from
   // table state would close the loop. Visibility is the one column property
   // that can be changed after the fact without touching the definitions.
   //
-  // Two, and this one is a workaround. In table-core 9.0.0-beta.21 the
-  // per-region column APIs do not list `grouping` among their memo
-  // dependencies, even though they all derive from `getAllLeafColumns()`, which
-  // does:
-  //
-  // | API | Declares |
-  // | --- | --- |
-  // | `getLeft/Center/RightVisibleLeafColumns` | columns, columnPinning, columnVisibility, columnOrder |
-  // | `getLeft/Center/RightHeaderGroups` | columnPinning, columnOrder |
-  // | `row.getLeft/Center/RightVisibleCells` | columnPinning, columnVisibility |
-  //
-  // So grouping a *second* column leaves every one of them returning the
-  // previous list: the column TanStack removed keeps its header and its grid
-  // track, and the row cells no longer line up with them. The first grouping
-  // appears to work only because the visibility write above happens to touch a
-  // dependency they share.
-  //
-  // Re-publishing `columnVisibility` and `columnOrder` - same contents, new
-  // identity - invalidates all three families. `columnOrder` is the only
-  // dependency the header groups declare, and `columnVisibility` the only one
-  // the cells do, so both are needed. Remove this once the deps are fixed
-  // upstream; the test that fails without it groups two columns and asserts the
-  // second one leaves the grid.
-  //
   // Writing back into the store from its own subscriber is safe: the guard is
-  // on `grouping`'s identity, and neither write touches it, so the callback
-  // these writes trigger short-circuits.
+  // on `grouping`'s identity, and the write does not touch it, so the callback
+  // it triggers short-circuits.
   useEffect(() => {
     if (!groupColumnEnabled) return;
     let previousGrouping = table.store.state.grouping;
@@ -1410,8 +1789,8 @@ export function useTMDataGrid<TData extends RowData>({
       // Keeps the entry injected into a controlled `columnVisibility` (see
       // requestedState) in sync with grouping.
       groupingActiveRef.current = state.grouping.length > 0;
-      // On a controlled slice the writes below round-trip through the
-      // consumer's handler; the next render must forward them unstabilized.
+      // On a controlled slice the write below round-trips through the
+      // consumer's handler; the next render must forward it unstabilized.
       // See republishControlledStateRef.
       republishControlledStateRef.current = true;
 
@@ -1419,7 +1798,6 @@ export function useTMDataGrid<TData extends RowData>({
         ...old,
         [GROUP_COLUMN_ID]: state.grouping.length > 0,
       }));
-      table.setColumnOrder((old) => [...old]);
     });
 
     return () => subscription.unsubscribe();
@@ -1464,9 +1842,11 @@ export function useTMDataGrid<TData extends RowData>({
 
   const ui = useCreateStore<TMDataGridUiState, TMDataGridUiActions>(
     {
-      filterPanelOpen: false,
-      columnsPanelOpen: false,
+      // `useCreateStore` builds the store once per mount, so `defaultOpen` is
+      // read the way `initialState` is - a starting point, not a controller.
+      filterPanelOpen: filters.defaultOpen,
       filterPanelColumnId: null,
+      headerFilterColumnId: null,
       draggedColumnId: null,
       // `useCreateStore` builds the store once per mount, so this is a genuine
       // default rather than a value that would fight later clicks.
@@ -1474,6 +1854,7 @@ export function useTMDataGrid<TData extends RowData>({
       selectionAnchorRowId: null,
       focusedCell: null,
       cellRange: null,
+      exportPicker: null,
     },
     ({ setState }) => ({
       openFilterPanel: (columnId = null) =>
@@ -1488,10 +1869,14 @@ export function useTMDataGrid<TData extends RowData>({
           filterPanelOpen: false,
           filterPanelColumnId: null,
         })),
-      setColumnsPanelOpen: (open) =>
-        setState((prev) => ({ ...prev, columnsPanelOpen: open })),
-      toggleColumnsPanel: () =>
-        setState((prev) => ({ ...prev, columnsPanelOpen: !prev.columnsPanelOpen })),
+      openExportPicker: (request) =>
+        setState((prev) => ({ ...prev, exportPicker: request })),
+      closeExportPicker: () =>
+        setState((prev) => ({ ...prev, exportPicker: null })),
+      focusPanelFilter: (columnId) =>
+        setState((prev) => ({ ...prev, filterPanelColumnId: columnId })),
+      focusHeaderFilter: (columnId) =>
+        setState((prev) => ({ ...prev, headerFilterColumnId: columnId })),
       startColumnDrag: (columnId) =>
         setState((prev) => ({ ...prev, draggedColumnId: columnId })),
       endColumnDrag: () =>
@@ -1580,12 +1965,12 @@ export function useTMDataGrid<TData extends RowData>({
     table.setColumnSizing({ ...initial?.columnSizing });
     table.setColumnOrder([...(initial?.columnOrder ?? [])]);
     table.setColumnPinning({
-      left: [
+      start: [
         ...(rowNumbersEnabled && pinningEnabled ? [ROW_NUMBER_COLUMN_ID] : []),
         ...(selectColumnEnabled && pinningEnabled ? [SELECT_COLUMN_ID] : []),
         ...(groupColumnEnabled && pinningEnabled ? [GROUP_COLUMN_ID] : []),
         ...(detailsColumnEnabled && pinningEnabled ? [DETAILS_COLUMN_ID] : []),
-        ...(initial?.columnPinning?.left ?? []).filter(
+        ...(initial?.columnPinning?.start ?? []).filter(
           (id) =>
             id !== ROW_NUMBER_COLUMN_ID &&
             id !== SELECT_COLUMN_ID &&
@@ -1593,8 +1978,8 @@ export function useTMDataGrid<TData extends RowData>({
             id !== GROUP_COLUMN_ID,
         ),
       ],
-      right: [
-        ...(initial?.columnPinning?.right ?? []).filter(
+      end: [
+        ...(initial?.columnPinning?.end ?? []).filter(
           (id) => id !== EDIT_COLUMN_ID,
         ),
         ...(editColumnEnabled && pinningEnabled ? [EDIT_COLUMN_ID] : []),
@@ -1617,6 +2002,8 @@ export function useTMDataGrid<TData extends RowData>({
     ui,
     edit,
     features,
+    filters,
+    exportOptions,
     labels,
     renderDetails,
     renderDetailsEstHeight,
@@ -1628,20 +2015,44 @@ export function useTMDataGrid<TData extends RowData>({
 }
 
 /**
- * Opens the filter panel for a column, seeding an empty filter row when the
- * column has none yet - mirrors "Filter" in the column header menu.
+ * Gives a column an empty filter of its default operator, unless it already
+ * has one - which is what makes a surface open on a row rather than on
+ * nothing.
+ *
+ * @internal Shared by `openColumnFilter` and the toolbar's filter button.
  */
-export function openColumnFilter<TData extends RowData>(
+export function seedColumnFilter<TData extends RowData>(
   api: TMDataGridApi<TData>,
   columnId: string,
 ): void {
   const column = api.table.getColumn(columnId);
-  if (column && column.getFilterValue() === undefined) {
-    const operator = getColumnDefaultOperator(column);
-    column.setFilterValue({
-      operator,
-      value: emptyValueForOperator(operator),
-    });
+  if (column === undefined || column.getFilterValue() !== undefined) return;
+  const operator = getColumnDefaultOperator(column);
+  column.setFilterValue({ operator, value: emptyValueForOperator(operator) });
+}
+
+/**
+ * Sends the user to a column's filter control, seeding an empty filter when
+ * the column has none yet - what "Filter" in the column menu and a click on a
+ * filter pill both do.
+ *
+ * Which control that is follows the grid's `filters` option. Under
+ * `inHeader` it is the column's header control, which is already on screen, so
+ * the call focuses it and leaves the popup or sidebar closed. Otherwise it is
+ * the panel's row for that column, and the call opens the surface on it.
+ */
+export function openColumnFilter<TData extends RowData>(
+  api: TMDataGridApi<TData>,
+  columnId: string,
+): void {
+  seedColumnFilter(api, columnId);
+  if (api.filters.inHeader) {
+    // The header control is always visible, so there is nothing to open -
+    // only a column to point at. The header row watching this focuses it and
+    // scrolls it into view. The panel, if one is also showing, is left alone:
+    // it reads the other slot.
+    api.ui.actions.focusHeaderFilter(columnId);
+    return;
   }
   api.ui.actions.openFilterPanel(columnId);
 }