@tanstack/react-table 8.0.0-alpha.6 → 8.0.0-alpha.9

package/src/features/Sorting.ts

@@ -7,8 +7,9 @@ import {
   Getter,
   Header,
   OnChangeFn,
+  PartialGenerics,
   PropGetterValue,
-  ReactTable,
+  TableInstance,
   Row,
   Updater,
 } from '../types'
@@ -18,6 +19,7 @@ import {
   isFunction,
   makeStateUpdater,
   memo,
+  Overwrite,
   propGetter,
 } from '../utils'
 
@@ -30,27 +32,27 @@ export type ColumnSort = {
 
 export type SortingState = ColumnSort[]
 
-export type SortingFn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> =
-  {
-    (
-      rowA: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>,
-      rowB: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>,
-      columnId: string
-    ): number
-  }
+export type SortingFn<TGenerics extends PartialGenerics> = {
+  (rowA: Row<TGenerics>, rowB: Row<TGenerics>, columnId: string): number
+}
+
+export type CustomSortingTypes<TGenerics extends PartialGenerics> = Record<
+  string,
+  SortingFn<TGenerics>
+>
 
 export type SortingTableState = {
   sorting: SortingState
 }
 
-export type SortType<TSortingFns> =
+export type SortType<TGenerics extends PartialGenerics> =
   | 'auto'
   | BuiltInSortType
-  | keyof TSortingFns
-  | SortingFn<any, any, any, TSortingFns, any>
+  | keyof TGenerics['SortingFns']
+  | SortingFn<TGenerics>
 
-export type SortingColumnDef<TFilterFns> = {
-  sortType?: SortType<TFilterFns>
+export type SortingColumnDef<TGenerics extends PartialGenerics> = {
+  sortType?: SortType<Overwrite<TGenerics, { Value: any }>>
   sortDescFirst?: boolean
   enableSorting?: boolean
   enableMultiSort?: boolean
@@ -59,14 +61,8 @@ export type SortingColumnDef<TFilterFns> = {
   sortUndefined?: false | -1 | 1
 }
 
-export type SortingColumn<
-  _TData,
-  _TValue,
-  TFilterFns,
-  _TSortingFns,
-  _TAggregationFns
-> = {
-  sortType: SortType<TFilterFns>
+export type SortingColumn<TGenerics extends PartialGenerics> = {
+  sortType: SortType<Overwrite<TGenerics, { Value: any }>>
   getCanSort: () => boolean
   getCanMultiSort: () => boolean
   getSortIndex: () => number
@@ -77,14 +73,8 @@ export type SortingColumn<
   ) => undefined | PropGetterValue<ToggleSortingProps, TGetter>
 }
 
-export type SortingOptions<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
-> = {
-  sortTypes?: TSortingFns
+export type SortingOptions<TGenerics extends PartialGenerics> = {
+  sortTypes?: TGenerics['SortingFns']
   onSortingChange?: OnChangeFn<SortingState>
   autoResetSorting?: boolean
   enableSorting?: boolean
@@ -93,15 +83,9 @@ export type SortingOptions<
   enableMultiSort?: boolean
   sortDescFirst?: boolean
   sortRowsFn?: (
-    instance: ReactTable<
-      TData,
-      TValue,
-      TFilterFns,
-      TSortingFns,
-      TAggregationFns
-    >,
-    rowModel: RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-  ) => RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
+    instance: TableInstance<TGenerics>,
+    rowModel: RowModel<TGenerics>
+  ) => RowModel<TGenerics>
   maxMultiSortColCount?: number
   isMultiSortEvent?: (e: MouseEvent | TouchEvent) => boolean
 }
@@ -111,22 +95,12 @@ export type ToggleSortingProps = {
   onClick?: (event: MouseEvent | TouchEvent) => void
 }
 
-export type SortingInstance<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
-> = {
+export type SortingInstance<TGenerics extends PartialGenerics> = {
   _notifySortingReset: () => void
-  getColumnAutoSortingFn: (
-    columnId: string
-  ) => SortingFn<any, any, any, any, any> | undefined
+  getColumnAutoSortingFn: (columnId: string) => SortingFn<TGenerics> | undefined
   getColumnAutoSortDir: (columnId: string) => SortDirection
 
-  getColumnSortingFn: (
-    columnId: string
-  ) => SortingFn<any, any, any, any, any> | undefined
+  getColumnSortingFn: (columnId: string) => SortingFn<TGenerics> | undefined
 
   setSorting: (updater: Updater<SortingState>) => void
   toggleColumnSorting: (
@@ -143,54 +117,15 @@ export type SortingInstance<
     columnId: string,
     userProps?: TGetter
   ) => undefined | PropGetterValue<ToggleSortingProps, TGetter>
-  getSortedRowModel: () => RowModel<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >
-  getPreSortedRows: () => Row<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-  getPreSortedFlatRows: () => Row<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-  getPreSortedRowsById: () => Record<
-    string,
-    Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-  >
-  getSortedRows: () => Row<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-  getSortedFlatRows: () => Row<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-  getSortedRowsById: () => Record<
-    string,
-    Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-  >
+  getPreSortedRowModel: () => RowModel<TGenerics>
+  getSortedRowModel: () => RowModel<TGenerics>
 }
 
 //
 
-export function getDefaultColumn<TFilterFns>(): SortingColumnDef<TFilterFns> {
+export function getDefaultColumn<
+  TGenerics extends PartialGenerics
+>(): SortingColumnDef<TGenerics> {
   return {
     sortType: 'auto',
   }
@@ -202,15 +137,9 @@ export function getInitialState(): SortingTableState {
   }
 }
 
-export function getDefaultOptions<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): SortingOptions<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> {
+export function getDefaultOptions<TGenerics extends PartialGenerics>(
+  instance: TableInstance<TGenerics>
+): SortingOptions<TGenerics> {
   return {
     onSortingChange: makeStateUpdater('sorting', instance),
     autoResetSorting: true,
@@ -220,16 +149,10 @@ export function getDefaultOptions<
   }
 }
 
-export function createColumn<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  column: Column<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>,
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): SortingColumn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> {
+export function createColumn<TGenerics extends PartialGenerics>(
+  column: Column<TGenerics>,
+  instance: TableInstance<TGenerics>
+): SortingColumn<TGenerics> {
   return {
     sortType: column.sortType,
     getCanSort: () => instance.getColumnCanSort(column.id),
@@ -243,15 +166,9 @@ export function createColumn<
   }
 }
 
-export function getInstance<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): SortingInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> {
+export function getInstance<TGenerics extends PartialGenerics>(
+  instance: TableInstance<TGenerics>
+): SortingInstance<TGenerics> {
   let registered = false
 
   return {
@@ -323,13 +240,9 @@ export function getInstance<
         : column.sortType === 'auto'
         ? instance.getColumnAutoSortingFn(columnId)
         : (userSortTypes as Record<string, any>)?.[column.sortType as string] ??
-          (sortTypes[column.sortType as BuiltInSortType] as SortingFn<
-            TData,
-            TValue,
-            TFilterFns,
-            TSortingFns,
-            TAggregationFns
-          >)
+          (sortTypes[
+            column.sortType as BuiltInSortType
+          ] as SortingFn<TGenerics>)
     },
 
     setSorting: updater =>
@@ -514,6 +427,7 @@ export function getInstance<
       return propGetter(initialProps, userProps)
     },
 
+    getPreSortedRowModel: () => instance.getGlobalFilteredRowModel(),
     getSortedRowModel: memo(
       () => [
         instance.getState().sorting,
@@ -525,23 +439,15 @@ export function getInstance<
           return rowModel
         }
 
-        if (process.env.NODE_ENV !== 'production' && instance.options.debug)
-          console.info('Sorting...')
-
         return sortingFn(instance, rowModel)
       },
       {
         key: 'getSortedRowModel',
-        debug: instance.options.debug,
-        onChange: () => instance._notifyGroupingReset(),
+        debug: () => instance.options.debugAll ?? instance.options.debugTable,
+        onChange: () => {
+          instance._notifyGroupingReset()
+        },
       }
     ),
-
-    getPreSortedRows: () => instance.getGlobalFilteredRowModel().rows,
-    getPreSortedFlatRows: () => instance.getGlobalFilteredRowModel().flatRows,
-    getPreSortedRowsById: () => instance.getGlobalFilteredRowModel().rowsById,
-    getSortedRows: () => instance.getSortedRowModel().rows,
-    getSortedFlatRows: () => instance.getSortedRowModel().flatRows,
-    getSortedRowsById: () => instance.getSortedRowModel().rowsById,
   }
 }

package/src/features/Visibility.ts

@@ -3,8 +3,9 @@ import {
   Column,
   Getter,
   OnChangeFn,
+  PartialGenerics,
   PropGetterValue,
-  ReactTable,
+  TableInstance,
   Updater,
 } from '../types'
 import { functionalUpdate, makeStateUpdater, memo, propGetter } from '../utils'
@@ -24,27 +25,9 @@ export type VisibilityTableState = {
   columnVisibility: VisibilityState
 }
 
-export type VisibilityInstance<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
-> = {
-  getVisibleFlatColumns: () => Column<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-  getVisibleLeafColumns: () => Column<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
+export type VisibilityInstance<TGenerics extends PartialGenerics> = {
+  getVisibleFlatColumns: () => Column<TGenerics>[]
+  getVisibleLeafColumns: () => Column<TGenerics>[]
   setColumnVisibility: (updater: Updater<VisibilityState>) => void
   toggleColumnVisibility: (columnId: string, value?: boolean) => void
   toggleAllColumnsVisible: (value?: boolean) => void
@@ -67,20 +50,8 @@ export type VisibilityColumnDef = {
   defaultCanHide?: boolean
 }
 
-export type VisibilityRow<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
-> = {
-  getVisibleCells: () => Cell<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
+export type VisibilityRow<TGenerics extends PartialGenerics> = {
+  getVisibleCells: () => Cell<TGenerics>[]
 }
 
 export type VisibilityColumn = {
@@ -100,14 +71,8 @@ export function getInitialState(): VisibilityTableState {
   }
 }
 
-export function getDefaultOptions<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
+export function getDefaultOptions<TGenerics extends PartialGenerics>(
+  instance: TableInstance<TGenerics>
 ): VisibilityDefaultOptions {
   return {
     onColumnVisibilityChange: makeStateUpdater('columnVisibility', instance),
@@ -120,15 +85,9 @@ export function getDefaultColumn() {
   }
 }
 
-export function createColumn<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  column: Column<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>,
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
+export function createColumn<TGenerics extends PartialGenerics>(
+  column: Column<TGenerics>,
+  instance: TableInstance<TGenerics>
 ): VisibilityColumn {
   return {
     getCanHide: () => instance.getColumnCanHide(column.id),
@@ -150,15 +109,9 @@ export function createColumn<
   }
 }
 
-export function getInstance<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): VisibilityInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> {
+export function getInstance<TGenerics extends PartialGenerics>(
+  instance: TableInstance<TGenerics>
+): VisibilityInstance<TGenerics> {
   return {
     getVisibleFlatColumns: memo(
       () => [
@@ -172,7 +125,10 @@ export function getInstance<
       allFlatColumns => {
         return allFlatColumns.filter(d => d.getIsVisible?.())
       },
-      { key: 'getVisibleFlatColumns', debug: instance.options.debug }
+      {
+        key: 'getVisibleFlatColumns',
+        debug: () => instance.options.debugAll ?? instance.options.debugColumns,
+      }
     ),
 
     getVisibleLeafColumns: memo(
@@ -187,7 +143,10 @@ export function getInstance<
       allFlatColumns => {
         return allFlatColumns.filter(d => d.getIsVisible?.())
       },
-      { key: 'getVisibleLeafColumns', debug: instance.options.debug }
+      {
+        key: 'getVisibleLeafColumns',
+        debug: () => instance.options.debugAll ?? instance.options.debugColumns,
+      }
     ),
 
     setColumnVisibility: updater =>

package/src/filterTypes.ts

@@ -1,4 +1,4 @@
-import { AccessorFn, Row } from './types'
+import { AccessorFn, PartialGenerics, Row } from './types'
 
 export const filterTypes = {
   includesString,
@@ -14,15 +14,8 @@ export const filterTypes = {
 
 export type BuiltInFilterType = keyof typeof filterTypes
 
-function includesString<
-  TData,
-  TValue,
-  TAccessor extends AccessorFn<TData>,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  rows: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[],
+function includesString<TGenerics extends PartialGenerics>(
+  rows: Row<TGenerics>[],
   columnIds: string[],
   filterValue: unknown
 ) {
@@ -38,15 +31,8 @@ function includesString<
 
 includesString.autoRemove = (val: any) => testFalsey(val)
 
-function includesStringSensitive<
-  TData,
-  TValue,
-  TAccessor extends AccessorFn<TData>,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  rows: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[],
+function includesStringSensitive<TGenerics extends PartialGenerics>(
+  rows: Row<TGenerics>[],
   columnIds: string[],
   filterValue: unknown
 ) {
@@ -62,15 +48,8 @@ function includesStringSensitive<
 
 includesStringSensitive.autoRemove = (val: any) => testFalsey(val)
 
-function equalsString<
-  TData,
-  TValue,
-  TAccessor extends AccessorFn<TData>,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  rows: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[],
+function equalsString<TGenerics extends PartialGenerics>(
+  rows: Row<TGenerics>[],
   columnIds: string[],
   filterValue: unknown
 ) {
@@ -88,15 +67,8 @@ function equalsString<
 
 equalsString.autoRemove = (val: any) => testFalsey(val)
 
-function equalsStringSensitive<
-  TData,
-  TValue,
-  TAccessor extends AccessorFn<TData>,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  rows: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[],
+function equalsStringSensitive<TGenerics extends PartialGenerics>(
+  rows: Row<TGenerics>[],
   columnIds: string[],
   filterValue: unknown
 ) {
@@ -111,15 +83,8 @@ function equalsStringSensitive<
 
 equalsStringSensitive.autoRemove = (val: any) => testFalsey(val)
 
-function arrIncludes<
-  TData,
-  TValue,
-  TAccessor extends AccessorFn<TData>,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  rows: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[],
+function arrIncludes<TGenerics extends PartialGenerics>(
+  rows: Row<TGenerics>[],
   columnIds: string[],
   filterValue: unknown
 ) {
@@ -133,15 +98,8 @@ function arrIncludes<
 
 arrIncludes.autoRemove = (val: any) => testFalsey(val) || !val?.length
 
-function arrIncludesAll<
-  TData,
-  TValue,
-  TAccessor extends AccessorFn<TData>,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  rows: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[],
+function arrIncludesAll<TGenerics extends PartialGenerics>(
+  rows: Row<TGenerics>[],
   columnIds: string[],
   filterValue: unknown[]
 ) {
@@ -159,15 +117,8 @@ function arrIncludesAll<
 
 arrIncludesAll.autoRemove = (val: any) => testFalsey(val) || !val?.length
 
-function equals<
-  TData,
-  TValue,
-  TAccessor extends AccessorFn<TData>,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  rows: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[],
+function equals<TGenerics extends PartialGenerics>(
+  rows: Row<TGenerics>[],
   columnIds: string[],
   filterValue: unknown
 ) {
@@ -181,15 +132,8 @@ function equals<
 
 equals.autoRemove = (val: any) => testFalsey(val)
 
-function weakEquals<
-  TData,
-  TValue,
-  TAccessor extends AccessorFn<TData>,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  rows: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[],
+function weakEquals<TGenerics extends PartialGenerics>(
+  rows: Row<TGenerics>[],
   columnIds: string[],
   filterValue: unknown
 ) {
@@ -204,15 +148,8 @@ function weakEquals<
 
 weakEquals.autoRemove = (val: any) => testFalsey(val)
 
-function betweenNumberRange<
-  TData,
-  TValue,
-  TAccessor extends AccessorFn<TData>,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  rows: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[],
+function betweenNumberRange<TGenerics extends PartialGenerics>(
+  rows: Row<TGenerics>[],
   columnIds: string[],
   filterValue: [unknown, unknown]
 ) {

package/src/index.tsx

@@ -1,4 +1,5 @@
 export * from './types'
+export * from './utils'
 export * from './utils/columnFilterRowsFn'
 export * from './utils/globalFilterRowsFn'
 export * from './utils/sortRowsFn'