@tanstack/table-core 8.5.2 → 8.5.5

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/table-core",
   "author": "Tanner Linsley",
-  "version": "8.5.2",
+  "version": "8.5.5",
   "description": "Headless UI for building powerful tables & datagrids for TS/JS.",
   "license": "MIT",
   "homepage": "https://github.com/tanstack/table#readme",

package/src/columnHelper.ts

@@ -1,9 +1,11 @@
 import {
-  CoreColumnDefDisplay,
-  CoreColumnDefDisplayWithStringHeader,
-} from './core/column'
-import { GroupingColumnDef } from './features/Grouping'
-import { AccessorFn, ColumnDef, RowData } from './types'
+  AccessorFn,
+  ColumnDef,
+  DisplayColumnDef,
+  GroupColumnDef,
+  IdentifiedColumnDef,
+  RowData,
+} from './types'
 import { DeepKeys, DeepValue, RequiredKeys } from './utils'
 
 // type Person = {
@@ -13,6 +15,7 @@ import { DeepKeys, DeepValue, RequiredKeys } from './utils'
 //   visits: number
 //   status: string
 //   progress: number
+//   createdAt: Date
 //   nested: {
 //     foo: [
 //       {
@@ -56,24 +59,12 @@ export type ColumnHelper<TData extends RowData> = {
       : never
   >(
     accessor: TAccessor,
-    column: Omit<ColumnDef<TData, TValue>, 'accessorKey'>
+    column: TAccessor extends AccessorFn<TData>
+      ? DisplayColumnDef<TData, TValue>
+      : IdentifiedColumnDef<TData, TValue>
   ) => ColumnDef<TData, TValue>
-  display: (
-    column: RequiredKeys<
-      Omit<ColumnDef<TData, unknown>, 'accessorKey' | 'accessorFn'>,
-      'id'
-    >
-  ) => ColumnDef<TData, unknown>
-  group: (
-    column: Omit<
-      ColumnDef<TData, unknown>,
-      'id' | 'header' | 'accessorKey' | 'accessorFn' | 'columns'
-    > &
-      (
-        | CoreColumnDefDisplayWithStringHeader<TData, unknown>
-        | CoreColumnDefDisplay<TData, unknown>
-      ) & { columns: ColumnDef<TData, any>[] }
-  ) => ColumnDef<TData, unknown>
+  display: (column: DisplayColumnDef<TData>) => ColumnDef<TData, unknown>
+  group: (column: GroupColumnDef<TData>) => ColumnDef<TData, unknown>
 }
 
 export function createColumnHelper<

package/src/core/column.ts

@@ -1,3 +1,4 @@
+import { TaggedTemplateExpression } from '@babel/types'
 import {
   Column,
   Table,
@@ -6,62 +7,9 @@ import {
   ColumnDefTemplate,
   RowData,
   ColumnMeta,
+  ColumnDefResolved,
 } from '../types'
-import { DeepKeys, IsKnown, memo, UnionToIntersection } from '../utils'
-import { CellContext } from './cell'
-import { HeaderContext } from './headers'
-
-export type CoreColumnDefBase<TData extends RowData, TValue> = {
-  columns?: ColumnDef<TData, unknown>[]
-  header?: ColumnDefTemplate<HeaderContext<TData, TValue>>
-  footer?: ColumnDefTemplate<HeaderContext<TData, TValue>>
-  cell?: ColumnDefTemplate<CellContext<TData, TValue>>
-  meta?: ColumnMeta<TData, TValue>
-}
-
-export type CoreColumnDefDisplay<
-  TData extends RowData,
-  TValue
-> = CoreColumnDefBase<TData, TValue> & {
-  id: string
-}
-
-export type CoreColumnDefDisplayWithStringHeader<
-  TData extends RowData,
-  TValue
-> = CoreColumnDefBase<TData, TValue> & {
-  header: string
-  id?: string
-}
-
-export type CoreColumnDefAccessorFn<
-  TData extends RowData,
-  TValue
-> = CoreColumnDefBase<TData, TValue> & {
-  accessorFn: AccessorFn<TData, TValue>
-  id: string
-}
-
-export type CoreColumnDefAccessorKey<
-  TData extends RowData,
-  TValue
-> = CoreColumnDefBase<TData, TValue> & {
-  accessorKey: DeepKeys<TData>
-  id?: string
-}
-
-export type CoreColumnDef<TData extends RowData, TValue> =
-  | CoreColumnDefDisplay<TData, TValue>
-  | CoreColumnDefDisplayWithStringHeader<TData, TValue>
-  | CoreColumnDefAccessorFn<TData, TValue>
-  | CoreColumnDefAccessorKey<TData, TValue>
-
-export type CoreColumnDefResolved<
-  TData extends RowData,
-  TValue = unknown
-> = Partial<UnionToIntersection<CoreColumnDef<TData, TValue>>> & {
-  accessorKey?: string
-}
+import { memo } from '../utils'
 
 export type CoreColumn<TData extends RowData, TValue> = {
   id: string
@@ -85,7 +33,7 @@ export function createColumn<TData extends RowData, TValue>(
   const resolvedColumnDef = {
     ...defaultColumn,
     ...columnDef,
-  } as CoreColumnDefResolved<TData>
+  } as ColumnDefResolved<TData>
 
   const accessorKey = resolvedColumnDef.accessorKey
 

package/src/core/table.ts

@@ -14,17 +14,19 @@ import {
   TableOptions,
   RowData,
   TableMeta,
+  ColumnDefResolved,
+  GroupColumnDef,
 } from '../types'
 
 //
-import { CoreColumnDefResolved, createColumn } from './column'
+import { createColumn } from './column'
 import { Headers } from './headers'
 //
 
 import { ColumnSizing } from '../features/ColumnSizing'
 import { Expanding } from '../features/Expanding'
 import { Filters } from '../features/Filters'
-import { Grouping } from '../features/Grouping'
+import { Grouping, GroupingColumnDef } from '../features/Grouping'
 import { Ordering } from '../features/Ordering'
 import { Pagination } from '../features/Pagination'
 import { Pinning } from '../features/Pinning'
@@ -234,7 +236,7 @@ export function createTable<TData extends RowData>(
         return {
           header: props => {
             const resolvedColumnDef = props.header.column
-              .columnDef as CoreColumnDefResolved<TData>
+              .columnDef as ColumnDefResolved<TData>
 
             if (resolvedColumnDef.accessorKey) {
               return resolvedColumnDef.accessorKey
@@ -273,8 +275,13 @@ export function createTable<TData extends RowData>(
           return columnDefs.map(columnDef => {
             const column = createColumn(table, columnDef, depth, parent)
 
-            column.columns = columnDef.columns
-              ? recurseColumns(columnDef.columns, column, depth + 1)
+            const groupingColumnDef = columnDef as GroupColumnDef<
+              TData,
+              unknown
+            >
+
+            column.columns = groupingColumnDef.columns
+              ? recurseColumns(groupingColumnDef.columns, column, depth + 1)
               : []
 
             return column

package/src/features/RowSelection.ts

@@ -267,16 +267,16 @@ export const RowSelection: TableFeature = {
       // },
 
       getIsAllRowsSelected: () => {
-        const preFilteredFlatRows = table.getPreFilteredRowModel().flatRows
+        const preGroupedFlatRows = table.getFilteredRowModel().flatRows
         const { rowSelection } = table.getState()
 
         let isAllRowsSelected = Boolean(
-          preFilteredFlatRows.length && Object.keys(rowSelection).length
+          preGroupedFlatRows.length && Object.keys(rowSelection).length
         )
 
         if (isAllRowsSelected) {
           if (
-            preFilteredFlatRows.some(
+            preGroupedFlatRows.some(
               row => row.getCanSelect() && !rowSelection[row.id]
             )
           ) {
@@ -309,7 +309,7 @@ export const RowSelection: TableFeature = {
         ).length
         return (
           totalSelected > 0 &&
-          totalSelected < table.getCoreRowModel().flatRows.length
+          totalSelected < table.getFilteredRowModel().flatRows.length
         )
       },
 

package/src/types.ts

@@ -1,5 +1,4 @@
 import { CoreOptions, CoreTableState, CoreInstance } from './core/table'
-import { CoreColumn, CoreColumnDef } from './core/column'
 import {
   VisibilityInstance,
   VisibilityTableState,
@@ -21,7 +20,12 @@ import {
   ColumnPinningRow,
   ColumnPinningTableState,
 } from './features/Pinning'
-import { CoreHeader, CoreHeaderGroup, HeadersInstance } from './core/headers'
+import {
+  CoreHeader,
+  CoreHeaderGroup,
+  HeaderContext,
+  HeadersInstance,
+} from './core/headers'
 import {
   FilterFn,
   FiltersColumn,
@@ -75,8 +79,9 @@ import {
   RowSelectionTableState,
 } from './features/RowSelection'
 import { CoreRow } from './core/row'
-import { PartialKeys } from './utils'
-import { CoreCell } from './core/cell'
+import { DeepKeys, PartialKeys, UnionToIntersection } from './utils'
+import { CellContext, CoreCell } from './core/cell'
+import { CoreColumn } from './core/column'
 
 export interface TableMeta<TData extends RowData> {}
 export interface ColumnMeta<TData extends RowData, TValue> {}
@@ -171,18 +176,97 @@ export type ColumnDefTemplate<TProps extends object> =
   | string
   | ((props: TProps) => any)
 
-export type ColumnDef<
-  TData extends RowData,
-  TValue extends any = unknown
-> = CoreColumnDef<TData, TValue> &
-  VisibilityColumnDef &
+export type StringOrTemplateHeader<TData, TValue> =
+  | string
+  | ColumnDefTemplate<HeaderContext<TData, TValue>>
+
+type StringHeaderIdentifier = {
+  header: string
+  id?: string
+}
+
+type IdIdentifier<TData extends RowData, TValue> = {
+  id: string
+  header?: StringOrTemplateHeader<TData, TValue>
+}
+
+type ColumnIdentifiers<TData extends RowData, TValue> =
+  | IdIdentifier<TData, TValue>
+  | StringHeaderIdentifier
+
+//
+
+export type ColumnDefBase<TData extends RowData, TValue = unknown> = {
+  footer?: ColumnDefTemplate<HeaderContext<TData, TValue>>
+  cell?: ColumnDefTemplate<CellContext<TData, TValue>>
+  meta?: ColumnMeta<TData, TValue>
+} & VisibilityColumnDef &
   ColumnPinningColumnDef &
   FiltersColumnDef<TData> &
   SortingColumnDef<TData> &
   GroupingColumnDef<TData, TValue> &
   ColumnSizingColumnDef
 
-export type Column<TData extends RowData, TValue> = CoreColumn<TData, TValue> &
+//
+
+export type IdentifiedColumnDef<
+  TData extends RowData,
+  TValue = unknown
+> = ColumnDefBase<TData, TValue> & {
+  id?: string
+  header?: StringOrTemplateHeader<TData, TValue>
+}
+
+export type DisplayColumnDef<
+  TData extends RowData,
+  TValue = unknown
+> = ColumnDefBase<TData, TValue> & ColumnIdentifiers<TData, TValue>
+
+export type GroupColumnDef<
+  TData extends RowData,
+  TValue = unknown
+> = ColumnDefBase<TData, TValue> &
+  ColumnIdentifiers<TData, TValue> & {
+    columns?: ColumnDef<TData, any>[]
+  }
+
+export type AccessorFnColumnDef<
+  TData extends RowData,
+  TValue = unknown
+> = ColumnDefBase<TData, TValue> &
+  ColumnIdentifiers<TData, TValue> & {
+    accessorFn: AccessorFn<TData, TValue>
+  }
+
+export type AccessorKeyColumnDef<TData extends RowData, TValue = unknown> = {
+  id?: string
+} & ColumnIdentifiers<TData, TValue> &
+  ColumnDefBase<TData, TValue> & {
+    accessorKey: DeepKeys<TData>
+  }
+
+export type AccessorColumnDef<TData extends RowData, TValue = unknown> =
+  | AccessorKeyColumnDef<TData, TValue>
+  | AccessorFnColumnDef<TData, TValue>
+
+//
+
+export type ColumnDef<TData extends RowData, TValue = unknown> =
+  | DisplayColumnDef<TData, TValue>
+  | GroupColumnDef<TData, TValue>
+  | AccessorColumnDef<TData, TValue>
+
+export type ColumnDefResolved<
+  TData extends RowData,
+  TValue = unknown
+> = Partial<UnionToIntersection<ColumnDef<TData, TValue>>> & {
+  accessorKey?: string
+}
+
+export type Column<TData extends RowData, TValue = unknown> = CoreColumn<
+  TData,
+  TValue
+> &
   ColumnVisibilityColumn &
   ColumnPinningColumn &
   FiltersColumn<TData> &

package/src/utils.ts

@@ -51,6 +51,8 @@ export type DeepKeys<T> = unknown extends T
   ? AllowedIndexes<T> | DeepKeysPrefix<T, AllowedIndexes<T>>
   : T extends any[]
   ? never & 'Dynamic length array indexing is not supported'
+  : T extends Date
+  ? never
   : T extends object
   ? (keyof T & string) | DeepKeysPrefix<T, keyof T>
   : never