@tanstack/table-core 9.0.0-beta.10 → 9.0.0-beta.12

package/src/types/Table.ts

@@ -16,36 +16,40 @@ import type { Table_RowSorting } from '../features/row-sorting/rowSortingFeature
 import type { Table_RowModels } from '../core/row-models/coreRowModelsFeature.types'
 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,19 +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> & {
-    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>
 }

package/src/types/TableOptions.ts

@@ -28,8 +28,8 @@ import type {
  * options are mixed in.
  */
 export interface TableOptions_Core<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 >
   extends
     TableOptions_Table<TFeatures, TData>,
@@ -55,8 +55,8 @@ export type DebugOptions<TFeatures extends TableFeatures> = {
 } & DebugKeysFor<CoreFeatures & TFeatures>
 
 export interface TableOptions_FeatureMap<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   columnFilteringFeature: TableOptions_ColumnFiltering<TFeatures, TData>
   columnGroupingFeature: TableOptions_ColumnGrouping
@@ -73,15 +73,42 @@ export interface TableOptions_FeatureMap<
   rowSortingFeature: TableOptions_RowSorting
 }
 
-export type TableOptions_FeatureMap_All<
+type TableOptions_StockFeatureKeys =
+  | 'columnFilteringFeature'
+  | 'columnGroupingFeature'
+  | 'columnOrderingFeature'
+  | 'columnPinningFeature'
+  | 'columnResizingFeature'
+  | 'columnSizingFeature'
+  | 'columnVisibilityFeature'
+  | 'globalFilteringFeature'
+  | 'rowExpandingFeature'
+  | 'rowPaginationFeature'
+  | 'rowPinningFeature'
+  | 'rowSelectionFeature'
+  | 'rowSortingFeature'
+
+/**
+ * Plugin entries declaration-merged into `TableOptions_FeatureMap`, i.e. keys
+ * beyond the stock set. Resolves to `unknown` (an intersection no-op) when no
+ * plugins are merged so the common case skips the union-to-intersection work.
+ */
+type TableOptions_PluginFeatureMapTypes<
   TFeatures extends TableFeatures,
   TData extends RowData,
-> = UnionToIntersection<
-  TableOptions_FeatureMap<TFeatures, TData>[keyof TableOptions_FeatureMap<
-    TFeatures,
-    TData
-  >]
->
+> = [
+  Exclude<
+    keyof TableOptions_FeatureMap<TFeatures, TData>,
+    TableOptions_StockFeatureKeys
+  >,
+] extends [never]
+  ? unknown
+  : UnionToIntersection<
+      TableOptions_FeatureMap<TFeatures, TData>[Exclude<
+        keyof TableOptions_FeatureMap<TFeatures, TData>,
+        TableOptions_StockFeatureKeys
+      >]
+    >
 
 /**
  * Complete table options for a specific feature set.
@@ -105,4 +132,19 @@ export type TableOptions_All<
   TFeatures extends TableFeatures,
   TData extends RowData,
 > = TableOptions_Core<TFeatures, TData> &
-  Partial<TableOptions_FeatureMap_All<TFeatures, TData>>
+  Partial<
+    TableOptions_ColumnFiltering<TFeatures, TData> &
+      TableOptions_ColumnGrouping &
+      TableOptions_ColumnOrdering &
+      TableOptions_ColumnPinning &
+      TableOptions_ColumnResizing &
+      TableOptions_ColumnSizing &
+      TableOptions_ColumnVisibility &
+      TableOptions_GlobalFiltering<TFeatures, TData> &
+      TableOptions_RowExpanding<TFeatures, TData> &
+      TableOptions_RowPagination &
+      TableOptions_RowPinning<TFeatures, TData> &
+      TableOptions_RowSelection<TFeatures, TData> &
+      TableOptions_RowSorting &
+      TableOptions_PluginFeatureMapTypes<TFeatures, TData>
+  >

package/src/types/TableState.ts

@@ -44,4 +44,18 @@ export type TableState<TFeatures extends TableFeatures> =
  * Feature internals use this when they may need to inspect optional slices owned
  * by other features.
  */
-export type TableState_All = Partial<TableState<TableFeatures>>
+export interface TableState_All extends Partial<
+  TableState_ColumnFiltering &
+    TableState_ColumnGrouping &
+    TableState_ColumnOrdering &
+    TableState_ColumnPinning &
+    TableState_ColumnResizing &
+    TableState_ColumnSizing &
+    TableState_ColumnVisibility &
+    TableState_GlobalFiltering &
+    TableState_RowExpanding &
+    TableState_RowPagination &
+    TableState_RowPinning &
+    TableState_RowSelection &
+    TableState_RowSorting
+> {}

package/src/utils.ts

@@ -1,4 +1,4 @@
-import type { Table, Table_Internal } from './types/Table'
+import type { Table_Internal } from './types/Table'
 import type { NoInfer, RowData, Updater } from './types/type-utils'
 import type { TableFeatures } from './types/TableFeatures'
 import type { TableState, TableState_All } from './types/TableState'
@@ -53,7 +53,16 @@ export function cloneState<T>(value: T): T {
 export function makeStateUpdater<
   TFeatures extends TableFeatures,
   K extends (string & {}) | keyof TableState_All | keyof TableState<TFeatures>,
->(key: K, instance: Table<TFeatures, any>) {
+>(
+  key: K,
+  // Minimal structural shape so any table view (public `Table`,
+  // `Table_Internal`, or a custom plugin table) can be passed without forcing
+  // the compiler to relate the full table types.
+  instance: {
+    readonly options: { readonly atoms?: object | undefined }
+    readonly baseAtoms: object
+  },
+) {
   return (updater: Updater<TableState<any>[K & keyof TableState<any>]>) => {
     const externalAtom = (instance.options as any).atoms?.[key]
     const targetAtom = externalAtom ?? (instance.baseAtoms as any)[key]