@tanstack/table-core 9.0.0-beta.5 → 9.0.0-beta.51

package/src/core/cells/coreCellsFeature.types.ts

@@ -6,8 +6,8 @@ import type { Cell } from '../../types/Cell'
 import type { Column } from '../../types/Column'
 
 export interface CellContext<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > {
   cell: Cell<TFeatures, TData, TValue>
@@ -19,8 +19,8 @@ export interface CellContext<
 }
 
 export interface Cell_CoreProperties<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > {
   /**
@@ -42,8 +42,8 @@ export interface Cell_CoreProperties<
 }
 
 export interface Cell_Cell<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > extends Cell_CoreProperties<TFeatures, TData, TValue> {
   /**

package/src/core/columns/constructColumn.ts

@@ -115,5 +115,11 @@ export function constructColumn<
   column.id = `${String(id)}`
   column.parent = parent
 
+  // Initialize instance-specific data for features that need it
+  const features = Object.values(table._features)
+  for (let i = 0; i < features.length; i++) {
+    features[i]!.initColumnInstanceData?.(column)
+  }
+
   return column as Column<TFeatures, TData, TValue>
 }

package/src/core/columns/coreColumnsFeature.types.ts

@@ -5,8 +5,8 @@ import type { AccessorFn, ColumnDef } from '../../types/ColumnDef'
 import type { Column } from '../../types/Column'
 
 export interface Column_CoreProperties<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > {
   /**
@@ -43,8 +43,8 @@ export interface Column_CoreProperties<
 }
 
 export interface Column_Column<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > extends Column_CoreProperties<TFeatures, TData, TValue> {
   /**
@@ -59,8 +59,8 @@ export interface Column_Column<
 }
 
 export interface TableOptions_Columns<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > {
   /**
@@ -74,8 +74,8 @@ export interface TableOptions_Columns<
 }
 
 export interface Table_Columns<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Returns a map of all flat columns by their ID.

package/src/core/columns/coreColumnsFeature.utils.ts

@@ -1,4 +1,4 @@
-import { callMemoOrStaticFn } from '../../utils'
+import { callMemoOrStaticFn, makeObjectMap } from '../../utils'
 import { table_getOrderColumnsFn } from '../../features/column-ordering/columnOrderingFeature.utils'
 import { constructColumn } from './constructColumn'
 import type { Table_Internal } from '../../types/Table'
@@ -185,7 +185,7 @@ export function table_getAllFlatColumnsById<
 >(
   table: Table_Internal<TFeatures, TData>,
 ): Record<string, Column<TFeatures, TData, unknown>> {
-  const result: Record<string, Column<TFeatures, TData, unknown>> = {}
+  const result = makeObjectMap<Column<TFeatures, TData, unknown>>()
   const flatColumns = table.getAllFlatColumns()
   for (let i = 0; i < flatColumns.length; i++) {
     const column = flatColumns[i]!
@@ -218,7 +218,7 @@ export function table_getAllLeafColumns<
     table,
     'getOrderColumns',
     table_getOrderColumnsFn,
-  )(leafColumns)
+  )(leafColumns) as Array<Column<TFeatures, TData, unknown>>
 }
 
 /**
@@ -238,7 +238,7 @@ export function table_getAllLeafColumnsById<
 >(
   table: Table_Internal<TFeatures, TData>,
 ): Record<string, Column<TFeatures, TData, unknown>> {
-  const result: Record<string, Column<TFeatures, TData, unknown>> = {}
+  const result = makeObjectMap<Column<TFeatures, TData, unknown>>()
   const leafColumns = table.getAllLeafColumns()
   for (let i = 0; i < leafColumns.length; i++) {
     const column = leafColumns[i]!

package/src/core/coreFeatures.ts

@@ -7,7 +7,7 @@ import { coreTablesFeature } from './table/coreTablesFeature'
 import type { TableReactivityBindings } from '../reactivity'
 
 export interface CoreFeatures {
-  coreReativityFeature?: TableReactivityBindings
+  coreReactivityFeature?: TableReactivityBindings
   coreCellsFeature: typeof coreCellsFeature
   coreColumnsFeature: typeof coreColumnsFeature
   coreHeadersFeature: typeof coreHeadersFeature

package/src/core/headers/buildHeaderGroups.ts

@@ -21,7 +21,7 @@ export function buildHeaderGroups<
   allColumns: Array<Column<TFeatures, TData, TValue>>,
   columnsToGroup: Array<Column<TFeatures, TData, TValue>>,
   table: Table_Internal<TFeatures, TData>,
-  headerFamily?: 'center' | 'left' | 'right',
+  headerFamily?: 'center' | 'start' | 'end',
 ) {
   // Find the max depth of the columns:
   // build the leaf column row
@@ -113,7 +113,9 @@ export function buildHeaderGroups<
         pendingParentHeaders.push(header)
       }
 
-      headerGroup.headers.push(headerToGroup)
+      headerGroup.headers.push(
+        headerToGroup as Header<TFeatures, TData, unknown>,
+      )
       headerToGroup.headerGroup = headerGroup
     })
 

package/src/core/headers/coreHeadersFeature.types.ts

@@ -1,13 +1,13 @@
 import type { CellData, RowData } from '../../types/type-utils'
 import type { TableFeatures } from '../../types/TableFeatures'
-import type { Table } from '../../types/Table'
+import type { Table, Table_Internal } from '../../types/Table'
 import type { Header } from '../../types/Header'
 import type { HeaderGroup } from '../../types/HeaderGroup'
 import type { Column } from '../../types/Column'
 
 export interface Table_Headers<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Builds the visible header groups for the current column tree, visibility,
@@ -30,8 +30,8 @@ export interface Table_Headers<
 }
 
 export interface HeaderContext<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > {
   /**
@@ -49,8 +49,8 @@ export interface HeaderContext<
 }
 
 export interface Header_CoreProperties<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > {
   /**
@@ -96,12 +96,12 @@ export interface Header_CoreProperties<
   /**
    * Reference to the parent table instance.
    */
-  table: Table<TFeatures, TData>
+  table: Table_Internal<TFeatures, TData>
 }
 
 export interface Header_Header<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > extends Header_CoreProperties<TFeatures, TData, TValue> {
   /**
@@ -115,8 +115,8 @@ export interface Header_Header<
 }
 
 export interface HeaderGroup_Header<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > {
   depth: number

package/src/core/headers/coreHeadersFeature.utils.ts

@@ -10,7 +10,6 @@ import type { Header } from '../../types/Header'
 import type { RowData } from '../../types/type-utils'
 import type { TableFeatures } from '../../types/TableFeatures'
 import type { Header_Header } from './coreHeadersFeature.types'
-import type { Column } from '../../types/Column'
 
 /**
  * Walks a header tree and collects all descendant leaf headers.
@@ -79,7 +78,7 @@ export function table_getHeaderGroups<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(table: Table_Internal<TFeatures, TData>) {
-  const { left, right } =
+  const { start, end } =
     table.atoms.columnPinning?.get() ?? getDefaultColumnPinningState()
   const allColumns = table.getAllColumns()
   const leafColumns = callMemoOrStaticFn(
@@ -89,15 +88,15 @@ export function table_getHeaderGroups<
   )
 
   // Fast path: no columns are pinned — skip per-side lookups, partition, and spread.
-  if (!left.length && !right.length) {
+  if (!start.length && !end.length) {
     return buildHeaderGroups(allColumns, leafColumns, table)
   }
 
   const leafColumnsById = table.getAllLeafColumnsById()
 
   const leftColumns: typeof leafColumns = []
-  for (let i = 0; i < left.length; i++) {
-    const column = leafColumnsById[left[i]!]
+  for (let i = 0; i < start.length; i++) {
+    const column = leafColumnsById[start[i]!]
     if (
       column &&
       callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible)
@@ -107,8 +106,8 @@ export function table_getHeaderGroups<
   }
 
   const rightColumns: typeof leafColumns = []
-  for (let i = 0; i < right.length; i++) {
-    const column = leafColumnsById[right[i]!]
+  for (let i = 0; i < end.length; i++) {
+    const column = leafColumnsById[end[i]!]
     if (
       column &&
       callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible)
@@ -118,7 +117,7 @@ export function table_getHeaderGroups<
   }
 
   const centerColumns = leafColumns.filter(
-    (column) => !left.includes(column.id) && !right.includes(column.id),
+    (column) => !start.includes(column.id) && !end.includes(column.id),
   )
 
   return buildHeaderGroups(

package/src/core/row-models/coreRowModelsFeature.types.ts

@@ -1,4 +1,3 @@
-import type { Table } from '../../types/Table'
 import type { Table_RowModels_Faceted } from '../../features/column-faceting/columnFacetingFeature.types'
 import type { Table_RowModels_Filtered } from '../../features/column-filtering/columnFilteringFeature.types'
 import type { Table_RowModels_Grouped } from '../../features/column-grouping/columnGroupingFeature.types'
@@ -10,37 +9,24 @@ import type { TableFeatures } from '../../types/TableFeatures'
 import type { RowData } from '../../types/type-utils'
 
 export interface RowModel<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   rows: Array<Row<TFeatures, TData>>
   flatRows: Array<Row<TFeatures, TData>>
   rowsById: Record<string, Row<TFeatures, TData>>
 }
 
-export interface CreateRowModel_Core<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  /**
-   * Optional factory for the core row model. When omitted, the built-in
-   * `createCoreRowModel()` factory is used.
-   */
-  coreRowModel?: (
-    table: Table<TFeatures, TData>,
-  ) => () => RowModel<TFeatures, TData>
-}
-
 export interface CachedRowModel_Core<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   coreRowModel: () => RowModel<TFeatures, TData>
 }
 
 export interface Table_RowModels_Core<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Returns the core row model before any processing has been applied.

package/src/core/row-models/coreRowModelsFeature.utils.ts

@@ -7,7 +7,7 @@ import type { RowModel } from './coreRowModelsFeature.types'
 /**
  * Resolves the table's unmodified core row model.
  *
- * The factory is created once per table, either from `options.rowModels.coreRowModel`
+ * The factory is created once per table, either from the `coreRowModel` slot on the `features` option
  * or the built-in `createCoreRowModel()`, then reused for later calls.
  *
  * @example
@@ -21,7 +21,7 @@ export function table_getCoreRowModel<
 >(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {
   if (!table._rowModels.coreRowModel) {
     table._rowModels.coreRowModel =
-      table.options.rowModels?.coreRowModel?.(table) ??
+      table.options.features.coreRowModel?.(table) ??
       createCoreRowModel<TFeatures, TData>()(table)
   }
 
@@ -64,7 +64,7 @@ export function table_getFilteredRowModel<
 >(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {
   if (!table._rowModels.filteredRowModel) {
     table._rowModels.filteredRowModel =
-      table.options.rowModels?.filteredRowModel?.(table)
+      table.options.features.filteredRowModel?.(table)
   }
 
   if (table.options.manualFiltering || !table._rowModels.filteredRowModel) {
@@ -92,7 +92,7 @@ export function table_getPreGroupedRowModel<
 }
 
 /**
- * Resolves the row model after grouping has produced grouped and aggregated rows.
+ * Resolves the row model after grouping has produced grouped rows.
  *
  * When `manualGrouping` is enabled, or no grouped row-model factory was
  * registered, this returns the pre-grouped row model unchanged.
@@ -108,7 +108,7 @@ export function table_getGroupedRowModel<
 >(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {
   if (!table._rowModels.groupedRowModel) {
     table._rowModels.groupedRowModel =
-      table.options.rowModels?.groupedRowModel?.(table)
+      table.options.features.groupedRowModel?.(table)
   }
 
   if (table.options.manualGrouping || !table._rowModels.groupedRowModel) {
@@ -153,7 +153,7 @@ export function table_getSortedRowModel<
 >(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {
   if (!table._rowModels.sortedRowModel) {
     table._rowModels.sortedRowModel =
-      table.options.rowModels?.sortedRowModel?.(table)
+      table.options.features.sortedRowModel?.(table)
   }
 
   if (table.options.manualSorting || !table._rowModels.sortedRowModel) {
@@ -197,7 +197,7 @@ export function table_getExpandedRowModel<
 >(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {
   if (!table._rowModels.expandedRowModel) {
     table._rowModels.expandedRowModel =
-      table.options.rowModels?.expandedRowModel?.(table)
+      table.options.features.expandedRowModel?.(table)
   }
 
   if (table.options.manualExpanding || !table._rowModels.expandedRowModel) {
@@ -243,7 +243,7 @@ export function table_getPaginatedRowModel<
 >(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {
   if (!table._rowModels.paginatedRowModel) {
     table._rowModels.paginatedRowModel =
-      table.options.rowModels?.paginatedRowModel?.(table)
+      table.options.features.paginatedRowModel?.(table)
   }
 
   if (table.options.manualPagination || !table._rowModels.paginatedRowModel) {

package/src/core/row-models/createCoreRowModel.ts

@@ -1,7 +1,7 @@
 import { constructRow } from '../rows/constructRow'
-import { tableMemo } from '../../utils'
+import { makeObjectMap, tableMemo } from '../../utils'
 import { table_autoResetPageIndex } from '../../features/row-pagination/rowPaginationFeature.utils'
-import type { Table, Table_Internal } from '../../types/Table'
+import type { Table_Internal } from '../../types/Table'
 import type { RowModel } from './coreRowModelsFeature.types'
 import type { TableFeatures } from '../../types/TableFeatures'
 import type { Row } from '../../types/Row'
@@ -15,9 +15,10 @@ import type { RowData } from '../../types/type-utils'
 export function createCoreRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
->(): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {
-  return (_table) => {
-    const table = _table as unknown as Table_Internal<TFeatures, TData>
+>(): (
+  table: Table_Internal<TFeatures, TData>,
+) => () => RowModel<TFeatures, TData> {
+  return (table) => {
     return tableMemo({
       feature: 'coreRowModelsFeature',
       table,
@@ -43,7 +44,7 @@ function _createCoreRowModel<
   const rowModel: RowModel<TFeatures, TData> = {
     rows: [],
     flatRows: [],
-    rowsById: {},
+    rowsById: makeObjectMap(),
   }
 
   const accessRows = (

package/src/core/rows/constructRow.ts

@@ -1,3 +1,4 @@
+import { makeObjectMap } from '../../utils'
 import type { Table_Internal } from '../../types/Table'
 import type { RowData } from '../../types/type-utils'
 import type { TableFeatures } from '../../types/TableFeatures'
@@ -47,8 +48,9 @@ export const constructRow = <
   >
 
   // Only assign instance-specific properties
-  row._uniqueValuesCache = {}
-  row._valuesCache = {}
+  row._displayIndexCache = -1
+  row._uniqueValuesCache = makeObjectMap()
+  row._valuesCache = makeObjectMap()
   row.depth = depth
   row.id = id
   row.index = rowIndex

package/src/core/rows/coreRowsFeature.ts

@@ -2,14 +2,17 @@ import { assignPrototypeAPIs, assignTableAPIs } from '../../utils'
 import {
   row_getAllCells,
   row_getAllCellsByColumnId,
+  row_getDisplayIndex,
   row_getLeafRows,
   row_getParentRow,
   row_getParentRows,
   row_getUniqueValues,
   row_getValue,
   row_renderValue,
+  table_getMaxSubRowDepth,
   table_getRow,
   table_getRowId,
+  table_getRowsInDisplayOrder,
 } from './coreRowsFeature.utils'
 import type { TableFeature } from '../../types/TableFeatures'
 
@@ -19,6 +22,9 @@ import type { TableFeature } from '../../types/TableFeatures'
 export const coreRowsFeature: TableFeature = {
   assignRowPrototype: (prototype, table) => {
     assignPrototypeAPIs('coreRowsFeature', prototype, table, {
+      row_getDisplayIndex: {
+        fn: (row) => row_getDisplayIndex(row),
+      },
       row_getAllCellsByColumnId: {
         fn: (row) => row_getAllCellsByColumnId(row),
         memoDeps: (row) => [row.getAllCells()],
@@ -29,6 +35,7 @@ export const coreRowsFeature: TableFeature = {
       },
       row_getLeafRows: {
         fn: (row) => row_getLeafRows(row),
+        memoDeps: (row) => [row.subRows],
       },
       row_getParentRow: {
         fn: (row) => row_getParentRow(row),
@@ -49,6 +56,16 @@ export const coreRowsFeature: TableFeature = {
   },
   constructTableAPIs: (table) => {
     assignTableAPIs('coreRowsFeature', table, {
+      table_getRowsInDisplayOrder: {
+        fn: () => table_getRowsInDisplayOrder(table),
+        memoDeps: () => [
+          table.getPrePaginatedRowModel().rows,
+          table.options.paginateExpandedRows,
+          table.options.paginateExpandedRows === false
+            ? table.atoms.expanded?.get()
+            : undefined,
+        ],
+      },
       table_getRowId: {
         fn: (originalRow, index, parent) =>
           table_getRowId(originalRow, table, index, parent),
@@ -57,6 +74,10 @@ export const coreRowsFeature: TableFeature = {
         fn: (id: string, searchAll?: boolean) =>
           table_getRow(table, id, searchAll),
       },
+      table_getMaxSubRowDepth: {
+        fn: () => table_getMaxSubRowDepth(table),
+        memoDeps: () => [table.getCoreRowModel()],
+      },
     })
   },
 }

package/src/core/rows/coreRowsFeature.types.ts

@@ -3,11 +3,26 @@ import type { RowData } from '../../types/type-utils'
 import type { TableFeatures } from '../../types/TableFeatures'
 import type { Row } from '../../types/Row'
 import type { Cell } from '../../types/Cell'
+import type { Column } from '../../types/Column'
 
 export interface Row_CoreProperties<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
+  _cellsCache?: WeakMap<
+    Column<TFeatures, TData, unknown>,
+    Cell<TFeatures, TData, unknown>
+  >
+  /**
+   * Internal cache used while resolving the current display order.
+   *
+   * This value may be stale until display order is recomputed. Use
+   * `row.getDisplayIndex()` instead; it refreshes and validates the cached
+   * position before returning it.
+   *
+   * @internal
+   */
+  _displayIndexCache: number
   _uniqueValuesCache: Record<string, unknown>
   _valuesCache: Record<string, unknown>
   /**
@@ -45,9 +60,16 @@ export interface Row_CoreProperties<
 }
 
 export interface Row_Row<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > extends Row_CoreProperties<TFeatures, TData> {
+  /**
+   * Returns the zero-based index of the row in the current display order
+   * before pagination, or `-1` if the row is not in that model. Use this for
+   * display row-number columns instead of `row.index` or the internal
+   * `_displayIndexCache` field.
+   */
+  getDisplayIndex: () => number
   /**
    * Builds a lookup of this row's cells keyed by leaf column id.
    */
@@ -83,8 +105,8 @@ export interface Row_Row<
 }
 
 export interface TableOptions_Rows<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * This optional function is used to derive a unique ID for any given row. If not provided the rows index is used (nested rows join together with `.` using their grandparents' index eg. `index.index.index`). If you need to identify individual rows that are originating from any server-side operations, it's suggested you use this function to return an ID that makes sense regardless of network IO/ambiguity eg. a userId, taskId, database ID field, etc.
@@ -106,9 +128,24 @@ export interface TableOptions_Rows<
 }
 
 export interface Table_Rows<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
+  /**
+   * Returns the deepest structural row depth in the core row model.
+   * Root rows are depth `0`, direct sub-rows are depth `1`, and so on.
+   */
+  getMaxSubRowDepth: () => number
+  /**
+   * Returns the rows in the current display order and assigns their display
+   * indexes. When expanded rows bypass pagination, expanded descendants are
+   * included in this order. This is the memoized source for
+   * `row.getDisplayIndex()`.
+   */
+  getRowsInDisplayOrder: () => Array<Row<TFeatures, TData>>
+  /**
+   * Returns the row id for a given row.
+   */
   getRowId: (_: TData, index: number, parent?: Row<TFeatures, TData>) => string
   /**
    * Returns the row with the given ID.