@tanstack/react-table 8.0.0-alpha.5 → 8.0.0-alpha.52

package/src/features/Grouping.ts

@@ -1,466 +0,0 @@
-import React, { MouseEvent, TouchEvent } from 'react'
-import { RowModel } from '..'
-import { BuiltInAggregationType, aggregationTypes } from '../aggregationTypes'
-import {
-  Cell,
-  Column,
-  Getter,
-  OnChangeFn,
-  PropGetterValue,
-  ReactTable,
-  Row,
-  Updater,
-} from '../types'
-import {
-  functionalUpdate,
-  isFunction,
-  makeStateUpdater,
-  memo,
-  propGetter,
-} from '../utils'
-
-export type GroupingState = string[]
-
-export type AggregationFn = (leafValues: any[], childValues: any[]) => any
-
-export type AggregationType<TAggregationFns> =
-  | 'auto'
-  | BuiltInAggregationType
-  | keyof TAggregationFns
-  | AggregationFn
-
-export type GroupingTableState = {
-  grouping: GroupingState
-}
-
-export type GroupingColumnDef<TAggregationFns> = {
-  aggregationType?: AggregationType<TAggregationFns>
-  aggregateValue?: (columnValue: unknown) => any
-  renderAggregatedCell?: () => React.ReactNode
-  enableGrouping?: boolean
-  defaultCanGroup?: boolean
-}
-
-export type GroupingColumn<
-  _TData,
-  _TValue,
-  _TFilterFns,
-  _TSortingFns,
-  TAggregationFns
-> = {
-  aggregationType?: AggregationType<TAggregationFns>
-  getCanGroup: () => boolean
-  getIsGrouped: () => boolean
-  getGroupedIndex: () => number
-  toggleGrouping: () => void
-  getToggleGroupingProps: <TGetter extends Getter<ToggleGroupingProps>>(
-    userProps?: TGetter
-  ) => undefined | PropGetterValue<ToggleGroupingProps, TGetter>
-}
-
-export type GroupingRow = {
-  groupingColumnId?: string
-  groupingValue?: any
-  getIsGrouped: () => boolean
-}
-
-export type GroupingCell = {
-  getIsGrouped: () => boolean
-  getIsPlaceholder: () => boolean
-  getIsAggregated: () => boolean
-}
-
-export type ColumnDefaultOptions = {
-  // Column
-  onGroupingChange: OnChangeFn<GroupingState>
-  autoResetGrouping: boolean
-  enableGrouping: boolean
-}
-
-export type GroupingOptions<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
-> = {
-  aggregationTypes?: TAggregationFns
-  onGroupingChange?: OnChangeFn<GroupingState>
-  autoResetGrouping?: boolean
-  enableGrouping?: boolean
-  enableGroupingRemoval?: boolean
-  groupRowsFn?: (
-    instance: ReactTable<
-      TData,
-      TValue,
-      TFilterFns,
-      TSortingFns,
-      TAggregationFns
-    >,
-    rowModel: RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-  ) => RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-
-  groupedColumnMode?: false | 'reorder' | 'remove'
-}
-
-export type GroupingColumnMode = false | 'reorder' | 'remove'
-
-export type ToggleGroupingProps = {
-  title?: string
-  onClick?: (event: MouseEvent | TouchEvent) => void
-}
-
-export type GroupingInstance<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
-> = {
-  _notifyGroupingReset: () => void
-  getColumnAutoAggregationFn: (columnId: string) => AggregationFn | undefined
-  getColumnAggregationFn: (columnId: string) => AggregationFn | undefined
-  setGrouping: (updater: Updater<GroupingState>) => void
-  resetGrouping: () => void
-  toggleColumnGrouping: (columnId: string) => void
-  getColumnCanGroup: (columnId: string) => boolean
-  getColumnIsGrouped: (columnId: string) => boolean
-  getColumnGroupedIndex: (columnId: string) => number
-  getToggleGroupingProps: <TGetter extends Getter<ToggleGroupingProps>>(
-    columnId: string,
-    userProps?: TGetter
-  ) => undefined | PropGetterValue<ToggleGroupingProps, TGetter>
-  getRowIsGrouped: (rowId: string) => boolean
-  getGroupedRowModel: () => RowModel<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >
-  getPreGroupedRows: () => Row<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-  getPreGroupedFlatRows: () => Row<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-  getPreGroupedRowsById: () => Record<
-    string,
-    Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-  >
-  getGroupedRows: () => Row<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-  getGroupedFlatRows: () => Row<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-  getGroupedRowsById: () => Record<
-    string,
-    Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-  >
-}
-
-//
-
-export function getDefaultColumn<TFilterFns>(): GroupingColumnDef<TFilterFns> {
-  return {
-    aggregationType: 'auto',
-  }
-}
-
-export function getInitialState(): GroupingTableState {
-  return {
-    grouping: [],
-  }
-}
-
-export function getDefaultOptions<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): GroupingOptions<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> {
-  return {
-    onGroupingChange: makeStateUpdater('grouping', instance),
-    autoResetGrouping: true,
-    groupedColumnMode: 'reorder',
-  }
-}
-
-export function createColumn<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  column: Column<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>,
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): GroupingColumn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> {
-  return {
-    aggregationType: column.aggregationType,
-    getCanGroup: () => instance.getColumnCanGroup(column.id),
-    getGroupedIndex: () => instance.getColumnGroupedIndex(column.id),
-    getIsGrouped: () => instance.getColumnIsGrouped(column.id),
-    toggleGrouping: () => instance.toggleColumnGrouping(column.id),
-    getToggleGroupingProps: userProps =>
-      instance.getToggleGroupingProps(column.id, userProps),
-  }
-}
-
-export function getInstance<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): GroupingInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> {
-  let registered = false
-
-  return {
-    _notifyGroupingReset: () => {
-      if (!registered) {
-        registered = true
-        return
-      }
-
-      if (instance.options.autoResetAll === false) {
-        return
-      }
-
-      if (
-        instance.options.autoResetAll === true ||
-        instance.options.autoResetGrouping
-      ) {
-        instance.resetGrouping()
-      }
-    },
-    getColumnAutoAggregationFn: columnId => {
-      const firstRow = instance.getCoreFlatRows()[0]
-
-      const value = firstRow?.values[columnId]
-
-      if (typeof value === 'number') {
-        return aggregationTypes.sum
-      }
-
-      if (Object.prototype.toString.call(value) === '[object Date]') {
-        return aggregationTypes.extent
-      }
-
-      return aggregationTypes.count
-    },
-    getColumnAggregationFn: columnId => {
-      const column = instance.getColumn(columnId)
-      const userAggregationTypes = instance.options.aggregationTypes
-
-      if (!column) {
-        throw new Error()
-      }
-
-      return isFunction(column.aggregationType)
-        ? column.aggregationType
-        : column.aggregationType === 'auto'
-        ? instance.getColumnAutoFilterFn(columnId)
-        : (userAggregationTypes as Record<string, any>)?.[
-            column.aggregationType as string
-          ] ??
-          (aggregationTypes[
-            column.aggregationType as BuiltInAggregationType
-          ] as AggregationFn)
-    },
-
-    setGrouping: updater =>
-      instance.options.onGroupingChange?.(
-        updater,
-        functionalUpdate(updater, instance.getState().grouping)
-      ),
-
-    toggleColumnGrouping: columnId => {
-      instance.setGrouping(old => {
-        // Find any existing grouping for this column
-        if (old?.includes(columnId)) {
-          return old.filter(d => d !== columnId)
-        }
-
-        return [...(old ?? []), columnId]
-      })
-    },
-
-    getColumnCanGroup: columnId => {
-      const column = instance.getColumn(columnId)
-
-      if (!column) {
-        throw new Error()
-      }
-
-      return (
-        column.enableGrouping ??
-        instance.options.enableGrouping ??
-        column.defaultCanGroup ??
-        !!column.accessorFn
-      )
-    },
-
-    getColumnIsGrouped: columnId => {
-      return instance.getState().grouping?.includes(columnId)
-    },
-
-    getColumnGroupedIndex: columnId =>
-      instance.getState().grouping?.indexOf(columnId),
-
-    resetGrouping: () => {
-      instance.setGrouping(instance.options?.initialState?.grouping ?? [])
-    },
-
-    getToggleGroupingProps: (columnId, userProps) => {
-      const column = instance.getColumn(columnId)
-
-      if (!column) {
-        return
-      }
-
-      const canGroup = column.getCanGroup()
-
-      const initialProps: ToggleGroupingProps = {
-        title: canGroup ? 'Toggle Grouping' : undefined,
-        onClick: canGroup
-          ? (e: MouseEvent | TouchEvent) => {
-              e.persist()
-              column.toggleGrouping?.()
-            }
-          : undefined,
-      }
-
-      return propGetter(initialProps, userProps)
-    },
-
-    getRowIsGrouped: rowId => !!instance.getRow(rowId)?.groupingColumnId,
-
-    getGroupedRowModel: memo(
-      () => [
-        instance.getState().grouping,
-        instance.getSortedRowModel(),
-        instance.options.groupRowsFn,
-      ],
-      (grouping, rowModel, groupRowsFn) => {
-        if (!groupRowsFn || !grouping.length) {
-          return rowModel
-        }
-
-        if (process.env.NODE_ENV !== 'production' && instance.options.debug)
-          console.info('Grouping...')
-
-        return groupRowsFn(instance, rowModel)
-      },
-      {
-        key: 'getGroupedRowModel',
-        debug: instance.options.debug,
-        onChange: () => instance._notifyExpandedReset(),
-      }
-    ),
-
-    getPreGroupedRows: () => instance.getSortedRowModel().rows,
-    getPreGroupedFlatRows: () => instance.getSortedRowModel().flatRows,
-    getPreGroupedRowsById: () => instance.getSortedRowModel().rowsById,
-    getGroupedRows: () => instance.getGroupedRowModel().rows,
-    getGroupedFlatRows: () => instance.getGroupedRowModel().flatRows,
-    getGroupedRowsById: () => instance.getGroupedRowModel().rowsById,
-  }
-}
-
-export function createRow<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  row: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>,
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): GroupingRow {
-  return {
-    getIsGrouped: () => instance.getRowIsGrouped(row.id),
-  }
-}
-
-export function createCell<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  cell: Cell<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> &
-    GroupingCell,
-  column: Column<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>,
-  row: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>,
-  _instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): GroupingCell {
-  return {
-    getIsGrouped: () =>
-      column.getIsGrouped() && column.id === row.groupingColumnId,
-    getIsPlaceholder: () => !cell.getIsGrouped() && column.getIsGrouped(),
-    getIsAggregated: () =>
-      !cell.getIsGrouped() &&
-      !cell.getIsPlaceholder() &&
-      row.subRows?.length > 1,
-  }
-}
-
-export function orderColumns<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  leafColumns: Column<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[],
-  grouping: string[],
-  groupedColumnMode?: GroupingColumnMode
-) {
-  if (!grouping?.length || !groupedColumnMode) {
-    return leafColumns
-  }
-
-  const nonGroupingColumns = leafColumns.filter(
-    col => !grouping.includes(col.id)
-  )
-
-  if (groupedColumnMode === 'remove') {
-    return nonGroupingColumns
-  }
-
-  const groupingColumns = grouping
-    .map(g => leafColumns.find(col => col.id === g)!)
-    .filter(Boolean)
-
-  return [...groupingColumns, ...nonGroupingColumns]
-}