re-arrange where plugins are added

TanStack · Jan 3, 2025 · 9330b1d · 9330b1d
1 parent 5d0987d
commit 9330b1d
Show file tree

Hide file tree

Showing 16 changed files with 177 additions and 429 deletions.
diff --git a/packages/angular-table/src/constructTableHelper.ts b/packages/angular-table/src/constructTableHelper.ts
@@ -8,6 +8,11 @@ import type {
 } from '@tanstack/table-core'
 import type { Signal } from '@angular/core'
 
+// NOTE: This is a custom fork of the constructTableHelper function from the core package
+// It is used to create a table helper that can be used to create tables in Angular
+// It is a fork because the core package does not support Angular's reactive system
+// So we need to create a custom function to create a table helper that can be used in Angular
+
 /**
  * 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

diff --git a/packages/angular-table/src/reactivity.ts b/packages/angular-table/src/reactivity.ts
@@ -1,17 +1,27 @@
 import { computed, signal } from '@angular/core'
 import { toComputed } from './proxy'
 import type { Signal } from '@angular/core'
-import type { Table, TableFeature } from '@tanstack/table-core'
+import type {
+  RowData,
+  Table,
+  TableFeature,
+  TableFeatures,
+} from '@tanstack/table-core'
 
-// TODO: remove this once we have a better way to define plugins
 declare module '@tanstack/table-core' {
-  interface TableOptions_Plugins {
+  interface TableOptions_Plugins<
+    TFeatures extends TableFeatures,
+    TData extends RowData,
+  > {
     enableExperimentalReactivity?: boolean
   }
 
-  interface Table_Plugins {
-    _rootNotifier?: Signal<Table<any, any>>
-    _setRootNotifier?: (signal: Signal<Table<any, any>>) => void
+  interface Table_Plugins<
+    TFeatures extends TableFeatures,
+    TData extends RowData,
+  > {
+    _rootNotifier?: Signal<Table<TFeatures, TData>>
+    _setRootNotifier?: (signal: Signal<Table<TFeatures, TData>>) => void
   }
 }
 

diff --git a/packages/react-table/src/useTable.ts b/packages/react-table/src/useTable.ts
@@ -9,7 +9,6 @@ import type {
   Table,
   TableFeatures,
   TableOptions,
-  TableOptions_Internal,
   TableState,
 } from '@tanstack/table-core'
 
@@ -35,9 +34,7 @@ function useTableRef<TFeatures extends TableFeatures, TData extends RowData>(
 export function useTable<
   TFeatures extends TableFeatures,
   TData extends RowData,
->(
-  tableOptions: TableOptions_Internal<TFeatures, Array<TData>>,
-): Table<TFeatures, TData> {
+>(tableOptions: TableOptions<TFeatures, TData>): Table<TFeatures, TData> {
   const _features = { ...coreFeatures, ...tableOptions._features }
 
   const [state, setState] = useState<TableState<TFeatures>>(() =>

diff --git a/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts b/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts
@@ -2,9 +2,8 @@ import { functionalUpdate, isDev, isFunction } from '../../utils'
 import type { CellData, RowData, Updater } from '../../types/type-utils'
 import type { TableFeatures } from '../../types/TableFeatures'
 import type { Table_Internal } from '../../types/Table'
-import type { Column } from '../../types/Column'
+import type { Column_Internal } from '../../types/Column'
 import type {
-  ColumnDef_ColumnFiltering,
   ColumnFiltersState,
   FilterFn,
 } from './columnFilteringFeature.types'
@@ -17,7 +16,7 @@ export function column_getAutoFilterFn<
   TFeatures extends TableFeatures,
   TData extends RowData,
   TValue extends CellData = CellData,
->(column: Column<TFeatures, TData, TValue>) {
+>(column: Column_Internal<TFeatures, TData, TValue>) {
   const filterFns = column._table._rowModelFns.filterFns as
     | Record<string, FilterFn<TFeatures, TData>>
     | undefined
@@ -54,9 +53,7 @@ export function column_getFilterFn<
   TData extends RowData,
   TValue extends CellData = CellData,
 >(
-  column: Column<TFeatures, TData, TValue> & {
-    columnDef: ColumnDef_ColumnFiltering<TFeatures, TData>
-  },
+  column: Column_Internal<TFeatures, TData, TValue>,
 ): FilterFn<TFeatures, TData> | undefined {
   let filterFn = null
   const filterFns = column._table._rowModelFns.filterFns as
@@ -81,11 +78,7 @@ export function column_getCanFilter<
   TFeatures extends TableFeatures,
   TData extends RowData,
   TValue extends CellData = CellData,
->(
-  column: Column<TFeatures, TData, TValue> & {
-    columnDef: ColumnDef_ColumnFiltering<TFeatures, TData>
-  },
-) {
+>(column: Column_Internal<TFeatures, TData, TValue>) {
   return (
     (column.columnDef.enableColumnFilter ?? true) &&
     (column._table.options.enableColumnFilters ?? true) &&
@@ -98,23 +91,15 @@ export function column_getIsFiltered<
   TFeatures extends TableFeatures,
   TData extends RowData,
   TValue extends CellData = CellData,
->(
-  column: Column<TFeatures, TData, TValue> & {
-    columnDef: ColumnDef_ColumnFiltering<TFeatures, TData>
-  },
-) {
+>(column: Column_Internal<TFeatures, TData, TValue>) {
   return column_getFilterIndex(column) > -1
 }
 
 export function column_getFilterValue<
   TFeatures extends TableFeatures,
   TData extends RowData,
   TValue extends CellData = CellData,
->(
-  column: Column<TFeatures, TData, TValue> & {
-    columnDef: ColumnDef_ColumnFiltering<TFeatures, TData>
-  },
-) {
+>(column: Column_Internal<TFeatures, TData, TValue>) {
   return column._table.options.state?.columnFilters?.find(
     (d) => d.id === column.id,
   )?.value
@@ -124,11 +109,7 @@ export function column_getFilterIndex<
   TFeatures extends TableFeatures,
   TData extends RowData,
   TValue extends CellData = CellData,
->(
-  column: Column<TFeatures, TData, TValue> & {
-    columnDef: ColumnDef_ColumnFiltering<TFeatures, TData>
-  },
-): number {
+>(column: Column_Internal<TFeatures, TData, TValue>): number {
   return (
     column._table.options.state?.columnFilters?.findIndex(
       (d) => d.id === column.id,
@@ -140,12 +121,7 @@ export function column_setFilterValue<
   TFeatures extends TableFeatures,
   TData extends RowData,
   TValue extends CellData = CellData,
->(
-  column: Column<TFeatures, TData, TValue> & {
-    columnDef: ColumnDef_ColumnFiltering<TFeatures, TData>
-  },
-  value: any,
-) {
+>(column: Column_Internal<TFeatures, TData, TValue>, value: any) {
   table_setColumnFilters(column._table, (old) => {
     const filterFn = column_getFilterFn(column)
     const previousFilter = old.find((d) => d.id === column.id)
@@ -223,11 +199,14 @@ export function shouldAutoRemoveFilter<
 >(
   filterFn?: FilterFn<TFeatures, TData>,
   value?: any,
-  column?: Column<TFeatures, TData, TValue>,
+  column?: Column_Internal<TFeatures, TData, TValue>,
 ) {
   return (
     (filterFn && filterFn.autoRemove
-      ? filterFn.autoRemove(value, column as Column<TFeatures, TData, unknown>)
+      ? filterFn.autoRemove(
+          value,
+          column as Column_Internal<TFeatures, TData, unknown>,
+        )
       : false) ||
     typeof value === 'undefined' ||
     (typeof value === 'string' && !value)

diff --git a/packages/table-core/src/types/Cell.ts b/packages/table-core/src/types/Cell.ts
@@ -2,28 +2,26 @@ import type { CellData, RowData } from './type-utils'
 import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
 import type { Cell_Cell } from '../core/cells/coreCellsFeature.types'
 
-export interface Cell_Plugins {}
+/**
+ * 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>,
-    Cell_Plugins {}
-
-// 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
-//   >
+> extends Cell_Cell<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_Core<TFeatures, TData, TValue> &
+  ExtractFeatureTypes<TFeatures, 'Cell'> &
+  Cell_Plugins<TFeatures, TData, TValue>
diff --git a/packages/table-core/src/types/Column.ts b/packages/table-core/src/types/Column.ts
@@ -3,59 +3,29 @@ import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
 import type { RowData } from './type-utils'
 import type { ColumnDefBase_All } from './ColumnDef'
 
-export interface Column_Plugins {}
+/**
+ * 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 Column_Plugins<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue = unknown,
+> {}
 
 export interface Column_Core<
   TFeatures extends TableFeatures,
   TData extends RowData,
   TValue = unknown,
-> extends Column_Column<TFeatures, TData, TValue>,
-    Column_Plugins {}
-
-// export type Column<
-//   TFeatures extends TableFeatures,
-//   TData extends RowData,
-//   TValue = unknown,
-// > = Column_Core<TFeatures, TData, TValue> &
-//   UnionToIntersection<
-//     | ('columnFacetingFeature' extends keyof TFeatures
-//         ? Column_ColumnFaceting<TFeatures, TData>
-//         : never)
-//     | ('columnFilteringFeature' extends keyof TFeatures
-//         ? Column_ColumnFiltering<TFeatures, TData>
-//         : never)
-//     | ('columnGroupingFeature' extends keyof TFeatures
-//         ? Column_ColumnGrouping<TFeatures, TData>
-//         : never)
-//     | ('columnOrderingFeature' extends keyof TFeatures
-//         ? Column_ColumnOrdering
-//         : never)
-//     | ('columnPinningFeature' extends keyof TFeatures
-//         ? Column_ColumnPinning
-//         : never)
-//     | ('columnResizingFeature' extends keyof TFeatures
-//         ? Column_ColumnResizing
-//         : never)
-//     | ('columnSizingFeature' extends keyof TFeatures
-//         ? Column_ColumnSizing
-//         : never)
-//     | ('columnVisibilityFeature' extends keyof TFeatures
-//         ? Column_ColumnVisibility
-//         : never)
-//     | ('globalFilteringFeature' extends keyof TFeatures
-//         ? Column_GlobalFiltering
-//         : never)
-//     | ('rowSortingFeature' extends keyof TFeatures
-//         ? Column_RowSorting<TFeatures, TData>
-//         : never)
-//   >
+> extends Column_Column<TFeatures, TData, TValue> {}
 
 export type Column<
   TFeatures extends TableFeatures,
   TData extends RowData,
   TValue = unknown,
 > = Column_Core<TFeatures, TData, TValue> &
-  ExtractFeatureTypes<TFeatures, 'Column'>
+  ExtractFeatureTypes<TFeatures, 'Column'> &
+  Column_Plugins<TFeatures, TData, TValue>
 
 export type Column_Internal<
   TFeatures extends TableFeatures,

diff --git a/packages/table-core/src/types/ColumnDef.ts b/packages/table-core/src/types/ColumnDef.ts
@@ -11,7 +11,15 @@ 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'
 
-export interface ColumnDef_Plugins {}
+/**
+ * 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 ColumnDef_Plugins<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> {}
 
 export interface ColumnMeta<
   TFeatures extends TableFeatures,
@@ -57,51 +65,20 @@ interface ColumnDefBase_Core<
   TFeatures extends TableFeatures,
   TData extends RowData,
   TValue extends CellData = CellData,
-> extends ColumnDef_Plugins {
+> {
   getUniqueValues?: AccessorFn<TData, Array<unknown>>
   footer?: ColumnDefTemplate<HeaderContext<TFeatures, TData, TValue>>
   cell?: ColumnDefTemplate<CellContext<TFeatures, TData, TValue>>
   meta?: ColumnMeta<TFeatures, TData, TValue>
 }
 
-// export type ColumnDefBase<
-//   TFeatures extends TableFeatures,
-//   TData extends RowData,
-//   TValue extends CellData = CellData,
-// > = ColumnDefBase_Core<TFeatures, TData, TValue> &
-//   UnionToIntersection<
-//     | ('columnVisibilityFeature' extends keyof TFeatures
-//         ? ColumnDef_ColumnVisibility
-//         : never)
-//     | ('columnPinningFeature' extends keyof TFeatures
-//         ? ColumnDef_ColumnPinning
-//         : never)
-//     | ('columnFilteringFeature' extends keyof TFeatures
-//         ? ColumnDef_ColumnFiltering<TFeatures, TData>
-//         : never)
-//     | ('globalFilteringFeature' extends keyof TFeatures
-//         ? ColumnDef_GlobalFiltering
-//         : never)
-//     | ('rowSortingFeature' extends keyof TFeatures
-//         ? ColumnDef_RowSorting<TFeatures, TData>
-//         : never)
-//     | ('columnGroupingFeature' extends keyof TFeatures
-//         ? ColumnDef_ColumnGrouping<TFeatures, TData, TValue>
-//         : never)
-//     | ('columnSizingFeature' extends keyof TFeatures
-//         ? ColumnDef_ColumnSizing
-//         : never)
-//     | ('columnResizingFeature' extends keyof TFeatures
-//         ? ColumnDef_ColumnResizing
-//         : never)
-//   >
-
 export type ColumnDefBase<
   TFeatures extends TableFeatures,
   TData extends RowData,
   TValue extends CellData = CellData,
 > = ColumnDefBase_Core<TFeatures, TData, TValue> &
-  ExtractFeatureTypes<TFeatures, 'ColumnDef'>
+  ExtractFeatureTypes<TFeatures, 'ColumnDef'> &
+  ColumnDef_Plugins<TFeatures, TData, TValue>
 
 export type ColumnDefBase_All<
   TFeatures extends TableFeatures,