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

package/build/types/features/Filters.d.ts

@@ -14,10 +14,12 @@ export declare type ColumnFilter = {
     value: unknown;
 };
 export declare type FilterFn<TGenerics extends TableGenerics> = {
-    (rows: Row<TGenerics>[], columnIds: string[], filterValue: any): any;
+    (row: Row<TGenerics>, columnId: string, filterValue: any): boolean;
+    resolveFilterValue?: TransformFilterValueFn<TGenerics>;
     autoRemove?: ColumnFilterAutoRemoveTestFn<TGenerics>;
 };
-export declare type ColumnFilterAutoRemoveTestFn<TGenerics extends TableGenerics> = (value: unknown, column?: Column<TGenerics>) => boolean;
+export declare type TransformFilterValueFn<TGenerics extends TableGenerics> = (value: any, column?: Column<TGenerics>) => unknown;
+export declare type ColumnFilterAutoRemoveTestFn<TGenerics extends TableGenerics> = (value: any, column?: Column<TGenerics>) => boolean;
 export declare type CustomFilterFns<TGenerics extends TableGenerics> = Record<string, FilterFn<TGenerics>>;
 export declare type FilterFnOption<TGenerics extends TableGenerics> = 'auto' | BuiltInFilterFn | keyof TGenerics['FilterFns'] | FilterFn<TGenerics>;
 export declare type FiltersColumnDef<TGenerics extends TableGenerics> = {
@@ -26,6 +28,7 @@ export declare type FiltersColumnDef<TGenerics extends TableGenerics> = {
     }>>;
     enableColumnFilter?: boolean;
     enableGlobalFilter?: boolean;
+    enableFaceting?: boolean;
 };
 export declare type FiltersColumn<TGenerics extends TableGenerics> = {
     filterFn: FilterFnOption<Overwrite<TGenerics, {
@@ -37,22 +40,25 @@ export declare type FiltersColumn<TGenerics extends TableGenerics> = {
     getColumnIsFiltered: () => boolean;
     getColumnFilterValue: () => unknown;
     setColumnFilterValue: (updater: Updater<any>) => void;
-    getPreFilteredRows: () => Row<TGenerics>[] | undefined;
-    getPreFilteredUniqueValues: () => Map<any, number>;
-    getPreFilteredMinMaxValues: () => [any, any];
+    getFacetedRowModel: () => RowModel<TGenerics>;
+    getFacetedUniqueValues: () => Map<any, number>;
+    getFacetedMinMaxValues: () => [any, any];
+};
+export declare type FiltersRow<TGenerics extends TableGenerics> = {
+    columnFilterMap: Record<string, boolean>;
+    subRowsByFacetId: Record<string, Row<TGenerics>[]>;
 };
 export declare type FiltersOptions<TGenerics extends TableGenerics> = {
+    enableFilters?: boolean;
+    manualFiltering?: boolean;
     filterFromLeafRows?: boolean;
     filterFns?: TGenerics['FilterFns'];
-    manualColumnFiltering?: boolean;
     onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>;
     enableColumnFilters?: boolean;
-    getColumnFilteredRowModel?: (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
-    manualGlobalFiltering?: boolean;
+    getFilteredRowModel?: (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
     globalFilterFn?: FilterFnOption<TGenerics>;
     onGlobalFilterChange?: OnChangeFn<any>;
     enableGlobalFilter?: boolean;
-    getGlobalFilteredRowModel?: (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
     getColumnCanGlobalFilter?: (column: Column<TGenerics>) => boolean;
 };
 export declare type FiltersInstance<TGenerics extends TableGenerics> = {
@@ -62,20 +68,23 @@ export declare type FiltersInstance<TGenerics extends TableGenerics> = {
     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;
-    getPreColumnFilteredRowModel: () => RowModel<TGenerics>;
-    getColumnFilteredRowModel: () => RowModel<TGenerics>;
-    _getColumnFilteredRowModel?: () => RowModel<TGenerics>;
+    getPreFilteredRowModel: () => RowModel<TGenerics>;
+    getFilteredRowModel: () => RowModel<TGenerics>;
+    _getFilteredRowModel?: () => RowModel<TGenerics>;
     setGlobalFilter: (updater: Updater<any>) => void;
     resetGlobalFilter: () => void;
     getGlobalAutoFilterFn: () => FilterFn<TGenerics> | undefined;
     getGlobalFilterFn: () => FilterFn<TGenerics> | undefined;
     getColumnCanGlobalFilter: (columnId: string) => boolean;
-    getPreGlobalFilteredRowModel: () => RowModel<TGenerics>;
-    getGlobalFilteredRowModel: () => RowModel<TGenerics>;
-    _getGlobalFilteredRowModel?: () => RowModel<TGenerics>;
+    getGlobalFacetedRowModel: () => RowModel<TGenerics>;
+    getGlobalFacetedUniqueValues: () => Map<any, number>;
+    getGlobalFacetedMinMaxValues: () => [number, number];
 };
 export declare const Filters: TableFeature;
 export declare function shouldAutoRemoveFilter<TGenerics extends TableGenerics>(filterFn?: FilterFn<TGenerics>, value?: any, column?: Column<TGenerics>): boolean;
+export declare function getRowModelMinMaxValues<TGenerics extends TableGenerics>(rowModel: RowModel<TGenerics>, columnId: string): [any, any];
+export declare function getRowModelUniqueValues<TGenerics extends TableGenerics>(rowModel: RowModel<TGenerics>, columnId: string): Map<any, number>;

package/build/types/filterFns.d.ts

@@ -1,55 +1,13 @@
-import { TableGenerics, Row } from './types';
+import { FilterFn } from './features/Filters';
 export declare const filterFns: {
-    includesString: typeof includesString;
-    includesStringSensitive: typeof includesStringSensitive;
-    equalsString: typeof equalsString;
-    equalsStringSensitive: typeof equalsStringSensitive;
-    arrIncludes: typeof arrIncludes;
-    arrIncludesAll: typeof arrIncludesAll;
-    arrIncludesSome: typeof arrIncludesSome;
-    equals: typeof equals;
-    weakEquals: typeof weakEquals;
-    betweenNumberRange: typeof betweenNumberRange;
+    includesString: FilterFn<any>;
+    includesStringSensitive: FilterFn<any>;
+    equalsString: FilterFn<any>;
+    arrIncludes: FilterFn<any>;
+    arrIncludesAll: FilterFn<any>;
+    arrIncludesSome: FilterFn<any>;
+    equals: FilterFn<any>;
+    weakEquals: FilterFn<any>;
+    inNumberRange: FilterFn<any>;
 };
 export declare type BuiltInFilterFn = keyof typeof filterFns;
-declare function includesString<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], columnIds: string[], filterValue: unknown): Row<TGenerics>[];
-declare namespace includesString {
-    var autoRemove: (val: any) => boolean;
-}
-declare function includesStringSensitive<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], columnIds: string[], filterValue: unknown): Row<TGenerics>[];
-declare namespace includesStringSensitive {
-    var autoRemove: (val: any) => boolean;
-}
-declare function equalsString<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], columnIds: string[], filterValue: unknown): Row<TGenerics>[];
-declare namespace equalsString {
-    var autoRemove: (val: any) => boolean;
-}
-declare function equalsStringSensitive<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], columnIds: string[], filterValue: unknown): Row<TGenerics>[];
-declare namespace equalsStringSensitive {
-    var autoRemove: (val: any) => boolean;
-}
-declare function arrIncludes<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], columnIds: string[], filterValue: unknown): Row<TGenerics>[];
-declare namespace arrIncludes {
-    var autoRemove: (val: any) => boolean;
-}
-declare function arrIncludesAll<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], columnIds: string[], filterValue: unknown[]): Row<TGenerics>[];
-declare namespace arrIncludesAll {
-    var autoRemove: (val: any) => boolean;
-}
-declare function arrIncludesSome<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], columnIds: string[], filterValue: unknown[]): Row<TGenerics>[];
-declare namespace arrIncludesSome {
-    var autoRemove: (val: any) => boolean;
-}
-declare function equals<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], columnIds: string[], filterValue: unknown): Row<TGenerics>[];
-declare namespace equals {
-    var autoRemove: (val: any) => boolean;
-}
-declare function weakEquals<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], columnIds: string[], filterValue: unknown): Row<TGenerics>[];
-declare namespace weakEquals {
-    var autoRemove: (val: any) => boolean;
-}
-declare function betweenNumberRange<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], columnIds: string[], filterValue: [unknown, unknown]): Row<TGenerics>[];
-declare namespace betweenNumberRange {
-    var autoRemove: (val: any) => boolean;
-}
-export {};

package/build/types/index.d.ts

@@ -17,8 +17,7 @@ export * from './features/Expanding';
 export * from './utils';
 export * from './utils/getCoreRowModelSync';
 export * from './utils/getCoreRowModelAsync';
-export * from './utils/getColumnFilteredRowModelSync';
-export * from './utils/getGlobalFilteredRowModelSync';
+export * from './utils/getFilteredRowModelSync';
 export * from './utils/getSortedRowModelSync';
 export * from './utils/getGroupedRowModel';
 export * from './utils/getExpandedRowModel';

package/build/types/types.d.ts

@@ -4,7 +4,7 @@ import { VisibilityInstance, VisibilityTableState, VisibilityColumn as ColumnVis
 import { ColumnOrderInstance, ColumnOrderOptions, ColumnOrderTableState } from './features/Ordering';
 import { ColumnPinningColumn, ColumnPinningColumnDef, ColumnPinningInstance, ColumnPinningOptions, ColumnPinningRow, ColumnPinningTableState } from './features/Pinning';
 import { HeadersInstance } from './features/Headers';
-import { FiltersColumn, FiltersColumnDef, FiltersInstance, FiltersOptions, FiltersTableState } from './features/Filters';
+import { FiltersColumn, FiltersColumnDef, FiltersInstance, FiltersOptions, FiltersRow, FiltersTableState } from './features/Filters';
 import { SortingColumn, SortingColumnDef, SortingInstance, SortingOptions, SortingTableState } from './features/Sorting';
 import { GroupingCell, GroupingColumn, GroupingColumnDef, GroupingInstance, GroupingOptions, GroupingRow, GroupingTableState } from './features/Grouping';
 import { ExpandedInstance, ExpandedOptions, ExpandedTableState, ExpandedRow } from './features/Expanding';
@@ -42,7 +42,7 @@ export declare type TableInstance<TGenerics extends TableGenerics> = TableCore<T
 export declare type TableOptions<TGenerics extends TableGenerics> = CoreOptions<TGenerics> & ColumnsOptions<TGenerics> & RowsOptions<TGenerics> & VisibilityOptions & ColumnOrderOptions & ColumnPinningOptions & FiltersOptions<TGenerics> & SortingOptions<TGenerics> & GroupingOptions<TGenerics> & ExpandedOptions<TGenerics> & ColumnSizingOptions & PaginationOptions<TGenerics> & RowSelectionOptions<TGenerics>;
 export declare type TableState = CoreTableState & VisibilityTableState & ColumnOrderTableState & ColumnPinningTableState & FiltersTableState & SortingTableState & ExpandedTableState & GroupingTableState & ColumnSizingTableState & PaginationTableState & RowSelectionTableState;
 export declare type InitialTableState = Partial<CoreTableState & VisibilityTableState & ColumnOrderTableState & ColumnPinningTableState & FiltersTableState & SortingTableState & ExpandedTableState & GroupingTableState & ColumnSizingTableState & PaginationInitialTableState & RowSelectionTableState>;
-export declare type Row<TGenerics extends TableGenerics> = CoreRow<TGenerics> & CellsRow<TGenerics> & VisibilityRow<TGenerics> & ColumnPinningRow<TGenerics> & GroupingRow & RowSelectionRow & ExpandedRow;
+export declare type Row<TGenerics extends TableGenerics> = CoreRow<TGenerics> & CellsRow<TGenerics> & VisibilityRow<TGenerics> & ColumnPinningRow<TGenerics> & FiltersRow<TGenerics> & GroupingRow & RowSelectionRow & ExpandedRow;
 export declare type RowValues = {
     [key: string]: any;
 };

package/build/types/utils/filterRowsUtils.d.ts

@@ -1,3 +1,4 @@
 import { TableGenerics, Row, RowModel, TableInstance } from '../types';
+export declare function filterRows<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], columnIds: string[], instance: TableInstance<TGenerics>): RowModel<TGenerics>;
 export declare function filterRowModelFromLeafs<TGenerics extends TableGenerics>(rowsToFilter: Row<TGenerics>[], filterRows: (rowsToFilter: Row<TGenerics>[], depth: number) => Row<TGenerics>[], instance: TableInstance<TGenerics>): RowModel<TGenerics>;
 export declare function filterRowModelFromRoot<TGenerics extends TableGenerics>(rowsToFilter: Row<TGenerics>[], filterRows: (rowsToFilter: Row<TGenerics>[], depth: number) => Row<TGenerics>[], instance: TableInstance<TGenerics>): RowModel<TGenerics>;

package/build/types/utils/{getColumnFilteredRowModelAsync.d.ts → getFilteredRowModelAsync.d.ts}

@@ -1,4 +1,4 @@
 import { TableInstance, RowModel, TableGenerics } from '../types';
-export declare function getColumnFilteredRowModelAsync<TGenerics extends TableGenerics>(opts?: {
+export declare function getFilteredRowModelAsync<TGenerics extends TableGenerics>(opts?: {
     initialSync?: boolean;
 }): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;

package/build/types/utils/getFilteredRowModelSync.d.ts

@@ -0,0 +1,2 @@
+import { TableInstance, RowModel, TableGenerics } from '../types';
+export declare function getFilteredRowModelSync<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;

package/build/types/utils.d.ts

@@ -17,7 +17,7 @@ declare type AnyFunction = (...args: any) => any;
 export declare function isFunction<T extends AnyFunction>(d: any): d is T;
 export declare function flattenBy<TNode>(arr: TNode[], getChildren: (item: TNode) => TNode[]): TNode[];
 export declare function memo<TDeps extends readonly any[], TResult>(getDeps: () => [...TDeps], fn: (...args: NoInfer<[...TDeps]>) => TResult, opts: {
-    key: string;
+    key: any;
     debug?: () => any;
     onChange?: (result: TResult, previousResult?: TResult) => void;
 }): () => TResult;
@@ -25,7 +25,7 @@ declare type WorkFn = () => void;
 export declare function incrementalMemo<TDeps extends readonly any[], TResult>(getDeps: () => [...TDeps], getInitialValue: (...args: NoInfer<[...TDeps]>) => TResult, schedule: (...args: NoInfer<[...TDeps]>) => (resultRef: {
     current: TResult;
 }) => (scheduler: (workFn: WorkFn) => void) => void, opts: {
-    key: string;
+    key: any;
     onProgress: (progress: number, nextResult: TResult, result?: TResult) => void;
     onChange: (result: TResult, previousResult?: TResult) => void;
     initialSync?: boolean;