@tanstack/table-core 8.0.0-alpha.55 → 8.0.0-alpha.59

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,
@@ -66,6 +62,7 @@ import {
   ColumnSizingTableState,
 } from './features/ColumnSizing'
 import {
+  PaginationInitialTableState,
   PaginationInstance,
   PaginationOptions,
   PaginationTableState,
@@ -76,6 +73,12 @@ 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 TableGenerics = {
   Row?: any
@@ -83,28 +86,30 @@ export type TableGenerics = {
   FilterFns?: any
   SortingFns?: any
   AggregationFns?: any
-  Render?: any
+  Renderer?: any
+  Rendered?: any
   ColumnMeta?: any
   TableMeta?: any
 }
 
 export type AnyRender = (Comp: any, props: any) => any
 
-export type UseRenderer<TGenerics extends TableGenerics> =
-  TGenerics['Render'] extends (...args: any) => any ? TGenerics['Render'] : any
-
 export type TableFeature = {
   getDefaultOptions?: (instance: any) => any
-  getInitialState?: () => any
-  getInstance?: (instance: any) => any
+  getInitialState?: (initialState?: InitialTableState) => 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 TableGenerics> =
   TableCore<TGenerics> &
+    ColumnsInstance<TGenerics> &
+    RowsInstance<TGenerics> &
+    CellsInstance<TGenerics> &
     VisibilityInstance<TGenerics> &
     ColumnOrderInstance<TGenerics> &
     ColumnPinningInstance<TGenerics> &
@@ -117,22 +122,20 @@ export type TableInstance<TGenerics extends TableGenerics> =
     PaginationInstance<TGenerics> &
     RowSelectionInstance<TGenerics>
 
-//
-
-export type Options<TGenerics extends TableGenerics> = CoreOptions<TGenerics> &
-  VisibilityOptions &
-  ColumnOrderOptions &
-  ColumnPinningOptions &
-  FiltersOptions<TGenerics> &
-  SortingOptions<TGenerics> &
-  GroupingOptions<TGenerics> &
-  ExpandedOptions<TGenerics> &
-  ColumnSizingOptions &
-  PaginationOptions<TGenerics> &
-  RowSelectionOptions<TGenerics>
-
-export type Updater<T> = T | ((old: T) => T)
-export type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void
+export 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 type TableState = CoreTableState &
   VisibilityTableState &
@@ -146,9 +149,24 @@ export type TableState = CoreTableState &
   PaginationTableState &
   RowSelectionTableState
 
+export type InitialTableState = Partial<
+  CoreTableState &
+    VisibilityTableState &
+    ColumnOrderTableState &
+    ColumnPinningTableState &
+    FiltersTableState &
+    SortingTableState &
+    ExpandedTableState &
+    GroupingTableState &
+    ColumnSizingTableState &
+    PaginationInitialTableState &
+    RowSelectionTableState
+>
+
 export type Row<TGenerics extends TableGenerics> = CoreRow<TGenerics> &
+  CellsRow<TGenerics> &
   VisibilityRow<TGenerics> &
-  HeadersRow<TGenerics> &
+  ColumnPinningRow<TGenerics> &
   GroupingRow &
   RowSelectionRow &
   ExpandedRow
@@ -165,28 +183,9 @@ export type RowModel<TGenerics extends TableGenerics> = {
 
 export type AccessorFn<TData> = (originalRow: TData, index: number) => any
 
-// export type UserColumnDef<TGenerics extends TableGenerics> = 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 TableGenerics, TProps> =
   | string
-  | ((props: TProps) => ReturnType<UseRenderer<TGenerics>>)
+  | ((props: TProps) => TGenerics['Rendered'])
 
 export type ColumnDef<TGenerics extends TableGenerics> =
   CoreColumnDef<TGenerics> &
@@ -216,8 +215,7 @@ export type CoreCell<TGenerics extends TableGenerics> = {
   value: TGenerics['Value']
   row: Row<TGenerics>
   column: Column<TGenerics>
-  getCellProps: PropGetter<CellProps>
-  renderCell: () => string | null | ReturnType<UseRenderer<TGenerics>>
+  renderCell: () => string | null | TGenerics['Rendered']
 }
 
 export type Header<TGenerics extends TableGenerics> = CoreHeader<TGenerics> &
@@ -225,31 +223,30 @@ export type Header<TGenerics extends TableGenerics> = CoreHeader<TGenerics> &
 
 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
-  getHeaderProps: PropGetter<HeaderProps>
-  getFooterProps: PropGetter<HeaderProps>
   getLeafHeaders: () => Header<TGenerics>[]
   isPlaceholder?: boolean
   placeholderId?: string
   renderHeader: (options?: {
     renderPlaceholder?: boolean
-  }) => string | null | ReturnType<UseRenderer<TGenerics>>
+  }) => string | null | TGenerics['Rendered']
   renderFooter: (options?: {
     renderPlaceholder?: boolean
-  }) => string | null | ReturnType<UseRenderer<TGenerics>>
+  }) => string | null | TGenerics['Rendered']
 }
 
 export type HeaderGroup<TGenerics extends TableGenerics> = {
   id: string
   depth: number
   headers: Header<TGenerics>[]
-  getHeaderGroupProps: PropGetter<HeaderGroupProps>
-  getFooterGroupProps: PropGetter<FooterGroupProps>
 }
 
 export type HeaderRenderProps<THeader> = {
@@ -265,75 +262,4 @@ export type CellRenderProps<TCell, TRow> = {
   row: TRow
 }
 
-export type TableProps = {
-  role: string
-}
-
-export type TableBodyProps = {
-  role: string
-}
-
-export type TableHeadProps = {
-  key: string
-  role: string
-}
-
-export type TableFooterProps = {
-  key: string
-  role: string
-}
-
-export type HeaderGroupProps = {
-  key: string
-  role: string
-}
-
-export type FooterGroupProps = {
-  key: string
-  role: string
-}
-
-export type HeaderProps = {
-  key: string
-  role: string
-  colSpan?: number
-  rowSpan?: number
-}
-
-export type FooterProps = {
-  key: string
-  role: string
-  colSpan?: number
-  rowSpan?: number
-}
-
-export type RowProps = {
-  key: string
-  role: string
-}
-
-export type CellProps = {
-  key: string
-  role: string
-}
-
-//
-
-export type PropGetter<TBase> = <TGetter extends Getter<TBase>>(
-  userProps?: TGetter
-) => PropGetterValue<TBase, TGetter>
-
-export type Getter<TInitial> =
-  | ((initial: TInitial) => object)
-  | object
-  | undefined
-
-export type PropGetterValue<TBase, TGetter> = TGetter extends undefined
-  ? TBase
-  : TGetter extends (...args: any[]) => infer TReturn
-  ? Overwrite<TBase, TReturn>
-  : TGetter extends object
-  ? Overwrite<TBase, TGetter>
-  : never
-
 export type NoInfer<A extends any> = [A][A extends any ? 0 : never]

package/src/utils/getColumnFilteredRowModelAsync.ts

@@ -1,9 +1,5 @@
 import { TableInstance, RowModel, TableGenerics, Row } from '../types'
-import { incrementalMemo, memo } from '../utils'
-import {
-  filterRowModelFromLeafs,
-  filterRowModelFromRoot,
-} from './filterRowsUtils'
+import { incrementalMemo } from '../utils'
 
 export function getColumnFilteredRowModelAsync<
   TGenerics extends TableGenerics

package/src/utils/getGlobalFilteredRowModelAsync.ts

@@ -1,9 +1,5 @@
-import { TableInstance, RowModel, TableGenerics, Row } from '../types'
-import { incrementalMemo, memo } from '../utils'
-import {
-  filterRowModelFromLeafs,
-  filterRowModelFromRoot,
-} from './filterRowsUtils'
+import { TableInstance, RowModel, TableGenerics } from '../types'
+import { incrementalMemo } from '../utils'
 
 export function getGlobalFilteredRowModelAsync<
   TGenerics extends TableGenerics

package/src/utils/getSortedRowModelAsync.ts

@@ -1,5 +1,4 @@
 import { TableInstance, Row, RowModel, TableGenerics } from '../types'
-import { SortingFn } from '../features/Sorting'
 import { incrementalMemo, memo } from '../utils'
 
 export function getSortedRowModelSync<TGenerics extends TableGenerics>(opts?: {

package/src/utils.ts

@@ -1,6 +1,5 @@
-import { Getter, NoInfer, PropGetterValue, TableState, Updater } from './types'
+import { NoInfer, TableState, Updater } from './types'
 
-export type IsAny<T> = 0 extends 1 & T ? true : false
 export type PartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
 export type RequiredKeys<T, K extends keyof T> = Omit<T, K> &
   Required<Pick<T, K>>
@@ -12,20 +11,9 @@ 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 TableGenerics> = {
-//   [K in keyof T]: 0 extends 1 & T[K] ? never : T[K] extends {} ? K : never
-// }[keyof T]
-
-// 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
 }
 
@@ -100,23 +88,6 @@ export function flattenBy<TNode>(
   return flat
 }
 
-type PropGetterImpl = <TBaseProps, TGetter extends Getter<TBaseProps>>(
-  initial: TBaseProps,
-  userProps?: TGetter
-) => PropGetterValue<TBaseProps, TGetter>
-
-// @ts-ignore // Just rely on the type, not the implementation
-export const propGetter: PropGetterImpl = (initial, getter) => {
-  if (isFunction(getter)) {
-    return getter(initial)
-  }
-
-  return {
-    ...initial,
-    ...(getter ?? {}),
-  }
-}
-
 export function memo<TDeps extends readonly any[], TResult>(
   getDeps: () => [...TDeps],
   fn: (...args: NoInfer<[...TDeps]>) => TResult,