@tanstack/table-core 8.3.6 → 8.5.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/table-core",
   "author": "Tanner Linsley",
-  "version": "8.3.6",
+  "version": "8.5.1",
   "description": "Headless UI for building powerful tables & datagrids for TS/JS.",
   "license": "MIT",
   "homepage": "https://github.com/tanstack/table#readme",

package/src/columnHelper.ts

@@ -1,5 +1,5 @@
 import { AccessorFn, ColumnDef, RowData } from './types'
-import { DeepKeys, DeepValue } from './utils'
+import { DeepKeys, DeepValue, RequiredKeys } from './utils'
 
 // type Person = {
 //   firstName: string
@@ -53,6 +53,18 @@ export type ColumnHelper<TData extends RowData> = {
     accessor: TAccessor,
     column: Omit<ColumnDef<TData, TValue>, 'accessorKey'>
   ) => ColumnDef<TData, TValue>
+  display: (
+    column: RequiredKeys<
+      Omit<ColumnDef<TData, unknown>, 'accessorKey' | 'accessorFn'>,
+      'id'
+    >
+  ) => ColumnDef<TData, unknown>
+  group: (
+    column: RequiredKeys<
+      Omit<ColumnDef<TData, unknown>, 'accessorKey' | 'accessorFn'>,
+      'id' | 'columns'
+    >
+  ) => ColumnDef<TData, unknown>
 }
 
 export function createColumnHelper<
@@ -70,5 +82,7 @@ export function createColumnHelper<
             accessorKey: accessor,
           }
     },
+    display: column => column as ColumnDef<TData, unknown>,
+    group: column => column as ColumnDef<TData, unknown>,
   }
 }

package/src/features/Filters.ts

@@ -9,6 +9,7 @@ import {
   Updater,
   RowData,
   FilterMeta,
+  FilterFns,
 } from '../types'
 import { functionalUpdate, isFunction, makeStateUpdater } from '../utils'
 
@@ -60,6 +61,7 @@ export type CustomFilterFns<TData extends RowData> = Record<
 export type FilterFnOption<TData extends RowData> =
   | 'auto'
   | BuiltInFilterFn
+  | keyof FilterFns
   | FilterFn<TData>
 
 export type FiltersColumnDef<TData extends RowData> = {
@@ -119,7 +121,13 @@ export type FiltersOptions<TData extends RowData> = {
     table: Table<TData>,
     columnId: string
   ) => () => undefined | [number, number]
-}
+} & (keyof FilterFns extends never
+  ? {
+      filterFns?: Record<string, FilterFn<any>>
+    }
+  : {
+      filterFns: Record<keyof FilterFns, FilterFn<any>>
+    })
 
 export type FiltersInstance<TData extends RowData> = {
   setColumnFilters: (updater: Updater<ColumnFiltersState>) => void
@@ -219,9 +227,8 @@ export const Filters: TableFeature = {
           ? column.columnDef.filterFn
           : column.columnDef.filterFn === 'auto'
           ? column.getAutoFilterFn()
-          : (filterFns[
-              column.columnDef.filterFn as BuiltInFilterFn
-            ] as FilterFn<TData>)
+          : table.options.filterFns?.[column.columnDef.filterFn as string] ??
+            filterFns[column.columnDef.filterFn as BuiltInFilterFn]
       },
       getCanFilter: () => {
         return (
@@ -352,7 +359,8 @@ export const Filters: TableFeature = {
           ? globalFilterFn
           : globalFilterFn === 'auto'
           ? table.getGlobalAutoFilterFn()
-          : (filterFns[globalFilterFn as BuiltInFilterFn] as FilterFn<TData>)
+          : table.options.filterFns?.[globalFilterFn as string] ??
+            filterFns[globalFilterFn as BuiltInFilterFn]
       },
 
       setColumnFilters: (updater: Updater<ColumnFiltersState>) => {
@@ -394,10 +402,11 @@ export const Filters: TableFeature = {
       },
 
       getPreFilteredRowModel: () => table.getCoreRowModel(),
-      _getFilteredRowModel:
-        table.options.getFilteredRowModel &&
-        table.options.getFilteredRowModel(table),
       getFilteredRowModel: () => {
+        if (!table._getFilteredRowModel && table.options.getFilteredRowModel) {
+          table._getFilteredRowModel = table.options.getFilteredRowModel(table)
+        }
+
         if (table.options.manualFiltering || !table._getFilteredRowModel) {
           return table.getPreFilteredRowModel()
         }

package/src/features/Grouping.ts

@@ -10,8 +10,9 @@ import {
   Updater,
   ColumnDefTemplate,
   RowData,
+  AggregationFns,
 } from '../types'
-import { isFunction, makeStateUpdater, Overwrite } from '../utils'
+import { isFunction, makeStateUpdater } from '../utils'
 
 export type GroupingState = string[]
 
@@ -29,6 +30,7 @@ export type CustomAggregationFns = Record<string, AggregationFn<any>>
 
 export type AggregationFnOption<TData extends RowData> =
   | 'auto'
+  | keyof AggregationFns
   | BuiltInAggregationFn
   | AggregationFn<TData>
 
@@ -75,7 +77,13 @@ export type GroupingOptions = {
   enableGrouping?: boolean
   getGroupedRowModel?: (table: Table<any>) => () => RowModel<any>
   groupedColumnMode?: false | 'reorder' | 'remove'
-}
+} & (keyof AggregationFns extends never
+  ? {
+      aggregationFns?: Record<string, AggregationFn<any>>
+    }
+  : {
+      aggregationFns: Record<keyof AggregationFns, AggregationFn<any>>
+    })
 
 export type GroupingColumnMode = false | 'reorder' | 'remove'
 
@@ -178,9 +186,12 @@ export const Grouping: TableFeature = {
           ? column.columnDef.aggregationFn
           : column.columnDef.aggregationFn === 'auto'
           ? column.getAutoAggregationFn()
-          : (aggregationFns[
+          : table.options.aggregationFns?.[
+              column.columnDef.aggregationFn as string
+            ] ??
+            aggregationFns[
               column.columnDef.aggregationFn as BuiltInAggregationFn
-            ] as AggregationFn<TData>)
+            ]
       },
     }
   },

package/src/features/Sorting.ts

@@ -6,9 +6,17 @@ import {
   sortingFns,
 } from '../sortingFns'
 
-import { Column, OnChangeFn, Table, Row, Updater, RowData } from '../types'
+import {
+  Column,
+  OnChangeFn,
+  Table,
+  Row,
+  Updater,
+  RowData,
+  SortingFns,
+} from '../types'
 
-import { isFunction, makeStateUpdater, Overwrite } from '../utils'
+import { isFunction, makeStateUpdater } from '../utils'
 
 export type SortDirection = 'asc' | 'desc'
 
@@ -34,6 +42,7 @@ export type CustomSortingFns<TData extends RowData> = Record<
 
 export type SortingFnOption<TData extends RowData> =
   | 'auto'
+  | keyof SortingFns
   | BuiltInSortingFn
   | SortingFn<TData>
 
@@ -72,7 +81,13 @@ export type SortingOptions<TData extends RowData> = {
   getSortedRowModel?: (table: Table<any>) => () => RowModel<any>
   maxMultiSortColCount?: number
   isMultiSortEvent?: (e: unknown) => boolean
-}
+} & (keyof SortingFns extends never
+  ? {
+      sortingFns?: Record<string, SortingFn<any>>
+    }
+  : {
+      sortingFns: Record<keyof SortingFns, SortingFn<any>>
+    })
 
 export type SortingInstance<TData extends RowData> = {
   setSorting: (updater: Updater<SortingState>) => void
@@ -161,9 +176,8 @@ export const Sorting: TableFeature = {
           ? column.columnDef.sortingFn
           : column.columnDef.sortingFn === 'auto'
           ? column.getAutoSortingFn()
-          : (sortingFns[
-              column.columnDef.sortingFn as BuiltInSortingFn
-            ] as SortingFn<TData>)
+          : table.options.sortingFns?.[column.columnDef.sortingFn as string] ??
+            sortingFns[column.columnDef.sortingFn as BuiltInSortingFn]
       },
       toggleSorting: (desc, multi) => {
         // if (column.columns.length) {

package/src/types.ts

@@ -23,6 +23,7 @@ import {
 } from './features/Pinning'
 import { CoreHeader, CoreHeaderGroup, HeadersInstance } from './core/headers'
 import {
+  FilterFn,
   FiltersColumn,
   FiltersColumnDef,
   FiltersInstance,
@@ -80,6 +81,9 @@ import { CoreCell } from './core/cell'
 export interface TableMeta<TData extends RowData> {}
 export interface ColumnMeta<TData extends RowData, TValue> {}
 export interface FilterMeta {}
+export interface FilterFns {}
+export interface SortingFns {}
+export interface AggregationFns {}
 
 export type Updater<T> = T | ((old: T) => T)
 export type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void