@tanstack/table-core 8.4.0 → 8.5.0

package/build/types/index.d.ts

@@ -239,7 +239,7 @@ declare type FilterFn<TData extends RowData> = {
 declare type TransformFilterValueFn<TData extends RowData> = (value: any, column?: Column<TData, unknown>) => unknown;
 declare type ColumnFilterAutoRemoveTestFn<TData extends RowData> = (value: any, column?: Column<TData, unknown>) => boolean;
 declare type CustomFilterFns<TData extends RowData> = Record<string, FilterFn<TData>>;
-declare type FilterFnOption<TData extends RowData> = 'auto' | BuiltInFilterFn | FilterFn<TData>;
+declare type FilterFnOption<TData extends RowData> = 'auto' | BuiltInFilterFn | keyof FilterFns | FilterFn<TData>;
 declare type FiltersColumnDef<TData extends RowData> = {
     filterFn?: FilterFnOption<TData>;
     enableColumnFilter?: boolean;
@@ -279,7 +279,11 @@ declare type FiltersOptions<TData extends RowData> = {
     getFacetedRowModel?: (table: Table<TData>, columnId: string) => () => RowModel<TData>;
     getFacetedUniqueValues?: (table: Table<TData>, columnId: string) => () => Map<any, number>;
     getFacetedMinMaxValues?: (table: Table<TData>, columnId: string) => () => undefined | [number, number];
-};
+} & (keyof FilterFns extends never ? {
+    filterFns?: Record<string, FilterFn<any>>;
+} : {
+    filterFns: Record<keyof FilterFns, FilterFn<any>>;
+});
 declare type FiltersInstance<TData extends RowData> = {
     setColumnFilters: (updater: Updater<ColumnFiltersState>) => void;
     resetColumnFilters: (defaultState?: boolean) => void;
@@ -324,7 +328,7 @@ declare type SortingFn<TData extends RowData> = {
     (rowA: Row<TData>, rowB: Row<TData>, columnId: string): number;
 };
 declare type CustomSortingFns<TData extends RowData> = Record<string, SortingFn<TData>>;
-declare type SortingFnOption<TData extends RowData> = 'auto' | BuiltInSortingFn | SortingFn<TData>;
+declare type SortingFnOption<TData extends RowData> = 'auto' | keyof SortingFns | BuiltInSortingFn | SortingFn<TData>;
 declare type SortingColumnDef<TData extends RowData> = {
     sortingFn?: SortingFnOption<TData>;
     sortDescFirst?: boolean;
@@ -358,7 +362,11 @@ declare type SortingOptions<TData extends RowData> = {
     getSortedRowModel?: (table: Table<any>) => () => RowModel<any>;
     maxMultiSortColCount?: number;
     isMultiSortEvent?: (e: unknown) => boolean;
-};
+} & (keyof SortingFns extends never ? {
+    sortingFns?: Record<string, SortingFn<any>>;
+} : {
+    sortingFns: Record<keyof SortingFns, SortingFn<any>>;
+});
 declare type SortingInstance<TData extends RowData> = {
     setSorting: (updater: Updater<SortingState>) => void;
     resetSorting: (defaultState?: boolean) => void;
@@ -387,7 +395,7 @@ declare type GroupingTableState = {
 };
 declare type AggregationFn<TData extends RowData> = (columnId: string, leafRows: Row<TData>[], childRows: Row<TData>[]) => any;
 declare type CustomAggregationFns = Record<string, AggregationFn<any>>;
-declare type AggregationFnOption<TData extends RowData> = 'auto' | BuiltInAggregationFn | AggregationFn<TData>;
+declare type AggregationFnOption<TData extends RowData> = 'auto' | keyof AggregationFns | BuiltInAggregationFn | AggregationFn<TData>;
 declare type GroupingColumnDef<TData extends RowData, TValue> = {
     aggregationFn?: AggregationFnOption<TData>;
     aggregatedCell?: ColumnDefTemplate<ReturnType<Cell<TData, TValue>['getContext']>>;
@@ -423,7 +431,11 @@ declare type GroupingOptions = {
     enableGrouping?: boolean;
     getGroupedRowModel?: (table: Table<any>) => () => RowModel<any>;
     groupedColumnMode?: false | 'reorder' | 'remove';
-};
+} & (keyof AggregationFns extends never ? {
+    aggregationFns?: Record<string, AggregationFn<any>>;
+} : {
+    aggregationFns: Record<keyof AggregationFns, AggregationFn<any>>;
+});
 declare type GroupingColumnMode = false | 'reorder' | 'remove';
 declare type GroupingInstance<TData extends RowData> = {
     setGrouping: (updater: Updater<GroupingState>) => void;
@@ -637,6 +649,12 @@ interface ColumnMeta<TData extends RowData, TValue> {
 }
 interface FilterMeta {
 }
+interface FilterFns {
+}
+interface SortingFns {
+}
+interface AggregationFns {
+}
 declare type Updater<T> = T | ((old: T) => T);
 declare type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void;
 declare type RowData = unknown | object | any[];
@@ -749,6 +767,7 @@ declare function createTable<TData extends RowData>(options: TableOptionsResolve
 declare type ColumnHelper<TData extends RowData> = {
     accessor: <TAccessor extends AccessorFn<TData> | DeepKeys<TData>, TValue extends TAccessor extends AccessorFn<TData, infer TReturn> ? TReturn : TAccessor extends DeepKeys<TData> ? DeepValue<TData, TAccessor> : never>(accessor: TAccessor, column: Omit<ColumnDef<TData, TValue>, 'accessorKey'>) => ColumnDef<TData, TValue>;
     display: (column: RequiredKeys<Omit<ColumnDef<TData, unknown>, 'accessorKey' | 'accessorFn'>, 'id'>) => ColumnDef<TData, unknown>;
+    group: (column: RequiredKeys<Omit<ColumnDef<TData, unknown>, 'accessorKey' | 'accessorFn'>, 'id' | 'columns'>) => ColumnDef<TData, unknown>;
 };
 declare function createColumnHelper<TData extends RowData>(): ColumnHelper<TData>;
 
@@ -777,4 +796,4 @@ declare function getPaginationRowModel<TData extends RowData>(opts?: {
     initialSync: boolean;
 }): (table: Table<TData>) => () => RowModel<TData>;
 
-export { AccessorFn, AggregationFn, AggregationFnOption, AnyRender, BuiltInAggregationFn, BuiltInFilterFn, BuiltInSortingFn, Cell, CellContext, Column, ColumnDef, ColumnDefTemplate, ColumnDefaultOptions, ColumnFilter, ColumnFilterAutoRemoveTestFn, ColumnFiltersState, ColumnHelper, ColumnMeta, ColumnOrderDefaultOptions, ColumnOrderInstance, ColumnOrderOptions, ColumnOrderState, ColumnOrderTableState, ColumnPinningColumn, ColumnPinningColumnDef, ColumnPinningDefaultOptions, ColumnPinningInstance, ColumnPinningOptions, ColumnPinningPosition, ColumnPinningRow, ColumnPinningState, ColumnPinningTableState, ColumnResizeMode, ColumnSizing, ColumnSizingColumn, ColumnSizingColumnDef, ColumnSizingDefaultOptions, ColumnSizingHeader, ColumnSizingInfoState, ColumnSizingInstance, ColumnSizingOptions, ColumnSizingState, ColumnSizingTableState, ColumnSort, CoreCell, CoreColumn, CoreColumnDef, CoreColumnDefAccessorFn, CoreColumnDefAccessorKey, CoreColumnDefBase, CoreColumnDefDisplay, CoreColumnDefDisplayWithStringHeader, CoreColumnDefResolved, CoreHeader, CoreHeaderGroup, CoreInstance, CoreOptions, CoreRow, CoreTableState, CustomAggregationFns, CustomFilterFns, CustomSortingFns, DeepKeys, DeepValue, ExpandedInstance, ExpandedOptions, ExpandedRow, ExpandedState, ExpandedStateList, ExpandedTableState, Expanding, FilterFn, FilterFnOption, FilterMeta, Filters, FiltersColumn, FiltersColumnDef, FiltersInstance, FiltersOptions, FiltersRow, FiltersTableState, Getter, Grouping, GroupingCell, GroupingColumn, GroupingColumnDef, GroupingColumnMode, GroupingInstance, GroupingOptions, GroupingRow, GroupingState, GroupingTableState, Header, HeaderContext, HeaderGroup, Headers, HeadersInstance, InitialTableState, IsAny, IsKnown, NoInfer, OnChangeFn, Ordering, Overwrite, Pagination, PaginationDefaultOptions, PaginationInitialTableState, PaginationInstance, PaginationOptions, PaginationState, PaginationTableState, PartialKeys, Pinning, RequiredKeys, ResolvedColumnFilter, Row, RowData, RowModel, RowSelection, RowSelectionInstance, RowSelectionOptions, RowSelectionRow, RowSelectionState, RowSelectionTableState, SortDirection, Sorting, SortingColumn, SortingColumnDef, SortingFn, SortingFnOption, SortingInstance, SortingOptions, SortingState, SortingTableState, Table, TableFeature, TableMeta, TableOptions, TableOptionsResolved, TableState, TransformFilterValueFn, UnionToIntersection, Updater, Visibility, VisibilityColumn, VisibilityColumnDef, VisibilityDefaultOptions, VisibilityInstance, VisibilityOptions, VisibilityRow, VisibilityState, VisibilityTableState, aggregationFns, buildHeaderGroups, createCell, createColumn, createColumnHelper, createRow, createTable, defaultColumnSizing, expandRows, filterFns, flattenBy, functionalUpdate, getCoreRowModel, getExpandedRowModel, getFacetedMinMaxValues, getFacetedRowModel, getFacetedUniqueValues, getFilteredRowModel, getGroupedRowModel, getPaginationRowModel, getSortedRowModel, isFunction, isRowSelected, isSubRowSelected, makeStateUpdater, memo, noop, orderColumns, passiveEventSupported, reSplitAlphaNumeric, selectRowsFn, shouldAutoRemoveFilter, sortingFns };
+export { AccessorFn, AggregationFn, AggregationFnOption, AggregationFns, AnyRender, BuiltInAggregationFn, BuiltInFilterFn, BuiltInSortingFn, Cell, CellContext, Column, ColumnDef, ColumnDefTemplate, ColumnDefaultOptions, ColumnFilter, ColumnFilterAutoRemoveTestFn, ColumnFiltersState, ColumnHelper, ColumnMeta, ColumnOrderDefaultOptions, ColumnOrderInstance, ColumnOrderOptions, ColumnOrderState, ColumnOrderTableState, ColumnPinningColumn, ColumnPinningColumnDef, ColumnPinningDefaultOptions, ColumnPinningInstance, ColumnPinningOptions, ColumnPinningPosition, ColumnPinningRow, ColumnPinningState, ColumnPinningTableState, ColumnResizeMode, ColumnSizing, ColumnSizingColumn, ColumnSizingColumnDef, ColumnSizingDefaultOptions, ColumnSizingHeader, ColumnSizingInfoState, ColumnSizingInstance, ColumnSizingOptions, ColumnSizingState, ColumnSizingTableState, ColumnSort, CoreCell, CoreColumn, CoreColumnDef, CoreColumnDefAccessorFn, CoreColumnDefAccessorKey, CoreColumnDefBase, CoreColumnDefDisplay, CoreColumnDefDisplayWithStringHeader, CoreColumnDefResolved, CoreHeader, CoreHeaderGroup, CoreInstance, CoreOptions, CoreRow, CoreTableState, CustomAggregationFns, CustomFilterFns, CustomSortingFns, DeepKeys, DeepValue, ExpandedInstance, ExpandedOptions, ExpandedRow, ExpandedState, ExpandedStateList, ExpandedTableState, Expanding, FilterFn, FilterFnOption, FilterFns, FilterMeta, Filters, FiltersColumn, FiltersColumnDef, FiltersInstance, FiltersOptions, FiltersRow, FiltersTableState, Getter, Grouping, GroupingCell, GroupingColumn, GroupingColumnDef, GroupingColumnMode, GroupingInstance, GroupingOptions, GroupingRow, GroupingState, GroupingTableState, Header, HeaderContext, HeaderGroup, Headers, HeadersInstance, InitialTableState, IsAny, IsKnown, NoInfer, OnChangeFn, Ordering, Overwrite, Pagination, PaginationDefaultOptions, PaginationInitialTableState, PaginationInstance, PaginationOptions, PaginationState, PaginationTableState, PartialKeys, Pinning, RequiredKeys, ResolvedColumnFilter, Row, RowData, RowModel, RowSelection, RowSelectionInstance, RowSelectionOptions, RowSelectionRow, RowSelectionState, RowSelectionTableState, SortDirection, Sorting, SortingColumn, SortingColumnDef, SortingFn, SortingFnOption, SortingFns, SortingInstance, SortingOptions, SortingState, SortingTableState, Table, TableFeature, TableMeta, TableOptions, TableOptionsResolved, TableState, TransformFilterValueFn, UnionToIntersection, Updater, Visibility, VisibilityColumn, VisibilityColumnDef, VisibilityDefaultOptions, VisibilityInstance, VisibilityOptions, VisibilityRow, VisibilityState, VisibilityTableState, aggregationFns, buildHeaderGroups, createCell, createColumn, createColumnHelper, createRow, createTable, defaultColumnSizing, expandRows, filterFns, flattenBy, functionalUpdate, getCoreRowModel, getExpandedRowModel, getFacetedMinMaxValues, getFacetedRowModel, getFacetedUniqueValues, getFilteredRowModel, getGroupedRowModel, getPaginationRowModel, getSortedRowModel, isFunction, isRowSelected, isSubRowSelected, makeStateUpdater, memo, noop, orderColumns, passiveEventSupported, reSplitAlphaNumeric, selectRowsFn, shouldAutoRemoveFilter, sortingFns };

package/build/umd/index.development.js

@@ -1149,7 +1149,9 @@
           return filterFns.weakEquals;
         },
         getFilterFn: () => {
-          return isFunction(column.columnDef.filterFn) ? column.columnDef.filterFn : column.columnDef.filterFn === 'auto' ? column.getAutoFilterFn() : filterFns[column.columnDef.filterFn];
+          var _table$options$filter, _table$options$filter2;
+
+          return isFunction(column.columnDef.filterFn) ? column.columnDef.filterFn : column.columnDef.filterFn === 'auto' ? column.getAutoFilterFn() : (_table$options$filter = (_table$options$filter2 = table.options.filterFns) == null ? void 0 : _table$options$filter2[column.columnDef.filterFn]) != null ? _table$options$filter : filterFns[column.columnDef.filterFn];
         },
         getCanFilter: () => {
           var _column$columnDef$ena, _table$options$enable, _table$options$enable2;
@@ -1248,10 +1250,12 @@
           return filterFns.includesString;
         },
         getGlobalFilterFn: () => {
+          var _table$options$filter3, _table$options$filter4;
+
           const {
             globalFilterFn: globalFilterFn
           } = table.options;
-          return isFunction(globalFilterFn) ? globalFilterFn : globalFilterFn === 'auto' ? table.getGlobalAutoFilterFn() : filterFns[globalFilterFn];
+          return isFunction(globalFilterFn) ? globalFilterFn : globalFilterFn === 'auto' ? table.getGlobalAutoFilterFn() : (_table$options$filter3 = (_table$options$filter4 = table.options.filterFns) == null ? void 0 : _table$options$filter4[globalFilterFn]) != null ? _table$options$filter3 : filterFns[globalFilterFn];
         },
         setColumnFilters: updater => {
           const leafColumns = table.getAllLeafColumns();
@@ -1505,11 +1509,13 @@
           }
         },
         getAggregationFn: () => {
+          var _table$options$aggreg, _table$options$aggreg2;
+
           if (!column) {
             throw new Error();
           }
 
-          return isFunction(column.columnDef.aggregationFn) ? column.columnDef.aggregationFn : column.columnDef.aggregationFn === 'auto' ? column.getAutoAggregationFn() : aggregationFns[column.columnDef.aggregationFn];
+          return isFunction(column.columnDef.aggregationFn) ? column.columnDef.aggregationFn : column.columnDef.aggregationFn === 'auto' ? column.getAutoAggregationFn() : (_table$options$aggreg = (_table$options$aggreg2 = table.options.aggregationFns) == null ? void 0 : _table$options$aggreg2[column.columnDef.aggregationFn]) != null ? _table$options$aggreg : aggregationFns[column.columnDef.aggregationFn];
         }
       };
     },
@@ -2526,11 +2532,13 @@
           return 'desc';
         },
         getSortingFn: () => {
+          var _table$options$sortin, _table$options$sortin2;
+
           if (!column) {
             throw new Error();
           }
 
-          return isFunction(column.columnDef.sortingFn) ? column.columnDef.sortingFn : column.columnDef.sortingFn === 'auto' ? column.getAutoSortingFn() : sortingFns[column.columnDef.sortingFn];
+          return isFunction(column.columnDef.sortingFn) ? column.columnDef.sortingFn : column.columnDef.sortingFn === 'auto' ? column.getAutoSortingFn() : (_table$options$sortin = (_table$options$sortin2 = table.options.sortingFns) == null ? void 0 : _table$options$sortin2[column.columnDef.sortingFn]) != null ? _table$options$sortin : sortingFns[column.columnDef.sortingFn];
         },
         toggleSorting: (desc, multi) => {
           // if (column.columns.length) {
@@ -3152,7 +3160,8 @@
           accessorKey: accessor
         };
       },
-      display: column => column
+      display: column => column,
+      group: column => column
     };
   }