@tanstack/table-core 8.0.0-alpha.47 → 8.0.0-alpha.51

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/table-core",
   "author": "Tanner Linsley",
-  "version": "8.0.0-alpha.47",
+  "version": "8.0.0-alpha.51",
   "description": "Hooks for building lightweight, fast and extendable datagrids for React",
   "license": "MIT",
   "homepage": "https://github.com/tanstack/react-table#readme",

package/src/createTable.ts

@@ -24,13 +24,11 @@ export type CreateTableOptions<
 export type Table<TGenerics extends AnyGenerics> = {
   generics: TGenerics
   options: Partial<Options<TGenerics>>
-  setRowType: <TRow extends object>() => Table<
-    Overwrite<TGenerics, { Row: TRow }>
-  >
-  setTableMetaType: <TTableMeta extends object>() => Table<
+  setRowType: <TRow>() => Table<Overwrite<TGenerics, { Row: TRow }>>
+  setTableMetaType: <TTableMeta>() => Table<
     Overwrite<TGenerics, { TableMeta: TTableMeta }>
   >
-  setColumnMetaType: <TColumnMeta extends object>() => Table<
+  setColumnMetaType: <TColumnMeta>() => Table<
     Overwrite<TGenerics, { ColumnMeta: TColumnMeta }>
   >
   setOptions: <

package/src/features/ColumnSizing.ts

@@ -151,15 +151,9 @@ export const ColumnSizing = {
         )
       },
       setColumnSizing: updater =>
-        instance.options.onColumnSizingChange?.(
-          updater,
-          functionalUpdate(updater, instance.getState().columnSizing)
-        ),
+        instance.options.onColumnSizingChange?.(updater),
       setColumnSizingInfo: updater =>
-        instance.options.onColumnSizingInfoChange?.(
-          updater,
-          functionalUpdate(updater, instance.getState().columnSizingInfo)
-        ),
+        instance.options.onColumnSizingInfoChange?.(updater),
       resetColumnSizing: () => {
         instance.setColumnSizing(instance.initialState.columnSizing ?? {})
       },

package/src/features/Expanding.ts

@@ -46,7 +46,7 @@ export type ToggleExpandedProps = {
 }
 
 export type ExpandedInstance<TGenerics extends AnyGenerics> = {
-  _notifyExpandedReset: () => void
+  queueResetExpanded: () => void
   setExpanded: (updater: Updater<ExpandedState>) => void
   toggleRowExpanded: (rowId: string, expanded?: boolean) => void
   toggleAllRowsExpanded: (expanded?: boolean) => void
@@ -95,8 +95,8 @@ export const Expanding = {
     let registered = false
 
     return {
-      _notifyExpandedReset: () => {
-        instance._notifyPageIndexReset()
+      queueResetExpanded: () => {
+        instance.queueResetPageIndex()
 
         if (!registered) {
           registered = true
@@ -114,11 +114,7 @@ export const Expanding = {
           instance.resetExpanded()
         }
       },
-      setExpanded: updater =>
-        instance.options.onExpandedChange?.(
-          updater,
-          functionalUpdate(updater, instance.getState().expanded)
-        ),
+      setExpanded: updater => instance.options.onExpandedChange?.(updater),
       toggleRowExpanded: (rowId, expanded) => {
         if (!rowId) return
 

package/src/features/Filters.ts

@@ -17,12 +17,23 @@ import {
   Overwrite,
 } from '../utils'
 
+export type FiltersTableState = {
+  columnFilters: ColumnFiltersState
+  globalFilter: any
+  columnFiltersProgress: number
+  globalFilterProgress: number
+}
+
+export type ColumnFiltersState = ColumnFilter[]
+
 export type ColumnFilter = {
   id: string
   value: unknown
 }
 
-export type ColumnFiltersState = ColumnFilter[]
+/*
+A filter function is any function that takes an array of rows and returns an array of rows. Because filter functions can be used for both column and global filters, they are passed an array of columnIds to filter on. 
+*/
 
 export type FilterFn<TGenerics extends AnyGenerics> = {
   (rows: Row<TGenerics>[], columnIds: string[], filterValue: any): any
@@ -39,13 +50,6 @@ export type CustomFilterFns<TGenerics extends AnyGenerics> = Record<
   FilterFn<TGenerics>
 >
 
-export type FiltersTableState = {
-  columnFilters: ColumnFiltersState
-  globalFilter: any
-  columnFiltersProgress: number
-  globalFilterProgress: number
-}
-
 export type FilterFnOption<TGenerics extends AnyGenerics> =
   | 'auto'
   | BuiltInFilterFn
@@ -67,9 +71,9 @@ export type FiltersColumn<TGenerics extends AnyGenerics> = {
   getCanColumnFilter: () => boolean
   getCanGlobalFilter: () => boolean
   getColumnFilterIndex: () => number
-  getIsColumnFiltered: () => boolean
+  getColumnIsFiltered: () => boolean
   getColumnFilterValue: () => unknown
-  setColumnFilterValue: (value: any) => void
+  setColumnFilterValue: (updater: Updater<any>) => void
   getPreFilteredRows: () => Row<TGenerics>[] | undefined
   getPreFilteredUniqueValues: () => Map<any, number>
   getPreFilteredMinMaxValues: () => [any, any]
@@ -98,24 +102,20 @@ export type FiltersOptions<TGenerics extends AnyGenerics> = {
 }
 
 export type FiltersInstance<TGenerics extends AnyGenerics> = {
-  _notifyFiltersReset: () => void
+  queueResetFilters: () => void
   getColumnAutoFilterFn: (columnId: string) => FilterFn<TGenerics> | undefined
 
   getColumnFilterFn: (columnId: string) => FilterFn<TGenerics> | undefined
 
   setColumnFilters: (updater: Updater<ColumnFiltersState>) => void
-  setColumnFilterValue: (columnId: string, value: any) => void
+  setColumnFilterValue: (columnId: string, updater: Updater<any>) => void
   resetColumnFilters: () => void
   getColumnCanColumnFilter: (columnId: string) => boolean
-  getColumnCanGlobalFilterFn?: (column: Column<TGenerics>) => boolean
 
   getColumnIsFiltered: (columnId: string) => boolean
   getColumnFilterValue: (columnId: string) => unknown
   getColumnFilterIndex: (columnId: string) => number
 
-  // All
-  getPreFilteredRowModel: () => RowModel<TGenerics>
-
   // Column Filters
   getPreColumnFilteredRowModel: () => RowModel<TGenerics>
   getColumnFilteredRowModel: () => RowModel<TGenerics>
@@ -221,7 +221,7 @@ export const Filters = {
       getCanColumnFilter: () => instance.getColumnCanColumnFilter(column.id),
       getCanGlobalFilter: () => instance.getColumnCanGlobalFilter(column.id),
       getColumnFilterIndex: () => instance.getColumnFilterIndex(column.id),
-      getIsColumnFiltered: () => instance.getColumnIsFiltered(column.id),
+      getColumnIsFiltered: () => instance.getColumnIsFiltered(column.id),
       getColumnFilterValue: () => instance.getColumnFilterValue(column.id),
       setColumnFilterValue: val =>
         instance.setColumnFilterValue(column.id, val),
@@ -237,8 +237,8 @@ export const Filters = {
     let registered = false
 
     return {
-      _notifyFiltersReset: () => {
-        instance._notifySortingReset()
+      queueResetFilters: () => {
+        instance.queueResetSorting()
 
         if (!registered) {
           registered = true
@@ -344,17 +344,11 @@ export const Filters = {
           })
         }
 
-        instance.options.onColumnFiltersChange?.(
-          updateFn,
-          updateFn(instance.getState().columnFilters)
-        )
+        instance.options.onColumnFiltersChange?.(updateFn)
       },
 
       setGlobalFilter: updater => {
-        instance.options.onGlobalFilterChange?.(
-          updater,
-          functionalUpdate(updater, instance.getState().globalFilter)
-        )
+        instance.options.onGlobalFilterChange?.(updater)
       },
 
       resetGlobalFilter: () => {
@@ -373,8 +367,8 @@ export const Filters = {
           column.enableColumnFilter ??
           instance.options.enableFilters ??
           instance.options.enableColumnFilters ??
-          column.defaultCanFilter ??
           column.defaultCanColumnFilter ??
+          column.defaultCanFilter ??
           !!column.accessorFn
         )
       },
@@ -391,8 +385,8 @@ export const Filters = {
             instance.options.enableGlobalFilter ??
             column.enableAllFilters ??
             column.enableGlobalFilter ??
-            column.defaultCanFilter ??
             column.defaultCanGlobalFilter ??
+            column.defaultCanFilter ??
             !!column.accessorFn) &&
             instance.options.getColumnCanGlobalFilterFn?.(column)) ??
           true
@@ -468,7 +462,6 @@ export const Filters = {
         instance.setColumnFilters(instance.initialState?.columnFilters ?? [])
       },
 
-      getPreFilteredRowModel: () => instance.getCoreRowModel(),
       getPreColumnFilteredRowModel: () => instance.getCoreRowModel(),
       getColumnFilteredRowModel: () => {
         if (

package/src/features/Grouping.ts

@@ -114,7 +114,7 @@ export type ToggleGroupingProps = {
 }
 
 export type GroupingInstance<TGenerics extends AnyGenerics> = {
-  _notifyGroupingReset: () => void
+  queueResetGrouping: () => void
   getColumnAutoAggregationFn: (
     columnId: string
   ) => AggregationFn<TGenerics> | undefined
@@ -185,8 +185,8 @@ export const Grouping = {
     let registered = false
 
     return {
-      _notifyGroupingReset: () => {
-        instance._notifyExpandedReset()
+      queueResetGrouping: () => {
+        instance.queueResetExpanded()
 
         if (!registered) {
           registered = true
@@ -239,11 +239,7 @@ export const Grouping = {
             ] as AggregationFn<TGenerics>)
       },
 
-      setGrouping: updater =>
-        instance.options.onGroupingChange?.(
-          updater,
-          functionalUpdate(updater, instance.getState().grouping)
-        ),
+      setGrouping: updater => instance.options.onGroupingChange?.(updater),
 
       toggleColumnGrouping: columnId => {
         instance.setGrouping(old => {

package/src/features/Ordering.ts

@@ -53,10 +53,7 @@ export const Ordering = {
   ): ColumnOrderInstance<TGenerics> => {
     return {
       setColumnOrder: updater =>
-        instance.options.onColumnOrderChange?.(
-          updater,
-          functionalUpdate(updater, instance.getState().columnOrder)
-        ),
+        instance.options.onColumnOrderChange?.(updater),
       resetColumnOrder: () => {
         instance.setColumnOrder(instance.initialState.columnOrder ?? [])
       },

package/src/features/Pagination.ts

@@ -32,7 +32,7 @@ export type PaginationDefaultOptions = {
 }
 
 export type PaginationInstance<TGenerics extends AnyGenerics> = {
-  _notifyPageIndexReset: () => void
+  queueResetPageIndex: () => void
   setPagination: (updater: Updater<PaginationState>) => void
   resetPagination: () => void
   setPageIndex: (updater: Updater<number>) => void
@@ -78,7 +78,7 @@ export const Pagination = {
   ): PaginationInstance<TGenerics> => {
     let registered = false
     return {
-      _notifyPageIndexReset: () => {
+      queueResetPageIndex: () => {
         if (!registered) {
           registered = true
           return
@@ -102,10 +102,7 @@ export const Pagination = {
           return newState
         }
 
-        return instance.options.onPaginationChange?.(
-          safeUpdater,
-          functionalUpdate(safeUpdater, instance.getState().pagination)
-        )
+        return instance.options.onPaginationChange?.(safeUpdater)
       },
       resetPagination: () => {
         instance.setPagination(

package/src/features/Pinning.ts

@@ -87,10 +87,7 @@ export const Pinning = {
   ): ColumnPinningInstance<TGenerics> => {
     return {
       setColumnPinning: updater =>
-        instance.options.onColumnPinningChange?.(
-          updater,
-          functionalUpdate(updater, instance.getState().columnPinning)
-        ),
+        instance.options.onColumnPinningChange?.(updater),
 
       resetColumnPinning: () =>
         instance.setColumnPinning(instance.initialState?.columnPinning ?? {}),

package/src/features/RowSelection.ts

@@ -61,7 +61,7 @@ export type RowSelectionRow = {
 }
 
 export type RowSelectionInstance<TGenerics extends AnyGenerics> = {
-  _notifyRowSelectionReset: () => void
+  queueResetRowSelection: () => void
   getToggleRowSelectedProps: <TGetter extends Getter<ToggleRowSelectedProps>>(
     rowId: string,
     userProps?: TGetter
@@ -129,7 +129,7 @@ export const RowSelection = {
     // const pageRows = instance.getPageRows()
 
     return {
-      _notifyRowSelectionReset: () => {
+      queueResetRowSelection: () => {
         if (!registered) {
           registered = true
           return
@@ -147,10 +147,7 @@ export const RowSelection = {
         }
       },
       setRowSelection: updater =>
-        instance.options.onRowSelectionChange?.(
-          updater,
-          functionalUpdate(updater, instance.getState().rowSelection)
-        ),
+        instance.options.onRowSelectionChange?.(updater),
       resetRowSelection: () =>
         instance.setRowSelection(instance.initialState.rowSelection ?? {}),
       toggleAllRowsSelected: value => {
@@ -288,7 +285,7 @@ export const RowSelection = {
           key: 'getSelectedRowModel',
           debug: () => instance.options.debugAll ?? instance.options.debugTable,
           onChange: () => {
-            instance.queue(() => instance._notifyExpandedReset())
+            instance.queue(() => instance.queueResetExpanded())
           },
         }
       ),
@@ -312,7 +309,7 @@ export const RowSelection = {
         {
           key: 'getFilteredSelectedRowModel',
           debug: () => instance.options.debugAll ?? instance.options.debugTable,
-          onChange: () => instance.queue(() => instance._notifyExpandedReset()),
+          onChange: () => instance.queue(() => instance.queueResetExpanded()),
         }
       ),
 
@@ -332,7 +329,7 @@ export const RowSelection = {
         {
           key: 'getGroupedSelectedRowModel',
           debug: () => instance.options.debugAll ?? instance.options.debugTable,
-          onChange: () => instance.queue(() => instance._notifyExpandedReset()),
+          onChange: () => instance.queue(() => instance.queueResetExpanded()),
         }
       ),
 

package/src/features/Sorting.ts

@@ -100,7 +100,7 @@ export type ToggleSortingProps = {
 }
 
 export type SortingInstance<TGenerics extends AnyGenerics> = {
-  _notifySortingReset: () => void
+  queueResetSorting: () => void
   getColumnAutoSortingFn: (columnId: string) => SortingFn<TGenerics> | undefined
   getColumnAutoSortDir: (columnId: string) => SortDirection
 
@@ -179,8 +179,8 @@ export const Sorting = {
     let registered = false
 
     return {
-      _notifySortingReset: () => {
-        instance._notifyGroupingReset()
+      queueResetSorting: () => {
+        instance.queueResetGrouping()
 
         if (!registered) {
           registered = true
@@ -258,11 +258,7 @@ export const Sorting = {
             ] as SortingFn<TGenerics>)
       },
 
-      setSorting: updater =>
-        instance.options.onSortingChange?.(
-          updater,
-          functionalUpdate(updater, instance.getState().sorting)
-        ),
+      setSorting: updater => instance.options.onSortingChange?.(updater),
 
       toggleColumnSorting: (columnId, desc, multi) => {
         const column = instance.getColumn(columnId)

package/src/features/Visibility.ts

@@ -157,10 +157,7 @@ export const Visibility = {
       ),
 
       setColumnVisibility: updater =>
-        instance.options.onColumnVisibilityChange?.(
-          updater,
-          functionalUpdate(updater, instance.getState().columnVisibility)
-        ),
+        instance.options.onColumnVisibilityChange?.(updater),
 
       toggleColumnVisibility: (columnId, value) => {
         if (!columnId) return

package/src/types.ts

@@ -138,7 +138,7 @@ export type Options<TGenerics extends AnyGenerics> = CoreOptions<TGenerics> &
   RowSelectionOptions<TGenerics>
 
 export type Updater<T> = T | ((old: T) => T)
-export type OnChangeFn<T> = (updaterOrValue: Updater<T>, value: T) => void
+export type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void
 
 export type TableState = CoreTableState &
   VisibilityTableState &

package/src/utils/getColumnFilteredRowModelAsync.ts

@@ -114,7 +114,7 @@ export function getColumnFilteredRowModelAsync<
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance._notifySortingReset()
+            instance.queueResetSorting()
           })
         },
       }

package/src/utils/getColumnFilteredRowModelSync.ts

@@ -94,7 +94,7 @@ export function getColumnFilteredRowModelSync<
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance._notifySortingReset()
+            instance.queueResetSorting()
           })
         },
       }

package/src/utils/getCoreRowModelAsync.ts

@@ -96,8 +96,8 @@ export function getCoreRowModelAsync<TGenerics extends AnyGenerics>(opts?: {
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance._notifyFiltersReset()
-            instance._notifyRowSelectionReset()
+            instance.queueResetFilters()
+            instance.queueResetRowSelection()
           })
         },
       }

package/src/utils/getCoreRowModelSync.ts

@@ -98,8 +98,8 @@ export function getCoreRowModelSync<TGenerics extends AnyGenerics>(): (
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance._notifyFiltersReset()
-            instance._notifyRowSelectionReset()
+            instance.queueResetFilters()
+            instance.queueResetRowSelection()
           })
         },
       }

package/src/utils/getGlobalFilteredRowModelAsync.ts

@@ -92,7 +92,7 @@ export function getGlobalFilteredRowModelAsync<
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance._notifySortingReset()
+            instance.queueResetSorting()
           })
         },
       }

package/src/utils/getGlobalFilteredRowModelSync.ts

@@ -71,7 +71,7 @@ export function getGlobalFilteredRowModelSync<
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance._notifySortingReset()
+            instance.queueResetSorting()
           })
         },
       }

package/src/utils/getGroupedRowModel.ts

@@ -165,7 +165,7 @@ export function getGroupedRowModelSync<TGenerics extends AnyGenerics>(): (
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance._notifyExpandedReset()
+            instance.queueResetExpanded()
           })
         },
       }

package/src/utils/getSortedRowModelAsync.ts

@@ -84,7 +84,7 @@ export function getSortedRowModelSync<TGenerics extends AnyGenerics>(opts?: {
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance._notifyGroupingReset()
+            instance.queueResetGrouping()
           })
         },
       }

package/src/utils/getSortedRowModelSync.ts

@@ -110,7 +110,7 @@ export function getSortedRowModelSync<TGenerics extends AnyGenerics>(): (
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance._notifyGroupingReset()
+            instance.queueResetGrouping()
           })
         },
       }