fix(table-core): give TableFeature hooks an all-features table type

.changeset/plain-plugins-type.md

@@ -0,0 +1,5 @@
+---
+'@tanstack/table-core': patch
+---
+
+Publish `Table_All` and give `TableFeature` hooks that table type, so custom features can read their own options and state without casting `table.options`

docs/framework/alpine/guide/custom-features.md

@@ -288,9 +288,7 @@ export const densityPlugin: TableFeature = {
             const newState = functionalUpdate(updater, old)
             return newState
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
       table_toggleDensity: {
@@ -299,9 +297,7 @@ export const densityPlugin: TableFeature = {
             if (value) return value
             return old === 'lg' ? 'md' : old === 'md' ? 'sm' : 'lg'
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
     })

docs/framework/ember/guide/custom-features.md

@@ -294,9 +294,7 @@ export const densityPlugin: TableFeature = {
           const safeUpdater: Updater<DensityState> = (old) => {
             return functionalUpdate(updater, old)
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
       table_toggleDensity: {
@@ -306,9 +304,7 @@ export const densityPlugin: TableFeature = {
             // cycle through the 3 options
             return old === 'lg' ? 'md' : old === 'md' ? 'sm' : 'lg'
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
     })

examples/alpine/custom-plugin/src/main.ts

@@ -103,9 +103,7 @@ export const densityPlugin: TableFeature = {
             const newState = functionalUpdate(updater, old)
             return newState
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
       table_toggleDensity: {
@@ -114,9 +112,7 @@ export const densityPlugin: TableFeature = {
             if (value) return value
             return old === 'lg' ? 'md' : old === 'md' ? 'sm' : 'lg' // cycle through the 3 options
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
     })

examples/angular/custom-plugin/src/app/density/density-feature.ts

@@ -84,9 +84,7 @@ export const densityPlugin: TableFeature = {
             const newState = functionalUpdate(updater, old)
             return newState
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
       table_toggleDensity: {
@@ -95,9 +93,7 @@ export const densityPlugin: TableFeature = {
             if (value) return value
             return old === 'lg' ? 'md' : old === 'md' ? 'sm' : 'lg' // cycle through the 3 options
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
     })

examples/ember/custom-plugin/app/templates/application.gts

@@ -107,9 +107,7 @@ export const densityPlugin: TableFeature = {
           const safeUpdater: Updater<DensityState> = (old) => {
             return functionalUpdate(updater, old)
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
       table_toggleDensity: {
@@ -119,9 +117,7 @@ export const densityPlugin: TableFeature = {
             // cycle through the 3 options
             return old === 'lg' ? 'md' : old === 'md' ? 'sm' : 'lg'
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
     })

examples/octane/custom-plugin/src/main.tsrx

@@ -104,7 +104,7 @@ export const densityPlugin: TableFeature = {
             const newState = functionalUpdate(updater, old)
             return newState
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
+          return table.options.onDensityChange?.(
             safeUpdater,
           )
         },
@@ -115,7 +115,7 @@ export const densityPlugin: TableFeature = {
             if (value) return value
             return old === 'lg' ? 'md' : old === 'md' ? 'sm' : 'lg' // cycle through the 3 options
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
+          return table.options.onDensityChange?.(
             safeUpdater,
           )
         },

examples/preact/custom-plugin/src/main.tsx

@@ -104,9 +104,7 @@ export const densityPlugin: TableFeature = {
             const newState = functionalUpdate(updater, old)
             return newState
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
       table_toggleDensity: {
@@ -115,9 +113,7 @@ export const densityPlugin: TableFeature = {
             if (value) return value
             return old === 'lg' ? 'md' : old === 'md' ? 'sm' : 'lg' // cycle through the 3 options
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
     })

examples/react/custom-plugin/src/main.tsx

@@ -105,9 +105,7 @@ export const densityPlugin: TableFeature = {
             const newState = functionalUpdate(updater, old)
             return newState
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
       table_toggleDensity: {
@@ -116,9 +114,7 @@ export const densityPlugin: TableFeature = {
             if (value) return value
             return old === 'lg' ? 'md' : old === 'md' ? 'sm' : 'lg' // cycle through the 3 options
           }
-          return (table.options as TableOptions_Density).onDensityChange?.(
-            safeUpdater,
-          )
+          return table.options.onDensityChange?.(safeUpdater)
         },
       },
     })

packages/table-core/src/types/Table.ts

@@ -80,6 +80,32 @@ export type Table<
 > = Table_Core<TFeatures, TData> &
   ExtractFeatureMapTypes<TFeatures, Table_FeatureMap<TFeatures, TData>>
 
+/**
+ * `Table` with the options, state, and row models widened to their
+ * all-features types.
+ *
+ * `TableFeature` hooks receive this so a feature can read the options and state
+ * it contributes itself, which `Table` alone cannot describe because its
+ * members are narrowed to `TFeatures`.
+ */
+export type Table_All<
+  TFeatures extends TableFeatures,
+  TData extends RowData = any,
+> = Table<TFeatures, TData> & {
+  _rowModels: CachedRowModel_All<TFeatures, TData>
+  _rowModelFns: RowModelFns_All<TFeatures, TData>
+  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>
+}
+
 /**
  * `Table_Table` members that `Table_Internal` re-declares with broadened
  * (all-features) types so internal code can read any feature's slots and

scripts/rewrite-table-core-dts.mjs

@@ -141,9 +141,9 @@ function removeNamedSpecifiers(source, names) {
     )
 }
 
-function rewriteInternalImportSpecifiers(source) {
+function rewriteInternalImportSpecifiers(source, tableReplacement) {
   const replacements = new Map([
-    ['Table_Internal', 'Table'],
+    ['Table_Internal', tableReplacement],
     ['Column_Internal', 'Column'],
   ])
 
@@ -251,14 +251,33 @@ function ensureNamedImport(source, name, importPath) {
   return `import { ${name} } from "${importPath}";\n${source}`
 }
 
-function ensurePublicTypeImports(source, file) {
+function isDeclarationPath(file, suffix) {
+  return file.replaceAll('\\', '/').endsWith(suffix)
+}
+
+function ensurePublicTypeImports(source, file, tableReplacement) {
   let next = source
 
-  if (!file.endsWith('/types/Table.d.ts') && /\bTable</.test(next)) {
+  if (!isDeclarationPath(file, '/types/Table.d.ts') && /\bTable</.test(next)) {
     next = ensureNamedImport(next, 'Table', getImportPath(file, 'Table'))
   }
 
-  if (!file.endsWith('/types/Column.d.ts') && /\bColumn</.test(next)) {
+  if (
+    tableReplacement !== 'Table' &&
+    !isDeclarationPath(file, '/types/Table.d.ts') &&
+    new RegExp(String.raw`\b${tableReplacement}<`).test(next)
+  ) {
+    next = ensureNamedImport(
+      next,
+      tableReplacement,
+      getImportPath(file, 'Table'),
+    )
+  }
+
+  if (
+    !isDeclarationPath(file, '/types/Column.d.ts') &&
+    /\bColumn</.test(next)
+  ) {
     next = ensureNamedImport(next, 'Column', getImportPath(file, 'Column'))
   }
 
@@ -268,20 +287,27 @@ function ensurePublicTypeImports(source, file) {
 function rewriteDeclaration(source, file) {
   let next = source
 
+  // `TableFeature` hooks are the plugin-authoring surface, so they keep the
+  // all-features table. Everywhere else narrows to `Table` so ordinary
+  // consumers are not handed optional state slices.
+  const tableReplacement = isDeclarationPath(file, '/types/TableFeatures.d.ts')
+    ? 'Table_All'
+    : 'Table'
+
   for (const typeName of forbiddenTypeNames) {
     next = removeExportedInterface(next, typeName)
   }
 
   next = removeTypeAlias(next, 'Table_InternalBroadenedKeys')
-  next = rewriteInternalImportSpecifiers(next)
+  next = rewriteInternalImportSpecifiers(next, tableReplacement)
   next = removeNamedSpecifiers(next, forbiddenTypeNames)
 
-  next = next.replaceAll('Table_Internal<', 'Table<')
+  next = next.replaceAll('Table_Internal<', `${tableReplacement}<`)
   next = next.replaceAll('Column_Internal<', 'Column<')
-  next = next.replaceAll('Table_Internal', 'Table')
+  next = next.replaceAll('Table_Internal', tableReplacement)
   next = next.replaceAll('Column_Internal', 'Column')
 
-  next = ensurePublicTypeImports(next, file)
+  next = ensurePublicTypeImports(next, file, tableReplacement)
 
   return next
 }