@tanstack/table-core 9.0.0-alpha.0 → 9.0.0-alpha.11

package/src/{sortingFns.ts → fns/sortFns.ts}

@@ -1,42 +1,80 @@
-import { SortingFn } from './features/RowSorting'
+import type { RowData } from '../types/type-utils'
+import type { TableFeatures } from '../types/TableFeatures'
+import type { Row } from '../types/Row'
+import type { SortFn } from '../features/row-sorting/rowSortingFeature.types'
 
 export const reSplitAlphaNumeric = /([0-9]+)/gm
 
-const alphanumeric: SortingFn<any> = (rowA, rowB, columnId) => {
+export const sortFn_alphanumeric: SortFn<any, any> = <
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(
+  rowA: Row<any, any>,
+  rowB: Row<any, any>,
+  columnId: string,
+) => {
   return compareAlphanumeric(
     toString(rowA.getValue(columnId)).toLowerCase(),
-    toString(rowB.getValue(columnId)).toLowerCase()
+    toString(rowB.getValue(columnId)).toLowerCase(),
   )
 }
 
-const alphanumericCaseSensitive: SortingFn<any> = (rowA, rowB, columnId) => {
+export const sortFn_alphanumericCaseSensitive: SortFn<any, any> = <
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(
+  rowA: Row<any, any>,
+  rowB: Row<any, any>,
+  columnId: string,
+) => {
   return compareAlphanumeric(
     toString(rowA.getValue(columnId)),
-    toString(rowB.getValue(columnId))
+    toString(rowB.getValue(columnId)),
   )
 }
 
 // The text filter is more basic (less numeric support)
 // but is much faster
-const text: SortingFn<any> = (rowA, rowB, columnId) => {
+export const sortFn_text: SortFn<any, any> = <
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(
+  rowA: Row<any, any>,
+  rowB: Row<any, any>,
+  columnId: string,
+) => {
   return compareBasic(
     toString(rowA.getValue(columnId)).toLowerCase(),
-    toString(rowB.getValue(columnId)).toLowerCase()
+    toString(rowB.getValue(columnId)).toLowerCase(),
   )
 }
 
 // The text filter is more basic (less numeric support)
 // but is much faster
-const textCaseSensitive: SortingFn<any> = (rowA, rowB, columnId) => {
+export const sortFn_textCaseSensitive: SortFn<any, any> = <
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(
+  rowA: Row<any, any>,
+  rowB: Row<any, any>,
+  columnId: string,
+) => {
   return compareBasic(
     toString(rowA.getValue(columnId)),
-    toString(rowB.getValue(columnId))
+    toString(rowB.getValue(columnId)),
   )
 }
 
-const datetime: SortingFn<any> = (rowA, rowB, columnId) => {
-  const a = rowA.getValue<Date>(columnId)
-  const b = rowB.getValue<Date>(columnId)
+export const sortFn_datetime: SortFn<any, any> = <
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(
+  rowA: Row<any, any>,
+  rowB: Row<any, any>,
+  columnId: string,
+) => {
+  const a: number | string = rowA.getValue(columnId)
+  const b: number | string = rowB.getValue(columnId)
 
   // Can handle nullish values
   // Use > and < because == (and ===) doesn't work with
@@ -44,7 +82,14 @@ const datetime: SortingFn<any> = (rowA, rowB, columnId) => {
   return a > b ? 1 : a < b ? -1 : 0
 }
 
-const basic: SortingFn<any> = (rowA, rowB, columnId) => {
+export const sortFn_basic: SortFn<any, any> = <
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(
+  rowA: Row<any, any>,
+  rowB: Row<any, any>,
+  columnId: string,
+) => {
   return compareBasic(rowA.getValue(columnId), rowB.getValue(columnId))
 }
 
@@ -116,13 +161,13 @@ function compareAlphanumeric(aStr: string, bStr: string) {
 
 // Exports
 
-export const sortingFns = {
-  alphanumeric,
-  alphanumericCaseSensitive,
-  text,
-  textCaseSensitive,
-  datetime,
-  basic,
+export const sortFns = {
+  alphanumeric: sortFn_alphanumeric,
+  alphanumericCaseSensitive: sortFn_alphanumericCaseSensitive,
+  basic: sortFn_basic,
+  datetime: sortFn_datetime,
+  text: sortFn_text,
+  textCaseSensitive: sortFn_textCaseSensitive,
 }
 
-export type BuiltInSortingFn = keyof typeof sortingFns
+export type BuiltInSortFn = keyof typeof sortFns

package/src/helpers/columnHelper.ts

@@ -0,0 +1,117 @@
+import type { DeepKeys, DeepValue, RowData } from '../types/type-utils'
+import type { TableFeatures } from '../types/TableFeatures'
+import type {
+  AccessorFn,
+  AccessorFnColumnDef,
+  AccessorKeyColumnDef,
+  ColumnDef,
+  DisplayColumnDef,
+  GroupColumnDef,
+  IdentifiedColumnDef,
+} from '../types/ColumnDef'
+
+export type ColumnHelper<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> = {
+  /**
+   * Creates a data column definition with an accessor key or function to extract the cell value.
+   * @example
+   * ```ts
+   * helper.accessor('firstName', { cell: (info) => info.getValue() })
+   * helper.accessor((row) => row.lastName, { id: 'lastName' })
+   * ```
+   */
+  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: TAccessor extends AccessorFn<TData>
+      ? DisplayColumnDef<TFeatures, TData, TValue>
+      : IdentifiedColumnDef<TFeatures, TData, TValue>,
+  ) => TAccessor extends AccessorFn<TData>
+    ? AccessorFnColumnDef<TFeatures, TData, TValue>
+    : AccessorKeyColumnDef<TFeatures, TData, TValue>
+  /**
+   * Wraps an array of column definitions to preserve each column's individual TValue type.
+   * Uses variadic tuple types to infer element types before checking constraints, preventing type widening.
+   * @example
+   * ```ts
+   * helper.columns([helper.accessor('firstName', {}), helper.accessor('age', {})])
+   * ```
+   */
+  columns: <TColumns extends ReadonlyArray<ColumnDef<TFeatures, TData, any>>>(
+    columns: [...TColumns],
+  ) => Array<ColumnDef<TFeatures, TData, any>> & [...TColumns]
+  /**
+   * Creates a display column definition for non-data columns like actions or row selection.
+   * @example
+   * ```ts
+   * helper.display({ id: 'actions', header: 'Actions', cell: () => <button>Edit</button> })
+   * ```
+   */
+  display: (
+    column: DisplayColumnDef<TFeatures, TData>,
+  ) => DisplayColumnDef<TFeatures, TData, unknown>
+  /**
+   * Creates a group column definition that contains nested child columns.
+   * @example
+   * ```ts
+   * helper.group({
+   *   id: 'name',
+   *   header: 'Name',
+   *   columns: helper.columns([
+   *     helper.accessor('firstName', {}),
+   *     helper.accessor('lastName', { id: 'lastName' }),
+   *   ]),
+   * })
+   * ```
+   */
+  group: (
+    column: GroupColumnDef<TFeatures, TData, unknown>,
+  ) => GroupColumnDef<TFeatures, TData, unknown>
+}
+
+/**
+ * A helper utility for creating column definitions with slightly better type inference for each individual column.
+ * The `TValue` generic is inferred based on the accessor key or function provided.
+ * **Note:** From a JavaScript perspective, the functions in these helpers do not do anything. They are only used to help TypeScript infer the correct types for the column definitions.
+ * @example
+ * ```tsx
+ * const helper = createColumnHelper<typeof _features, Person>() // _features is the result of `tableFeatures({})` helper
+ * const columns = [
+ *  helper.display({ id: 'actions', header: 'Actions' }),
+ *  helper.accessor('firstName', {}),
+ *  helper.accessor((row) => row.lastName, {}
+ * ]
+ * ```
+ */
+export function createColumnHelper<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(): ColumnHelper<TFeatures, TData> {
+  return {
+    accessor: (accessor, column) => {
+      return typeof accessor === 'function'
+        ? ({
+            ...column,
+            accessorFn: accessor,
+          } as any)
+        : {
+            ...column,
+            accessorKey: accessor,
+          }
+    },
+    columns: <TColumns extends ReadonlyArray<ColumnDef<TFeatures, TData, any>>>(
+      columns: [...TColumns],
+    ): Array<ColumnDef<TFeatures, TData, any>> & [...TColumns] =>
+      columns as Array<ColumnDef<TFeatures, TData, any>> & [...TColumns],
+    display: (column) => column,
+    group: (column) => column,
+  }
+}

package/src/helpers/tableFeatures.ts

@@ -0,0 +1,24 @@
+import type { TableFeatures } from '../types/TableFeatures'
+
+/**
+ * A helper function to help define the features that are to be imported and applied to a table instance.
+ * Use this utility to make it easier to have the correct type inference for the features that are being imported.
+ * **Note:** It is recommended to use this utility statically outside of a component.
+ * @example
+ * ```
+ * import { tableFeatures, columnVisibilityFeature, rowPinningFeature } from '@tanstack/react-table'
+ * const _features = tableFeatures({ columnVisibilityFeature, rowPinningFeature });
+ * const table = useTable({ _features, rowModels: {}, columns, data });
+ * ```
+ */
+export function tableFeatures<TFeatures extends TableFeatures>(
+  features: TFeatures,
+): TFeatures {
+  return features
+}
+
+// test
+
+// const features = tableFeatures({
+//   rowPinningFeature: {},
+// });

package/src/helpers/tableHelper.ts

@@ -0,0 +1,61 @@
+import { createColumnHelper } from './columnHelper'
+import type { ColumnHelper } from './columnHelper'
+import type { RowData } from '../types/type-utils'
+import type { TableFeatures } from '../types/TableFeatures'
+import type { Table } from '../types/Table'
+import type { TableOptions } from '../types/TableOptions'
+
+/**
+ * Options for creating a table helper to share common options across multiple tables
+ * coreColumnsFeature, data, and state are excluded from this type and reserved for only the `useTable`/`createTable` functions
+ */
+export type TableHelperOptions<TFeatures extends TableFeatures> = Omit<
+  TableOptions<TFeatures, any>,
+  'columns' | 'data' | 'store' | 'state' | 'initialState'
+> & {
+  _features: TFeatures
+}
+
+/**
+ * Internal type that each adapter package will build off of to create a table helper
+ */
+export type TableHelper_Core<TFeatures extends TableFeatures> = {
+  createColumnHelper: <TData extends RowData>() => ColumnHelper<
+    TFeatures,
+    TData
+  >
+  features: TFeatures
+  options: Omit<
+    TableOptions<TFeatures, any>,
+    'columns' | 'data' | 'store' | 'state' | 'initialState'
+  >
+  tableCreator: <TData extends RowData>(
+    tableOptions: Omit<
+      TableOptions<TFeatures, TData>,
+      '_features' | '_rowModels'
+    >,
+    selector?: any,
+  ) => Table<TFeatures, TData>
+}
+
+/**
+ * Internal function to create a table helper that each adapter package will use to create their own table helper
+ */
+export function constructTableHelper<TFeatures extends TableFeatures>(
+  tableCreator: <TData extends RowData>(
+    tableOptions: Omit<
+      TableOptions<TFeatures, TData>,
+      '_features' | '_rowModels'
+    >,
+    selector?: any,
+  ) => Table<TFeatures, TData>,
+  tableHelperOptions: TableHelperOptions<TFeatures>,
+): TableHelper_Core<TFeatures> {
+  return {
+    createColumnHelper,
+    features: tableHelperOptions._features,
+    options: tableHelperOptions,
+    tableCreator: (tableOptions, selector) =>
+      tableCreator({ ...tableHelperOptions, ...tableOptions }, selector),
+  }
+}

package/src/helpers/tableOptions.ts

@@ -0,0 +1,82 @@
+import type { RowData } from '../types/type-utils'
+import type { TableFeatures } from '../types/TableFeatures'
+import type { TableOptions } from '../types/TableOptions'
+
+export function tableOptions<
+  TFeatures extends TableFeatures,
+  TData extends RowData = any,
+>(
+  options: Omit<TableOptions<TFeatures, TData>, 'columns'> & {
+    _features: TFeatures
+  },
+): Omit<TableOptions<TFeatures, TData>, 'columns' | '_features'> & {
+  _features: TFeatures
+}
+
+export function tableOptions<
+  TFeatures extends TableFeatures,
+  TData extends RowData = any,
+>(
+  options: Omit<TableOptions<TFeatures, TData>, 'data'> & {
+    _features: TFeatures
+  },
+): Omit<TableOptions<TFeatures, TData>, 'data' | '_features'> & {
+  _features: TFeatures
+}
+
+export function tableOptions<
+  TFeatures extends TableFeatures,
+  TData extends RowData = any,
+>(
+  options: Omit<TableOptions<TFeatures, TData>, '_features'>,
+): Omit<TableOptions<TFeatures, TData>, '_features'>
+
+export function tableOptions<
+  TFeatures extends TableFeatures,
+  TData extends RowData = any,
+>(
+  options: Omit<TableOptions<TFeatures, TData>, 'data' | 'columns'> & {
+    _features: TFeatures
+  },
+): Omit<TableOptions<TFeatures, TData>, 'data' | 'columns' | '_features'> & {
+  _features: TFeatures
+}
+
+export function tableOptions<
+  TFeatures extends TableFeatures,
+  TData extends RowData = any,
+>(
+  options: Omit<TableOptions<TFeatures, TData>, 'data' | '_features'>,
+): Omit<TableOptions<TFeatures, TData>, 'data' | '_features'>
+
+export function tableOptions<
+  TFeatures extends TableFeatures,
+  TData extends RowData = any,
+>(
+  options: Omit<TableOptions<TFeatures, TData>, 'columns' | '_features'>,
+): Omit<TableOptions<TFeatures, TData>, 'columns' | '_features'>
+
+export function tableOptions<
+  TFeatures extends TableFeatures,
+  TData extends RowData = any,
+>(
+  options: Omit<
+    TableOptions<TFeatures, TData>,
+    'data' | 'columns' | '_features'
+  >,
+): Omit<TableOptions<TFeatures, TData>, 'data' | 'columns' | '_features'>
+
+export function tableOptions<
+  TFeatures extends TableFeatures,
+  TData extends RowData = any,
+>(options: TableOptions<TFeatures, TData>): TableOptions<TFeatures, TData>
+
+export function tableOptions(options: unknown) {
+  return options
+}
+
+// test
+
+// const options = tableOptions({
+//   _features: {},
+// })

package/src/index.ts

@@ -1,43 +1,157 @@
-//types
-export * from './columnHelper'
-export * from './types'
-
-//core
-export * from './core/cell'
-export * from './core/column'
-export * from './core/headers'
-export * from './core/row'
-export * from './core/table'
-
-//features
-export * from './features/ColumnFaceting'
-export * from './features/ColumnFiltering'
-export * from './features/ColumnGrouping'
-export * from './features/ColumnOrdering'
-export * from './features/ColumnPinning'
-export * from './features/ColumnSizing'
-export * from './features/ColumnVisibility'
-export * from './features/GlobalFaceting'
-export * from './features/GlobalFiltering'
-export * from './features/RowExpanding'
-export * from './features/RowPagination'
-export * from './features/RowPinning'
-export * from './features/RowSelection'
-export * from './features/RowSorting'
-
-//utils
+/**
+ * Types
+ */
+
+export * from './types/Cell'
+export * from './types/Column'
+export * from './types/ColumnDef'
+export * from './types/Header'
+export * from './types/HeaderGroup'
+export * from './types/Row'
+export * from './types/RowModel'
+export * from './types/RowModelFns'
+export * from './types/Table'
+export * from './types/TableFeatures'
+export * from './types/TableOptions'
+export * from './types/TableState'
+export * from './types/type-utils'
+
+/**
+ * Core
+ */
+
+export * from './core/coreFeatures'
+export * from './helpers/columnHelper'
+export * from './helpers/tableFeatures'
+export * from './helpers/tableHelper'
+export * from './helpers/tableOptions'
 export * from './utils'
-export * from './utils/getCoreRowModel'
-export * from './utils/getExpandedRowModel'
-export * from './utils/getFacetedMinMaxValues'
-export * from './utils/getFacetedRowModel'
-export * from './utils/getFacetedUniqueValues'
-export * from './utils/getFilteredRowModel'
-export * from './utils/getGroupedRowModel'
-export * from './utils/getPaginationRowModel'
-export * from './utils/getSortedRowModel'
-
-//fns
-export * from './aggregationFns'
-export * from './filterFns'
-export * from './sortingFns'
+
+// Cells
+export * from './core/cells/constructCell'
+export * from './core/cells/coreCellsFeature'
+export * from './core/cells/coreCellsFeature.types'
+export * from './core/cells/coreCellsFeature.utils'
+
+// Columns
+export * from './core/columns/constructColumn'
+export * from './core/columns/coreColumnsFeature'
+export * from './core/columns/coreColumnsFeature.types'
+export * from './core/columns/coreColumnsFeature.utils'
+
+// Headers
+export * from './core/headers/buildHeaderGroups'
+export * from './core/headers/constructHeader'
+export * from './core/headers/coreHeadersFeature'
+export * from './core/headers/coreHeadersFeature.types'
+export * from './core/headers/coreHeadersFeature.utils'
+
+// Rows
+export * from './core/rows/constructRow'
+export * from './core/rows/coreRowsFeature'
+export * from './core/rows/coreRowsFeature.types'
+export * from './core/rows/coreRowsFeature.utils'
+
+// Row Models
+export * from './core/row-models/coreRowModelsFeature'
+export * from './core/row-models/coreRowModelsFeature.types'
+export * from './core/row-models/coreRowModelsFeature.utils'
+export * from './core/row-models/createCoreRowModel'
+
+// Tables
+export * from './core/table/constructTable'
+export * from './core/table/coreTablesFeature'
+export * from './core/table/coreTablesFeature.types'
+export * from './core/table/coreTablesFeature.utils'
+
+/**
+ * RowModelFns
+ */
+
+export * from './fns/aggregationFns'
+export * from './fns/filterFns'
+export * from './fns/sortFns'
+
+/**
+ * Features
+ */
+
+export * from './features/stockFeatures'
+
+// columnFacetingFeature
+export * from './features/column-faceting/columnFacetingFeature'
+export * from './features/column-faceting/columnFacetingFeature.types'
+export * from './features/column-faceting/columnFacetingFeature.utils'
+export * from './features/column-faceting/createFacetedMinMaxValues'
+export * from './features/column-faceting/createFacetedRowModel'
+export * from './features/column-faceting/createFacetedUniqueValues'
+
+// columnFilteringFeature
+export * from './features/column-filtering/columnFilteringFeature'
+export * from './features/column-filtering/columnFilteringFeature.types'
+export * from './features/column-filtering/columnFilteringFeature.utils'
+export * from './features/column-filtering/createFilteredRowModel'
+
+// columnGroupingFeature
+export * from './features/column-grouping/columnGroupingFeature'
+export * from './features/column-grouping/columnGroupingFeature.types'
+export * from './features/column-grouping/columnGroupingFeature.utils'
+export * from './features/column-grouping/createGroupedRowModel'
+
+// columnOrderingFeature
+export * from './features/column-ordering/columnOrderingFeature'
+export * from './features/column-ordering/columnOrderingFeature.types'
+export * from './features/column-ordering/columnOrderingFeature.utils'
+
+// columnPinningFeature
+export * from './features/column-pinning/columnPinningFeature'
+export * from './features/column-pinning/columnPinningFeature.types'
+export * from './features/column-pinning/columnPinningFeature.utils'
+
+// columnResizingFeature
+export * from './features/column-resizing/columnResizingFeature'
+export * from './features/column-resizing/columnResizingFeature.types'
+export * from './features/column-resizing/columnResizingFeature.utils'
+
+// columnSizingFeature
+export * from './features/column-sizing/columnSizingFeature'
+export * from './features/column-sizing/columnSizingFeature.types'
+export * from './features/column-sizing/columnSizingFeature.utils'
+
+// columnVisibilityFeature
+export * from './features/column-visibility/columnVisibilityFeature'
+export * from './features/column-visibility/columnVisibilityFeature.types'
+export * from './features/column-visibility/columnVisibilityFeature.utils'
+
+// globalFilteringFeature
+export * from './features/global-filtering/globalFilteringFeature'
+export * from './features/global-filtering/globalFilteringFeature.types'
+export * from './features/global-filtering/globalFilteringFeature.utils'
+
+// rowExpandingFeature
+export * from './features/row-expanding/rowExpandingFeature'
+export * from './features/row-expanding/rowExpandingFeature.types'
+export * from './features/row-expanding/rowExpandingFeature.utils'
+export * from './features/row-expanding/createExpandedRowModel'
+
+// rowPaginationFeature
+export * from './features/row-pagination/rowPaginationFeature'
+export * from './features/row-pagination/rowPaginationFeature.types'
+export * from './features/row-pagination/rowPaginationFeature.utils'
+export * from './features/row-pagination/createPaginatedRowModel'
+
+// rowPinningFeature
+export * from './features/row-pinning/rowPinningFeature'
+export * from './features/row-pinning/rowPinningFeature.types'
+export * from './features/row-pinning/rowPinningFeature.utils'
+
+// rowSelectionFeature
+export * from './features/row-selection/rowSelectionFeature'
+export * from './features/row-selection/rowSelectionFeature.types'
+export * from './features/row-selection/rowSelectionFeature.utils'
+
+// rowSortingFeature
+export * from './features/row-sorting/rowSortingFeature'
+export * from './features/row-sorting/rowSortingFeature.types'
+export * from './features/row-sorting/rowSortingFeature.utils'
+export * from './features/row-sorting/createSortedRowModel'

package/src/types/Cell.ts

@@ -0,0 +1,41 @@
+import type { Cell_ColumnGrouping } from '../features/column-grouping/columnGroupingFeature.types'
+import type { CellData, RowData, UnionToIntersection } from './type-utils'
+import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
+import type { Cell_Cell } from '../core/cells/coreCellsFeature.types'
+
+/**
+ * Use this interface as a target for declaration merging to add your own plugin properties.
+ * Note: This will affect the types of all tables in your project.
+ */
+export interface Cell_Plugins<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> {}
+
+export interface Cell_Core<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> extends Cell_Cell<TFeatures, TData, TValue> {}
+
+export type Cell<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = Cell_Cell<TFeatures, TData, TValue> &
+  UnionToIntersection<
+    'columnGroupingFeature' extends keyof TFeatures
+      ? Cell_ColumnGrouping
+      : never
+  > &
+  ExtractFeatureTypes<'Cell', TFeatures> &
+  Cell_Plugins<TFeatures, TData, TValue>
+
+// export type Cell<
+//   TFeatures extends TableFeatures,
+//   TData extends RowData,
+//   TValue extends CellData = CellData,
+// > = Cell_Core<TFeatures, TData, TValue> &
+//   ExtractFeatureTypes<TFeatures, 'Cell'> &
+//   Cell_Plugins<TFeatures, TData, TValue>