@tanstack/table-core 9.0.0-beta.2 → 9.0.0-beta.20

package/src/types/RowModel.ts

@@ -1,90 +1,19 @@
-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_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,
-  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_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,
-  ExtractFeatureTypes,
-  TableFeatures,
-} from './TableFeatures'
-
-/**
- * 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 CreateRowModels_Plugins<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {}
-
-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>
-  > &
-  ExtractFeatureTypes<'CreateRowModels', TFeatures> &
-  CreateRowModels_Plugins<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_Plugins<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {}
+import type { ExtractFeatureMapTypes, TableFeatures } from './TableFeatures'
 
 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>
@@ -102,14 +31,12 @@ export type CachedRowModels<
 } & ExtractFeatureMapTypes<
   TFeatures,
   CachedRowModels_FeatureMap<TFeatures, TData>
-> &
-  ExtractFeatureTypes<'CachedRowModel', TFeatures> &
-  CachedRowModels_Plugins<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> &
@@ -117,4 +44,4 @@ export type CachedRowModel_All<
     CachedRowModel_Grouped<TFeatures, TData> &
     CachedRowModel_Paginated<TFeatures, TData> &
     CachedRowModel_Sorted<TFeatures, TData>
->
+> {}

package/src/types/RowModelFns.ts

@@ -2,26 +2,13 @@ import type { RowModelFns_RowSorting } from '../features/row-sorting/rowSortingF
 import type { RowModelFns_ColumnGrouping } from '../features/column-grouping/columnGroupingFeature.types'
 import type { RowData } from './type-utils'
 import type { RowModelFns_ColumnFiltering } from '../features/column-filtering/columnFilteringFeature.types'
-import type {
-  ExtractFeatureMapTypes,
-  ExtractFeatureTypes,
-  TableFeatures,
-} from './TableFeatures'
-
-/**
- * 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 RowModelFns_Plugins<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {}
+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,
 > {
   columnFilteringFeature: RowModelFns_ColumnFiltering<TFeatures, TData>
   columnGroupingFeature: RowModelFns_ColumnGrouping<TFeatures, TData>
@@ -32,16 +19,14 @@ export type RowModelFns<
   TFeatures extends TableFeatures,
   TData extends RowData,
 > = Partial<
-  ExtractFeatureMapTypes<TFeatures, RowModelFns_FeatureMap<TFeatures, TData>> &
-    ExtractFeatureTypes<'RowModelFns', TFeatures> &
-    RowModelFns_Plugins<TFeatures, TData>
+  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_RowSorting<TFeatures, TData>
->
+> {}

package/src/types/Table.ts

@@ -14,51 +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,
-  ExtractFeatureTypes,
-  TableFeatures,
-} from './TableFeatures'
+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'
-
-/**
- * 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 Table_Plugins<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {}
+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>
@@ -83,24 +74,43 @@ export type Table<
   TFeatures extends TableFeatures,
   TData extends RowData,
 > = Table_Core<TFeatures, TData> &
-  ExtractFeatureMapTypes<TFeatures, Table_FeatureMap<TFeatures, TData>> &
-  ExtractFeatureTypes<'Table', TFeatures> &
-  Table_Plugins<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>
 }