@tanstack/table-core 9.0.0-beta.5 → 9.0.0-beta.50

package/src/types/ColumnDef.ts

@@ -1,8 +1,13 @@
 import type { CellData, RowData, UnionToIntersection } from './type-utils'
-import type { ExtractFeatureMapTypes, TableFeatures } from './TableFeatures'
+import type {
+  ExtractFeatureMapTypes,
+  IsAny,
+  TableFeatures,
+} from './TableFeatures'
 import type { CellContext } from '../core/cells/coreCellsFeature.types'
 import type { HeaderContext } from '../core/headers/coreHeadersFeature.types'
 import type { ColumnDef_ColumnFiltering } from '../features/column-filtering/columnFilteringFeature.types'
+import type { ColumnDef_Aggregation } from '../features/aggregation/aggregationFeature.types'
 import type { ColumnDef_ColumnGrouping } from '../features/column-grouping/columnGroupingFeature.types'
 import type { ColumnDef_ColumnPinning } from '../features/column-pinning/columnPinningFeature.types'
 import type { ColumnDef_ColumnResizing } from '../features/column-resizing/columnResizingFeature.types'
@@ -11,11 +16,31 @@ import type { ColumnDef_ColumnVisibility } from '../features/column-visibility/c
 import type { ColumnDef_GlobalFiltering } from '../features/global-filtering/globalFilteringFeature.types'
 import type { ColumnDef_RowSorting } from '../features/row-sorting/rowSortingFeature.types'
 
+// @ts-expect-error Phantom type params: unused in this empty base declaration, but required with these exact names so user `declare module` augmentations merge correctly.
 export interface ColumnMeta<
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
+  TValue extends CellData = CellData,
+> {}
+
+/**
+ * Resolves the type of `columnDef.meta` for a feature set.
+ *
+ * When the features object declares a `columnMeta` type-only slot
+ * (`tableFeatures({ ..., columnMeta: {} as MyColumnMeta })`), that type wins.
+ * Otherwise this falls back to the global declaration-merged `ColumnMeta`
+ * interface.
+ */
+export type ExtractColumnMeta<
   TFeatures extends TableFeatures,
   TData extends RowData,
   TValue extends CellData = CellData,
-> {}
+> =
+  IsAny<TFeatures> extends true
+    ? ColumnMeta<TFeatures, TData, TValue>
+    : TFeatures extends { columnMeta: infer TMeta extends object }
+      ? TMeta
+      : ColumnMeta<TFeatures, TData, TValue>
 
 /**
  * Reads a cell value from an original row object.
@@ -56,8 +81,8 @@ export interface StringHeaderIdentifier {
 }
 
 export interface IdIdentifier<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > {
   /**
@@ -96,21 +121,25 @@ interface ColumnDefBase_Core<
   cell?: ColumnDefTemplate<CellContext<TFeatures, TData, TValue>>
   /**
    * User-defined metadata available on the resolved column definition.
+   *
+   * Declare its type per-table via the `columnMeta` type-only slot on the
+   * `features` option, or globally via declaration merging on `ColumnMeta`.
    */
-  meta?: ColumnMeta<TFeatures, TData, TValue>
+  meta?: ExtractColumnMeta<TFeatures, TData, TValue>
 }
 
 export interface ColumnDef_FeatureMap<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData,
 > {
+  aggregationFeature: ColumnDef_Aggregation<TFeatures, TData, TValue>
   columnVisibilityFeature: ColumnDef_ColumnVisibility
   columnPinningFeature: ColumnDef_ColumnPinning
   columnFilteringFeature: ColumnDef_ColumnFiltering<TFeatures, TData>
   globalFilteringFeature: ColumnDef_GlobalFiltering
   rowSortingFeature: ColumnDef_RowSorting<TFeatures, TData>
-  columnGroupingFeature: ColumnDef_ColumnGrouping<TFeatures, TData, TValue>
+  columnGroupingFeature: ColumnDef_ColumnGrouping<TFeatures, TData>
   columnSizingFeature: ColumnDef_ColumnSizing
   columnResizingFeature: ColumnDef_ColumnResizing
 }
@@ -131,12 +160,13 @@ export type ColumnDefBase_All<
   TValue extends CellData = CellData,
 > = ColumnDefBase_Core<TFeatures, TData, TValue> &
   Partial<
-    ColumnDef_ColumnVisibility &
+    ColumnDef_Aggregation<TFeatures, TData, TValue> &
+      ColumnDef_ColumnVisibility &
       ColumnDef_ColumnPinning &
       ColumnDef_ColumnFiltering<TFeatures, TData> &
       ColumnDef_GlobalFiltering &
       ColumnDef_RowSorting<TFeatures, TData> &
-      ColumnDef_ColumnGrouping<TFeatures, TData, TValue> &
+      ColumnDef_ColumnGrouping<TFeatures, TData> &
       ColumnDef_ColumnSizing &
       ColumnDef_ColumnResizing
   >

package/src/types/Header.ts

@@ -5,8 +5,8 @@ import type { Header_Header } from '../core/headers/coreHeadersFeature.types'
 import type { Header_ColumnResizing } from '../features/column-resizing/columnResizingFeature.types'
 
 export interface Header_Core<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
   TValue extends CellData = CellData,
 > extends Header_Header<TFeatures, TData, TValue> {}
 

package/src/types/HeaderGroup.ts

@@ -3,11 +3,11 @@ import type { TableFeatures } from './TableFeatures'
 import type { RowData } from './type-utils'
 
 export interface HeaderGroup_Core<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > extends HeaderGroup_Header<TFeatures, TData> {}
 
-export type HeaderGroup<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> = HeaderGroup_Core<TFeatures, TData>
+export interface HeaderGroup<
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
+> extends HeaderGroup_Core<TFeatures, TData> {}

package/src/types/Row.ts

@@ -1,4 +1,5 @@
 import type { Row_ColumnVisibility } from '../features/column-visibility/columnVisibilityFeature.types'
+import type { Row_Aggregation } from '../features/aggregation/aggregationFeature.types'
 import type { Row_ColumnPinning } from '../features/column-pinning/columnPinningFeature.types'
 import type { Row_ColumnGrouping } from '../features/column-grouping/columnGroupingFeature.types'
 import type { Row_ColumnFiltering } from '../features/column-filtering/columnFilteringFeature.types'
@@ -10,14 +11,15 @@ import type { ExtractFeatureMapTypes, TableFeatures } from './TableFeatures'
 import type { Row_Row } from '../core/rows/coreRowsFeature.types'
 
 export interface Row_Core<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > extends Row_Row<TFeatures, TData> {}
 
 export interface Row_FeatureMap<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
+  aggregationFeature: Row_Aggregation
   columnFilteringFeature: Row_ColumnFiltering<TFeatures, TData>
   columnGroupingFeature: Row_ColumnGrouping
   columnPinningFeature: Row_ColumnPinning<TFeatures, TData>

package/src/types/RowModel.ts

@@ -1,70 +1,16 @@
-import type {
-  CachedRowModel_Faceted,
-  CreateRowModel_Faceted,
-} from '../features/column-faceting/columnFacetingFeature.types'
-import type {
-  CachedRowModel_Grouped,
-  CreateRowModel_Grouped,
-} from '../features/column-grouping/columnGroupingFeature.types'
-import type {
-  CachedRowModel_Filtered,
-  CreateRowModel_Filtered,
-} from '../features/column-filtering/columnFilteringFeature.types'
-import type {
-  CachedRowModel_Core,
-  CreateRowModel_Core,
-  RowModel,
-} from '../core/row-models/coreRowModelsFeature.types'
-import type {
-  CachedRowModel_Expanded,
-  CreateRowModel_Expanded,
-} from '../features/row-expanding/rowExpandingFeature.types'
-import type {
-  CachedRowModel_Paginated,
-  CreateRowModel_Paginated,
-} from '../features/row-pagination/rowPaginationFeature.types'
-import type {
-  CachedRowModel_Sorted,
-  CreateRowModel_Sorted,
-} from '../features/row-sorting/rowSortingFeature.types'
+import type { CachedRowModel_Faceted } from '../features/column-faceting/columnFacetingFeature.types'
+import type { CachedRowModel_Grouped } from '../features/column-grouping/columnGroupingFeature.types'
+import type { CachedRowModel_Filtered } from '../features/column-filtering/columnFilteringFeature.types'
+import type { CachedRowModel_Core } from '../core/row-models/coreRowModelsFeature.types'
+import type { CachedRowModel_Expanded } from '../features/row-expanding/rowExpandingFeature.types'
+import type { CachedRowModel_Paginated } from '../features/row-pagination/rowPaginationFeature.types'
+import type { CachedRowModel_Sorted } from '../features/row-sorting/rowSortingFeature.types'
 import type { RowData } from './type-utils'
 import type { ExtractFeatureMapTypes, TableFeatures } from './TableFeatures'
 
-export interface CreateRowModels_FeatureMap<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  columnFacetingFeature: CreateRowModel_Faceted<TFeatures, TData>
-  columnFilteringFeature: CreateRowModel_Filtered<TFeatures, TData>
-  rowExpandingFeature: CreateRowModel_Expanded<TFeatures, TData>
-  columnGroupingFeature: CreateRowModel_Grouped<TFeatures, TData>
-  rowPaginationFeature: CreateRowModel_Paginated<TFeatures, TData>
-  rowSortingFeature: CreateRowModel_Sorted<TFeatures, TData>
-}
-
-export type CreateRowModels<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> = CreateRowModel_Core<TFeatures, TData> &
-  ExtractFeatureMapTypes<
-    TFeatures,
-    CreateRowModels_FeatureMap<TFeatures, TData>
-  >
-
-export type CreateRowModels_All<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> = CreateRowModel_Core<TFeatures, TData> &
-  CreateRowModel_Expanded<TFeatures, TData> &
-  CreateRowModel_Faceted<TFeatures, TData> &
-  CreateRowModel_Filtered<TFeatures, TData> &
-  CreateRowModel_Grouped<TFeatures, TData> &
-  CreateRowModel_Paginated<TFeatures, TData> &
-  CreateRowModel_Sorted<TFeatures, TData>
-
 export interface CachedRowModels_FeatureMap<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   columnFacetingFeature: CachedRowModel_Faceted<TFeatures, TData>
   columnFilteringFeature: CachedRowModel_Filtered<TFeatures, TData>
@@ -77,17 +23,16 @@ export interface CachedRowModels_FeatureMap<
 export type CachedRowModels<
   TFeatures extends TableFeatures,
   TData extends RowData,
-> = {
-  CachedRowModel_Core: () => RowModel<TFeatures, TData>
-} & ExtractFeatureMapTypes<
-  TFeatures,
-  CachedRowModels_FeatureMap<TFeatures, TData>
->
+> = Partial<CachedRowModel_Core<TFeatures, TData>> &
+  ExtractFeatureMapTypes<
+    TFeatures,
+    CachedRowModels_FeatureMap<TFeatures, TData>
+  >
 
-export type CachedRowModel_All<
-  TFeatures extends TableFeatures,
-  TData extends RowData = any,
-> = Partial<
+export interface CachedRowModel_All<
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData = any,
+> extends Partial<
   CachedRowModel_Core<TFeatures, TData> &
     CachedRowModel_Expanded<TFeatures, TData> &
     CachedRowModel_Faceted<TFeatures, TData> &
@@ -95,4 +40,4 @@ export type CachedRowModel_All<
     CachedRowModel_Grouped<TFeatures, TData> &
     CachedRowModel_Paginated<TFeatures, TData> &
     CachedRowModel_Sorted<TFeatures, TData>
->
+> {}

package/src/types/RowModelFns.ts

@@ -1,5 +1,5 @@
 import type { RowModelFns_RowSorting } from '../features/row-sorting/rowSortingFeature.types'
-import type { RowModelFns_ColumnGrouping } from '../features/column-grouping/columnGroupingFeature.types'
+import type { RowModelFns_Aggregation } from '../features/aggregation/aggregationFeature.types'
 import type { RowData } from './type-utils'
 import type { RowModelFns_ColumnFiltering } from '../features/column-filtering/columnFilteringFeature.types'
 import type { ExtractFeatureMapTypes, TableFeatures } from './TableFeatures'
@@ -7,11 +7,11 @@ import type { ExtractFeatureMapTypes, TableFeatures } from './TableFeatures'
 export interface RowModelFns_Core {}
 
 export interface RowModelFns_FeatureMap<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
+  aggregationFeature: RowModelFns_Aggregation<TFeatures, TData>
   columnFilteringFeature: RowModelFns_ColumnFiltering<TFeatures, TData>
-  columnGroupingFeature: RowModelFns_ColumnGrouping<TFeatures, TData>
   rowSortingFeature: RowModelFns_RowSorting<TFeatures, TData>
 }
 
@@ -22,11 +22,11 @@ export type RowModelFns<
   ExtractFeatureMapTypes<TFeatures, RowModelFns_FeatureMap<TFeatures, TData>>
 >
 
-export type RowModelFns_All<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> = Partial<
+export interface RowModelFns_All<
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
+> extends Partial<
   RowModelFns_ColumnFiltering<TFeatures, TData> &
-    RowModelFns_ColumnGrouping<TFeatures, TData> &
+    RowModelFns_Aggregation<TFeatures, TData> &
     RowModelFns_RowSorting<TFeatures, TData>
->
+> {}

package/src/types/Table.ts

@@ -14,38 +14,42 @@ import type { Table_RowPagination } from '../features/row-pagination/rowPaginati
 import type { Table_RowSelection } from '../features/row-selection/rowSelectionFeature.types'
 import type { Table_RowSorting } from '../features/row-sorting/rowSortingFeature.types'
 import type { Table_RowModels } from '../core/row-models/coreRowModelsFeature.types'
-import type { CachedRowModel_All, CreateRowModels_All } from './RowModel'
+import type { CachedRowModel_All } from './RowModel'
 import type { RowModelFns_All } from './RowModelFns'
-import type { TableState_All } from './TableState'
+import type { TableState, TableState_All } from './TableState'
 import type { RowData } from './type-utils'
 import type { ExtractFeatureMapTypes, TableFeatures } from './TableFeatures'
 import type { Table_Columns } from '../core/columns/coreColumnsFeature.types'
 import type { Table_Headers } from '../core/headers/coreHeadersFeature.types'
 import type { Table_Rows } from '../core/rows/coreRowsFeature.types'
 import type {
+  Atoms,
   Atoms_All,
+  BaseAtoms,
   BaseAtoms_All,
   ExternalAtoms_All,
   Table_Table,
 } from '../core/table/coreTablesFeature.types'
-import type { TableOptions_All } from './TableOptions'
+import type { DebugOptions, TableOptions_All } from './TableOptions'
 
 /**
  * The core table object that only includes the core table functionality such as column, header, row, and table APIS.
  * No features are included.
  */
-export type Table_Core<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> = Table_Table<TFeatures, TData> &
-  Table_Columns<TFeatures, TData> &
-  Table_Rows<TFeatures, TData> &
-  Table_RowModels<TFeatures, TData> &
-  Table_Headers<TFeatures, TData>
+export interface Table_Core<
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
+>
+  extends
+    Table_Table<TFeatures, TData>,
+    Table_Columns<TFeatures, TData>,
+    Table_Rows<TFeatures, TData>,
+    Table_RowModels<TFeatures, TData>,
+    Table_Headers<TFeatures, TData> {}
 
 export interface Table_FeatureMap<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   columnFilteringFeature: Table_ColumnFiltering
   columnGroupingFeature: Table_ColumnGrouping<TFeatures, TData>
@@ -72,20 +76,41 @@ export type Table<
 > = Table_Core<TFeatures, TData> &
   ExtractFeatureMapTypes<TFeatures, Table_FeatureMap<TFeatures, TData>>
 
-export type Table_Internal<
-  TFeatures extends TableFeatures,
-  TData extends RowData = any,
-> = Table<TFeatures, TData> & {
+/**
+ * `Table_Table` members that `Table_Internal` re-declares with broadened
+ * (all-features) types so internal code can read any feature's slots and
+ * construction code can assign them.
+ */
+type Table_InternalBroadenedKeys =
+  | '_rowModels'
+  | '_rowModelFns'
+  | 'options'
+  | 'initialState'
+  | 'store'
+
+/**
+ * Internal broad table shape used by feature implementations.
+ */
+export interface Table_Internal<
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData = any,
+>
+  extends
+    Omit<Table_Table<TFeatures, TData>, Table_InternalBroadenedKeys>,
+    Table_Columns<TFeatures, TData>,
+    Table_Rows<TFeatures, TData>,
+    Table_RowModels<TFeatures, TData>,
+    Table_Headers<TFeatures, TData> {
   _rowModels: CachedRowModel_All<TFeatures, TData>
   _rowModelFns: RowModelFns_All<TFeatures, TData>
-  options: TableOptions_All<TFeatures, TData> & {
-    rowModels?: CreateRowModels_All<TFeatures, TData>
-    state?: TableState_All
-    initialState?: TableState_All
-    atoms?: ExternalAtoms_All
-  }
-  initialState: TableState_All
-  baseAtoms: BaseAtoms_All
-  atoms: Atoms_All
-  store: ReadonlyStore<TableState_All>
+  options: DebugOptions<TableFeatures> &
+    TableOptions_All<TFeatures, TData> & {
+      state?: TableState_All
+      initialState?: TableState_All
+      atoms?: ExternalAtoms_All
+    }
+  initialState: TableState<TFeatures> & TableState_All
+  baseAtoms: BaseAtoms<TFeatures> & BaseAtoms_All
+  atoms: Atoms<TFeatures> & Atoms_All
+  store: ReadonlyStore<TableState<TFeatures>> & ReadonlyStore<TableState_All>
 }