@tanstack/table-core 8.0.0-alpha.46 → 8.0.0-alpha.47

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/table-core",
   "author": "Tanner Linsley",
-  "version": "8.0.0-alpha.46",
+  "version": "8.0.0-alpha.47",
   "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<
   {

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
@@ -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>)
       },
 

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
@@ -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>)
       },
 

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>,