@tanstack/table-core 8.11.8 → 8.12.0

package/src/features/Pinning.ts

@@ -8,7 +8,7 @@ import {
   Cell,
   RowData,
 } from '../types'
-import { makeStateUpdater, memo } from '../utils'
+import { getMemoOptions, makeStateUpdater, memo } from '../utils'
 
 export type ColumnPinningPosition = false | 'left' | 'right'
 export type RowPinningPosition = false | 'top' | 'bottom'
@@ -426,11 +426,7 @@ export const Pinning: TableFeature = {
 
         return allCells.filter(d => !leftAndRight.includes(d.column.id))
       },
-      {
-        key:
-          process.env.NODE_ENV === 'development' && 'row.getCenterVisibleCells',
-        debug: () => table.options.debugAll ?? table.options.debugRows,
-      }
+      getMemoOptions(table.options, 'debugRows', 'getCenterVisibleCells')
     )
     row.getLeftVisibleCells = memo(
       () => [row._getAllVisibleCells(), table.getState().columnPinning.left, ,],
@@ -442,11 +438,7 @@ export const Pinning: TableFeature = {
 
         return cells
       },
-      {
-        key:
-          process.env.NODE_ENV === 'development' && 'row.getLeftVisibleCells',
-        debug: () => table.options.debugAll ?? table.options.debugRows,
-      }
+      getMemoOptions(table.options, 'debugRows', 'getLeftVisibleCells')
     )
     row.getRightVisibleCells = memo(
       () => [row._getAllVisibleCells(), table.getState().columnPinning.right],
@@ -458,11 +450,7 @@ export const Pinning: TableFeature = {
 
         return cells
       },
-      {
-        key:
-          process.env.NODE_ENV === 'development' && 'row.getRightVisibleCells',
-        debug: () => table.options.debugAll ?? table.options.debugRows,
-      }
+      getMemoOptions(table.options, 'debugRows', 'getRightVisibleCells')
     )
   },
 
@@ -493,10 +481,7 @@ export const Pinning: TableFeature = {
           .map(columnId => allColumns.find(column => column.id === columnId)!)
           .filter(Boolean)
       },
-      {
-        key: process.env.NODE_ENV === 'development' && 'getLeftLeafColumns',
-        debug: () => table.options.debugAll ?? table.options.debugColumns,
-      }
+      getMemoOptions(table.options, 'debugColumns', 'getLeftLeafColumns')
     )
 
     table.getRightLeafColumns = memo(
@@ -506,10 +491,7 @@ export const Pinning: TableFeature = {
           .map(columnId => allColumns.find(column => column.id === columnId)!)
           .filter(Boolean)
       },
-      {
-        key: process.env.NODE_ENV === 'development' && 'getRightLeafColumns',
-        debug: () => table.options.debugAll ?? table.options.debugColumns,
-      }
+      getMemoOptions(table.options, 'debugColumns', 'getRightLeafColumns')
     )
 
     table.getCenterLeafColumns = memo(
@@ -523,10 +505,7 @@ export const Pinning: TableFeature = {
 
         return allColumns.filter(d => !leftAndRight.includes(d.id))
       },
-      {
-        key: process.env.NODE_ENV === 'development' && 'getCenterLeafColumns',
-        debug: () => table.options.debugAll ?? table.options.debugColumns,
-      }
+      getMemoOptions(table.options, 'debugColumns', 'getCenterLeafColumns')
     )
 
     table.setRowPinning = updater => table.options.onRowPinningChange?.(updater)
@@ -547,34 +526,32 @@ export const Pinning: TableFeature = {
       return Boolean(pinningState[position]?.length)
     }
 
-    table._getPinnedRows = (position: 'top' | 'bottom') =>
-      memo(
-        () => [table.getRowModel().rows, table.getState().rowPinning[position]],
-        (visibleRows, pinnedRowIds) => {
-          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>[]
-        },
-        {
-          key:
-            process.env.NODE_ENV === 'development' &&
-            `row.get${position === 'top' ? 'Top' : 'Bottom'}Rows`,
-          debug: () => table.options.debugAll ?? table.options.debugRows,
-        }
-      )()
+    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)!
+              )
+
+        return rows
+          .filter(Boolean)
+          .map(d => ({ ...d, position })) as Row<TData>[]
+      },
+      getMemoOptions(table.options, 'debugRows', '_getPinnedRows')
+    )
 
     table.getTopRows = () => table._getPinnedRows('top')
 
@@ -590,10 +567,7 @@ export const Pinning: TableFeature = {
         const topAndBottom = new Set([...(top ?? []), ...(bottom ?? [])])
         return allRows.filter(d => !topAndBottom.has(d.id))
       },
-      {
-        key: process.env.NODE_ENV === 'development' && 'row.getCenterRows',
-        debug: () => table.options.debugAll ?? table.options.debugRows,
-      }
+      getMemoOptions(table.options, 'debugRows', 'getCenterRows')
     )
   },
 }

package/src/features/RowSelection.ts

@@ -1,6 +1,6 @@
 import { TableFeature } from '../core/table'
 import { OnChangeFn, Table, Row, RowModel, Updater, RowData } from '../types'
-import { makeStateUpdater, memo } from '../utils'
+import { getMemoOptions, makeStateUpdater, memo } from '../utils'
 
 export type RowSelectionState = Record<string, boolean>
 
@@ -333,10 +333,7 @@ export const RowSelection: TableFeature = {
 
         return selectRowsFn(table, rowModel)
       },
-      {
-        key: process.env.NODE_ENV === 'development' && 'getSelectedRowModel',
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-      }
+      getMemoOptions(table.options, 'debugTable', 'getSelectedRowModel')
     )
 
     table.getFilteredSelectedRowModel = memo(
@@ -352,12 +349,7 @@ export const RowSelection: TableFeature = {
 
         return selectRowsFn(table, rowModel)
       },
-      {
-        key:
-          process.env.NODE_ENV === 'production' &&
-          'getFilteredSelectedRowModel',
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-      }
+      getMemoOptions(table.options, 'debugTable', 'getFilteredSelectedRowModel')
     )
 
     table.getGroupedSelectedRowModel = memo(
@@ -373,11 +365,7 @@ export const RowSelection: TableFeature = {
 
         return selectRowsFn(table, rowModel)
       },
-      {
-        key:
-          process.env.NODE_ENV === 'production' && 'getGroupedSelectedRowModel',
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-      }
+      getMemoOptions(table.options, 'debugTable', 'getGroupedSelectedRowModel')
     )
 
     ///

package/src/features/Visibility.ts

@@ -1,3 +1,4 @@
+import { ColumnPinningPosition } from '..'
 import { TableFeature } from '../core/table'
 import {
   Cell,
@@ -8,7 +9,7 @@ import {
   Row,
   RowData,
 } from '../types'
-import { makeStateUpdater, memo } from '../utils'
+import { getMemoOptions, makeStateUpdater, memo } from '../utils'
 
 export type VisibilityState = Record<string, boolean>
 
@@ -199,10 +200,7 @@ export const Visibility: TableFeature = {
       cells => {
         return cells.filter(cell => cell.column.getIsVisible())
       },
-      {
-        key: process.env.NODE_ENV === 'production' && 'row._getAllVisibleCells',
-        debug: () => table.options.debugAll ?? table.options.debugRows,
-      }
+      getMemoOptions(table.options, 'debugRows', '_getAllVisibleCells')
     )
     row.getVisibleCells = memo(
       () => [
@@ -211,10 +209,7 @@ export const Visibility: TableFeature = {
         row.getRightVisibleCells(),
       ],
       (left, center, right) => [...left, ...center, ...right],
-      {
-        key: process.env.NODE_ENV === 'development' && 'row.getVisibleCells',
-        debug: () => table.options.debugAll ?? table.options.debugRows,
-      }
+      getMemoOptions(table.options, 'debugRows', 'getVisibleCells')
     )
   },
 
@@ -234,10 +229,7 @@ export const Visibility: TableFeature = {
         columns => {
           return columns.filter(d => d.getIsVisible?.())
         },
-        {
-          key,
-          debug: () => table.options.debugAll ?? table.options.debugColumns,
-        }
+        getMemoOptions(table.options, 'debugColumns', key)
       )
     }
 
@@ -300,3 +292,16 @@ export const Visibility: TableFeature = {
     }
   },
 }
+
+export function _getVisibleLeafColumns<TData extends RowData>(
+  table: Table<TData>,
+  position?: ColumnPinningPosition | 'center'
+) {
+  return !position
+    ? table.getVisibleLeafColumns()
+    : position === 'center'
+      ? table.getCenterVisibleLeafColumns()
+      : position === 'left'
+        ? table.getLeftVisibleLeafColumns()
+        : table.getRightVisibleLeafColumns()
+}

package/src/types.ts

@@ -8,6 +8,7 @@ import {
   VisibilityRow,
 } from './features/Visibility'
 import {
+  ColumnOrderColumn,
   ColumnOrderInstance,
   ColumnOrderOptions,
   ColumnOrderTableState,
@@ -304,7 +305,8 @@ export interface Column<TData extends RowData, TValue = unknown>
     FiltersColumn<TData>,
     SortingColumn<TData>,
     GroupingColumn<TData>,
-    ColumnSizingColumn {}
+    ColumnSizingColumn,
+    ColumnOrderColumn {}
 
 export interface Cell<TData extends RowData, TValue>
   extends CoreCell<TData, TValue>,

package/src/utils/getCoreRowModel.ts

@@ -1,6 +1,6 @@
 import { createRow } from '../core/row'
 import { Table, Row, RowModel, RowData } from '../types'
-import { memo } from '../utils'
+import { getMemoOptions, memo } from '../utils'
 
 export function getCoreRowModel<TData extends RowData>(): (
   table: Table<TData>
@@ -75,12 +75,8 @@ export function getCoreRowModel<TData extends RowData>(): (
 
         return rowModel
       },
-      {
-        key: process.env.NODE_ENV === 'development' && 'getRowModel',
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-        onChange: () => {
-          table._autoResetPageIndex()
-        },
-      }
+      getMemoOptions(table.options, 'debugTable', 'getRowModel', () =>
+        table._autoResetPageIndex()
+      )
     )
 }

package/src/utils/getExpandedRowModel.ts

@@ -1,5 +1,5 @@
 import { Table, Row, RowModel, RowData } from '../types'
-import { memo } from '../utils'
+import { getMemoOptions, memo } from '../utils'
 
 export function getExpandedRowModel<TData extends RowData>(): (
   table: Table<TData>
@@ -26,10 +26,7 @@ export function getExpandedRowModel<TData extends RowData>(): (
 
         return expandRows(rowModel)
       },
-      {
-        key: process.env.NODE_ENV === 'development' && 'getExpandedRowModel',
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-      }
+      getMemoOptions(table.options, 'debugTable', 'getExpandedRowModel')
     )
 }
 

package/src/utils/getFacetedMinMaxValues.ts

@@ -1,5 +1,5 @@
 import { Table, RowData } from '../types'
-import { memo } from '../utils'
+import { getMemoOptions, memo } from '../utils'
 
 export function getFacetedMinMaxValues<TData extends RowData>(): (
   table: Table<TData>,
@@ -37,12 +37,6 @@ export function getFacetedMinMaxValues<TData extends RowData>(): (
 
         return facetedMinMaxValues
       },
-      {
-        key:
-          process.env.NODE_ENV === 'development' &&
-          'getFacetedMinMaxValues_' + columnId,
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-        onChange: () => {},
-      }
+      getMemoOptions(table.options, 'debugTable', 'getFacetedMinMaxValues')
     )
 }

package/src/utils/getFacetedRowModel.ts

@@ -1,5 +1,5 @@
 import { Table, RowModel, Row, RowData } from '../types'
-import { memo } from '../utils'
+import { getMemoOptions, memo } from '../utils'
 import { filterRows } from './filterRowsUtils'
 
 export function getFacetedRowModel<TData extends RowData>(): (
@@ -39,12 +39,6 @@ export function getFacetedRowModel<TData extends RowData>(): (
 
         return filterRows(preRowModel.rows, filterRowsImpl, table)
       },
-      {
-        key:
-          process.env.NODE_ENV === 'development' &&
-          'getFacetedRowModel_' + columnId,
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-        onChange: () => {},
-      }
+      getMemoOptions(table.options, 'debugTable', 'getFacetedRowModel')
     )
 }

package/src/utils/getFacetedUniqueValues.ts

@@ -1,5 +1,5 @@
 import { Table, RowData } from '../types'
-import { memo } from '../utils'
+import { getMemoOptions, memo } from '../utils'
 
 export function getFacetedUniqueValues<TData extends RowData>(): (
   table: Table<TData>,
@@ -33,12 +33,10 @@ export function getFacetedUniqueValues<TData extends RowData>(): (
 
         return facetedUniqueValues
       },
-      {
-        key:
-          process.env.NODE_ENV === 'development' &&
-          'getFacetedUniqueValues_' + columnId,
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-        onChange: () => {},
-      }
+      getMemoOptions(
+        table.options,
+        'debugTable',
+        `getFacetedUniqueValues_${columnId}`
+      )
     )
 }

package/src/utils/getFilteredRowModel.ts

@@ -1,6 +1,6 @@
 import { ResolvedColumnFilter } from '../features/Filters'
 import { Table, RowModel, Row, RowData } from '../types'
-import { memo } from '../utils'
+import { getMemoOptions, memo } from '../utils'
 import { filterRows } from './filterRowsUtils'
 
 export function getFilteredRowModel<TData extends RowData>(): (
@@ -144,12 +144,8 @@ export function getFilteredRowModel<TData extends RowData>(): (
         // Filter final rows using all of the active filters
         return filterRows(rowModel.rows, filterRowsImpl, table)
       },
-      {
-        key: process.env.NODE_ENV === 'development' && 'getFilteredRowModel',
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-        onChange: () => {
-          table._autoResetPageIndex()
-        },
-      }
+      getMemoOptions(table.options, 'debugTable', 'getFilteredRowModel', () =>
+        table._autoResetPageIndex()
+      )
     )
 }

package/src/utils/getGroupedRowModel.ts

@@ -1,6 +1,6 @@
 import { createRow } from '../core/row'
 import { Table, Row, RowModel, RowData } from '../types'
-import { flattenBy, memo } from '../utils'
+import { flattenBy, getMemoOptions, memo } from '../utils'
 
 export function getGroupedRowModel<TData extends RowData>(): (
   table: Table<TData>
@@ -156,16 +156,12 @@ export function getGroupedRowModel<TData extends RowData>(): (
           rowsById: groupedRowsById,
         }
       },
-      {
-        key: process.env.NODE_ENV === 'development' && 'getGroupedRowModel',
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-        onChange: () => {
-          table._queue(() => {
-            table._autoResetExpanded()
-            table._autoResetPageIndex()
-          })
-        },
-      }
+      getMemoOptions(table.options, 'debugTable', 'getGroupedRowModel', () => {
+        table._queue(() => {
+          table._autoResetExpanded()
+          table._autoResetPageIndex()
+        })
+      })
     )
 }
 

package/src/utils/getPaginationRowModel.ts

@@ -1,5 +1,5 @@
 import { Table, RowModel, Row, RowData } from '../types'
-import { memo } from '../utils'
+import { getMemoOptions, memo } from '../utils'
 import { expandRows } from './getExpandedRowModel'
 
 export function getPaginationRowModel<TData extends RowData>(opts?: {
@@ -55,9 +55,6 @@ export function getPaginationRowModel<TData extends RowData>(opts?: {
 
         return paginatedRowModel
       },
-      {
-        key: process.env.NODE_ENV === 'development' && 'getPaginationRowModel',
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-      }
+      getMemoOptions(table.options, 'debugTable', 'getPaginationRowModel')
     )
 }

package/src/utils/getSortedRowModel.ts

@@ -1,6 +1,6 @@
 import { Table, Row, RowModel, RowData } from '../types'
 import { SortingFn } from '../features/Sorting'
-import { memo } from '../utils'
+import { getMemoOptions, memo } from '../utils'
 
 export function getSortedRowModel<TData extends RowData>(): (
   table: Table<TData>
@@ -111,12 +111,8 @@ export function getSortedRowModel<TData extends RowData>(): (
           rowsById: rowModel.rowsById,
         }
       },
-      {
-        key: process.env.NODE_ENV === 'development' && 'getSortedRowModel',
-        debug: () => table.options.debugAll ?? table.options.debugTable,
-        onChange: () => {
-          table._autoResetPageIndex()
-        },
-      }
+      getMemoOptions(table.options, 'debugTable', 'getSortedRowModel', () =>
+        table._autoResetPageIndex()
+      )
     )
 }

package/src/utils.ts

@@ -1,4 +1,4 @@
-import { TableState, Updater } from './types'
+import { TableOptionsResolved, TableState, Updater } from './types'
 
 export type PartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
 export type RequiredKeys<T, K extends keyof T> = Omit<T, K> &
@@ -134,23 +134,23 @@ export function flattenBy<TNode>(
   return flat
 }
 
-export function memo<TDeps extends readonly any[], TResult>(
-  getDeps: () => [...TDeps],
+export function memo<TDeps extends readonly any[], TDepArgs, TResult>(
+  getDeps: (depArgs?: TDepArgs) => [...TDeps],
   fn: (...args: NoInfer<[...TDeps]>) => TResult,
   opts: {
     key: any
     debug?: () => any
     onChange?: (result: TResult) => void
   }
-): () => TResult {
+): (depArgs?: TDepArgs) => TResult {
   let deps: any[] = []
   let result: TResult | undefined
 
-  return () => {
+  return depArgs => {
     let depTime: number
     if (opts.key && opts.debug) depTime = Date.now()
 
-    const newDeps = getDeps()
+    const newDeps = getDeps(depArgs)
 
     const depsChanged =
       newDeps.length !== deps.length ||
@@ -199,3 +199,22 @@ export function memo<TDeps extends readonly any[], TResult>(
     return result!
   }
 }
+
+export function getMemoOptions(
+  tableOptions: Partial<TableOptionsResolved<any>>,
+  debugLevel:
+    | 'debugAll'
+    | 'debugCells'
+    | 'debugTable'
+    | 'debugColumns'
+    | 'debugRows'
+    | 'debugHeaders',
+  key: string,
+  onChange?: (result: any) => void
+) {
+  return {
+    debug: () => tableOptions?.debugAll ?? tableOptions[debugLevel],
+    key: process.env.NODE_ENV === 'development' && key,
+    onChange,
+  }
+}