@tanstack/table-core 8.13.1 → 8.14.0

package/src/features/{Filters.ts → ColumnFiltering.ts}

@@ -1,21 +1,20 @@
 import { RowModel } from '..'
-import { TableFeature } from '../core/table'
 import { BuiltInFilterFn, filterFns } from '../filterFns'
 import {
   Column,
+  FilterFns,
+  FilterMeta,
   OnChangeFn,
-  Table,
   Row,
-  Updater,
   RowData,
-  FilterMeta,
-  FilterFns,
+  Table,
+  TableFeature,
+  Updater,
 } from '../types'
 import { functionalUpdate, isFunction, makeStateUpdater } from '../utils'
 
-export interface FiltersTableState {
+export interface ColumnFiltersTableState {
   columnFilters: ColumnFiltersState
-  globalFilter: any
 }
 
 export type ColumnFiltersState = ColumnFilter[]
@@ -26,9 +25,9 @@ export interface ColumnFilter {
 }
 
 export interface ResolvedColumnFilter<TData extends RowData> {
+  filterFn: FilterFn<TData>
   id: string
   resolvedValue: unknown
-  filterFn: FilterFn<TData>
 }
 
 export interface FilterFn<TData extends RowData> {
@@ -38,9 +37,8 @@ export interface FilterFn<TData extends RowData> {
     filterValue: any,
     addMeta: (meta: FilterMeta) => void
   ): boolean
-
-  resolveFilterValue?: TransformFilterValueFn<TData>
   autoRemove?: ColumnFilterAutoRemoveTestFn<TData>
+  resolveFilterValue?: TransformFilterValueFn<TData>
 }
 
 export type TransformFilterValueFn<TData extends RowData> = (
@@ -64,13 +62,7 @@ export type FilterFnOption<TData extends RowData> =
   | keyof FilterFns
   | FilterFn<TData>
 
-export interface FiltersColumnDef<TData extends RowData> {
-  /**
-   * The filter function to use with this column. Can be the name of a built-in filter function or a custom filter function.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#filterfn)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  filterFn?: FilterFnOption<TData>
+export interface ColumnFiltersColumnDef<TData extends RowData> {
   /**
    * Enables/disables the **column** filter for this column.
    * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enablecolumnfilter)
@@ -78,17 +70,14 @@ export interface FiltersColumnDef<TData extends RowData> {
    */
   enableColumnFilter?: boolean
   /**
-   * Enables/disables the **global** filter for this column.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enableglobalfilter)
+   * The filter function to use with this column. Can be the name of a built-in filter function or a custom filter function.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#filterfn)
    * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
    */
-  enableGlobalFilter?: boolean
+  filterFn?: FilterFnOption<TData>
 }
 
-export interface FiltersColumn<TData extends RowData> {
-  _getFacetedMinMaxValues?: () => undefined | [number, number]
-  _getFacetedRowModel?: () => RowModel<TData>
-  _getFacetedUniqueValues?: () => Map<any, number>
+export interface ColumnFiltersColumn<TData extends RowData> {
   /**
    * Returns an automatically calculated filter function for the column based off of the columns first known value.
    * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getautofilterfn)
@@ -101,33 +90,6 @@ export interface FiltersColumn<TData extends RowData> {
    * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
    */
   getCanFilter: () => boolean
-  /**
-   * Returns whether or not the column can be **globally** filtered. Set to `false` to disable a column from being scanned during global filtering.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getcanglobalfilter)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  getCanGlobalFilter: () => boolean
-  /**
-   * A function that **computes and returns** a min/max tuple derived from `column.getFacetedRowModel`. Useful for displaying faceted result values.
-   * > ⚠️ Requires that you pass a valid `getFacetedMinMaxValues` function to `options.getFacetedMinMaxValues`. A default implementation is provided via the exported `getFacetedMinMaxValues` function.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfacetedminmaxvalues)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  getFacetedMinMaxValues: () => undefined | [number, number]
-  /**
-   * Returns the row model with all other column filters applied, excluding its own filter. Useful for displaying faceted result counts.
-   * > ⚠️ Requires that you pass a valid `getFacetedRowModel` function to `options.facetedRowModel`. A default implementation is provided via the exported `getFacetedRowModel` function.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfacetedrowmodel)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  getFacetedRowModel: () => RowModel<TData>
-  /**
-   * A function that **computes and returns** a `Map` of unique values and their occurrences derived from `column.getFacetedRowModel`. Useful for displaying faceted result values.
-   * > ⚠️ Requires that you pass a valid `getFacetedUniqueValues` function to `options.getFacetedUniqueValues`. A default implementation is provided via the exported `getFacetedUniqueValues` function.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfaceteduniquevalues)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  getFacetedUniqueValues: () => Map<any, number>
   /**
    * Returns the filter function (either user-defined or automatic, depending on configuration) for the columnId specified.
    * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfilterfn)
@@ -160,7 +122,7 @@ export interface FiltersColumn<TData extends RowData> {
   setFilterValue: (updater: Updater<any>) => void
 }
 
-export interface FiltersRow<TData extends RowData> {
+export interface ColumnFiltersRow<TData extends RowData> {
   /**
    * The column filters map for the row. This object tracks whether a row is passing/failing specific filters by their column ID.
    * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#columnfilters)
@@ -175,7 +137,13 @@ export interface FiltersRow<TData extends RowData> {
   columnFiltersMeta: Record<string, FilterMeta>
 }
 
-interface FiltersOptionsBase<TData extends RowData> {
+interface ColumnFiltersOptionsBase<TData extends RowData> {
+  /**
+   * Enables/disables **column** filtering for all columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enablecolumnfilters)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  enableColumnFilters?: boolean
   /**
    * Enables/disables all filtering for the table.
    * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enablefilters)
@@ -210,65 +178,12 @@ interface FiltersOptionsBase<TData extends RowData> {
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
    */
   maxLeafRowFilterDepth?: number
-
-  // Column
-  /**
-   * Enables/disables **column** filtering for all columns.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enablecolumnfilters)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  enableColumnFilters?: boolean
   /**
    * If provided, this function will be called with an `updaterFn` when `state.columnFilters` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.
    * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#oncolumnfilterschange)
    * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
    */
   onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>
-
-  // Global
-  /**
-   * Enables/disables **global** filtering for all columns.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enableglobalfilter)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  enableGlobalFilter?: boolean
-  /**
-   * If provided, this function will be called with the column and should return `true` or `false` to indicate whether this column should be used for global filtering.
-   *
-   * This is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`).
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getcolumncanglobalfilter)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  getColumnCanGlobalFilter?: (column: Column<TData, unknown>) => boolean
-  /**
-   * The filter function to use for global filtering.
-   * - A `string` referencing a built-in filter function
-   * - A `string` that references a custom filter functions provided via the `tableOptions.filterFns` option
-   * - A custom filter function
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#globalfilterfn)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  globalFilterFn?: FilterFnOption<TData>
-  /**
-   * If provided, this function will be called with an `updaterFn` when `state.globalFilter` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#onglobalfilterchange)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  onGlobalFilterChange?: OnChangeFn<any>
-
-  // Faceting
-  getFacetedRowModel?: (
-    table: Table<TData>,
-    columnId: string
-  ) => () => RowModel<TData>
-  getFacetedUniqueValues?: (
-    table: Table<TData>,
-    columnId: string
-  ) => () => Map<any, number>
-  getFacetedMinMaxValues?: (
-    table: Table<TData>,
-    columnId: string
-  ) => () => undefined | [number, number]
 }
 
 type ResolvedFilterFns = keyof FilterFns extends never
@@ -279,25 +194,11 @@ type ResolvedFilterFns = keyof FilterFns extends never
       filterFns: Record<keyof FilterFns, FilterFn<any>>
     }
 
-export interface FiltersOptions<TData extends RowData>
-  extends FiltersOptionsBase<TData>,
+export interface ColumnFiltersOptions<TData extends RowData>
+  extends ColumnFiltersOptionsBase<TData>,
     ResolvedFilterFns {}
 
-export interface FiltersInstance<TData extends RowData> {
-  /**
-   * Sets or updates the `state.columnFilters` state.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#setcolumnfilters)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  setColumnFilters: (updater: Updater<ColumnFiltersState>) => void
-  /**
-   * Resets the **columnFilters** state to `initialState.columnFilters`, or `true` can be passed to force a default blank state reset to `[]`.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#resetcolumnfilters)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  resetColumnFilters: (defaultState?: boolean) => void
-
-  // Column Filters
+export interface ColumnFiltersInstance<TData extends RowData> {
   _getFilteredRowModel?: () => RowModel<TData>
   /**
    * Returns the row model for the table after **column** filtering has been applied.
@@ -311,47 +212,24 @@ export interface FiltersInstance<TData extends RowData> {
    * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
    */
   getPreFilteredRowModel: () => RowModel<TData>
-
-  // Global Filters
-  _getGlobalFacetedMinMaxValues?: () => undefined | [number, number]
-  _getGlobalFacetedRowModel?: () => RowModel<TData>
-  _getGlobalFacetedUniqueValues?: () => Map<any, number>
-  /**
-   * Currently, this function returns the built-in `includesString` filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getglobalautofilterfn)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  getGlobalAutoFilterFn: () => FilterFn<TData> | undefined
-  /**
-   * Returns the faceted min and max values for the global filter.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getglobalfacetedminmaxvalues)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  getGlobalFacetedMinMaxValues: () => undefined | [number, number]
-  /**
-   * Returns the row model for the table after **global** filtering has been applied.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getglobalfacetedrowmodel)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  getGlobalFacetedRowModel: () => RowModel<TData>
-  /**
-   * Returns the faceted unique values for the global filter.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getglobalfaceteduniquevalues)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
-   */
-  getGlobalFacetedUniqueValues: () => Map<any, number>
   /**
-   * Returns the filter function (either user-defined or automatic, depending on configuration) for the global filter.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getglobalfilterfn)
+   * Resets the **columnFilters** state to `initialState.columnFilters`, or `true` can be passed to force a default blank state reset to `[]`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#resetcolumnfilters)
    * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
    */
-  getGlobalFilterFn: () => FilterFn<TData> | undefined
+  resetColumnFilters: (defaultState?: boolean) => void
   /**
    * Resets the **globalFilter** state to `initialState.globalFilter`, or `true` can be passed to force a default blank state reset to `undefined`.
    * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#resetglobalfilter)
    * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
    */
   resetGlobalFilter: (defaultState?: boolean) => void
+  /**
+   * Sets or updates the `state.columnFilters` state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#setcolumnfilters)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  setColumnFilters: (updater: Updater<ColumnFiltersState>) => void
   /**
    * Sets or updates the `state.globalFilter` state.
    * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#setglobalfilter)
@@ -362,41 +240,30 @@ export interface FiltersInstance<TData extends RowData> {
 
 //
 
-export const Filters: TableFeature = {
-  getDefaultColumnDef: <TData extends RowData>(): FiltersColumnDef<TData> => {
+export const ColumnFiltering: TableFeature = {
+  getDefaultColumnDef: <
+    TData extends RowData,
+  >(): ColumnFiltersColumnDef<TData> => {
     return {
       filterFn: 'auto',
     }
   },
 
-  getInitialState: (state): FiltersTableState => {
+  getInitialState: (state): ColumnFiltersTableState => {
     return {
       columnFilters: [],
-      globalFilter: undefined,
-      // filtersProgress: 1,
-      // facetProgress: {},
       ...state,
     }
   },
 
   getDefaultOptions: <TData extends RowData>(
     table: Table<TData>
-  ): FiltersOptions<TData> => {
+  ): ColumnFiltersOptions<TData> => {
     return {
       onColumnFiltersChange: makeStateUpdater('columnFilters', table),
-      onGlobalFilterChange: makeStateUpdater('globalFilter', table),
       filterFromLeafRows: false,
       maxLeafRowFilterDepth: 100,
-      globalFilterFn: 'auto',
-      getColumnCanGlobalFilter: column => {
-        const value = table
-          .getCoreRowModel()
-          .flatRows[0]?._getAllCellsByColumnId()
-          [column.id]?.getValue()
-
-        return typeof value === 'string' || typeof value === 'number'
-      },
-    } as FiltersOptions<TData>
+    } as ColumnFiltersOptions<TData>
   },
 
   createColumn: <TData extends RowData>(
@@ -448,16 +315,6 @@ export const Filters: TableFeature = {
       )
     }
 
-    column.getCanGlobalFilter = () => {
-      return (
-        (column.columnDef.enableGlobalFilter ?? true) &&
-        (table.options.enableGlobalFilter ?? true) &&
-        (table.options.enableFilters ?? true) &&
-        (table.options.getColumnCanGlobalFilter?.(column) ?? true) &&
-        !!column.accessorFn
-      )
-    }
-
     column.getIsFiltered = () => column.getFilterIndex() > -1
 
     column.getFilterValue = () =>
@@ -469,11 +326,11 @@ export const Filters: TableFeature = {
     column.setFilterValue = value => {
       table.setColumnFilters(old => {
         const filterFn = column.getFilterFn()
-        const previousfilter = old?.find(d => d.id === column.id)
+        const previousFilter = old?.find(d => d.id === column.id)
 
         const newFilter = functionalUpdate(
           value,
-          previousfilter ? previousfilter.value : undefined
+          previousFilter ? previousFilter.value : undefined
         )
 
         //
@@ -485,7 +342,7 @@ export const Filters: TableFeature = {
 
         const newFilterObj = { id: column.id, value: newFilter }
 
-        if (previousfilter) {
+        if (previousFilter) {
           return (
             old?.map(d => {
               if (d.id === column.id) {
@@ -503,65 +360,17 @@ export const Filters: TableFeature = {
         return [newFilterObj]
       })
     }
-    column._getFacetedRowModel =
-      table.options.getFacetedRowModel &&
-      table.options.getFacetedRowModel(table, column.id)
-    column.getFacetedRowModel = () => {
-      if (!column._getFacetedRowModel) {
-        return table.getPreFilteredRowModel()
-      }
-
-      return column._getFacetedRowModel()
-    }
-    column._getFacetedUniqueValues =
-      table.options.getFacetedUniqueValues &&
-      table.options.getFacetedUniqueValues(table, column.id)
-    column.getFacetedUniqueValues = () => {
-      if (!column._getFacetedUniqueValues) {
-        return new Map()
-      }
-
-      return column._getFacetedUniqueValues()
-    }
-    column._getFacetedMinMaxValues =
-      table.options.getFacetedMinMaxValues &&
-      table.options.getFacetedMinMaxValues(table, column.id)
-    column.getFacetedMinMaxValues = () => {
-      if (!column._getFacetedMinMaxValues) {
-        return undefined
-      }
-
-      return column._getFacetedMinMaxValues()
-    }
-    // () => [column.getFacetedRowModel()],
-    // facetedRowModel => getRowModelMinMaxValues(facetedRowModel, column.id),
   },
 
   createRow: <TData extends RowData>(
     row: Row<TData>,
-    table: Table<TData>
+    _table: Table<TData>
   ): void => {
     row.columnFilters = {}
     row.columnFiltersMeta = {}
   },
 
   createTable: <TData extends RowData>(table: Table<TData>): void => {
-    table.getGlobalAutoFilterFn = () => {
-      return filterFns.includesString
-    }
-
-    table.getGlobalFilterFn = () => {
-      const { globalFilterFn: globalFilterFn } = table.options
-
-      return isFunction(globalFilterFn)
-        ? globalFilterFn
-        : globalFilterFn === 'auto'
-          ? table.getGlobalAutoFilterFn()
-          : // @ts-ignore
-            table.options.filterFns?.[globalFilterFn as string] ??
-            filterFns[globalFilterFn as BuiltInFilterFn]
-    }
-
     table.setColumnFilters = (updater: Updater<ColumnFiltersState>) => {
       const leafColumns = table.getAllLeafColumns()
 
@@ -584,16 +393,6 @@ export const Filters: TableFeature = {
       table.options.onColumnFiltersChange?.(updateFn)
     }
 
-    table.setGlobalFilter = updater => {
-      table.options.onGlobalFilterChange?.(updater)
-    }
-
-    table.resetGlobalFilter = defaultState => {
-      table.setGlobalFilter(
-        defaultState ? undefined : table.initialState.globalFilter
-      )
-    }
-
     table.resetColumnFilters = defaultState => {
       table.setColumnFilters(
         defaultState ? [] : table.initialState?.columnFilters ?? []
@@ -612,40 +411,6 @@ export const Filters: TableFeature = {
 
       return table._getFilteredRowModel()
     }
-
-    table._getGlobalFacetedRowModel =
-      table.options.getFacetedRowModel &&
-      table.options.getFacetedRowModel(table, '__global__')
-
-    table.getGlobalFacetedRowModel = () => {
-      if (table.options.manualFiltering || !table._getGlobalFacetedRowModel) {
-        return table.getPreFilteredRowModel()
-      }
-
-      return table._getGlobalFacetedRowModel()
-    }
-
-    table._getGlobalFacetedUniqueValues =
-      table.options.getFacetedUniqueValues &&
-      table.options.getFacetedUniqueValues(table, '__global__')
-    table.getGlobalFacetedUniqueValues = () => {
-      if (!table._getGlobalFacetedUniqueValues) {
-        return new Map()
-      }
-
-      return table._getGlobalFacetedUniqueValues()
-    }
-
-    table._getGlobalFacetedMinMaxValues =
-      table.options.getFacetedMinMaxValues &&
-      table.options.getFacetedMinMaxValues(table, '__global__')
-    table.getGlobalFacetedMinMaxValues = () => {
-      if (!table._getGlobalFacetedMinMaxValues) {
-        return
-      }
-
-      return table._getGlobalFacetedMinMaxValues()
-    }
   },
 }
 

package/src/features/{Grouping.ts → ColumnGrouping.ts}

@@ -1,16 +1,16 @@
 import { RowModel } from '..'
 import { BuiltInAggregationFn, aggregationFns } from '../aggregationFns'
-import { TableFeature } from '../core/table'
 import {
+  AggregationFns,
   Cell,
   Column,
+  ColumnDefTemplate,
   OnChangeFn,
-  Table,
   Row,
-  Updater,
-  ColumnDefTemplate,
   RowData,
-  AggregationFns,
+  Table,
+  TableFeature,
+  Updater,
 } from '../types'
 import { isFunction, makeStateUpdater } from '../utils'
 
@@ -239,7 +239,7 @@ export interface GroupingInstance<TData extends RowData> {
 
 //
 
-export const Grouping: TableFeature = {
+export const ColumnGrouping: TableFeature = {
   getDefaultColumnDef: <TData extends RowData>(): GroupingColumnDef<
     TData,
     unknown

package/src/features/{Ordering.ts → ColumnOrdering.ts}

@@ -1,9 +1,15 @@
 import { getMemoOptions, makeStateUpdater, memo } from '../utils'
 
-import { Table, OnChangeFn, Updater, Column, RowData } from '../types'
-
-import { orderColumns } from './Grouping'
-import { TableFeature } from '../core/table'
+import {
+  Column,
+  OnChangeFn,
+  RowData,
+  Table,
+  TableFeature,
+  Updater,
+} from '../types'
+
+import { orderColumns } from './ColumnGrouping'
 import { ColumnPinningPosition, _getVisibleLeafColumns } from '..'
 
 export interface ColumnOrderTableState {
@@ -66,7 +72,7 @@ export interface ColumnOrderInstance<TData extends RowData> {
 
 //
 
-export const Ordering: TableFeature = {
+export const ColumnOrdering: TableFeature = {
   getInitialState: (state): ColumnOrderTableState => {
     return {
       columnOrder: [],