@tanstack/table-core 8.0.0-alpha.45 → 8.0.0-alpha.48

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/table-core",
   "author": "Tanner Linsley",
-  "version": "8.0.0-alpha.45",
+  "version": "8.0.0-alpha.48",
   "description": "Hooks for building lightweight, fast and extendable datagrids for React",
   "license": "MIT",
   "homepage": "https://github.com/tanstack/react-table#readme",

package/src/aggregationFns.ts

@@ -10,7 +10,7 @@ export const aggregationFns = {
   count,
 }
 
-export type BuiltInAggregationType = keyof typeof aggregationFns
+export type BuiltInAggregationFn = keyof typeof aggregationFns
 
 function sum(_getLeafValues: () => unknown[], getChildValues: () => unknown[]) {
   // It's faster to just add the aggregations together instead of

package/src/createTable.ts

@@ -1,6 +1,6 @@
-import { CustomFilterTypes, FilterFn } from './features/Filters'
-import { AggregationFn, CustomAggregationTypes } from './features/Grouping'
-import { CustomSortingTypes, SortingFn } from './features/Sorting'
+import { CustomFilterFns, FilterFn } from './features/Filters'
+import { AggregationFn, CustomAggregationFns } from './features/Grouping'
+import { CustomSortingFns, SortingFn } from './features/Sorting'
 import { ColumnDef, AccessorFn, AnyRender, AnyGenerics, Options } from './types'
 import { IfDefined, Overwrite, PartialKeys } from './utils'
 
@@ -8,9 +8,9 @@ export type TableFactory<TGenerics extends AnyGenerics> = () => Table<TGenerics>
 
 export type CreateTableOptions<
   TRender extends AnyRender,
-  TFilterFns extends CustomFilterTypes<any>,
-  TSortingFns extends CustomSortingTypes<any>,
-  TAggregationFns extends CustomAggregationTypes<any>,
+  TFilterFns extends CustomFilterFns<any>,
+  TSortingFns extends CustomSortingFns<any>,
+  TAggregationFns extends CustomAggregationFns<any>,
   TGenerics extends AnyGenerics
 > = Partial<
   {
@@ -24,13 +24,11 @@ export type CreateTableOptions<
 export type Table<TGenerics extends AnyGenerics> = {
   generics: TGenerics
   options: Partial<Options<TGenerics>>
-  setRowType: <TRow extends object>() => Table<
-    Overwrite<TGenerics, { Row: TRow }>
-  >
-  setTableMetaType: <TTableMeta extends object>() => Table<
+  setRowType: <TRow>() => Table<Overwrite<TGenerics, { Row: TRow }>>
+  setTableMetaType: <TTableMeta>() => Table<
     Overwrite<TGenerics, { TableMeta: TTableMeta }>
   >
-  setColumnMetaType: <TColumnMeta extends object>() => Table<
+  setColumnMetaType: <TColumnMeta>() => Table<
     Overwrite<TGenerics, { ColumnMeta: TColumnMeta }>
   >
   setOptions: <

package/src/features/ColumnSizing.ts

@@ -228,7 +228,7 @@ export const ColumnSizing = {
 
         const canResize = column.getCanResize()
 
-        const onResizeStart = (e: MouseEvent | TouchEvent) => {
+        const onResizeStart = (e: unknown) => {
           if (isTouchStartEvent(e)) {
             // lets not respond to multiple touches (e.g. 2 or 3 fingers)
             if (e.touches && e.touches.length > 1) {
@@ -246,7 +246,7 @@ export const ColumnSizing = {
 
           const clientX = isTouchStartEvent(e)
             ? Math.round(e.touches[0].clientX)
-            : e.clientX
+            : (e as MouseEvent).clientX
 
           const updateOffset = (
             eventType: 'move' | 'end',
@@ -446,6 +446,6 @@ export function passiveEventSupported() {
   return passiveSupported
 }
 
-function isTouchStartEvent(e: TouchEvent | MouseEvent): e is TouchEvent {
-  return e.type === 'touchstart'
+function isTouchStartEvent(e: unknown): e is TouchEvent {
+  return (e as TouchEvent).type === 'touchstart'
 }

package/src/features/Expanding.ts

@@ -42,7 +42,7 @@ export type ExpandedOptions<TGenerics extends AnyGenerics> = {
 
 export type ToggleExpandedProps = {
   title?: string
-  onClick?: (event: MouseEvent | TouchEvent) => void
+  onClick?: (event: unknown) => void
 }
 
 export type ExpandedInstance<TGenerics extends AnyGenerics> = {
@@ -217,7 +217,7 @@ export const Expanding = {
         const initialProps: ToggleExpandedProps = {
           title: canExpand ? 'Toggle Expanded' : undefined,
           onClick: canExpand
-            ? (e: MouseEvent | TouchEvent) => {
+            ? (e: unknown) => {
                 ;(e as any).persist?.()
                 instance.toggleRowExpanded(rowId)
               }
@@ -229,7 +229,7 @@ export const Expanding = {
       getToggleAllRowsExpandedProps: userProps => {
         const initialProps: ToggleExpandedProps = {
           title: 'Toggle All Expanded',
-          onClick: (e: MouseEvent | TouchEvent) => {
+          onClick: (e: unknown) => {
             ;(e as any).persist?.()
             instance.toggleAllRowsExpanded()
           },

package/src/features/Filters.ts

@@ -1,5 +1,5 @@
 import { RowModel } from '..'
-import { BuiltInFilterType, filterFns } from '../filterFns'
+import { BuiltInFilterFn, filterFns } from '../filterFns'
 import {
   Column,
   OnChangeFn,
@@ -34,7 +34,7 @@ export type ColumnFilterAutoRemoveTestFn<TGenerics extends AnyGenerics> = (
   column?: Column<TGenerics>
 ) => boolean
 
-export type CustomFilterTypes<TGenerics extends AnyGenerics> = Record<
+export type CustomFilterFns<TGenerics extends AnyGenerics> = Record<
   string,
   FilterFn<TGenerics>
 >
@@ -46,14 +46,14 @@ export type FiltersTableState = {
   globalFilterProgress: number
 }
 
-export type FilterType<TGenerics extends AnyGenerics> =
+export type FilterFnOption<TGenerics extends AnyGenerics> =
   | 'auto'
-  | BuiltInFilterType
+  | BuiltInFilterFn
   | keyof TGenerics['FilterFns']
   | FilterFn<TGenerics>
 
 export type FiltersColumnDef<TGenerics extends AnyGenerics> = {
-  filterFn?: FilterType<Overwrite<TGenerics, { Value: any }>>
+  filterFn?: FilterFnOption<Overwrite<TGenerics, { Value: any }>>
   enableAllFilters?: boolean
   enableColumnFilter?: boolean
   enableGlobalFilter?: boolean
@@ -63,7 +63,7 @@ export type FiltersColumnDef<TGenerics extends AnyGenerics> = {
 }
 
 export type FiltersColumn<TGenerics extends AnyGenerics> = {
-  filterFn: FilterType<Overwrite<TGenerics, { Value: any }>>
+  filterFn: FilterFnOption<Overwrite<TGenerics, { Value: any }>>
   getCanColumnFilter: () => boolean
   getCanGlobalFilter: () => boolean
   getColumnFilterIndex: () => number
@@ -87,7 +87,7 @@ export type FiltersOptions<TGenerics extends AnyGenerics> = {
     instance: TableInstance<TGenerics>
   ) => () => RowModel<TGenerics>
   // Global
-  globalFilterType?: FilterType<TGenerics>
+  globalFilterFn?: FilterFnOption<TGenerics>
   onGlobalFilterChange?: OnChangeFn<any>
   autoResetGlobalFilter?: boolean
   enableGlobalFilter?: boolean
@@ -161,7 +161,7 @@ export const Filters = {
       autoResetColumnFilters: true,
       filterFromLeafRows: true,
       autoResetGlobalFilter: true,
-      globalFilterType: 'auto',
+      globalFilterFn: 'auto',
       getColumnCanGlobalFilterFn: column => {
         const value = instance
           .getCoreRowModel()
@@ -291,7 +291,7 @@ export const Filters = {
       },
       getColumnFilterFn: columnId => {
         const column = instance.getColumn(columnId)
-        const userFilterTypes = instance.options.filterFns
+        const userFilterFns = instance.options.filterFns
 
         if (!column) {
           throw new Error()
@@ -301,27 +301,27 @@ export const Filters = {
           ? column.filterFn
           : column.filterFn === 'auto'
           ? instance.getColumnAutoFilterFn(columnId)
-          : (userFilterTypes as Record<string, any>)?.[
+          : (userFilterFns as Record<string, any>)?.[
               column.filterFn as string
             ] ??
             (filterFns[
-              column.filterFn as BuiltInFilterType
+              column.filterFn as BuiltInFilterFn
             ] as FilterFn<TGenerics>)
       },
 
       getGlobalFilterFn: () => {
-        const { filterFns: userFilterTypes, globalFilterType } =
+        const { filterFns: userFilterFns, globalFilterFn: globalFilterFn } =
           instance.options
 
-        return isFunction(globalFilterType)
-          ? globalFilterType
-          : globalFilterType === 'auto'
+        return isFunction(globalFilterFn)
+          ? globalFilterFn
+          : globalFilterFn === 'auto'
           ? instance.getGlobalAutoFilterFn()
-          : (userFilterTypes as Record<string, any>)?.[
-              globalFilterType as string
+          : (userFilterFns as Record<string, any>)?.[
+              globalFilterFn as string
             ] ??
             (filterFns[
-              globalFilterType as BuiltInFilterType
+              globalFilterFn as BuiltInFilterFn
             ] as FilterFn<TGenerics>)
       },
 

package/src/features/Grouping.ts

@@ -1,5 +1,5 @@
 import { RowModel } from '..'
-import { BuiltInAggregationType, aggregationFns } from '../aggregationFns'
+import { BuiltInAggregationFn, aggregationFns } from '../aggregationFns'
 import {
   Cell,
   Column,
@@ -30,14 +30,14 @@ export type AggregationFn<TGenerics extends AnyGenerics> = (
   getChildValues: () => TGenerics['Row'][]
 ) => any
 
-export type CustomAggregationTypes<TGenerics extends AnyGenerics> = Record<
+export type CustomAggregationFns<TGenerics extends AnyGenerics> = Record<
   string,
   AggregationFn<TGenerics>
 >
 
-export type AggregationType<TGenerics extends AnyGenerics> =
+export type AggregationFnOption<TGenerics extends AnyGenerics> =
   | 'auto'
-  | BuiltInAggregationType
+  | BuiltInAggregationFn
   | keyof TGenerics['AggregationFns']
   | AggregationFn<TGenerics>
 
@@ -46,7 +46,7 @@ export type GroupingTableState = {
 }
 
 export type GroupingColumnDef<TGenerics extends AnyGenerics> = {
-  aggregationFn?: AggregationType<Overwrite<TGenerics, { Value: any }>>
+  aggregationFn?: AggregationFnOption<Overwrite<TGenerics, { Value: any }>>
   aggregateValue?: (columnValue: unknown) => any
   aggregatedCell?: Renderable<
     TGenerics,
@@ -63,7 +63,7 @@ export type GroupingColumnDef<TGenerics extends AnyGenerics> = {
 }
 
 export type GroupingColumn<TGenerics extends AnyGenerics> = {
-  aggregationFn?: AggregationType<Overwrite<TGenerics, { Value: any }>>
+  aggregationFn?: AggregationFnOption<Overwrite<TGenerics, { Value: any }>>
   getCanGroup: () => boolean
   getIsGrouped: () => boolean
   getGroupedIndex: () => number
@@ -110,7 +110,7 @@ export type GroupingColumnMode = false | 'reorder' | 'remove'
 
 export type ToggleGroupingProps = {
   title?: string
-  onClick?: (event: MouseEvent | TouchEvent) => void
+  onClick?: (event: unknown) => void
 }
 
 export type GroupingInstance<TGenerics extends AnyGenerics> = {
@@ -221,7 +221,7 @@ export const Grouping = {
       },
       getColumnAggregationFn: columnId => {
         const column = instance.getColumn(columnId)
-        const userAggregationTypes = instance.options.aggregationFns
+        const userAggregationFns = instance.options.aggregationFns
 
         if (!column) {
           throw new Error()
@@ -231,11 +231,11 @@ export const Grouping = {
           ? column.aggregationFn
           : column.aggregationFn === 'auto'
           ? instance.getColumnAutoAggregationFn(columnId)
-          : (userAggregationTypes as Record<string, any>)?.[
+          : (userAggregationFns as Record<string, any>)?.[
               column.aggregationFn as string
             ] ??
             (aggregationFns[
-              column.aggregationFn as BuiltInAggregationType
+              column.aggregationFn as BuiltInAggregationFn
             ] as AggregationFn<TGenerics>)
       },
 
@@ -290,7 +290,7 @@ export const Grouping = {
         const initialProps: ToggleGroupingProps = {
           title: canGroup ? 'Toggle Grouping' : undefined,
           onClick: canGroup
-            ? (e: MouseEvent | TouchEvent) => {
+            ? (e: unknown) => {
                 column.toggleGrouping?.()
               }
             : undefined,

package/src/features/RowSelection.ts

@@ -28,8 +28,8 @@ export type RowSelectionOptions<TGenerics extends AnyGenerics> = {
   //   | ((
   //       row: Row<TGenerics>
   //     ) => boolean)
-  // isAdditiveSelectEvent?: (e: MouseEvent | TouchEvent) => boolean
-  // isInclusiveSelectEvent?: (e: MouseEvent | TouchEvent) => boolean
+  // isAdditiveSelectEvent?: (e: unknown) => boolean
+  // isInclusiveSelectEvent?: (e: unknown) => boolean
   // selectRowsFn?: (
   //   instance: TableInstance<
   //     TData,
@@ -43,7 +43,7 @@ export type RowSelectionOptions<TGenerics extends AnyGenerics> = {
 }
 
 type ToggleRowSelectedProps = {
-  onChange?: (e: MouseEvent | TouchEvent) => void
+  onChange?: (e: unknown) => void
   checked?: boolean
   title?: string
   indeterminate?: boolean
@@ -116,8 +116,8 @@ export const RowSelection = {
       enableMultiRowSelection: true,
       enableSubRowSelection: true,
       // enableGroupingRowSelection: false,
-      // isAdditiveSelectEvent: (e: MouseEvent | TouchEvent) => !!e.metaKey,
-      // isInclusiveSelectEvent: (e: MouseEvent | TouchEvent) => !!e.shiftKey,
+      // isAdditiveSelectEvent: (e: unknown) => !!e.metaKey,
+      // isInclusiveSelectEvent: (e: unknown) => !!e.shiftKey,
     }
   },
 
@@ -473,8 +473,10 @@ export const RowSelection = {
 
         const initialProps: ToggleRowSelectedProps = {
           onChange: canSelect
-            ? (e: MouseEvent | TouchEvent) => {
-                row.toggleSelected((e.target as HTMLInputElement).checked)
+            ? (e: unknown) => {
+                row.toggleSelected(
+                  ((e as MouseEvent).target as HTMLInputElement).checked
+                )
               }
             : undefined,
           checked: isSelected,
@@ -504,9 +506,9 @@ export const RowSelection = {
         const isAllRowsSelected = instance.getIsAllRowsSelected()
 
         const initialProps: ToggleRowSelectedProps = {
-          onChange: (e: MouseEvent | TouchEvent) => {
+          onChange: (e: unknown) => {
             instance.toggleAllRowsSelected(
-              (e.target as HTMLInputElement).checked
+              ((e as MouseEvent).target as HTMLInputElement).checked
             )
           },
           checked: isAllRowsSelected,
@@ -522,9 +524,9 @@ export const RowSelection = {
         const isAllPageRowsSelected = instance.getIsAllPageRowsSelected()
 
         const initialProps: ToggleRowSelectedProps = {
-          onChange: (e: MouseEvent | TouchEvent) => {
+          onChange: (e: unknown) => {
             instance.toggleAllPageRowsSelected(
-              (e.target as HTMLInputElement).checked
+              ((e as MouseEvent).target as HTMLInputElement).checked
             )
           },
           checked: isAllPageRowsSelected,

package/src/features/Sorting.ts

@@ -1,5 +1,9 @@
 import { RowModel } from '..'
-import { BuiltInSortType, reSplitAlphaNumeric, sortingFns } from '../sortingFns'
+import {
+  BuiltInSortingFn,
+  reSplitAlphaNumeric,
+  sortingFns,
+} from '../sortingFns'
 
 import {
   Column,
@@ -36,7 +40,7 @@ export type SortingFn<TGenerics extends AnyGenerics> = {
   (rowA: Row<TGenerics>, rowB: Row<TGenerics>, columnId: string): number
 }
 
-export type CustomSortingTypes<TGenerics extends AnyGenerics> = Record<
+export type CustomSortingFns<TGenerics extends AnyGenerics> = Record<
   string,
   SortingFn<TGenerics>
 >
@@ -45,14 +49,14 @@ export type SortingTableState = {
   sorting: SortingState
 }
 
-export type SortType<TGenerics extends AnyGenerics> =
+export type SortingFnOption<TGenerics extends AnyGenerics> =
   | 'auto'
-  | BuiltInSortType
+  | BuiltInSortingFn
   | keyof TGenerics['SortingFns']
   | SortingFn<TGenerics>
 
 export type SortingColumnDef<TGenerics extends AnyGenerics> = {
-  sortingFn?: SortType<Overwrite<TGenerics, { Value: any }>>
+  sortingFn?: SortingFnOption<Overwrite<TGenerics, { Value: any }>>
   sortDescFirst?: boolean
   enableSorting?: boolean
   enableMultiSort?: boolean
@@ -62,7 +66,7 @@ export type SortingColumnDef<TGenerics extends AnyGenerics> = {
 }
 
 export type SortingColumn<TGenerics extends AnyGenerics> = {
-  sortingFn: SortType<Overwrite<TGenerics, { Value: any }>>
+  sortingFn: SortingFnOption<Overwrite<TGenerics, { Value: any }>>
   getCanSort: () => boolean
   getCanMultiSort: () => boolean
   getSortIndex: () => number
@@ -87,12 +91,12 @@ export type SortingOptions<TGenerics extends AnyGenerics> = {
     instance: TableInstance<TGenerics>
   ) => () => RowModel<TGenerics>
   maxMultiSortColCount?: number
-  isMultiSortEvent?: (e: MouseEvent | TouchEvent) => boolean
+  isMultiSortEvent?: (e: unknown) => boolean
 }
 
 export type ToggleSortingProps = {
   title?: string
-  onClick?: (event: MouseEvent | TouchEvent) => void
+  onClick?: (event: unknown) => void
 }
 
 export type SortingInstance<TGenerics extends AnyGenerics> = {
@@ -145,8 +149,8 @@ export const Sorting = {
     return {
       onSortingChange: makeStateUpdater('sorting', instance),
       autoResetSorting: true,
-      isMultiSortEvent: (e: MouseEvent | TouchEvent) => {
-        return e.shiftKey
+      isMultiSortEvent: (e: unknown) => {
+        return (e as MouseEvent).shiftKey
       },
     }
   },
@@ -236,7 +240,7 @@ export const Sorting = {
       },
       getColumnSortingFn: columnId => {
         const column = instance.getColumn(columnId)
-        const userSortTypes = instance.options.sortingFns
+        const userSortingFn = instance.options.sortingFns
 
         if (!column) {
           throw new Error()
@@ -246,11 +250,11 @@ export const Sorting = {
           ? column.sortingFn
           : column.sortingFn === 'auto'
           ? instance.getColumnAutoSortingFn(columnId)
-          : (userSortTypes as Record<string, any>)?.[
+          : (userSortingFn as Record<string, any>)?.[
               column.sortingFn as string
             ] ??
             (sortingFns[
-              column.sortingFn as BuiltInSortType
+              column.sortingFn as BuiltInSortingFn
             ] as SortingFn<TGenerics>)
       },
 
@@ -428,7 +432,7 @@ export const Sorting = {
         const initialProps: ToggleSortingProps = {
           title: canSort ? 'Toggle Sorting' : undefined,
           onClick: canSort
-            ? (e: MouseEvent | TouchEvent) => {
+            ? (e: unknown) => {
                 ;(e as any).persist?.()
                 column.toggleSorting?.(
                   undefined,

package/src/features/Visibility.ts

@@ -102,8 +102,10 @@ export const Visibility = {
           type: 'checkbox',
           checked: column.getIsVisible?.(),
           title: 'Toggle Column Visibility',
-          onChange: (e: MouseEvent | TouchEvent) => {
-            column.toggleVisibility?.((e.target as HTMLInputElement).checked)
+          onChange: (e: unknown) => {
+            column.toggleVisibility?.(
+              ((e as MouseEvent).target as HTMLInputElement).checked
+            )
           },
         }
 

package/src/filterFns.ts

@@ -12,7 +12,7 @@ export const filterFns = {
   betweenNumberRange,
 }
 
-export type BuiltInFilterType = keyof typeof filterFns
+export type BuiltInFilterFn = keyof typeof filterFns
 
 function includesString<TGenerics extends AnyGenerics>(
   rows: Row<TGenerics>[],

package/src/sortingFns.ts

@@ -1,4 +1,4 @@
-import { PartialGenerics, AnyGenerics, Row } from './types'
+import { AnyGenerics, Row } from './types'
 
 export const reSplitAlphaNumeric = /([0-9]+)/gm
 
@@ -11,7 +11,7 @@ export const sortingFns = {
   basic,
 }
 
-export type BuiltInSortType = keyof typeof sortingFns
+export type BuiltInSortingFn = keyof typeof sortingFns
 
 function alphanumeric<TGenerics extends AnyGenerics>(
   rowA: Row<TGenerics>,