@tanstack/table-core 9.0.0-alpha.4 → 9.0.0-alpha.42

package/src/features/column-grouping/columnGroupingFeature.types.ts

@@ -0,0 +1,218 @@
+import type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'
+import type { Table } from '../../types/Table'
+import type { BuiltInAggregationFn } from '../../fns/aggregationFns'
+import type {
+  CellData,
+  OnChangeFn,
+  RowData,
+  Updater,
+} from '../../types/type-utils'
+import type { TableFeatures } from '../../types/TableFeatures'
+import type { Row } from '../../types/Row'
+import type { Cell } from '../../types/Cell'
+import type { ColumnDefTemplate } from '../../types/ColumnDef'
+
+export type GroupingState = Array<string>
+
+export interface TableState_ColumnGrouping {
+  grouping: GroupingState
+}
+
+export interface RowModelFns_ColumnGrouping<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  aggregationFns: Record<keyof AggregationFns, AggregationFn<TFeatures, TData>>
+}
+
+export interface AggregationFns {}
+
+export type AggregationFn<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> = (
+  columnId: string,
+  leafRows: Array<Row<TFeatures, TData>>,
+  childRows: Array<Row<TFeatures, TData>>,
+) => any
+
+export type CustomAggregationFns<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> = Record<string, AggregationFn<TFeatures, TData>>
+
+export type AggregationFnOption<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> =
+  | 'auto'
+  | keyof AggregationFns
+  | BuiltInAggregationFn
+  | AggregationFn<TFeatures, TData>
+
+export interface ColumnDef_ColumnGrouping<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> {
+  /**
+   * The cell to display each row for the column if the cell is an aggregate. If a function is passed, it will be passed a props object with the context of the cell and should return the property type for your adapter (the exact type depends on the adapter being used).
+   */
+  aggregatedCell?: ColumnDefTemplate<
+    ReturnType<Cell<TFeatures, TData, TValue>['getContext']>
+  >
+  /**
+   * The resolved aggregation function for the column.
+   */
+  aggregationFn?: AggregationFnOption<TFeatures, TData>
+  /**
+   * Enables/disables grouping for this column.
+   */
+  enableGrouping?: boolean
+  /**
+   * Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from `accessorKey` / `accessorFn` will be used instead.
+   */
+  getGroupingValue?: (row: TData) => any
+}
+
+export interface Column_ColumnGrouping<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  /**
+   * Returns the aggregation function for the column.
+   */
+  getAggregationFn: () => AggregationFn<TFeatures, TData> | undefined
+  /**
+   * Returns the automatically inferred aggregation function for the column.
+   */
+  getAutoAggregationFn: () => AggregationFn<TFeatures, TData> | undefined
+  /**
+   * Returns whether or not the column can be grouped.
+   */
+  getCanGroup: () => boolean
+  /**
+   * Returns the index of the column in the grouping state.
+   */
+  getGroupedIndex: () => number
+  /**
+   * Returns whether or not the column is currently grouped.
+   */
+  getIsGrouped: () => boolean
+  /**
+   * Returns a function that toggles the grouping state of the column. This is useful for passing to the `onClick` prop of a button.
+   */
+  getToggleGroupingHandler: () => () => void
+  /**
+   * Toggles the grouping state of the column.
+   */
+  toggleGrouping: () => void
+}
+
+export interface Row_ColumnGrouping {
+  _groupingValuesCache: Record<string, any>
+  /**
+   * Returns the grouping value for any row and column (including leaf rows).
+   */
+  getGroupingValue: (columnId: string) => unknown
+  /**
+   * Returns whether or not the row is currently grouped.
+   */
+  getIsGrouped: () => boolean
+  /**
+   * If this row is grouped, this is the id of the column that this row is grouped by.
+   */
+  groupingColumnId?: string
+  /**
+   * If this row is grouped, this is the unique/shared value for the `groupingColumnId` for all of the rows in this group.
+   */
+  groupingValue?: unknown
+}
+
+export interface Cell_ColumnGrouping {
+  /**
+   * Returns whether or not the cell is currently aggregated.
+   */
+  getIsAggregated: () => boolean
+  /**
+   * Returns whether or not the cell is currently grouped.
+   */
+  getIsGrouped: () => boolean
+  /**
+   * Returns whether or not the cell is currently a placeholder cell.
+   */
+  getIsPlaceholder: () => boolean
+}
+
+export interface ColumnDefaultOptions {
+  enableGrouping: boolean
+  onGroupingChange: OnChangeFn<GroupingState>
+}
+
+export interface TableOptions_ColumnGrouping {
+  /**
+   * Enables/disables grouping for the table.
+   */
+  enableGrouping?: boolean
+  /**
+   * Grouping columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here.
+   */
+  groupedColumnMode?: false | 'reorder' | 'remove'
+  /**
+   * Enables manual grouping. If this option is set to `true`, the table will not automatically group rows using `getGroupedRowModel()` and instead will expect you to manually group the rows before passing them to the table. This is useful if you are doing server-side grouping and aggregation.
+   */
+  manualGrouping?: boolean
+  /**
+   * If this function is provided, it will be called when the grouping state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.grouping` option.
+   */
+  onGroupingChange?: OnChangeFn<GroupingState>
+}
+
+export type GroupingColumnMode = false | 'reorder' | 'remove'
+
+export interface Table_ColumnGrouping<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  /**
+   * Resets the **grouping** state to `initialState.grouping`, or `true` can be passed to force a default blank state reset to `[]`.
+   */
+  resetGrouping: (defaultState?: boolean) => void
+  /**
+   * Updates the grouping state of the table via an update function or value.
+   */
+  setGrouping: (updater: Updater<GroupingState>) => void
+}
+
+export interface Table_RowModels_Grouped<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  /**
+   * Returns the row model for the table after grouping has been applied.
+   */
+  getGroupedRowModel: () => RowModel<TFeatures, TData>
+  /**
+   * Returns the row model for the table before any grouping has been applied.
+   */
+  getPreGroupedRowModel: () => RowModel<TFeatures, TData>
+}
+
+export interface CreateRowModel_Grouped<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  /**
+   * Returns the row model after grouping has taken place, but no further.
+   */
+  groupedRowModel?: (
+    table: Table<TFeatures, TData>,
+  ) => () => RowModel<TFeatures, TData>
+}
+
+export interface CachedRowModel_Grouped<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  groupedRowModel: () => RowModel<TFeatures, TData>
+}

package/src/features/column-grouping/columnGroupingFeature.utils.ts

@@ -0,0 +1,192 @@
+import { cloneState, isFunction } from '../../utils'
+import { table_getColumn } from '../../core/columns/coreColumnsFeature.utils'
+import type { Column_Internal } from '../../types/Column'
+import type { CellData, RowData, Updater } from '../../types/type-utils'
+import type { TableFeatures } from '../../types/TableFeatures'
+import type { Table_Internal } from '../../types/Table'
+import type { Row } from '../../types/Row'
+import type { Cell } from '../../types/Cell'
+import type {
+  AggregationFn,
+  GroupingState,
+  Row_ColumnGrouping,
+} from './columnGroupingFeature.types'
+
+export function getDefaultGroupingState(): GroupingState {
+  return []
+}
+
+export function column_toggleGrouping<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(column: Column_Internal<TFeatures, TData, TValue>) {
+  table_setGrouping(column.table, (old) => {
+    // Find any existing grouping for this column
+    if (old.includes(column.id)) {
+      return old.filter((d) => d !== column.id)
+    }
+
+    return [...old, column.id]
+  })
+}
+
+export function column_getCanGroup<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(column: Column_Internal<TFeatures, TData, TValue>) {
+  return (
+    (column.columnDef.enableGrouping ?? true) &&
+    (column.table.options.enableGrouping ?? true) &&
+    (!!column.accessorFn || !!column.columnDef.getGroupingValue)
+  )
+}
+
+export function column_getIsGrouped<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(column: Column_Internal<TFeatures, TData, TValue>): boolean {
+  return !!column.table.atoms.grouping?.get()?.includes(column.id)
+}
+
+export function column_getGroupedIndex<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(column: Column_Internal<TFeatures, TData, TValue>): number {
+  return column.table.atoms.grouping?.get()?.indexOf(column.id) ?? -1
+}
+
+export function column_getToggleGroupingHandler<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(column: Column_Internal<TFeatures, TData, TValue>) {
+  const canGroup = column_getCanGroup(column)
+
+  return () => {
+    if (!canGroup) return
+    column_toggleGrouping(column)
+  }
+}
+
+export function column_getAutoAggregationFn<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(column: Column_Internal<TFeatures, TData, TValue>) {
+  const aggregationFns:
+    | Record<string, AggregationFn<TFeatures, TData>>
+    | undefined = column.table._rowModelFns.aggregationFns
+
+  const firstRow = column.table.getCoreRowModel().flatRows[0]
+
+  const value = firstRow?.getValue(column.id)
+
+  if (typeof value === 'number') {
+    return aggregationFns?.sum
+  }
+
+  if (Object.prototype.toString.call(value) === '[object Date]') {
+    return aggregationFns?.extent
+  }
+}
+
+export function column_getAggregationFn<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(column: Column_Internal<TFeatures, TData, TValue>) {
+  const aggregationFns:
+    | Record<string, AggregationFn<TFeatures, TData>>
+    | undefined = column.table._rowModelFns.aggregationFns
+
+  return isFunction(column.columnDef.aggregationFn)
+    ? column.columnDef.aggregationFn
+    : column.columnDef.aggregationFn === 'auto'
+      ? column_getAutoAggregationFn(column)
+      : aggregationFns?.[column.columnDef.aggregationFn as string]
+}
+
+export function table_setGrouping<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(table: Table_Internal<TFeatures, TData>, updater: Updater<GroupingState>) {
+  table.options.onGroupingChange?.(updater)
+}
+
+export function table_resetGrouping<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {
+  table_setGrouping(
+    table,
+    defaultState ? [] : cloneState(table.initialState.grouping ?? []),
+  )
+}
+
+export function row_getIsGrouped<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(row: Row<TFeatures, TData> & Partial<Row_ColumnGrouping>) {
+  return !!row.groupingColumnId
+}
+
+export function row_getGroupingValue<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(row: Row<TFeatures, TData> & Partial<Row_ColumnGrouping>, columnId: string) {
+  if (row._groupingValuesCache?.hasOwnProperty(columnId)) {
+    return row._groupingValuesCache[columnId]
+  }
+
+  const column = table_getColumn(row.table, columnId) as Column_Internal<
+    TFeatures,
+    TData
+  >
+
+  if (!column.columnDef.getGroupingValue) {
+    return row.getValue(columnId)
+  }
+
+  if (row._groupingValuesCache) {
+    row._groupingValuesCache[columnId] = column.columnDef.getGroupingValue(
+      row.original,
+    )
+  }
+
+  return row._groupingValuesCache?.[columnId]
+}
+
+export function cell_getIsGrouped<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(cell: Cell<TFeatures, TData, TValue>) {
+  const row = cell.row as Row<TFeatures, TData> & Partial<Row_ColumnGrouping>
+  return (
+    column_getIsGrouped(cell.column) && cell.column.id === row.groupingColumnId
+  )
+}
+
+export function cell_getIsPlaceholder<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(cell: Cell<TFeatures, TData, TValue>) {
+  return !cell_getIsGrouped(cell) && column_getIsGrouped(cell.column)
+}
+
+export function cell_getIsAggregated<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(cell: Cell<TFeatures, TData, TValue>) {
+  return (
+    !cell_getIsGrouped(cell) &&
+    !cell_getIsPlaceholder(cell) &&
+    !!cell.row.subRows.length
+  )
+}

package/src/features/column-grouping/createGroupedRowModel.ts

@@ -0,0 +1,215 @@
+import { flattenBy, tableMemo } from '../../utils'
+import { constructRow } from '../../core/rows/constructRow'
+import { table_getColumn } from '../../core/columns/coreColumnsFeature.utils'
+import { table_autoResetExpanded } from '../row-expanding/rowExpandingFeature.utils'
+import { table_autoResetPageIndex } from '../row-pagination/rowPaginationFeature.utils'
+import {
+  column_getAggregationFn,
+  row_getGroupingValue,
+} from './columnGroupingFeature.utils'
+import type { Column } from '../../types/Column'
+import type {
+  AggregationFn,
+  AggregationFns,
+  Row_ColumnGrouping,
+} from './columnGroupingFeature.types'
+import type { TableFeatures } from '../../types/TableFeatures'
+import type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'
+import type { Table, Table_Internal } from '../../types/Table'
+import type { Row } from '../../types/Row'
+import type { RowData } from '../../types/type-utils'
+
+export function createGroupedRowModel<
+  TFeatures extends TableFeatures,
+  TData extends RowData = any,
+>(
+  aggregationFns: Record<keyof AggregationFns, AggregationFn<TFeatures, TData>>,
+): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {
+  return (_table) => {
+    const table: Table_Internal<TFeatures, TData> = _table
+    if (!table._rowModelFns.aggregationFns)
+      table._rowModelFns.aggregationFns = aggregationFns
+    return tableMemo({
+      feature: 'columnGroupingFeature',
+      table,
+      fnName: 'table.getGroupedRowModel',
+      memoDeps: () => [
+        table.atoms.grouping?.get(),
+        table.getPreGroupedRowModel(),
+      ],
+      fn: () => _createGroupedRowModel(table),
+      onAfterUpdate: () => {
+        table_autoResetExpanded(table)
+        table_autoResetPageIndex(table)
+      },
+    })
+  }
+}
+
+function _createGroupedRowModel<
+  TFeatures extends TableFeatures,
+  TData extends RowData = any,
+>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {
+  const rowModel = table.getPreGroupedRowModel()
+  const grouping = table.atoms.grouping?.get()
+
+  if (!rowModel.rows.length || !grouping?.length) {
+    rowModel.rows.forEach((row) => {
+      row.depth = 0
+      row.parentId = undefined
+    })
+    return rowModel
+  }
+
+  // Filter the grouping list down to columns that exist
+  const existingGrouping = grouping.filter((columnId) =>
+    table_getColumn(table, columnId),
+  )
+
+  const groupedFlatRows: Array<Row<TFeatures, TData>> &
+    Partial<Row_ColumnGrouping> = []
+  const groupedRowsById: Record<string, Row<TFeatures, TData>> = {}
+
+  // Recursively group the data
+  const groupUpRecursively = (
+    rows: Array<Row<TFeatures, TData>>,
+    depth = 0,
+    parentId?: string,
+  ) => {
+    // Grouping depth has been been met
+    // Stop grouping and simply rewrite thd depth and row relationships
+    if (depth >= existingGrouping.length) {
+      return rows.map((row) => {
+        row.depth = depth
+
+        groupedFlatRows.push(row)
+        groupedRowsById[row.id] = row
+
+        if (row.subRows.length) {
+          row.subRows = groupUpRecursively(row.subRows, depth + 1, row.id)
+        }
+
+        return row
+      })
+    }
+
+    const columnId = existingGrouping[depth] as string
+
+    // Group the rows together for this level
+    const rowGroupsMap = groupBy(rows, columnId)
+
+    // Perform aggregations for each group
+    const aggregatedGroupedRows = Array.from(rowGroupsMap.entries()).map(
+      ([groupingValue, groupedRows], index) => {
+        let id = `${columnId}:${groupingValue}`
+        id = parentId ? `${parentId}>${id}` : id
+
+        // First, Recurse to group sub rows before aggregation
+        const subRows = groupUpRecursively(groupedRows, depth + 1, id)
+
+        subRows.forEach((subRow) => {
+          subRow.parentId = id
+        })
+
+        // Flatten the leaf rows of the rows in this group
+        const leafRows = depth
+          ? flattenBy(groupedRows, (row) => row.subRows)
+          : groupedRows
+
+        const row = constructRow(
+          table,
+          id,
+          leafRows[0]!.original,
+          index,
+          depth,
+          undefined,
+          parentId,
+        ) as Row<TFeatures, TData> & Partial<Row_ColumnGrouping>
+
+        Object.assign(row, {
+          groupingColumnId: columnId,
+          groupingValue,
+          subRows,
+          leafRows,
+          getValue: (colId: string) => {
+            // Don't aggregate columns that are in the grouping
+            if (existingGrouping.includes(colId)) {
+              if (row._valuesCache.hasOwnProperty(colId)) {
+                return row._valuesCache[colId]
+              }
+
+              if (groupedRows[0]) {
+                row._valuesCache[colId] =
+                  groupedRows[0].getValue(colId) ?? undefined
+              }
+
+              return row._valuesCache[colId]
+            }
+
+            if (row._groupingValuesCache?.hasOwnProperty(colId)) {
+              return row._groupingValuesCache[colId]
+            }
+
+            // Aggregate the values
+            const column = table.getColumn(colId)
+            const aggregateFn = column_getAggregationFn(
+              column as Column<TFeatures, TData, unknown>,
+            )
+
+            if (!row._groupingValuesCache) row._groupingValuesCache = {}
+
+            if (aggregateFn) {
+              row._groupingValuesCache[colId] = aggregateFn(
+                colId,
+                leafRows,
+                groupedRows,
+              )
+
+              return row._groupingValuesCache[colId]
+            }
+          },
+        })
+
+        subRows.forEach((subRow) => {
+          groupedFlatRows.push(subRow)
+          groupedRowsById[subRow.id] = subRow
+        })
+
+        return row
+      },
+    )
+
+    return aggregatedGroupedRows
+  }
+
+  const groupedRows = groupUpRecursively(rowModel.rows, 0)
+
+  groupedRows.forEach((subRow) => {
+    groupedFlatRows.push(subRow)
+    groupedRowsById[subRow.id] = subRow
+  })
+
+  return {
+    rows: groupedRows,
+    flatRows: groupedFlatRows,
+    rowsById: groupedRowsById,
+  }
+}
+
+function groupBy<TFeatures extends TableFeatures, TData extends RowData = any>(
+  rows: Array<Row<TFeatures, TData>>,
+  columnId: string,
+) {
+  const groupMap = new Map<any, Array<Row<TFeatures, TData>>>()
+
+  return rows.reduce((map, row) => {
+    const resKey = `${row_getGroupingValue(row, columnId)}`
+    const previous = map.get(resKey)
+    if (!previous) {
+      map.set(resKey, [row])
+    } else {
+      previous.push(row)
+    }
+    return map
+  }, groupMap)
+}