@tanstack/table-core 9.0.0-beta.9 → 9.0.1

package/src/features/column-faceting/columnFacetingFeature.utils.ts

@@ -1,145 +0,0 @@
-import type { CellData, RowData } from '../../types/type-utils'
-import type { TableFeatures } from '../../types/TableFeatures'
-import type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'
-import type { Table_Internal } from '../../types/Table'
-import type { Column_Internal } from '../../types/Column'
-
-/**
- * Computes min and max numeric facet values for one column.
- *
- * The configured `facetedMinMaxValues` row-model factory owns the calculation.
- * If no factory is registered, the result is `undefined`.
- *
- * @example
- * ```ts
- * const range = column_getFacetedMinMaxValues(column, table)
- * ```
- */
-export function column_getFacetedMinMaxValues<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-  TValue extends CellData = CellData,
->(
-  column: Column_Internal<TFeatures, TData, TValue>,
-  table: Table_Internal<TFeatures, TData>,
-): [number, number] | undefined {
-  const facetedMinMaxValuesFn =
-    table.options.rowModels?.facetedMinMaxValues?.(table, column.id) ??
-    (() => undefined)
-  return facetedMinMaxValuesFn()
-}
-
-/**
- * Computes the row model used to derive one column's facet values.
- *
- * The faceted row model normally applies every other active filter while
- * excluding this column's own filter. If no factory is registered, the
- * pre-filtered row model is returned.
- *
- * @example
- * ```ts
- * const rows = column_getFacetedRowModel(column, table)
- * ```
- */
-export function column_getFacetedRowModel<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-  TValue extends CellData = CellData,
->(
-  column: Column_Internal<TFeatures, TData, TValue> | undefined,
-  table: Table_Internal<TFeatures, TData>,
-): RowModel<TFeatures, TData> {
-  const facetedRowModelFn =
-    table.options.rowModels?.facetedRowModel?.(table, column?.id ?? '') ??
-    (() => table.getPreFilteredRowModel())
-  return facetedRowModelFn()
-}
-
-/**
- * Computes unique facet values and their occurrence counts for one column.
- *
- * The configured `facetedUniqueValues` row-model factory owns the calculation.
- * If no factory is registered, an empty `Map` is returned.
- *
- * @example
- * ```ts
- * const values = column_getFacetedUniqueValues(column, table)
- * ```
- */
-export function column_getFacetedUniqueValues<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-  TValue extends CellData = CellData,
->(
-  column: Column_Internal<TFeatures, TData, TValue>,
-  table: Table_Internal<TFeatures, TData>,
-): Map<any, number> {
-  const facetedUniqueValuesFn =
-    table.options.rowModels?.facetedUniqueValues?.(table, column.id) ??
-    (() => new Map<any, number>())
-  return facetedUniqueValuesFn()
-}
-
-/**
- * Computes min and max numeric facet values for the global filter context.
- *
- * The global context is requested with the internal `__global__` column id. If
- * no factory is registered, the result is `undefined`.
- *
- * @example
- * ```ts
- * const range = table_getGlobalFacetedMinMaxValues(table)
- * ```
- */
-export function table_getGlobalFacetedMinMaxValues<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>): undefined | [number, number] {
-  const facetedMinMaxValuesFn =
-    table.options.rowModels?.facetedMinMaxValues?.(table, '__global__') ??
-    (() => undefined)
-  return facetedMinMaxValuesFn()
-}
-
-/**
- * Computes the row model used to derive global facet values.
- *
- * The global context is requested with the internal `__global__` column id. If
- * no faceted row-model factory is registered, the pre-filtered row model is
- * returned.
- *
- * @example
- * ```ts
- * const rows = table_getGlobalFacetedRowModel(table)
- * ```
- */
-export function table_getGlobalFacetedRowModel<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {
-  const facetedRowModelFn =
-    table.options.rowModels?.facetedRowModel?.(table, '__global__') ??
-    (() => table.getPreFilteredRowModel())
-  return facetedRowModelFn()
-}
-
-/**
- * Computes unique values and occurrence counts for the global filter context.
- *
- * The global context is requested with the internal `__global__` column id. If
- * no factory is registered, an empty `Map` is returned.
- *
- * @example
- * ```ts
- * const values = table_getGlobalFacetedUniqueValues(table)
- * ```
- */
-export function table_getGlobalFacetedUniqueValues<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(table: Table_Internal<TFeatures, TData>): Map<any, number> {
-  const facetedUniqueValuesFn =
-    table.options.rowModels?.facetedUniqueValues?.(table, '__global__') ??
-    (() => new Map())
-  return facetedUniqueValuesFn()
-}

package/src/features/column-faceting/createFacetedMinMaxValues.ts

@@ -1,66 +0,0 @@
-import { callMemoOrStaticFn, tableMemo } from '../../utils'
-import { column_getFacetedRowModel } from './columnFacetingFeature.utils'
-import type { Row } from '../../types/Row'
-import type { Table, Table_Internal } from '../../types/Table'
-import type { TableFeatures } from '../../types/TableFeatures'
-import type { RowData } from '../../types/type-utils'
-
-/**
- * Creates a memoized faceted min max values helper for faceted filtering.
- *
- * The returned function derives facet data from the table row model and relevant filter state so filter UIs can display available values.
- */
-export function createFacetedMinMaxValues<
-  TFeatures extends TableFeatures,
-  TData extends RowData = any,
->(): (
-  table: Table<TFeatures, TData>,
-  columnId: string,
-) => () => undefined | [number, number] {
-  return (_table, columnId) => {
-    const table = _table as unknown as Table_Internal<TFeatures, TData>
-    return tableMemo({
-      feature: 'columnFacetingFeature',
-      fn: (flatRows) => _createFacetedMinMaxValues(columnId, flatRows),
-      fnName: 'table.getFacetedMinMaxValues',
-      memoDeps: () => {
-        const column = table.getColumn(columnId)
-        if (!column) return [table.getPreFilteredRowModel().flatRows]
-        return [
-          callMemoOrStaticFn(
-            column,
-            'getFacetedRowModel',
-            column_getFacetedRowModel,
-            table,
-          ).flatRows,
-        ]
-      },
-      table,
-    })
-  }
-}
-
-function _createFacetedMinMaxValues<
-  TFeatures extends TableFeatures,
-  TData extends RowData = any,
->(
-  columnId: string,
-  flatRows: Array<Row<TFeatures, TData>>,
-): undefined | [number, number] {
-  if (!flatRows.length) return undefined
-
-  let facetedMinValue = Number.POSITIVE_INFINITY
-  let facetedMaxValue = Number.NEGATIVE_INFINITY
-  let foundAny = false
-
-  for (let i = 0; i < flatRows.length; i++) {
-    const value = Number(flatRows[i]!.getValue(columnId))
-    if (Number.isNaN(value)) continue
-    foundAny = true
-    if (value < facetedMinValue) facetedMinValue = value
-    if (value > facetedMaxValue) facetedMaxValue = value
-  }
-
-  if (!foundAny) return undefined
-  return [facetedMinValue, facetedMaxValue]
-}

package/src/features/column-faceting/createFacetedRowModel.ts

@@ -1,85 +0,0 @@
-import { tableMemo } from '../../utils'
-import { filterRows } from '../column-filtering/filterRowsUtils'
-import type { Table, Table_Internal } from '../../types/Table'
-import type {
-  ColumnFiltersState,
-  Row_ColumnFiltering,
-} from '../column-filtering/columnFilteringFeature.types'
-import type { TableFeatures } from '../../types/TableFeatures'
-import type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'
-import type { Row } from '../../types/Row'
-import type { RowData } from '../../types/type-utils'
-
-/**
- * Creates a memoized faceted row model factory.
- *
- * The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.
- */
-export function createFacetedRowModel<
-  TFeatures extends TableFeatures,
-  TData extends RowData = any,
->(): (
-  table: Table<TFeatures, TData>,
-  columnId: string,
-) => () => RowModel<TFeatures, TData> {
-  return (_table, columnId) => {
-    const table = _table as unknown as Table_Internal<TFeatures, TData>
-    return tableMemo({
-      feature: 'columnFacetingFeature',
-      table,
-      fnName: 'createFacetedRowModel',
-      memoDeps: () => [
-        table.getPreFilteredRowModel(),
-        table.atoms.columnFilters?.get(),
-        table.atoms.globalFilter?.get(),
-        table.getFilteredRowModel(),
-      ],
-      fn: (preRowModel, columnFilters, globalFilter) =>
-        _createFacetedRowModel(
-          table,
-          columnId,
-          preRowModel,
-          columnFilters,
-          globalFilter,
-        ),
-    })
-  }
-}
-
-function _createFacetedRowModel<
-  TFeatures extends TableFeatures,
-  TData extends RowData = any,
->(
-  table: Table_Internal<TFeatures, TData>,
-  columnId: string,
-  preRowModel: RowModel<TFeatures, TData>,
-  columnFilters?: ColumnFiltersState,
-  globalFilter?: string,
-) {
-  if (!preRowModel.rows.length || (!columnFilters?.length && !globalFilter)) {
-    return preRowModel
-  }
-
-  const filterableIds: Array<string> = []
-  if (columnFilters) {
-    for (let i = 0; i < columnFilters.length; i++) {
-      const id = columnFilters[i]!.id
-      if (id !== columnId) filterableIds.push(id)
-    }
-  }
-  if (globalFilter) filterableIds.push('__global__')
-
-  const filterRowsImpl = (
-    row: Row<TFeatures, TData> & Partial<Row_ColumnFiltering<TFeatures, TData>>,
-  ) => {
-    // Horizontally filter rows through each column
-    for (let i = 0; i < filterableIds.length; i++) {
-      if (row.columnFilters?.[filterableIds[i]!] === false) {
-        return false
-      }
-    }
-    return true
-  }
-
-  return filterRows(preRowModel.rows, filterRowsImpl, table)
-}

package/src/features/column-faceting/createFacetedUniqueValues.ts

@@ -1,66 +0,0 @@
-import { callMemoOrStaticFn, tableMemo } from '../../utils'
-import { column_getFacetedRowModel } from './columnFacetingFeature.utils'
-import type { Row } from '../../types/Row'
-import type { Table, Table_Internal } from '../../types/Table'
-import type { TableFeatures } from '../../types/TableFeatures'
-import type { RowData } from '../../types/type-utils'
-
-/**
- * Creates a memoized faceted unique values helper for faceted filtering.
- *
- * The returned function derives facet data from the table row model and relevant filter state so filter UIs can display available values.
- */
-export function createFacetedUniqueValues<
-  TFeatures extends TableFeatures,
-  TData extends RowData = any,
->(): (
-  table: Table<TFeatures, TData>,
-  columnId: string,
-) => () => Map<any, number> {
-  return (_table, columnId) => {
-    const table = _table as unknown as Table_Internal<TFeatures, TData>
-    return tableMemo({
-      feature: 'columnFacetingFeature',
-      table,
-      fnName: 'table.getFacetedUniqueValues',
-      memoDeps: () => {
-        const column = table.getColumn(columnId)
-        if (!column) return [table.getPreFilteredRowModel().flatRows]
-        return [
-          callMemoOrStaticFn(
-            column,
-            'getFacetedRowModel',
-            column_getFacetedRowModel,
-            table,
-          ).flatRows,
-        ]
-      },
-      fn: (flatRows) => _createFacetedUniqueValues(columnId, flatRows),
-    })
-  }
-}
-
-function _createFacetedUniqueValues<
-  TFeatures extends TableFeatures,
-  TData extends RowData = any,
->(columnId: string, flatRows: Array<Row<TFeatures, TData>>): Map<any, number> {
-  const facetedUniqueValues = new Map<any, number>()
-
-  for (let i = 0; i < flatRows.length; i++) {
-    const values = flatRows[i]!.getUniqueValues(columnId)
-
-    for (let j = 0; j < values.length; j++) {
-      const value = values[j]
-      if (facetedUniqueValues.has(value)) {
-        facetedUniqueValues.set(
-          value,
-          (facetedUniqueValues.get(value) ?? 0) + 1,
-        )
-      } else {
-        facetedUniqueValues.set(value, 1)
-      }
-    }
-  }
-
-  return facetedUniqueValues
-}

package/src/features/column-filtering/columnFilteringFeature.ts

@@ -1,86 +0,0 @@
-import {
-  assignPrototypeAPIs,
-  assignTableAPIs,
-  makeStateUpdater,
-} from '../../utils'
-import {
-  column_getAutoFilterFn,
-  column_getCanFilter,
-  column_getFilterFn,
-  column_getFilterIndex,
-  column_getFilterValue,
-  column_getIsFiltered,
-  column_setFilterValue,
-  getDefaultColumnFiltersState,
-  table_resetColumnFilters,
-  table_setColumnFilters,
-} from './columnFilteringFeature.utils'
-import type { TableFeature } from '../../types/TableFeatures'
-
-/**
- * Feature that adds per-column filtering state, options, and column/table filter APIs.
- */
-export const columnFilteringFeature: TableFeature = {
-  getInitialState: (initialState) => {
-    return {
-      columnFilters: getDefaultColumnFiltersState(),
-      ...initialState,
-    }
-  },
-
-  getDefaultColumnDef: () => {
-    return {
-      filterFn: 'auto',
-    }
-  },
-
-  getDefaultTableOptions: (table) => {
-    return {
-      onColumnFiltersChange: makeStateUpdater('columnFilters', table),
-      filterFromLeafRows: false,
-      maxLeafRowFilterDepth: 100,
-    }
-  },
-
-  assignColumnPrototype: (prototype, table) => {
-    assignPrototypeAPIs('columnFilteringFeature', prototype, table, {
-      column_getAutoFilterFn: {
-        fn: (column) => column_getAutoFilterFn(column),
-      },
-      column_getFilterFn: {
-        fn: (column) => column_getFilterFn(column),
-      },
-      column_getCanFilter: {
-        fn: (column) => column_getCanFilter(column),
-      },
-      column_getIsFiltered: {
-        fn: (column) => column_getIsFiltered(column),
-      },
-      column_getFilterValue: {
-        fn: (column) => column_getFilterValue(column),
-      },
-      column_getFilterIndex: {
-        fn: (column) => column_getFilterIndex(column),
-      },
-      column_setFilterValue: {
-        fn: (column, value) => column_setFilterValue(column, value),
-      },
-    })
-  },
-
-  initRowInstanceData: (row) => {
-    ;(row as any).columnFilters = {}
-    ;(row as any).columnFiltersMeta = {}
-  },
-
-  constructTableAPIs: (table) => {
-    assignTableAPIs('columnFilteringFeature', table, {
-      table_setColumnFilters: {
-        fn: (updater) => table_setColumnFilters(table, updater),
-      },
-      table_resetColumnFilters: {
-        fn: (defaultState) => table_resetColumnFilters(table, defaultState),
-      },
-    })
-  },
-}

package/src/features/column-filtering/columnFilteringFeature.types.ts

@@ -1,232 +0,0 @@
-import type { Table } from '../../types/Table'
-import type { BuiltInFilterFn } from '../../fns/filterFns'
-import type {
-  CellData,
-  OnChangeFn,
-  RowData,
-  Updater,
-} from '../../types/type-utils'
-import type { TableFeatures } from '../../types/TableFeatures'
-import type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'
-import type { Row } from '../../types/Row'
-import type { Column } from '../../types/Column'
-
-export interface FilterMeta {}
-
-export interface FilterFns {}
-
-export interface TableState_ColumnFiltering {
-  columnFilters: ColumnFiltersState
-}
-
-export type ColumnFiltersState = Array<ColumnFilter>
-
-export interface ColumnFilter {
-  id: string
-  value: unknown
-}
-
-export interface ResolvedColumnFilter<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  filterFn: FilterFn<TFeatures, TData>
-  id: string
-  resolvedValue: unknown
-}
-
-export interface RowModelFns_ColumnFiltering<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  filterFns: Record<keyof FilterFns, FilterFn<TFeatures, RowData>>
-}
-
-export interface FilterFn<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  (
-    row: Row<TFeatures, TData>,
-    columnId: string,
-    filterValue: any,
-    addMeta?: (meta: FilterMeta) => void,
-  ): boolean
-  autoRemove?: ColumnFilterAutoRemoveTestFn<TFeatures, TData>
-  resolveFilterValue?: TransformFilterValueFn<TFeatures, TData>
-}
-
-export type TransformFilterValueFn<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-  TValue extends CellData = CellData,
-> = (value: any, column?: Column<TFeatures, TData, TValue>) => TValue
-
-export type ColumnFilterAutoRemoveTestFn<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-  TValue extends CellData = CellData,
-> = (value: any, column?: Column<TFeatures, TData, TValue>) => boolean
-
-export type CustomFilterFns<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> = Record<string, FilterFn<TFeatures, RowData>>
-
-export type FilterFnOption<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> = 'auto' | BuiltInFilterFn | keyof FilterFns | FilterFn<TFeatures, RowData>
-
-export interface ColumnDef_ColumnFiltering<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  /**
-   * Enables this column to participate in column-specific filtering.
-   *
-   * Defaults to `true`; table-level `enableColumnFilters` and `enableFilters`
-   * must also allow filtering.
-   */
-  enableColumnFilter?: boolean
-  /**
-   * The filter function to use with this column. Can be the name of a built-in filter function or a custom filter function.
-   */
-  filterFn?: FilterFnOption<TFeatures, TData>
-}
-
-export interface Column_ColumnFiltering<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  /**
-   * Returns an automatically calculated filter function for the column based off of the columns first known value.
-   */
-  getAutoFilterFn: () => FilterFn<TFeatures, TData>
-  /**
-   * Checks whether this accessor column can currently be column-filtered.
-   */
-  getCanFilter: () => boolean
-  /**
-   * Returns the filter function (either user-defined or automatic, depending on configuration) for the columnId specified.
-   */
-  getFilterFn: () => FilterFn<TFeatures, TData>
-  /**
-   * Returns the index (including `-1`) of the column filter in the table's `state.columnFilters` array.
-   */
-  getFilterIndex: () => number
-  /**
-   * Reads this column's current value from `state.columnFilters`.
-   */
-  getFilterValue: () => unknown
-  /**
-   * Checks whether this column has an active entry in `state.columnFilters`.
-   */
-  getIsFiltered: () => boolean
-  /**
-   * Adds, updates, or removes this column's filter value.
-   *
-   * Updater functions receive the previous filter value. Values that satisfy
-   * the filter function's `autoRemove` rule are removed from filter state.
-   */
-  setFilterValue: (updater: Updater<any>) => void
-}
-
-export interface Row_ColumnFiltering<
-  TFeatures extends TableFeatures,
-  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.
-   */
-  columnFilters: Record<string, boolean>
-  /**
-   * The column filters meta map for the row. This object tracks any filter meta for a row as optionally provided during the filtering process.
-   */
-  columnFiltersMeta: Record<string, FilterMeta>
-}
-
-export interface TableOptions_ColumnFiltering<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  /**
-   * Enables column-specific filtering for all columns that also allow it.
-   */
-  enableColumnFilters?: boolean
-  /**
-   * Enables all filtering features for the table.
-   *
-   * Set this to `false` to disable both column filtering and global filtering.
-   */
-  enableFilters?: boolean
-  /**
-   * By default, filtering is done from parent rows down (so if a parent row is filtered out, all of its children will be filtered out as well). Setting this option to `true` will cause filtering to be done from leaf rows up (which means parent rows will be included so long as one of their child or grand-child rows is also included).
-   */
-  filterFromLeafRows?: boolean
-  /**
-   * Disables the `getFilteredRowModel` from being used to filter data. This may be useful if your table needs to dynamically support both client-side and server-side filtering.
-   */
-  manualFiltering?: boolean
-  /**
-     * By default, filtering is done for all rows (max depth of 100), no matter if they are root level parent rows or the child leaf rows of a parent row. Setting this option to `0` will cause filtering to only be applied to the root level parent rows, with all sub-rows remaining unfiltered. Similarly, setting this option to `1` will cause filtering to only be applied to child leaf rows 1 level deep, and so on.
-
-     * This is useful for situations where you want a row's entire child hierarchy to be visible regardless of the applied filter.
-     */
-  maxLeafRowFilterDepth?: number
-  /**
-   * Called with an updater when column filter state changes. Pair this with
-   * `state.columnFilters` when using external state; external atoms can own the
-   * slice without this callback.
-   */
-  onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>
-}
-
-export interface Table_ColumnFiltering {
-  /**
-   * Resets `columnFilters` to `initialState.columnFilters`.
-   *
-   * Pass `true` to ignore initial state and reset to `[]`.
-   */
-  resetColumnFilters: (defaultState?: boolean) => void
-  /**
-   * Updates column filter state with a next array or updater function.
-   */
-  setColumnFilters: (updater: Updater<ColumnFiltersState>) => void
-}
-
-export interface Table_RowModels_Filtered<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  /**
-   * Resolves the row model after column and global filters have been applied.
-   */
-  getFilteredRowModel: () => RowModel<TFeatures, TData>
-  /**
-   * Reads the row model immediately before filtering.
-   */
-  getPreFilteredRowModel: () => RowModel<TFeatures, TData>
-}
-
-export interface CreateRowModel_Filtered<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  /**
-   * If provided, this factory is called once per table and should return a
-   * function that calculates the filtered row model.
-   * - For server-side filtering, this function is unnecessary and can be ignored since the server should already return the filtered row model.
-   * - For client-side filtering, pass the exported `createFilteredRowModel()` or implement your own factory.
-   */
-  filteredRowModel?: (
-    table: Table<TFeatures, TData>,
-  ) => () => RowModel<TFeatures, TData>
-}
-
-export interface CachedRowModel_Filtered<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  filteredRowModel: () => RowModel<TFeatures, TData>
-}