@tanstack/table-core 8.0.0-alpha.65 → 8.0.0-alpha.67

package/src/features/Filters.ts

@@ -32,6 +32,12 @@ export type ColumnFilter = {
   value: unknown
 }
 
+export type ResolvedColumnFilter<TGenerics extends TableGenerics> = {
+  id: string
+  resolvedValue: unknown
+  filterFn: FilterFn<TGenerics>
+}
+
 export type FilterFn<TGenerics extends TableGenerics> = {
   (row: Row<TGenerics>, columnId: string, filterValue: any): boolean
   resolveFilterValue?: TransformFilterValueFn<TGenerics>
@@ -68,13 +74,15 @@ export type FiltersColumnDef<TGenerics extends TableGenerics> = {
 
 export type FiltersColumn<TGenerics extends TableGenerics> = {
   filterFn: FilterFnOption<Overwrite<TGenerics, { Value: any }>>
-  getCanColumnFilter: () => boolean
+  getAutoFilterFn: () => FilterFn<TGenerics> | undefined
+  getFilterFn: () => FilterFn<TGenerics> | undefined
+  setFilterValue: (updater: Updater<any>) => void
+  getCanFilter: () => boolean
   getCanGlobalFilter: () => boolean
-  getColumnFilterIndex: () => number
-  getColumnIsFiltered: () => boolean
-  getColumnFilterValue: () => unknown
-  setColumnFilterValue: (updater: Updater<any>) => void
   getFacetedRowModel: () => RowModel<TGenerics>
+  getIsFiltered: () => boolean
+  getFilterValue: () => unknown
+  getFilterIndex: () => number
   getFacetedUniqueValues: () => Map<any, number>
   getFacetedMinMaxValues: () => [any, any]
 }
@@ -105,19 +113,9 @@ export type FiltersOptions<TGenerics extends TableGenerics> = {
 }
 
 export type FiltersInstance<TGenerics extends TableGenerics> = {
-  getColumnAutoFilterFn: (columnId: string) => FilterFn<TGenerics> | undefined
-
-  getColumnFilterFn: (columnId: string) => FilterFn<TGenerics> | undefined
-
   setColumnFilters: (updater: Updater<ColumnFiltersState>) => void
-  setColumnFilterValue: (columnId: string, updater: Updater<any>) => void
-  resetColumnFilters: () => void
-  getColumnCanColumnFilter: (columnId: string) => boolean
-  getColumnFacetedRowModel: (columnId: string) => RowModel<TGenerics>
 
-  getColumnIsFiltered: (columnId: string) => boolean
-  getColumnFilterValue: (columnId: string) => unknown
-  getColumnFilterIndex: (columnId: string) => number
+  resetColumnFilters: () => void
 
   // Column Filters
   getPreFilteredRowModel: () => RowModel<TGenerics>
@@ -129,7 +127,7 @@ export type FiltersInstance<TGenerics extends TableGenerics> = {
   resetGlobalFilter: () => void
   getGlobalAutoFilterFn: () => FilterFn<TGenerics> | undefined
   getGlobalFilterFn: () => FilterFn<TGenerics> | undefined
-  getColumnCanGlobalFilter: (columnId: string) => boolean
+
   getGlobalFacetedRowModel: () => RowModel<TGenerics>
   getGlobalFacetedUniqueValues: () => Map<any, number>
   getGlobalFacetedMinMaxValues: () => [number, number]
@@ -180,13 +178,112 @@ export const Filters: TableFeature = {
   ): FiltersColumn<TGenerics> => {
     return {
       filterFn: column.filterFn,
-      getCanColumnFilter: () => instance.getColumnCanColumnFilter(column.id),
-      getCanGlobalFilter: () => instance.getColumnCanGlobalFilter(column.id),
-      getColumnFilterIndex: () => instance.getColumnFilterIndex(column.id),
-      getColumnIsFiltered: () => instance.getColumnIsFiltered(column.id),
-      getColumnFilterValue: () => instance.getColumnFilterValue(column.id),
-      setColumnFilterValue: val =>
-        instance.setColumnFilterValue(column.id, val),
+      getAutoFilterFn: () => {
+        const firstRow = instance.getCoreRowModel().flatRows[0]
+
+        const value = firstRow?.values[column.id]
+
+        if (typeof value === 'string') {
+          return filterFns.includesString
+        }
+
+        if (typeof value === 'number') {
+          return filterFns.inNumberRange
+        }
+
+        if (value !== null && typeof value === 'object') {
+          return filterFns.equals
+        }
+
+        if (Array.isArray(value)) {
+          return filterFns.arrIncludes
+        }
+
+        return filterFns.weakEquals
+      },
+      getFilterFn: () => {
+        const userFilterFns = instance.options.filterFns
+
+        return isFunction(column.filterFn)
+          ? column.filterFn
+          : column.filterFn === 'auto'
+          ? column.getAutoFilterFn()
+          : (userFilterFns as Record<string, any>)?.[
+              column.filterFn as string
+            ] ??
+            (filterFns[
+              column.filterFn as BuiltInFilterFn
+            ] as FilterFn<TGenerics>)
+      },
+      getCanFilter: () => {
+        return (
+          (column.enableColumnFilter ?? true) &&
+          (instance.options.enableColumnFilters ?? true) &&
+          (instance.options.enableFilters ?? true) &&
+          !!column.accessorFn
+        )
+      },
+
+      getCanGlobalFilter: () => {
+        return (
+          (column.enableGlobalFilter ?? true) &&
+          (instance.options.enableGlobalFilter ?? true) &&
+          (instance.options.enableFilters ?? true) &&
+          (instance.options.getColumnCanGlobalFilter?.(column) ?? true) &&
+          !!column.accessorFn
+        )
+      },
+
+      getIsFiltered: () => column.getFilterIndex() > -1,
+
+      getFilterValue: () =>
+        instance.getState().columnFilters?.find(d => d.id === column.id)?.value,
+
+      getFilterIndex: () =>
+        instance.getState().columnFilters?.findIndex(d => d.id === column.id) ??
+        -1,
+
+      setFilterValue: value => {
+        instance.setColumnFilters(old => {
+          const filterFn = column.getFilterFn()
+          const previousfilter = old?.find(d => d.id === column.id)
+
+          const newFilter = functionalUpdate(
+            value,
+            previousfilter ? previousfilter.value : undefined
+          )
+
+          //
+          if (
+            shouldAutoRemoveFilter(
+              filterFn as FilterFn<TGenerics>,
+              newFilter,
+              column
+            )
+          ) {
+            return old?.filter(d => d.id !== column.id) ?? []
+          }
+
+          const newFilterObj = { id: column.id, value: newFilter }
+
+          if (previousfilter) {
+            return (
+              old?.map(d => {
+                if (d.id === column.id) {
+                  return newFilterObj
+                }
+                return d
+              }) ?? []
+            )
+          }
+
+          if (old?.length) {
+            return [...old, newFilterObj]
+          }
+
+          return [newFilterObj]
+        })
+      },
       getFacetedRowModel: memo(
         () => [
           instance.getPreFilteredRowModel(),
@@ -256,60 +353,9 @@ export const Filters: TableFeature = {
     instance: TableInstance<TGenerics>
   ): FiltersInstance<TGenerics> => {
     return {
-      getColumnAutoFilterFn: columnId => {
-        const firstRow = instance.getCoreRowModel().flatRows[0]
-
-        const value = firstRow?.values[columnId]
-
-        if (typeof value === 'string') {
-          return filterFns.includesString
-        }
-
-        if (typeof value === 'number') {
-          return filterFns.inNumberRange
-        }
-
-        if (value !== null && typeof value === 'object') {
-          return filterFns.equals
-        }
-
-        if (Array.isArray(value)) {
-          return filterFns.arrIncludes
-        }
-
-        return filterFns.weakEquals
-      },
-      getColumnFacetedRowModel: columnId => {
-        const column = instance.getColumn(columnId)
-
-        if (!column) {
-          throw new Error()
-        }
-
-        return column.getFacetedRowModel()
-      },
       getGlobalAutoFilterFn: () => {
         return filterFns.includesString
       },
-      getColumnFilterFn: columnId => {
-        const column = instance.getColumn(columnId)
-        const userFilterFns = instance.options.filterFns
-
-        if (!column) {
-          throw new Error()
-        }
-
-        return isFunction(column.filterFn)
-          ? column.filterFn
-          : column.filterFn === 'auto'
-          ? instance.getColumnAutoFilterFn(columnId)
-          : (userFilterFns as Record<string, any>)?.[
-              column.filterFn as string
-            ] ??
-            (filterFns[
-              column.filterFn as BuiltInFilterFn
-            ] as FilterFn<TGenerics>)
-      },
 
       getGlobalFilterFn: () => {
         const { filterFns: userFilterFns, globalFilterFn: globalFilterFn } =
@@ -335,7 +381,7 @@ export const Filters: TableFeature = {
             const column = leafColumns.find(d => d.id === filter.id)
 
             if (column) {
-              const filterFn = instance.getColumnFilterFn(column.id)
+              const filterFn = column.getFilterFn()
 
               if (shouldAutoRemoveFilter(filterFn, filter.value, column)) {
                 return false
@@ -357,102 +403,6 @@ export const Filters: TableFeature = {
         instance.setGlobalFilter(instance.initialState.globalFilter)
       },
 
-      getColumnCanColumnFilter: columnId => {
-        const column = instance.getColumn(columnId)
-
-        if (!column) {
-          throw new Error()
-        }
-
-        return (
-          (column.enableColumnFilter ?? true) &&
-          (instance.options.enableColumnFilters ?? true) &&
-          (instance.options.enableFilters ?? true) &&
-          !!column.accessorFn
-        )
-      },
-
-      getColumnCanGlobalFilter: columnId => {
-        const column = instance.getColumn(columnId)
-
-        if (!column) {
-          throw new Error()
-        }
-
-        return (
-          (column.enableGlobalFilter ?? true) &&
-          (instance.options.enableGlobalFilter ?? true) &&
-          (instance.options.enableFilters ?? true) &&
-          (instance.options.getColumnCanGlobalFilter?.(column) ?? true) &&
-          !!column.accessorFn
-        )
-      },
-
-      getColumnIsFiltered: columnId =>
-        instance.getColumnFilterIndex(columnId) > -1,
-
-      getColumnFilterValue: columnId =>
-        instance.getState().columnFilters?.find(d => d.id === columnId)?.value,
-
-      getColumnFilterIndex: columnId =>
-        instance.getState().columnFilters?.findIndex(d => d.id === columnId) ??
-        -1,
-
-      setColumnFilterValue: (columnId, value) => {
-        if (!columnId) return
-
-        instance.setColumnFilters(old => {
-          const column = instance.getColumn(columnId)
-
-          if (!column) {
-            if (process.env.NODE_ENV !== 'production') {
-              console.warn(
-                `Table: Could not find a column with id: ${columnId}`
-              )
-            }
-            throw new Error()
-          }
-
-          const filterFn = instance.getColumnFilterFn(column.id)
-          const previousfilter = old?.find(d => d.id === columnId)
-
-          const newFilter = functionalUpdate(
-            value,
-            previousfilter ? previousfilter.value : undefined
-          )
-
-          //
-          if (
-            shouldAutoRemoveFilter(
-              filterFn as FilterFn<TGenerics>,
-              newFilter,
-              column
-            )
-          ) {
-            return old?.filter(d => d.id !== columnId) ?? []
-          }
-
-          const newFilterObj = { id: columnId, value: newFilter }
-
-          if (previousfilter) {
-            return (
-              old?.map(d => {
-                if (d.id === columnId) {
-                  return newFilterObj
-                }
-                return d
-              }) ?? []
-            )
-          }
-
-          if (old?.length) {
-            return [...old, newFilterObj]
-          }
-
-          return [newFilterObj]
-        })
-      },
-
       resetColumnFilters: () => {
         instance.setColumnFilters(instance.initialState?.columnFilters ?? [])
       },

package/src/features/Grouping.ts

@@ -49,7 +49,6 @@ export type GroupingColumnDef<TGenerics extends TableGenerics> = {
     }
   >
   enableGrouping?: boolean
-  defaultCanGroup?: boolean
 }
 
 export type GroupingColumn<TGenerics extends TableGenerics> = {
@@ -104,12 +103,6 @@ export type GroupingInstance<TGenerics extends TableGenerics> = {
   ) => AggregationFn<TGenerics> | undefined
   setGrouping: (updater: Updater<GroupingState>) => void
   resetGrouping: () => void
-  toggleColumnGrouping: (columnId: string) => void
-  getColumnCanGroup: (columnId: string) => boolean
-  getColumnIsGrouped: (columnId: string) => boolean
-  getColumnGroupedIndex: (columnId: string) => number
-  getToggleGroupingHandler: (columnId: string) => undefined | (() => void)
-  getRowIsGrouped: (rowId: string) => boolean
   getPreGroupedRowModel: () => RowModel<TGenerics>
   getGroupedRowModel: () => RowModel<TGenerics>
   _getGroupedRowModel?: () => RowModel<TGenerics>
@@ -147,13 +140,41 @@ export const Grouping: TableFeature = {
     instance: TableInstance<TGenerics>
   ): GroupingColumn<TGenerics> => {
     return {
-      aggregationFn: column.aggregationFn,
-      getCanGroup: () => instance.getColumnCanGroup(column.id),
-      getGroupedIndex: () => instance.getColumnGroupedIndex(column.id),
-      getIsGrouped: () => instance.getColumnIsGrouped(column.id),
-      toggleGrouping: () => instance.toggleColumnGrouping(column.id),
-      getToggleGroupingHandler: () =>
-        instance.getToggleGroupingHandler(column.id)!,
+      toggleGrouping: () => {
+        instance.setGrouping(old => {
+          // Find any existing grouping for this column
+          if (old?.includes(column.id)) {
+            return old.filter(d => d !== column.id)
+          }
+
+          return [...(old ?? []), column.id]
+        })
+      },
+
+      getCanGroup: () => {
+        return (
+          column.enableGrouping ??
+          true ??
+          instance.options.enableGrouping ??
+          true ??
+          !!column.accessorFn
+        )
+      },
+
+      getIsGrouped: () => {
+        return instance.getState().grouping?.includes(column.id)
+      },
+
+      getGroupedIndex: () => instance.getState().grouping?.indexOf(column.id),
+
+      getToggleGroupingHandler: () => {
+        const canGroup = column.getCanGroup()
+
+        return () => {
+          if (!canGroup) return
+          column.toggleGrouping()
+        }
+      },
     }
   },
 
@@ -198,55 +219,10 @@ export const Grouping: TableFeature = {
 
       setGrouping: updater => instance.options.onGroupingChange?.(updater),
 
-      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.initialState?.grouping ?? [])
       },
 
-      getToggleGroupingHandler: columnId => {
-        const column = instance.getColumn(columnId)
-        const canGroup = column.getCanGroup()
-
-        return () => {
-          if (!canGroup) return
-          column.toggleGrouping?.()
-        }
-      },
-
-      getRowIsGrouped: rowId => !!instance.getRow(rowId)?.groupingColumnId,
-
       getPreGroupedRowModel: () => instance.getSortedRowModel(),
       getGroupedRowModel: () => {
         if (
@@ -271,7 +247,7 @@ export const Grouping: TableFeature = {
     instance: TableInstance<TGenerics>
   ): GroupingRow => {
     return {
-      getIsGrouped: () => instance.getRowIsGrouped(row.id),
+      getIsGrouped: () => !!row.groupingColumnId,
     }
   },
 

package/src/features/Headers.ts

@@ -72,30 +72,6 @@ export const Headers = {
           colSpan: 0,
           rowSpan: 0,
           headerGroup: null!,
-          getSize: () => {
-            let sum = 0
-
-            const recurse = (header: CoreHeader<TGenerics>) => {
-              if (header.subHeaders.length) {
-                header.subHeaders.forEach(recurse)
-              } else {
-                sum += header.column.getSize() ?? 0
-              }
-            }
-
-            recurse(header)
-
-            return sum
-          },
-          getStart: () => {
-            if (header.index > 0) {
-              const prevSiblingHeader =
-                header.headerGroup.headers[header.index - 1]
-              return prevSiblingHeader.getStart() + prevSiblingHeader.getSize()
-            }
-
-            return 0
-          },
           getLeafHeaders: (): Header<TGenerics>[] => {
             const leafHeaders: CoreHeader<TGenerics>[] = []
 
@@ -163,7 +139,7 @@ export const Headers = {
           return headerGroups
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getHeaderGroups',
+          key: process.env.NODE_ENV === 'development' && 'getHeaderGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -183,7 +159,8 @@ export const Headers = {
           return buildHeaderGroups(allColumns, leafColumns, instance, 'center')
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getCenterHeaderGroups',
+          key:
+            process.env.NODE_ENV === 'development' && 'getCenterHeaderGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -200,7 +177,7 @@ export const Headers = {
           return buildHeaderGroups(allColumns, leafColumns, instance, 'left')
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getLeftHeaderGroups',
+          key: process.env.NODE_ENV === 'development' && 'getLeftHeaderGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -217,7 +194,7 @@ export const Headers = {
           return buildHeaderGroups(allColumns, leafColumns, instance, 'right')
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getRightHeaderGroups',
+          key: process.env.NODE_ENV === 'development' && 'getRightHeaderGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -231,7 +208,7 @@ export const Headers = {
           return [...headerGroups].reverse()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getFooterGroups',
+          key: process.env.NODE_ENV === 'development' && 'getFooterGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -243,7 +220,7 @@ export const Headers = {
           return [...headerGroups].reverse()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getLeftFooterGroups',
+          key: process.env.NODE_ENV === 'development' && 'getLeftFooterGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -255,7 +232,8 @@ export const Headers = {
           return [...headerGroups].reverse()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getCenterFooterGroups',
+          key:
+            process.env.NODE_ENV === 'development' && 'getCenterFooterGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -267,7 +245,7 @@ export const Headers = {
           return [...headerGroups].reverse()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getRightFooterGroups',
+          key: process.env.NODE_ENV === 'development' && 'getRightFooterGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -285,7 +263,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getFlatHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getFlatHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -301,7 +279,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getLeftFlatHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getLeftFlatHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -317,7 +295,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getCenterFlatHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getCenterFlatHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -333,7 +311,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getRightFlatHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getRightFlatHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -347,7 +325,7 @@ export const Headers = {
           return flatHeaders.filter(header => !header.subHeaders?.length)
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getCenterLeafHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getCenterLeafHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -359,7 +337,7 @@ export const Headers = {
           return flatHeaders.filter(header => !header.subHeaders?.length)
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getLeftLeafHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getLeftLeafHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -371,7 +349,7 @@ export const Headers = {
           return flatHeaders.filter(header => !header.subHeaders?.length)
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getRightLeafHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getRightLeafHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -395,7 +373,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getLeafHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getLeafHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }

package/src/features/Ordering.ts

@@ -100,7 +100,7 @@ export const Ordering: TableFeature = {
           return orderColumns(orderedColumns, grouping, groupedColumnMode)
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getOrderColumnsFn',
+          key: process.env.NODE_ENV === 'development' && 'getOrderColumnsFn',
           // debug: () => instance.options.debugAll ?? instance.options.debugTable,
         }
       ),

package/src/features/Pagination.ts

@@ -184,7 +184,7 @@ export const Pagination: TableFeature = {
           return pageOptions
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getPageOptions',
+          key: process.env.NODE_ENV === 'development' && 'getPageOptions',
           debug: () => instance.options.debugAll ?? instance.options.debugTable,
         }
       ),