@tanstack/table-core 8.2.4 → 8.3.0

package/build/types/index.d.ts

@@ -8,20 +8,23 @@
  *
  * @license MIT
  */
+declare type NoInfer$1<T> = [T][T extends any ? 0 : never];
+declare type Getter<TValue> = <TTValue = TValue>() => NoInfer$1<TTValue>;
+declare type CellContext<TData extends RowData, TValue> = {
+    table: Table<TData>;
+    column: Column<TData, TValue>;
+    row: Row<TData>;
+    cell: Cell<TData, TValue>;
+    getValue: Getter<TValue>;
+    renderValue: Getter<TValue | null>;
+};
 declare type CoreCell<TData extends RowData, TValue> = {
     id: string;
-    getValue: <TTValue = TValue>() => TTValue;
-    renderValue: <TTValue = TValue>() => TTValue | null;
+    getValue: CellContext<TData, TValue>['getValue'];
+    renderValue: CellContext<TData, TValue>['renderValue'];
     row: Row<TData>;
     column: Column<TData, TValue>;
-    getContext: () => {
-        table: Table<TData>;
-        column: Column<TData, TValue>;
-        row: Row<TData>;
-        cell: Cell<TData, TValue>;
-        getValue: <TTValue = TValue>() => TTValue;
-        renderValue: <TTValue = TValue>() => TTValue | null;
-    };
+    getContext: () => CellContext<TData, TValue>;
 };
 
 declare type CoreHeaderGroup<TData extends RowData> = {
@@ -29,6 +32,11 @@ declare type CoreHeaderGroup<TData extends RowData> = {
     depth: number;
     headers: Header<TData, unknown>[];
 };
+declare type HeaderContext<TData, TValue> = {
+    table: Table<TData>;
+    header: Header<TData, TValue>;
+    column: Column<TData, TValue>;
+};
 declare type CoreHeader<TData extends RowData, TValue> = {
     id: string;
     index: number;
@@ -41,11 +49,7 @@ declare type CoreHeader<TData extends RowData, TValue> = {
     getLeafHeaders: () => Header<TData, unknown>[];
     isPlaceholder: boolean;
     placeholderId?: string;
-    getContext: () => {
-        table: Table<TData>;
-        header: Header<TData, TValue>;
-        column: Column<TData, TValue>;
-    };
+    getContext: () => HeaderContext<TData, TValue>;
 };
 declare type HeadersInstance<TData extends RowData> = {
     getHeaderGroups: () => HeaderGroup<TData>[];
@@ -68,12 +72,11 @@ declare type HeadersInstance<TData extends RowData> = {
 declare const Headers: TableFeature;
 declare function buildHeaderGroups<TData extends RowData>(allColumns: Column<TData, unknown>[], columnsToGroup: Column<TData, unknown>[], table: Table<TData>, headerFamily?: 'center' | 'left' | 'right'): HeaderGroup<TData>[];
 
-declare type CoreColumnDefType = 'data' | 'display' | 'group';
 declare type CoreColumnDefBase<TData extends RowData, TValue> = {
-    columns?: ColumnDef<TData>[];
-    header?: ColumnDefTemplate<ReturnType<CoreHeader<TData, TValue>['getContext']>>;
-    footer?: ColumnDefTemplate<ReturnType<CoreHeader<TData, TValue>['getContext']>>;
-    cell?: ColumnDefTemplate<ReturnType<CoreCell<TData, TValue>['getContext']>>;
+    columns?: ColumnDef<TData, unknown>[];
+    header?: ColumnDefTemplate<HeaderContext<TData, TValue>>;
+    footer?: ColumnDefTemplate<HeaderContext<TData, TValue>>;
+    cell?: ColumnDefTemplate<CellContext<TData, TValue>>;
     meta?: ColumnMeta;
 };
 declare type CoreColumnDefDisplay<TData extends RowData, TValue> = CoreColumnDefBase<TData, TValue> & {
@@ -83,27 +86,29 @@ declare type CoreColumnDefDisplayWithStringHeader<TData extends RowData, TValue>
     header: string;
     id?: string;
 };
-declare type CoreColumnDefAccessorFn<TData extends RowData, TValue = unknown> = CoreColumnDefBase<TData, TValue> & {
+declare type CoreColumnDefAccessorFn<TData extends RowData, TValue> = CoreColumnDefBase<TData, TValue> & {
     accessorFn: AccessorFn<TData, TValue>;
     id: string;
 };
 declare type CoreColumnDefAccessorKey<TData extends RowData, TValue> = CoreColumnDefBase<TData, TValue> & {
-    accessorKey: keyof TData;
+    accessorKey: DeepKeys<TData>;
     id?: string;
 };
-declare type CoreColumnDef<TData extends RowData, TValue> = CoreColumnDefDisplay<TData, TValue> | CoreColumnDefDisplayWithStringHeader<TData, TValue> | CoreColumnDefAccessorFn<TData> | CoreColumnDefAccessorKey<TData, TValue>;
-declare type CoreColumnDefResolved<TData extends RowData, TValue = unknown> = Partial<UnionToIntersection<CoreColumnDef<TData, TValue>>>;
+declare type CoreColumnDef<TData extends RowData, TValue> = CoreColumnDefDisplay<TData, TValue> | CoreColumnDefDisplayWithStringHeader<TData, TValue> | CoreColumnDefAccessorFn<TData, TValue> | CoreColumnDefAccessorKey<TData, TValue>;
+declare type CoreColumnDefResolved<TData extends RowData, TValue = unknown> = Partial<UnionToIntersection<CoreColumnDef<TData, TValue>>> & {
+    accessorKey?: string;
+};
 declare type CoreColumn<TData extends RowData, TValue> = {
     id: string;
     depth: number;
     accessorFn?: AccessorFn<TData, TValue>;
-    columnDef: ColumnDef<TData>;
+    columnDef: ColumnDef<TData, TValue>;
     columns: Column<TData, TValue>[];
     parent?: Column<TData, TValue>;
     getFlatColumns: () => Column<TData, TValue>[];
     getLeafColumns: () => Column<TData, TValue>[];
 };
-declare function createColumn<TData extends RowData, TValue>(table: Table<TData>, columnDef: ColumnDef<TData>, depth: number, parent?: Column<TData, TValue>): Column<TData, TValue>;
+declare function createColumn<TData extends RowData, TValue>(table: Table<TData>, columnDef: ColumnDef<TData, TValue>, depth: number, parent?: Column<TData, TValue>): Column<TData, TValue>;
 
 declare type VisibilityState = Record<string, boolean>;
 declare type VisibilityTableState = {
@@ -669,7 +674,17 @@ declare type Overwrite<T, U extends {
     [TKey in keyof T]?: any;
 }> = Omit<T, keyof U> & U;
 declare type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
-declare type IfDefined<T, N> = 0 extends 1 & T ? N : T extends {} ? T : N;
+declare type IsAny<T, Y, N> = 1 extends 0 & T ? Y : N;
+declare type IsKnown<T, Y, N> = unknown extends T ? N : Y;
+declare type ComputeRange<N extends number, Result extends Array<unknown> = []> = Result['length'] extends N ? Result : ComputeRange<N, [...Result, Result['length']]>;
+declare type Index100 = ComputeRange<100>[number];
+declare type IsTuple<T> = T extends readonly any[] & {
+    length: infer Length;
+} ? Length extends Index100 ? T : never : never;
+declare type AllowedIndexes<Tuple extends ReadonlyArray<any>, Keys extends number = never> = Tuple extends readonly [] ? Keys : Tuple extends readonly [infer _, ...infer Tail] ? AllowedIndexes<Tail, Keys | Tail['length']> : Keys;
+declare type DeepKeys<T> = unknown extends T ? keyof T : object extends T ? string : T extends readonly any[] & IsTuple<T> ? AllowedIndexes<T> | DeepKeysPrefix<T, AllowedIndexes<T>> : T extends any[] ? never & 'Dynamic length array indexing is not supported' : T extends object ? (keyof T & string) | DeepKeysPrefix<T, keyof T> : never;
+declare type DeepKeysPrefix<T, TPrefix> = TPrefix extends keyof T & (number | string) ? `${TPrefix}.${DeepKeys<T[TPrefix]> & string}` : never;
+declare type DeepValue<T, TProp> = T extends Record<string | number, any> ? TProp extends `${infer TBranch}.${infer TDeepProp}` ? DeepValue<T[TBranch], TDeepProp> : T[TProp & string] : never;
 declare function functionalUpdate<T>(updater: Updater<T>, input: T): T;
 declare function noop(): void;
 declare function makeStateUpdater<K extends keyof TableState>(key: K, instance: unknown): (updater: Updater<TableState[K]>) => void;
@@ -709,8 +724,8 @@ declare type CoreOptions<TData extends RowData> = {
     getCoreRowModel: (table: Table<any>) => () => RowModel<any>;
     getSubRows?: (originalRow: TData, index: number) => undefined | TData[];
     getRowId?: (originalRow: TData, index: number, parent?: Row<TData>) => string;
-    columns: ColumnDef<TData>[];
-    defaultColumn?: Partial<ColumnDef<TData>>;
+    columns: ColumnDef<TData, any>[];
+    defaultColumn?: Partial<ColumnDef<TData, unknown>>;
     renderFallbackValue: any;
 };
 declare type CoreInstance<TData extends RowData> = {
@@ -727,8 +742,8 @@ declare type CoreInstance<TData extends RowData> = {
     _getCoreRowModel?: () => RowModel<TData>;
     getRowModel: () => RowModel<TData>;
     getRow: (id: string) => Row<TData>;
-    _getDefaultColumnDef: () => Partial<ColumnDef<TData>>;
-    _getColumnDefs: () => ColumnDef<TData>[];
+    _getDefaultColumnDef: () => Partial<ColumnDef<TData, unknown>>;
+    _getColumnDefs: () => ColumnDef<TData, unknown>[];
     _getAllFlatColumnsById: () => Record<string, Column<TData, unknown>>;
     getAllColumns: () => Column<TData, unknown>[];
     getAllFlatColumns: () => Column<TData, unknown>[];
@@ -737,6 +752,11 @@ declare type CoreInstance<TData extends RowData> = {
 };
 declare function createTable<TData extends RowData>(options: TableOptionsResolved<TData>): Table<TData>;
 
+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>;
+};
+declare function createColumnHelper<TData extends RowData>(): ColumnHelper<TData>;
+
 declare function getCoreRowModel<TData extends RowData>(): (table: Table<TData>) => () => RowModel<TData>;
 
 declare function getFilteredRowModel<TData extends RowData>(): (table: Table<TData>) => () => RowModel<TData>;
@@ -762,4 +782,4 @@ declare function getPaginationRowModel<TData extends RowData>(opts?: {
     initialSync: boolean;
 }): (table: Table<TData>) => () => RowModel<TData>;
 
-export { AccessorFn, AggregationFn, AggregationFnOption, AnyRender, BuiltInAggregationFn, BuiltInFilterFn, BuiltInSortingFn, Cell, Column, ColumnDef, ColumnDefTemplate, ColumnDefaultOptions, ColumnFilter, ColumnFilterAutoRemoveTestFn, ColumnFiltersState, 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, CoreColumn, CoreColumnDef, CoreColumnDefResolved, CoreColumnDefType, CoreHeader, CoreHeaderGroup, CoreInstance, CoreOptions, CoreRow, CoreTableState, CustomAggregationFns, CustomFilterFns, CustomSortingFns, ExpandedInstance, ExpandedOptions, ExpandedRow, ExpandedState, ExpandedStateList, ExpandedTableState, Expanding, FilterFn, FilterFnOption, FilterMeta, Filters, FiltersColumn, FiltersColumnDef, FiltersInstance, FiltersOptions, FiltersRow, FiltersTableState, Grouping, GroupingCell, GroupingColumn, GroupingColumnDef, GroupingColumnMode, GroupingInstance, GroupingOptions, GroupingRow, GroupingState, GroupingTableState, Header, HeaderGroup, Headers, HeadersInstance, IfDefined, InitialTableState, 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, TableGenerics, TableMeta, TableOptions, TableOptionsResolved, TableState, TransformFilterValueFn, UnionToIntersection, Updater, Visibility, VisibilityColumn, VisibilityColumnDef, VisibilityDefaultOptions, VisibilityInstance, VisibilityOptions, VisibilityRow, VisibilityState, VisibilityTableState, aggregationFns, buildHeaderGroups, createColumn, 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, AnyRender, BuiltInAggregationFn, BuiltInFilterFn, BuiltInSortingFn, Cell, 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, 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, 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, TableGenerics, TableMeta, TableOptions, TableOptionsResolved, TableState, TransformFilterValueFn, UnionToIntersection, Updater, Visibility, VisibilityColumn, VisibilityColumnDef, VisibilityDefaultOptions, VisibilityInstance, VisibilityOptions, VisibilityRow, VisibilityState, VisibilityTableState, aggregationFns, buildHeaderGroups, 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

@@ -14,6 +14,9 @@
   (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.TableCore = {}));
 })(this, (function (exports) { 'use strict';
 
+  // Is this type a tuple?
+  // If this type is a tuple, what indices are allowed?
+  ///
   function functionalUpdate(updater, input) {
     return typeof updater === 'function' ? updater(input) : updater;
   }
@@ -99,13 +102,27 @@
     const resolvedColumnDef = { ...defaultColumn,
       ...columnDef
     };
-    let id = (_ref = (_resolvedColumnDef$id = resolvedColumnDef.id) != null ? _resolvedColumnDef$id : resolvedColumnDef.accessorKey) != null ? _ref : typeof resolvedColumnDef.header === 'string' ? resolvedColumnDef.header : undefined;
+    const accessorKey = resolvedColumnDef.accessorKey;
+    let id = (_ref = (_resolvedColumnDef$id = resolvedColumnDef.id) != null ? _resolvedColumnDef$id : accessorKey ? accessorKey.replace('.', '_') : undefined) != null ? _ref : typeof resolvedColumnDef.header === 'string' ? resolvedColumnDef.header : undefined;
     let accessorFn;
 
     if (resolvedColumnDef.accessorFn) {
       accessorFn = resolvedColumnDef.accessorFn;
-    } else if (resolvedColumnDef.accessorKey) {
-      accessorFn = originalRow => originalRow[resolvedColumnDef.accessorKey];
+    } else if (accessorKey) {
+      // Support deep accessor keys
+      if (accessorKey.includes('.')) {
+        accessorFn = originalRow => {
+          let result = originalRow;
+
+          for (const key of accessorKey.split('.')) {
+            result = result[key];
+          }
+
+          return result;
+        };
+      } else {
+        accessorFn = originalRow => originalRow[resolvedColumnDef.accessorKey];
+      }
     }
 
     if (!id) {
@@ -953,7 +970,7 @@
         getCanExpand: () => {
           var _table$options$getRow, _table$options$enable, _row$subRows;
 
-          return ((_table$options$getRow = table.options.getRowCanExpand == null ? void 0 : table.options.getRowCanExpand(row)) != null ? _table$options$getRow : true) && ((_table$options$enable = table.options.enableExpanding) != null ? _table$options$enable : true) && !!((_row$subRows = row.subRows) != null && _row$subRows.length);
+          return (_table$options$getRow = table.options.getRowCanExpand == null ? void 0 : table.options.getRowCanExpand(row)) != null ? _table$options$getRow : ((_table$options$enable = table.options.enableExpanding) != null ? _table$options$enable : true) && !!((_row$subRows = row.subRows) != null && _row$subRows.length);
         },
         getToggleExpandedHandler: () => {
           const canExpand = row.getCanExpand();
@@ -1099,7 +1116,7 @@
           var _table$getCoreRowMode, _table$getCoreRowMode2;
 
           const value = (_table$getCoreRowMode = table.getCoreRowModel().flatRows[0]) == null ? void 0 : (_table$getCoreRowMode2 = _table$getCoreRowMode._getAllCellsByColumnId()[column.id]) == null ? void 0 : _table$getCoreRowMode2.getValue();
-          return typeof value === 'string';
+          return typeof value === 'string' || typeof value === 'number';
         }
       };
     },
@@ -3091,6 +3108,52 @@
     return row;
   };
 
+  // type Person = {
+  //   firstName: string
+  //   lastName: string
+  //   age: number
+  //   visits: number
+  //   status: string
+  //   progress: number
+  //   nested: {
+  //     foo: [
+  //       {
+  //         bar: 'bar'
+  //       }
+  //     ]
+  //     bar: { subBar: boolean }[]
+  //     baz: {
+  //       foo: 'foo'
+  //       bar: {
+  //         baz: 'baz'
+  //       }
+  //     }
+  //   }
+  // }
+  // const test: DeepKeys<Person> = 'nested.foo.0.bar'
+  // const test2: DeepKeys<Person> = 'nested.bar'
+  // const helper = createColumnHelper<Person>()
+  // helper.accessor('nested.foo', {
+  //   cell: info => info.getValue(),
+  // })
+  // helper.accessor('nested.foo.0.bar', {
+  //   cell: info => info.getValue(),
+  // })
+  // helper.accessor('nested.bar', {
+  //   cell: info => info.getValue(),
+  // })
+  function createColumnHelper() {
+    return {
+      accessor: (accessor, column) => {
+        return typeof accessor === 'function' ? { ...column,
+          accessorFn: accessor
+        } : { ...column,
+          accessorKey: accessor
+        };
+      }
+    };
+  }
+
   function getCoreRowModel() {
     return table => memo(() => [table.options.data], data => {
       const rowModel = {
@@ -3800,6 +3863,7 @@
   exports.aggregationFns = aggregationFns;
   exports.buildHeaderGroups = buildHeaderGroups;
   exports.createColumn = createColumn;
+  exports.createColumnHelper = createColumnHelper;
   exports.createRow = createRow;
   exports.createTable = createTable;
   exports.defaultColumnSizing = defaultColumnSizing;