@tanstack/table-core 9.0.0-alpha.0 → 9.0.0-alpha.10

package/src/features/ColumnGrouping.ts

@@ -240,7 +240,7 @@ export interface GroupingInstance<TData extends RowData> {
 //
 
 export const ColumnGrouping: TableFeature = {
-  getDefaultColumnDef: <TData extends RowData>(): GroupingColumnDef<
+  _getDefaultColumnDef: <TData extends RowData>(): GroupingColumnDef<
     TData,
     unknown
   > => {
@@ -250,14 +250,14 @@ export const ColumnGrouping: TableFeature = {
     }
   },
 
-  getInitialState: (state): GroupingTableState => {
+  _getInitialState: (state): GroupingTableState => {
     return {
       grouping: [],
       ...state,
     }
   },
 
-  getDefaultOptions: <TData extends RowData>(
+  _getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
   ): GroupingOptions => {
     return {
@@ -266,7 +266,7 @@ export const ColumnGrouping: TableFeature = {
     }
   },
 
-  createColumn: <TData extends RowData, TValue>(
+  _createColumn: <TData extends RowData, TValue>(
     column: Column<TData, TValue>,
     table: Table<TData>
   ): void => {
@@ -334,7 +334,7 @@ export const ColumnGrouping: TableFeature = {
     }
   },
 
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     table.setGrouping = updater => table.options.onGroupingChange?.(updater)
 
     table.resetGrouping = defaultState => {
@@ -355,7 +355,7 @@ export const ColumnGrouping: TableFeature = {
     }
   },
 
-  createRow: <TData extends RowData>(
+  _createRow: <TData extends RowData>(
     row: Row<TData>,
     table: Table<TData>
   ): void => {
@@ -380,7 +380,7 @@ export const ColumnGrouping: TableFeature = {
     row._groupingValuesCache = {}
   },
 
-  createCell: <TData extends RowData, TValue>(
+  _createCell: <TData extends RowData, TValue>(
     cell: Cell<TData, TValue>,
     column: Column<TData, TValue>,
     row: Row<TData>,

package/src/features/ColumnOrdering.ts

@@ -73,14 +73,14 @@ export interface ColumnOrderInstance<TData extends RowData> {
 //
 
 export const ColumnOrdering: TableFeature = {
-  getInitialState: (state): ColumnOrderTableState => {
+  _getInitialState: (state): ColumnOrderTableState => {
     return {
       columnOrder: [],
       ...state,
     }
   },
 
-  getDefaultOptions: <TData extends RowData>(
+  _getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
   ): ColumnOrderDefaultOptions => {
     return {
@@ -88,7 +88,7 @@ export const ColumnOrdering: TableFeature = {
     }
   },
 
-  createColumn: <TData extends RowData>(
+  _createColumn: <TData extends RowData>(
     column: Column<TData, unknown>,
     table: Table<TData>
   ): void => {
@@ -107,7 +107,7 @@ export const ColumnOrdering: TableFeature = {
     }
   },
 
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     table.setColumnOrder = updater =>
       table.options.onColumnOrderChange?.(updater)
     table.resetColumnOrder = defaultState => {

package/src/features/ColumnPinning.ts

@@ -151,14 +151,14 @@ const getDefaultColumnPinningState = (): ColumnPinningState => ({
 })
 
 export const ColumnPinning: TableFeature = {
-  getInitialState: (state): ColumnPinningTableState => {
+  _getInitialState: (state): ColumnPinningTableState => {
     return {
       columnPinning: getDefaultColumnPinningState(),
       ...state,
     }
   },
 
-  getDefaultOptions: <TData extends RowData>(
+  _getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
   ): ColumnPinningDefaultOptions => {
     return {
@@ -166,7 +166,7 @@ export const ColumnPinning: TableFeature = {
     }
   },
 
-  createColumn: <TData extends RowData, TValue>(
+  _createColumn: <TData extends RowData, TValue>(
     column: Column<TData, TValue>,
     table: Table<TData>
   ): void => {
@@ -236,7 +236,7 @@ export const ColumnPinning: TableFeature = {
     }
   },
 
-  createRow: <TData extends RowData>(
+  _createRow: <TData extends RowData>(
     row: Row<TData>,
     table: Table<TData>
   ): void => {
@@ -279,7 +279,7 @@ export const ColumnPinning: TableFeature = {
     )
   },
 
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     table.setColumnPinning = updater =>
       table.options.onColumnPinningChange?.(updater)
 

package/src/features/ColumnSizing.ts

@@ -232,10 +232,10 @@ const getDefaultColumnSizingInfoState = (): ColumnSizingInfoState => ({
 })
 
 export const ColumnSizing: TableFeature = {
-  getDefaultColumnDef: (): ColumnSizingColumnDef => {
+  _getDefaultColumnDef: (): ColumnSizingColumnDef => {
     return defaultColumnSizing
   },
-  getInitialState: (state): ColumnSizingTableState => {
+  _getInitialState: (state): ColumnSizingTableState => {
     return {
       columnSizing: {},
       columnSizingInfo: getDefaultColumnSizingInfoState(),
@@ -243,7 +243,7 @@ export const ColumnSizing: TableFeature = {
     }
   },
 
-  getDefaultOptions: <TData extends RowData>(
+  _getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
   ): ColumnSizingDefaultOptions => {
     return {
@@ -254,7 +254,7 @@ export const ColumnSizing: TableFeature = {
     }
   },
 
-  createColumn: <TData extends RowData, TValue>(
+  _createColumn: <TData extends RowData, TValue>(
     column: Column<TData, TValue>,
     table: Table<TData>
   ): void => {
@@ -312,7 +312,7 @@ export const ColumnSizing: TableFeature = {
     }
   },
 
-  createHeader: <TData extends RowData, TValue>(
+  _createHeader: <TData extends RowData, TValue>(
     header: Header<TData, TValue>,
     table: Table<TData>
   ): void => {
@@ -513,7 +513,7 @@ export const ColumnSizing: TableFeature = {
     }
   },
 
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     table.setColumnSizing = updater =>
       table.options.onColumnSizingChange?.(updater)
     table.setColumnSizingInfo = updater =>

package/src/features/ColumnVisibility.ts

@@ -150,14 +150,14 @@ export interface VisibilityColumn {
 //
 
 export const ColumnVisibility: TableFeature = {
-  getInitialState: (state): VisibilityTableState => {
+  _getInitialState: (state): VisibilityTableState => {
     return {
       columnVisibility: {},
       ...state,
     }
   },
 
-  getDefaultOptions: <TData extends RowData>(
+  _getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
   ): VisibilityDefaultOptions => {
     return {
@@ -165,7 +165,7 @@ export const ColumnVisibility: TableFeature = {
     }
   },
 
-  createColumn: <TData extends RowData, TValue>(
+  _createColumn: <TData extends RowData, TValue>(
     column: Column<TData, TValue>,
     table: Table<TData>
   ): void => {
@@ -201,7 +201,7 @@ export const ColumnVisibility: TableFeature = {
     }
   },
 
-  createRow: <TData extends RowData>(
+  _createRow: <TData extends RowData>(
     row: Row<TData>,
     table: Table<TData>
   ): void => {
@@ -223,7 +223,7 @@ export const ColumnVisibility: TableFeature = {
     )
   },
 
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     const makeVisibleColumnsMethod = (
       key: string,
       getColumns: () => Column<TData, unknown>[]

package/src/features/GlobalFaceting.ts

@@ -28,7 +28,7 @@ export interface GlobalFacetingInstance<TData extends RowData> {
 //
 
 export const GlobalFaceting: TableFeature = {
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     table._getGlobalFacetedRowModel =
       table.options.getFacetedRowModel &&
       table.options.getFacetedRowModel(table, '__global__')

package/src/features/GlobalFiltering.ts

@@ -94,14 +94,14 @@ export interface GlobalFilterInstance<TData extends RowData> {
 //
 
 export const GlobalFiltering: TableFeature = {
-  getInitialState: (state): GlobalFilterTableState => {
+  _getInitialState: (state): GlobalFilterTableState => {
     return {
       globalFilter: undefined,
       ...state,
     }
   },
 
-  getDefaultOptions: <TData extends RowData>(
+  _getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
   ): GlobalFilterOptions<TData> => {
     return {
@@ -118,7 +118,7 @@ export const GlobalFiltering: TableFeature = {
     } as GlobalFilterOptions<TData>
   },
 
-  createColumn: <TData extends RowData>(
+  _createColumn: <TData extends RowData>(
     column: Column<TData, unknown>,
     table: Table<TData>
   ): void => {
@@ -133,7 +133,7 @@ export const GlobalFiltering: TableFeature = {
     }
   },
 
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     table.getGlobalAutoFilterFn = () => {
       return filterFns.includesString
     }

package/src/features/RowExpanding.ts

@@ -167,14 +167,14 @@ export interface ExpandedInstance<TData extends RowData> {
 //
 
 export const RowExpanding: TableFeature = {
-  getInitialState: (state): ExpandedTableState => {
+  _getInitialState: (state): ExpandedTableState => {
     return {
       expanded: {},
       ...state,
     }
   },
 
-  getDefaultOptions: <TData extends RowData>(
+  _getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
   ): ExpandedOptions<TData> => {
     return {
@@ -183,7 +183,7 @@ export const RowExpanding: TableFeature = {
     }
   },
 
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     let registered = false
     let queued = false
 
@@ -283,7 +283,7 @@ export const RowExpanding: TableFeature = {
     }
   },
 
-  createRow: <TData extends RowData>(
+  _createRow: <TData extends RowData>(
     row: Row<TData>,
     table: Table<TData>
   ): void => {

package/src/features/RowPagination.ts

@@ -193,7 +193,7 @@ const getDefaultPaginationState = (): PaginationState => ({
 })
 
 export const RowPagination: TableFeature = {
-  getInitialState: (state): PaginationTableState => {
+  _getInitialState: (state): PaginationTableState => {
     return {
       ...state,
       pagination: {
@@ -203,7 +203,7 @@ export const RowPagination: TableFeature = {
     }
   },
 
-  getDefaultOptions: <TData extends RowData>(
+  _getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
   ): PaginationDefaultOptions => {
     return {
@@ -211,7 +211,7 @@ export const RowPagination: TableFeature = {
     }
   },
 
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     let registered = false
     let queued = false
 

package/src/features/RowPinning.ts

@@ -76,7 +76,11 @@ export interface RowPinningRow {
 }
 
 export interface RowPinningInstance<TData extends RowData> {
-  _getPinnedRows: (position: 'top' | 'bottom') => Row<TData>[]
+  _getPinnedRows: (
+    visiblePinnedRows: Array<Row<TData>>,
+    pinnedRowIds: Array<string> | undefined,
+    position: 'top' | 'bottom'
+  ) => Row<TData>[]
   /**
    * Returns all bottom pinned rows.
    * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getbottomrows)
@@ -123,14 +127,14 @@ const getDefaultRowPinningState = (): RowPinningState => ({
 })
 
 export const RowPinning: TableFeature = {
-  getInitialState: (state): RowPinningTableState => {
+  _getInitialState: (state): RowPinningTableState => {
     return {
       rowPinning: getDefaultRowPinningState(),
       ...state,
     }
   },
 
-  getDefaultOptions: <TData extends RowData>(
+  _getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
   ): RowPinningDefaultOptions => {
     return {
@@ -138,7 +142,7 @@ export const RowPinning: TableFeature = {
     }
   },
 
-  createRow: <TData extends RowData>(
+  _createRow: <TData extends RowData>(
     row: Row<TData>,
     table: Table<TData>
   ): void => {
@@ -199,15 +203,15 @@ export const RowPinning: TableFeature = {
       const position = row.getIsPinned()
       if (!position) return -1
 
-      const visiblePinnedRowIds = table
-        ._getPinnedRows(position)
-        ?.map(({ id }) => id)
+      const visiblePinnedRowIds = (
+        position === 'top' ? table.getTopRows() : table.getBottomRows()
+      )?.map(({ id }) => id)
 
       return visiblePinnedRowIds?.indexOf(row.id) ?? -1
     }
   },
 
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     table.setRowPinning = updater => table.options.onRowPinningChange?.(updater)
 
     table.resetRowPinning = defaultState =>
@@ -226,36 +230,36 @@ export const RowPinning: TableFeature = {
       return Boolean(pinningState[position]?.length)
     }
 
-    table._getPinnedRows = memo(
-      position => [
-        table.getRowModel().rows,
-        table.getState().rowPinning[position!],
-        position,
-      ],
-      (visibleRows, pinnedRowIds, position) => {
-        const rows =
-          table.options.keepPinnedRows ?? true
-            ? //get all rows that are pinned even if they would not be otherwise visible
-              //account for expanded parent rows, but not pagination or filtering
-              (pinnedRowIds ?? []).map(rowId => {
-                const row = table.getRow(rowId, true)
-                return row.getIsAllParentsExpanded() ? row : null
-              })
-            : //else get only visible rows that are pinned
-              (pinnedRowIds ?? []).map(
-                rowId => visibleRows.find(row => row.id === rowId)!
-              )
+    table._getPinnedRows = (visibleRows, pinnedRowIds, position) => {
+      const rows =
+        table.options.keepPinnedRows ?? true
+          ? //get all rows that are pinned even if they would not be otherwise visible
+            //account for expanded parent rows, but not pagination or filtering
+            (pinnedRowIds ?? []).map(rowId => {
+              const row = table.getRow(rowId, true)
+              return row.getIsAllParentsExpanded() ? row : null
+            })
+          : //else get only visible rows that are pinned
+            (pinnedRowIds ?? []).map(
+              rowId => visibleRows.find(row => row.id === rowId)!
+            )
 
-        return rows
-          .filter(Boolean)
-          .map(d => ({ ...d, position })) as Row<TData>[]
-      },
-      getMemoOptions(table.options, 'debugRows', '_getPinnedRows')
-    )
+      return rows.filter(Boolean).map(d => ({ ...d, position })) as Row<TData>[]
+    }
 
-    table.getTopRows = () => table._getPinnedRows('top')
+    table.getTopRows = memo(
+      () => [table.getRowModel().rows, table.getState().rowPinning.top],
+      (allRows, topPinnedRowIds) =>
+        table._getPinnedRows(allRows, topPinnedRowIds, 'top'),
+      getMemoOptions(table.options, 'debugRows', 'getTopRows')
+    )
 
-    table.getBottomRows = () => table._getPinnedRows('bottom')
+    table.getBottomRows = memo(
+      () => [table.getRowModel().rows, table.getState().rowPinning.bottom],
+      (allRows, bottomPinnedRowIds) =>
+        table._getPinnedRows(allRows, bottomPinnedRowIds, 'bottom'),
+      getMemoOptions(table.options, 'debugRows', 'getBottomRows')
+    )
 
     table.getCenterRows = memo(
       () => [

package/src/features/RowSelection.ts

@@ -197,14 +197,14 @@ export interface RowSelectionInstance<TData extends RowData> {
 //
 
 export const RowSelection: TableFeature = {
-  getInitialState: (state): RowSelectionTableState => {
+  _getInitialState: (state): RowSelectionTableState => {
     return {
       rowSelection: {},
       ...state,
     }
   },
 
-  getDefaultOptions: <TData extends RowData>(
+  _getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
   ): RowSelectionOptions<TData> => {
     return {
@@ -218,7 +218,7 @@ export const RowSelection: TableFeature = {
     }
   },
 
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     table.setRowSelection = updater =>
       table.options.onRowSelectionChange?.(updater)
     table.resetRowSelection = defaultState =>
@@ -466,7 +466,7 @@ export const RowSelection: TableFeature = {
     }
   },
 
-  createRow: <TData extends RowData>(
+  _createRow: <TData extends RowData>(
     row: Row<TData>,
     table: Table<TData>
   ): void => {

package/src/features/RowSorting.ts

@@ -276,21 +276,21 @@ export interface SortingInstance<TData extends RowData> {
 //
 
 export const RowSorting: TableFeature = {
-  getInitialState: (state): SortingTableState => {
+  _getInitialState: (state): SortingTableState => {
     return {
       sorting: [],
       ...state,
     }
   },
 
-  getDefaultColumnDef: <TData extends RowData>(): SortingColumnDef<TData> => {
+  _getDefaultColumnDef: <TData extends RowData>(): SortingColumnDef<TData> => {
     return {
       sortingFn: 'auto',
       sortUndefined: 1,
     }
   },
 
-  getDefaultOptions: <TData extends RowData>(
+  _getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
   ): SortingOptions<TData> => {
     return {
@@ -301,7 +301,7 @@ export const RowSorting: TableFeature = {
     }
   },
 
-  createColumn: <TData extends RowData, TValue>(
+  _createColumn: <TData extends RowData, TValue>(
     column: Column<TData, TValue>,
     table: Table<TData>
   ): void => {
@@ -521,7 +521,7 @@ export const RowSorting: TableFeature = {
     }
   },
 
-  createTable: <TData extends RowData>(table: Table<TData>): void => {
+  _createTable: <TData extends RowData>(table: Table<TData>): void => {
     table.setSorting = updater => table.options.onSortingChange?.(updater)
     table.resetSorting = defaultState => {
       table.setSorting(defaultState ? [] : table.initialState?.sorting ?? [])

package/src/filterFns.ts

@@ -69,8 +69,8 @@ const arrIncludesSome: FilterFn<any> = (
   columnId: string,
   filterValue: unknown[]
 ) => {
-  return filterValue.some(
-    val => row.getValue<unknown[]>(columnId)?.includes(val)
+  return filterValue.some(val =>
+    row.getValue<unknown[]>(columnId)?.includes(val)
   )
 }
 

package/src/types.ts

@@ -98,21 +98,21 @@ import { CellContext, CoreCell } from './core/cell'
 import { CoreColumn } from './core/column'
 
 export interface TableFeature<TData extends RowData = any> {
-  createCell?: (
+  _createCell?: (
     cell: Cell<TData, unknown>,
     column: Column<TData>,
     row: Row<TData>,
     table: Table<TData>
   ) => void
-  createColumn?: (column: Column<TData, unknown>, table: Table<TData>) => void
-  createHeader?: (header: Header<TData, unknown>, table: Table<TData>) => void
-  createRow?: (row: Row<TData>, table: Table<TData>) => void
-  createTable?: (table: Table<TData>) => void
-  getDefaultColumnDef?: () => Partial<ColumnDef<TData, unknown>>
-  getDefaultOptions?: (
+  _createColumn?: (column: Column<TData, unknown>, table: Table<TData>) => void
+  _createHeader?: (header: Header<TData, unknown>, table: Table<TData>) => void
+  _createRow?: (row: Row<TData>, table: Table<TData>) => void
+  _createTable?: (table: Table<TData>) => void
+  _getDefaultColumnDef?: () => Partial<ColumnDef<TData, unknown>>
+  _getDefaultOptions?: (
     table: Table<TData>
   ) => Partial<TableOptionsResolved<TData>>
-  getInitialState?: (initialState?: InitialTableState) => Partial<TableState>
+  _getInitialState?: (initialState?: InitialTableState) => Partial<TableState>
 }
 
 export interface TableMeta<TData extends RowData> {}

package/src/utils/filterRowsUtils.ts

@@ -1,4 +1,4 @@
-import { createRow } from '../core/row'
+import { _createRow } from '../core/row'
 import { Row, RowModel, Table, RowData } from '../types'
 
 export function filterRows<TData extends RowData>(
@@ -29,7 +29,7 @@ function filterRowModelFromLeafs<TData extends RowData>(
     for (let i = 0; i < rowsToFilter.length; i++) {
       let row = rowsToFilter[i]!
 
-      const newRow = createRow(
+      const newRow = _createRow(
         table,
         row.id,
         row.original,
@@ -100,7 +100,7 @@ function filterRowModelFromRoot<TData extends RowData>(
 
       if (pass) {
         if (row.subRows?.length && depth < maxDepth) {
-          const newRow = createRow(
+          const newRow = _createRow(
             table,
             row.id,
             row.original,

package/src/utils/getCoreRowModel.ts

@@ -1,4 +1,4 @@
-import { createRow } from '../core/row'
+import { _createRow } from '../core/row'
 import { Table, Row, RowModel, RowData } from '../types'
 import { getMemoOptions, memo } from '../utils'
 
@@ -37,7 +37,7 @@ export function getCoreRowModel<TData extends RowData>(): (
             // }
 
             // Make the row
-            const row = createRow(
+            const row = _createRow(
               table,
               table._getRowId(originalRows[i]!, i, parentRow),
               originalRows[i]!,

package/src/utils/getGroupedRowModel.ts

@@ -1,4 +1,4 @@
-import { createRow } from '../core/row'
+import { _createRow } from '../core/row'
 import { Table, Row, RowModel, RowData } from '../types'
 import { flattenBy, getMemoOptions, memo } from '../utils'
 
@@ -67,7 +67,7 @@ export function getGroupedRowModel<TData extends RowData>(): (
                 ? flattenBy(groupedRows, row => row.subRows)
                 : groupedRows
 
-              const row = createRow(
+              const row = _createRow(
                 table,
                 id,
                 leafRows[0]!.original,

package/src/utils/getSortedRowModel.ts

@@ -18,8 +18,8 @@ export function getSortedRowModel<TData extends RowData>(): (
         const sortedFlatRows: Row<TData>[] = []
 
         // Filter out sortings that correspond to non existing columns
-        const availableSorting = sortingState.filter(
-          sort => table.getColumn(sort.id)?.getCanSort()
+        const availableSorting = sortingState.filter(sort =>
+          table.getColumn(sort.id)?.getCanSort()
         )
 
         const columnInfoById: Record<

package/src/utils.ts

@@ -65,11 +65,12 @@ type DeepKeysPrefix<
   ? `${TPrefix}.${DeepKeys<T[TPrefix], [...TDepth, any]> & string}`
   : never
 
-export type DeepValue<T, TProp> = T extends Record<string | number, any>
-  ? TProp extends `${infer TBranch}.${infer TDeepProp}`
-    ? DeepValue<T[TBranch], TDeepProp>
-    : T[TProp & string]
-  : never
+export type DeepValue<T, TProp> =
+  T extends Record<string | number, any>
+    ? TProp extends `${infer TBranch}.${infer TDeepProp}`
+      ? DeepValue<T[TBranch], TDeepProp>
+      : T[TProp & string]
+    : never
 
 export type NoInfer<T> = [T][T extends any ? 0 : never]