@tanstack/table-core 8.0.0-alpha.53 → 8.0.0-alpha.57

package/src/types.ts

@@ -1,11 +1,5 @@
-import {
-  CoreColumn,
-  CoreColumnDef,
-  CoreOptions,
-  CoreRow,
-  CoreTableState,
-  TableCore,
-} from './core'
+import { CoreOptions, CoreTableState, TableCore } from './core'
+import { ColumnsOptions, CoreColumn, CoreColumnDef } from './features/Columns'
 import {
   VisibilityInstance,
   VisibilityTableState,
@@ -24,9 +18,11 @@ import {
   ColumnPinningColumnDef,
   ColumnPinningInstance,
   ColumnPinningOptions,
+  ColumnPinningPosition,
+  ColumnPinningRow,
   ColumnPinningTableState,
 } from './features/Pinning'
-import { HeadersInstance, HeadersRow } from './features/Headers'
+import { HeadersInstance } from './features/Headers'
 import {
   FiltersColumn,
   FiltersColumnDef,
@@ -56,7 +52,7 @@ import {
   ExpandedTableState,
   ExpandedRow,
 } from './features/Expanding'
-import { Overwrite, PartialKeys } from './utils'
+import { Overwrite } from './utils'
 import {
   ColumnSizingColumn,
   ColumnSizingColumnDef,
@@ -76,41 +72,45 @@ import {
   RowSelectionRow,
   RowSelectionTableState,
 } from './features/RowSelection'
+import { ColumnsInstance } from './features/Columns'
+import { CellsInstance, CellsRow } from './features/Cells'
+import { CoreRow, RowsInstance, RowsOptions } from './features/Rows'
+
+export type Updater<T> = T | ((old: T) => T)
+export type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void
 
-export type DefaultGenerics = {
-  Row: unknown
-  Value: unknown
-  FilterFns: object
-  SortingFns: object
-  AggregationFns: object
-  Render: unknown
-  ColumnMeta: object
-  TableMeta: object
+export type TableGenerics = {
+  Row?: any
+  Value?: any
+  FilterFns?: any
+  SortingFns?: any
+  AggregationFns?: any
+  Render?: any
+  ColumnMeta?: any
+  TableMeta?: any
 }
 
 export type AnyRender = (Comp: any, props: any) => any
 
-export type UseRenderer<TGenerics extends AnyGenerics> =
+export type UseRenderer<TGenerics extends TableGenerics> =
   TGenerics['Render'] extends (...args: any) => any ? TGenerics['Render'] : any
 
-export type PartialGenerics = Partial<DefaultGenerics>
-
-export type AnyGenerics = {
-  [TKey in keyof PartialGenerics]?: any
-}
-
 export type TableFeature = {
   getDefaultOptions?: (instance: any) => any
   getInitialState?: () => any
-  getInstance?: (instance: any) => any
+  createInstance?: (instance: any) => any
   getDefaultColumn?: () => any
   createColumn?: (column: any, instance: any) => any
+  createHeader?: (column: any, instance: any) => any
   createCell?: (cell: any, column: any, row: any, instance: any) => any
   createRow?: (row: any, instance: any) => any
 }
 
-export type TableInstance<TGenerics extends AnyGenerics> =
+export type TableInstance<TGenerics extends TableGenerics> =
   TableCore<TGenerics> &
+    ColumnsInstance<TGenerics> &
+    RowsInstance<TGenerics> &
+    CellsInstance<TGenerics> &
     VisibilityInstance<TGenerics> &
     ColumnOrderInstance<TGenerics> &
     ColumnPinningInstance<TGenerics> &
@@ -123,9 +123,9 @@ export type TableInstance<TGenerics extends AnyGenerics> =
     PaginationInstance<TGenerics> &
     RowSelectionInstance<TGenerics>
 
-//
-
-export type Options<TGenerics extends AnyGenerics> = CoreOptions<TGenerics> &
+export type Options<TGenerics extends TableGenerics> = CoreOptions<TGenerics> &
+  ColumnsOptions<TGenerics> &
+  RowsOptions<TGenerics> &
   VisibilityOptions &
   ColumnOrderOptions &
   ColumnPinningOptions &
@@ -137,9 +137,6 @@ export type Options<TGenerics extends AnyGenerics> = CoreOptions<TGenerics> &
   PaginationOptions<TGenerics> &
   RowSelectionOptions<TGenerics>
 
-export type Updater<T> = T | ((old: T) => T)
-export type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void
-
 export type TableState = CoreTableState &
   VisibilityTableState &
   ColumnOrderTableState &
@@ -152,9 +149,10 @@ export type TableState = CoreTableState &
   PaginationTableState &
   RowSelectionTableState
 
-export type Row<TGenerics extends AnyGenerics> = CoreRow<TGenerics> &
+export type Row<TGenerics extends TableGenerics> = CoreRow<TGenerics> &
+  CellsRow<TGenerics> &
   VisibilityRow<TGenerics> &
-  HeadersRow<TGenerics> &
+  ColumnPinningRow<TGenerics> &
   GroupingRow &
   RowSelectionRow &
   ExpandedRow
@@ -163,7 +161,7 @@ export type RowValues = {
   [key: string]: any
 }
 
-export type RowModel<TGenerics extends AnyGenerics> = {
+export type RowModel<TGenerics extends TableGenerics> = {
   rows: Row<TGenerics>[]
   flatRows: Row<TGenerics>[]
   rowsById: Record<string, Row<TGenerics>>
@@ -171,30 +169,11 @@ export type RowModel<TGenerics extends AnyGenerics> = {
 
 export type AccessorFn<TData> = (originalRow: TData, index: number) => any
 
-// export type UserColumnDef<TGenerics extends AnyGenerics> = Overwrite<
-//   ColumnDef<TGenerics>,
-//   GeneratedProperties<false>
-// >
-
-// type _GeneratedProperties = {
-//   ['Column definitions should be generated with the table.createColumn() (and related) utilities']: false
-// }
-
-// export type GeneratedProperties<T> = T extends true
-//   ? {
-//       [TKey in keyof _GeneratedProperties]: true
-//     }
-//   : T extends false
-//   ? {
-//       [TKey in keyof _GeneratedProperties]?: false
-//     }
-// : never
-
-export type Renderable<TGenerics extends AnyGenerics, TProps> =
+export type Renderable<TGenerics extends TableGenerics, TProps> =
   | string
   | ((props: TProps) => ReturnType<UseRenderer<TGenerics>>)
 
-export type ColumnDef<TGenerics extends AnyGenerics> =
+export type ColumnDef<TGenerics extends TableGenerics> =
   CoreColumnDef<TGenerics> &
     VisibilityColumnDef &
     ColumnPinningColumnDef &
@@ -203,7 +182,7 @@ export type ColumnDef<TGenerics extends AnyGenerics> =
     GroupingColumnDef<TGenerics> &
     ColumnSizingColumnDef
 
-export type Column<TGenerics extends AnyGenerics> = ColumnDef<TGenerics> &
+export type Column<TGenerics extends TableGenerics> = ColumnDef<TGenerics> &
   CoreColumn<TGenerics> &
   ColumnVisibilityColumn &
   ColumnPinningColumn &
@@ -212,10 +191,10 @@ export type Column<TGenerics extends AnyGenerics> = ColumnDef<TGenerics> &
   GroupingColumn<TGenerics> &
   ColumnSizingColumn<TGenerics>
 
-export type Cell<TGenerics extends AnyGenerics> = CoreCell<TGenerics> &
+export type Cell<TGenerics extends TableGenerics> = CoreCell<TGenerics> &
   GroupingCell<TGenerics>
 
-export type CoreCell<TGenerics extends AnyGenerics> = {
+export type CoreCell<TGenerics extends TableGenerics> = {
   id: string
   rowId: string
   columnId: string
@@ -226,14 +205,17 @@ export type CoreCell<TGenerics extends AnyGenerics> = {
   renderCell: () => string | null | ReturnType<UseRenderer<TGenerics>>
 }
 
-export type Header<TGenerics extends AnyGenerics> = CoreHeader<TGenerics> &
+export type Header<TGenerics extends TableGenerics> = CoreHeader<TGenerics> &
   ColumnSizingHeader<TGenerics>
 
-export type CoreHeader<TGenerics extends AnyGenerics> = {
+export type CoreHeader<TGenerics extends TableGenerics> = {
   id: string
+  index: number
   depth: number
   column: Column<TGenerics>
-  getWidth: () => number
+  getStart: () => number
+  getSize: () => number
+  headerGroup: HeaderGroup<TGenerics>
   subHeaders: Header<TGenerics>[]
   colSpan?: number
   rowSpan?: number
@@ -250,7 +232,7 @@ export type CoreHeader<TGenerics extends AnyGenerics> = {
   }) => string | null | ReturnType<UseRenderer<TGenerics>>
 }
 
-export type HeaderGroup<TGenerics extends AnyGenerics> = {
+export type HeaderGroup<TGenerics extends TableGenerics> = {
   id: string
   depth: number
   headers: Header<TGenerics>[]

package/src/utils/filterRowsUtils.ts

@@ -1,6 +1,6 @@
-import { AnyGenerics, Row, RowModel, TableInstance } from '../types'
+import { TableGenerics, Row, RowModel, TableInstance } from '../types'
 
-export function filterRowModelFromLeafs<TGenerics extends AnyGenerics>(
+export function filterRowModelFromLeafs<TGenerics extends TableGenerics>(
   rowsToFilter: Row<TGenerics>[],
   filterRows: (
     rowsToFilter: Row<TGenerics>[],
@@ -56,7 +56,7 @@ export function filterRowModelFromLeafs<TGenerics extends AnyGenerics>(
   }
 }
 
-export function filterRowModelFromRoot<TGenerics extends AnyGenerics>(
+export function filterRowModelFromRoot<TGenerics extends TableGenerics>(
   rowsToFilter: Row<TGenerics>[],
   filterRows: (
     rowsToFilter: Row<TGenerics>[],

package/src/utils/getColumnFilteredRowModelAsync.ts

@@ -1,4 +1,4 @@
-import { TableInstance, RowModel, AnyGenerics, Row } from '../types'
+import { TableInstance, RowModel, TableGenerics, Row } from '../types'
 import { incrementalMemo, memo } from '../utils'
 import {
   filterRowModelFromLeafs,
@@ -6,7 +6,7 @@ import {
 } from './filterRowsUtils'
 
 export function getColumnFilteredRowModelAsync<
-  TGenerics extends AnyGenerics
+  TGenerics extends TableGenerics
 >(opts?: {
   initialSync?: boolean
 }): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics> {

package/src/utils/getColumnFilteredRowModelSync.ts

@@ -1,4 +1,4 @@
-import { TableInstance, RowModel, AnyGenerics, Row } from '../types'
+import { TableInstance, RowModel, TableGenerics, Row } from '../types'
 import { memo } from '../utils'
 import {
   filterRowModelFromLeafs,
@@ -6,7 +6,7 @@ import {
 } from './filterRowsUtils'
 
 export function getColumnFilteredRowModelSync<
-  TGenerics extends AnyGenerics
+  TGenerics extends TableGenerics
 >(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics> {
   return instance =>
     memo(

package/src/utils/getCoreRowModelAsync.ts

@@ -1,7 +1,7 @@
-import { TableInstance, Row, RowModel, AnyGenerics } from '../types'
+import { TableInstance, Row, RowModel, TableGenerics } from '../types'
 import { getBatchGroups, incrementalMemo } from '../utils'
 
-export function getCoreRowModelAsync<TGenerics extends AnyGenerics>(opts?: {
+export function getCoreRowModelAsync<TGenerics extends TableGenerics>(opts?: {
   initialSync: boolean
 }): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics> {
   return instance =>

package/src/utils/getCoreRowModelSync.ts

@@ -1,7 +1,7 @@
-import { TableInstance, Row, RowModel, AnyGenerics } from '../types'
+import { TableInstance, Row, RowModel, TableGenerics } from '../types'
 import { memo } from '../utils'
 
-export function getCoreRowModelSync<TGenerics extends AnyGenerics>(): (
+export function getCoreRowModelSync<TGenerics extends TableGenerics>(): (
   instance: TableInstance<TGenerics>
 ) => () => RowModel<TGenerics> {
   return instance =>

package/src/utils/getExpandedRowModel.ts

@@ -1,7 +1,7 @@
-import { TableInstance, Row, RowModel, AnyGenerics } from '../types'
+import { TableInstance, Row, RowModel, TableGenerics } from '../types'
 import { memo } from '../utils'
 
-export function getExpandedRowModel<TGenerics extends AnyGenerics>(): (
+export function getExpandedRowModel<TGenerics extends TableGenerics>(): (
   instance: TableInstance<TGenerics>
 ) => () => RowModel<TGenerics> {
   return instance =>
@@ -30,7 +30,7 @@ export function getExpandedRowModel<TGenerics extends AnyGenerics>(): (
     )
 }
 
-export function expandRows<TGenerics extends AnyGenerics>(
+export function expandRows<TGenerics extends TableGenerics>(
   rowModel: RowModel<TGenerics>,
   instance: TableInstance<TGenerics>
 ) {

package/src/utils/getGlobalFilteredRowModelAsync.ts

@@ -1,4 +1,4 @@
-import { TableInstance, RowModel, AnyGenerics, Row } from '../types'
+import { TableInstance, RowModel, TableGenerics, Row } from '../types'
 import { incrementalMemo, memo } from '../utils'
 import {
   filterRowModelFromLeafs,
@@ -6,7 +6,7 @@ import {
 } from './filterRowsUtils'
 
 export function getGlobalFilteredRowModelAsync<
-  TGenerics extends AnyGenerics
+  TGenerics extends TableGenerics
 >(opts?: {
   initialSync?: boolean
 }): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics> {

package/src/utils/getGlobalFilteredRowModelSync.ts

@@ -1,4 +1,4 @@
-import { TableInstance, RowModel, AnyGenerics, Row } from '../types'
+import { TableInstance, RowModel, TableGenerics, Row } from '../types'
 import { memo } from '../utils'
 import {
   filterRowModelFromLeafs,
@@ -6,7 +6,7 @@ import {
 } from './filterRowsUtils'
 
 export function getGlobalFilteredRowModelSync<
-  TGenerics extends AnyGenerics
+  TGenerics extends TableGenerics
 >(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics> {
   return instance =>
     memo(

package/src/utils/getGroupedRowModel.ts

@@ -1,7 +1,7 @@
-import { TableInstance, Row, RowModel, AnyGenerics } from '../types'
+import { TableInstance, Row, RowModel, TableGenerics } from '../types'
 import { flattenBy, memo } from '../utils'
 
-export function getGroupedRowModelSync<TGenerics extends AnyGenerics>(): (
+export function getGroupedRowModelSync<TGenerics extends TableGenerics>(): (
   instance: TableInstance<TGenerics>
 ) => () => RowModel<TGenerics> {
   return instance =>
@@ -172,7 +172,7 @@ export function getGroupedRowModelSync<TGenerics extends AnyGenerics>(): (
     )
 }
 
-function groupBy<TGenerics extends AnyGenerics>(
+function groupBy<TGenerics extends TableGenerics>(
   rows: Row<TGenerics>[],
   columnId: string
 ) {

package/src/utils/getPaginationRowModel.ts

@@ -1,8 +1,8 @@
-import { TableInstance, RowModel, AnyGenerics } from '../types'
+import { TableInstance, RowModel, TableGenerics } from '../types'
 import { memo } from '../utils'
 import { expandRows } from './getExpandedRowModel'
 
-export function getPaginationRowModel<TGenerics extends AnyGenerics>(opts?: {
+export function getPaginationRowModel<TGenerics extends TableGenerics>(opts?: {
   initialSync: boolean
 }): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics> {
   return instance =>

package/src/utils/getSortedRowModelAsync.ts

@@ -1,8 +1,8 @@
-import { TableInstance, Row, RowModel, AnyGenerics } from '../types'
+import { TableInstance, Row, RowModel, TableGenerics } from '../types'
 import { SortingFn } from '../features/Sorting'
 import { incrementalMemo, memo } from '../utils'
 
-export function getSortedRowModelSync<TGenerics extends AnyGenerics>(opts?: {
+export function getSortedRowModelSync<TGenerics extends TableGenerics>(opts?: {
   initialSync?: boolean
 }): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics> {
   return instance =>
@@ -91,7 +91,7 @@ export function getSortedRowModelSync<TGenerics extends AnyGenerics>(opts?: {
     )
 }
 
-type Sorter<TGenerics extends AnyGenerics> = {
+type Sorter<TGenerics extends TableGenerics> = {
   id: string
   compare: (a: Row<TGenerics>, b: Row<TGenerics>) => number
   desc?: boolean
@@ -99,7 +99,7 @@ type Sorter<TGenerics extends AnyGenerics> = {
   invertSorting?: boolean
 }
 
-export function quicksort<TGenerics extends AnyGenerics>(
+export function quicksort<TGenerics extends TableGenerics>(
   rows: Row<TGenerics>[],
   sorters: Sorter<TGenerics>[]
 ): Row<TGenerics>[] {

package/src/utils/getSortedRowModelSync.ts

@@ -1,8 +1,8 @@
-import { TableInstance, Row, RowModel, AnyGenerics } from '../types'
+import { TableInstance, Row, RowModel, TableGenerics } from '../types'
 import { SortingFn } from '../features/Sorting'
 import { memo } from '../utils'
 
-export function getSortedRowModelSync<TGenerics extends AnyGenerics>(): (
+export function getSortedRowModelSync<TGenerics extends TableGenerics>(): (
   instance: TableInstance<TGenerics>
 ) => () => RowModel<TGenerics> {
   return instance =>

package/src/utils.ts

@@ -12,20 +12,18 @@ export type Overwrite<T, U extends { [TKey in keyof T]?: any }> = Omit<
 
 export type IfDefined<T, N> = 0 extends 1 & T ? N : T extends {} ? T : N
 
-// export type DefinedGenericKeys<T extends AnyGenerics> = {
+// export type DefinedGenericKeys<T extends TableGenerics> = {
 //   [K in keyof T]: 0 extends 1 & T[K] ? never : T[K] extends {} ? K : never
 // }[keyof T]
 
-// export type DefinedGenerics<T extends AnyGenerics> = Pick<
+// export type DefinedGenerics<T extends TableGenerics> = Pick<
 //   T,
 //   DefinedGenericKeys<T>
 // >
 
-export type DataUpdateFunction<T> = (input: T) => T
-
 export function functionalUpdate<T>(updater: Updater<T>, input: T): T {
   return typeof updater === 'function'
-    ? (updater as DataUpdateFunction<T>)(input)
+    ? (updater as (input: T) => T)(input)
     : updater
 }