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

package/build/types/types.d.ts

@@ -7,51 +7,63 @@ import { HeadersInstance, HeadersRow } from './features/Headers';
 import { FiltersColumn, FiltersColumnDef, FiltersInstance, FiltersOptions, FiltersTableState } from './features/Filters';
 import { SortingColumn, SortingColumnDef, SortingInstance, SortingOptions, SortingTableState } from './features/Sorting';
 import { GroupingColumn, GroupingColumnDef, GroupingInstance, GroupingOptions, GroupingRow, GroupingTableState } from './features/Grouping';
-import { ExpandedInstance, ExpandedOptions, ExpandedTableState } from './features/Expanding';
+import { ExpandedInstance, ExpandedOptions, ExpandedTableState, ExpandedRow } from './features/Expanding';
 import { Overwrite } from './utils';
-import { ColumnSizingColumn, ColumnSizingColumnDef, ColumnSizingInstance, ColumnSizingOptions, ColumnSizingTableState } from './features/ColumnSizing';
+import { ColumnSizingColumn, ColumnSizingColumnDef, ColumnSizingHeader, ColumnSizingInstance, ColumnSizingOptions, ColumnSizingTableState } from './features/ColumnSizing';
 import { PaginationInstance, PaginationOptions, PaginationTableState } from './features/Pagination';
 import { RowSelectionInstance, RowSelectionOptions, RowSelectionRow, RowSelectionTableState } from './features/RowSelection';
-export declare type ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> = TableCore<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & VisibilityInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & ColumnOrderInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & ColumnPinningInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & HeadersInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & FiltersInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & SortingInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & GroupingInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & ColumnSizingInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & ExpandedInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & PaginationInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & RowSelectionInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
+export declare type DefaultGenerics = {
+    Row: unknown;
+    Value: unknown;
+    FilterFns: object;
+    SortingFns: object;
+    AggregationFns: object;
+};
+export declare type PartialGenerics = Partial<DefaultGenerics>;
+export declare type TableInstance<TGenerics extends PartialGenerics> = TableCore<TGenerics> & VisibilityInstance<TGenerics> & ColumnOrderInstance<TGenerics> & ColumnPinningInstance<TGenerics> & HeadersInstance<TGenerics> & FiltersInstance<TGenerics> & SortingInstance<TGenerics> & GroupingInstance<TGenerics> & ColumnSizingInstance<TGenerics> & ExpandedInstance<TGenerics> & PaginationInstance<TGenerics> & RowSelectionInstance<TGenerics>;
 export declare type Renderable<TProps> = React.ReactNode | React.FunctionComponent<TProps> | React.Component<TProps>;
-export declare type Options<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> = CoreOptions<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & VisibilityOptions & ColumnOrderOptions & ColumnPinningOptions & FiltersOptions<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & SortingOptions<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & GroupingOptions<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & ExpandedOptions<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & ColumnSizingOptions & PaginationOptions<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & RowSelectionOptions<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
+export declare type Options<TGenerics extends PartialGenerics> = CoreOptions<TGenerics> & VisibilityOptions & ColumnOrderOptions & ColumnPinningOptions & FiltersOptions<TGenerics> & SortingOptions<TGenerics> & GroupingOptions<TGenerics> & ExpandedOptions<TGenerics> & ColumnSizingOptions & PaginationOptions<TGenerics> & RowSelectionOptions<TGenerics>;
 export declare type Updater<T> = T | ((old: T) => T);
 export declare type OnChangeFn<T> = (updaterOrValue: Updater<T>, value: T) => void;
 export declare type TableState = VisibilityTableState & ColumnOrderTableState & ColumnPinningTableState & FiltersTableState & SortingTableState & ExpandedTableState & GroupingTableState & ColumnSizingTableState & PaginationTableState & RowSelectionTableState;
-export declare type Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> = CoreRow<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & VisibilityRow<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & HeadersRow<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & GroupingRow & RowSelectionRow;
+export declare type Row<TGenerics extends PartialGenerics> = CoreRow<TGenerics> & VisibilityRow<TGenerics> & HeadersRow<TGenerics> & GroupingRow & RowSelectionRow & ExpandedRow;
 export declare type RowValues = {
     [key: string]: any;
 };
-export declare type RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> = {
-    rows: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[];
-    flatRows: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[];
-    rowsById: Record<string, Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>>;
+export declare type RowModel<TGenerics extends PartialGenerics> = {
+    rows: Row<TGenerics>[];
+    flatRows: Row<TGenerics>[];
+    rowsById: Record<string, Row<TGenerics>>;
 };
 export declare type AccessorFn<TData> = (originalRow: TData, index: number) => any;
-export declare type ColumnDef<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> = CoreColumnDef<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & VisibilityColumnDef & ColumnPinningColumnDef & FiltersColumnDef<TFilterFns> & SortingColumnDef<TSortingFns> & GroupingColumnDef<TAggregationFns> & ColumnSizingColumnDef;
-export declare type Column<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> = ColumnDef<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & CoreColumn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & ColumnVisibilityColumn & ColumnPinningColumn & FiltersColumn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & SortingColumn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & GroupingColumn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> & ColumnSizingColumn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
-export declare type Cell<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> = {
+export declare const Please_use_the_create_table_column_utilities_to_define_columns: unique symbol;
+export declare type _NonGenerated<T> = Overwrite<T, {
+    [Please_use_the_create_table_column_utilities_to_define_columns]?: never;
+}>;
+export declare type ColumnDef<TGenerics extends PartialGenerics> = CoreColumnDef<TGenerics> & VisibilityColumnDef & ColumnPinningColumnDef & FiltersColumnDef<TGenerics> & SortingColumnDef<TGenerics> & GroupingColumnDef<TGenerics> & ColumnSizingColumnDef;
+export declare type Column<TGenerics extends PartialGenerics> = ColumnDef<TGenerics> & CoreColumn<TGenerics> & ColumnVisibilityColumn & ColumnPinningColumn & FiltersColumn<TGenerics> & SortingColumn<TGenerics> & GroupingColumn<TGenerics> & ColumnSizingColumn<TGenerics>;
+export declare type Cell<TGenerics extends PartialGenerics> = {
     id: string;
     rowId: string;
     columnId: string;
-    value: TValue;
-    row: Row<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
-    column: Column<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
+    value: TGenerics['Value'];
+    row: Row<TGenerics>;
+    column: Column<TGenerics>;
     getCellProps: PropGetter<CellProps>;
     renderCell: () => React.ReactNode;
 };
-export declare type Header<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> = CoreHeader<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
-export declare type CoreHeader<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> = {
+export declare type Header<TGenerics extends PartialGenerics> = CoreHeader<TGenerics> & ColumnSizingHeader<TGenerics>;
+export declare type CoreHeader<TGenerics extends PartialGenerics> = {
     id: string;
     depth: number;
-    column: Column<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
+    column: Column<TGenerics>;
     getWidth: () => number;
-    subHeaders: Header<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[];
+    subHeaders: Header<TGenerics>[];
     colSpan?: number;
     rowSpan?: number;
     getHeaderProps: PropGetter<HeaderProps>;
     getFooterProps: PropGetter<HeaderProps>;
-    getLeafHeaders: () => Header<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[];
+    getLeafHeaders: () => Header<TGenerics>[];
     isPlaceholder?: boolean;
     placeholderId?: string;
     renderHeader: (options?: {
@@ -61,10 +73,10 @@ export declare type CoreHeader<TData, TValue, TFilterFns, TSortingFns, TAggregat
         renderPlaceholder?: boolean;
     }) => React.ReactNode;
 };
-export declare type HeaderGroup<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> = {
+export declare type HeaderGroup<TGenerics extends PartialGenerics> = {
     id: string;
     depth: number;
-    headers: Header<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>[];
+    headers: Header<TGenerics>[];
     getHeaderGroupProps: PropGetter<HeaderGroupProps>;
     getFooterGroupProps: PropGetter<FooterGroupProps>;
 };
@@ -120,7 +132,6 @@ export declare type CellProps = {
     key: string;
     role: string;
 };
-export declare type Listener<TArgs extends [...any]> = (...args: [...TArgs]) => void;
 export declare type PropGetter<TBase> = <TGetter extends Getter<TBase>>(userProps?: TGetter) => PropGetterValue<TBase, TGetter>;
 export declare type Getter<TInitial> = ((initial: TInitial) => object) | object | undefined;
 export declare type PropGetterValue<TBase, TGetter> = TGetter extends undefined ? TBase : TGetter extends (...args: any[]) => infer TReturn ? Overwrite<TBase, TReturn> : TGetter extends object ? Overwrite<TBase, TGetter> : never;

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

@@ -1,2 +1,2 @@
-import { ReactTable, RowModel } from '../types';
-export declare function columnFilterRowsFn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>(instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>, rowModel: RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>): RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
+import { PartialGenerics, TableInstance, RowModel } from '../types';
+export declare function columnFilterRowsFn<TGenerics extends PartialGenerics>(instance: TableInstance<TGenerics>, rowModel: RowModel<TGenerics>): RowModel<TGenerics>;

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

@@ -1,2 +1,2 @@
-import { ReactTable, RowModel } from '../types';
-export declare function expandRowsFn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>(instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>, sortedRowModel: RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>): RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
+import { PartialGenerics, TableInstance, RowModel } from '../types';
+export declare function expandRowsFn<TGenerics extends PartialGenerics>(instance: TableInstance<TGenerics>, sortedRowModel: RowModel<TGenerics>): RowModel<TGenerics>;

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

@@ -1,2 +1,2 @@
-import { ReactTable, RowModel } from '../types';
-export declare function globalFilterRowsFn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>(instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>, rowModel: RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>): RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
+import { PartialGenerics, TableInstance, RowModel } from '../types';
+export declare function globalFilterRowsFn<TGenerics extends PartialGenerics>(instance: TableInstance<TGenerics>, rowModel: RowModel<TGenerics>): RowModel<TGenerics>;

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

@@ -1,2 +1,2 @@
-import { ReactTable, RowModel } from '../types';
-export declare function groupRowsFn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>(instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>, sortedRowModel: RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>): RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
+import { PartialGenerics, TableInstance, RowModel } from '../types';
+export declare function groupRowsFn<TGenerics extends PartialGenerics>(instance: TableInstance<TGenerics>, sortedRowModel: RowModel<TGenerics>): RowModel<TGenerics>;

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

@@ -1,2 +1,2 @@
-import { ReactTable, RowModel } from '../types';
-export declare function paginateRowsFn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>(instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>, rowModel: RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>): RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
+import { PartialGenerics, TableInstance, RowModel } from '../types';
+export declare function paginateRowsFn<TGenerics extends PartialGenerics>(instance: TableInstance<TGenerics>, rowModel: RowModel<TGenerics>): RowModel<TGenerics>;

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

@@ -1,2 +1,2 @@
-import { ReactTable, RowModel } from '../types';
-export declare function sortRowsFn<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>(instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>, rowModel: RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>): RowModel<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>;
+import { PartialGenerics, TableInstance, RowModel } from '../types';
+export declare function sortRowsFn<TGenerics extends PartialGenerics>(instance: TableInstance<TGenerics>, rowModel: RowModel<TGenerics>): RowModel<TGenerics>;

package/build/types/utils.d.ts

@@ -1,14 +1,13 @@
 import React from 'react';
-import { Getter, NoInfer, PropGetterValue, Renderable, TableState } from './types';
+import { Getter, NoInfer, PropGetterValue, Renderable, TableState, Updater } from './types';
 export declare type IsAny<T> = 0 extends 1 & T ? true : false;
 export declare type PartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 export declare type RequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
 export declare type Overwrite<T, U> = Omit<T, keyof U> & U;
-export declare type DataUpdateFunction<TInput, TOutput> = (input: TInput) => TOutput;
-export declare type Updater<TInput, TOutput> = TOutput | DataUpdateFunction<TInput, TOutput>;
-export declare function functionalUpdate<TInput, TOutput = TInput>(updater: Updater<TInput, TOutput>, input: TInput): TOutput;
+export declare type DataUpdateFunction<T> = (input: T) => T;
+export declare function functionalUpdate<T>(updater: Updater<T>, input: T): T;
 export declare function noop(): void;
-export declare function makeStateUpdater(key: keyof TableState, instance: unknown): (updater: Updater<any, any>) => void;
+export declare function makeStateUpdater(key: keyof TableState, instance: unknown): (updater: Updater<any>) => void;
 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[];
@@ -16,7 +15,7 @@ declare type PropGetterImpl = <TBaseProps, TGetter extends Getter<TBaseProps>>(i
 export declare const propGetter: PropGetterImpl;
 export declare function memo<TDeps extends readonly any[], TResult>(getDeps: () => [...TDeps], fn: (...args: NoInfer<[...TDeps]>) => TResult, opts: {
     key: string;
-    debug?: boolean;
+    debug?: () => any;
     onChange?: (result: TResult, previousResult?: TResult) => void;
 }): () => TResult;
 export declare type Render = typeof flexRender;