@tanstack/table-core 9.0.0-alpha.8 → 9.0.0-beta.1

package/src/core/table/coreTablesFeature.types.ts

@@ -0,0 +1,216 @@
+import type { TableReactivityBindings } from '../reactivity/coreReactivityFeature.types'
+import type { Atom, ReadonlyAtom, ReadonlyStore } from '@tanstack/store'
+import type { CoreFeatures } from '../coreFeatures'
+import type { RowModelFns } from '../../types/RowModelFns'
+import type { RowData, Updater } from '../../types/type-utils'
+import type { TableFeatures } from '../../types/TableFeatures'
+import type { CachedRowModels, CreateRowModels_All } from '../../types/RowModel'
+import type { TableOptions } from '../../types/TableOptions'
+import type { TableState, TableState_All } from '../../types/TableState'
+
+export interface TableMeta<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {}
+
+/**
+ * A map of writable atoms, one per `TableState` slice. These are the internal
+ * writable atoms that the library always writes to via `makeStateUpdater`.
+ */
+export type BaseAtoms<TFeatures extends TableFeatures> = {
+  [K in keyof TableState<TFeatures>]-?: Atom<TableState<TFeatures>[K]>
+}
+
+/**
+ * A map of readonly derived atoms, one per `TableState` slice. Each derives
+ * from its corresponding `baseAtom` plus, optionally, a per-slice external
+ * atom or external state value.
+ *
+ * Precedence: `options.atoms[key]` > `options.state[key]` > `baseAtoms[key]`.
+ */
+export type Atoms<TFeatures extends TableFeatures> = {
+  [K in keyof TableState<TFeatures>]-?: ReadonlyAtom<TableState<TFeatures>[K]>
+}
+
+/**
+ * A map of optional external atoms, one per `TableState` slice. Consumers can
+ * provide their own writable atom for any state slice to take over ownership
+ * of that slice.
+ */
+export type ExternalAtoms<TFeatures extends TableFeatures> = Partial<{
+  [K in keyof TableState<TFeatures>]: Atom<TableState<TFeatures>[K]>
+}>
+
+/**
+ * Internal "all features" flat variants of the atom types. `Table_Internal`
+ * uses these so feature code (written generically over `TFeatures`) can access
+ * any slice atom (e.g. `table.atoms.columnPinning`) without TypeScript
+ * narrowing away slices that aren't in the current `TFeatures` union.
+ *
+ * Keys are optional: feature code can read atoms from slices it doesn't own,
+ * but those slices may not be registered on the current table. Consumers must
+ * use optional chaining (`table.atoms.columnPinning?.get() ?? default`).
+ */
+export type BaseAtoms_All = {
+  [K in keyof TableState_All]?: Atom<TableState_All[K]>
+}
+export type Atoms_All = {
+  [K in keyof TableState_All]?: ReadonlyAtom<TableState_All[K]>
+}
+export type ExternalAtoms_All = Partial<{
+  [K in keyof TableState_All]: Atom<TableState_All[K]>
+}>
+
+export interface TableOptions_Table<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  /**
+   * The feature modules registered on this table instance.
+   *
+   * Feature registration controls which state slices, options, and prototype
+   * APIs are available.
+   */
+  readonly features: TFeatures
+  /**
+   * Row model factories used by features such as filtering, grouping, sorting,
+   * expansion, and pagination.
+   */
+  readonly rowModels?: CreateRowModels_All<TFeatures, TData>
+  /**
+   * Optionally, provide your own external writable atoms for individual state slices.
+   * When an atom is provided for a given slice, it takes precedence over `options.state[key]`
+   * and the internal base atom for that slice. Feature state update APIs write through
+   * the corresponding atom updater, so external atoms are the preferred v9 ownership
+   * model for app-managed table state slices.
+   */
+  readonly atoms?: ExternalAtoms<TFeatures>
+  /**
+   * Set this option to override any of the `autoReset...` feature options.
+   */
+  readonly autoResetAll?: boolean
+  /**
+   * The data for the table to display. When the `data` option changes reference, the table will reprocess the data.
+   */
+  readonly data: ReadonlyArray<TData>
+  /**
+   * Optional key used to identify this table instance.
+   *
+   * This is used by TanStack Table Devtools to register and select tables. It is
+   * not required unless the table is passed to devtools.
+   */
+  readonly key?: string
+  /**
+   * Optionally provide starting values for registered table state slices.
+   * Feature reset APIs use this value by default, and many reset APIs accept
+   * `true` to reset to that feature's blank/default state instead. Changing this
+   * object later does not reset table state, so it does not need to be stable.
+   */
+  readonly initialState?: Partial<TableState<TFeatures>>
+  /**
+   * This option is used to optionally implement the merging of table options.
+   */
+  readonly mergeOptions?: (
+    defaultOptions: TableOptions<TFeatures, TData>,
+    options: Partial<TableOptions<TFeatures, TData>>,
+  ) => TableOptions<TFeatures, TData>
+  /**
+   * You can pass any object to `options.meta` and access it anywhere the `table` is available via `table.options.meta`.
+   */
+  readonly meta?: TableMeta<TFeatures, TData>
+  /**
+   * Optionally provide externally managed values for individual state slices.
+   *
+   * Pair each slice with its matching `on[State]Change` callback so table state
+   * updates can be persisted outside the table. External atoms take precedence
+   * over this option when both are provided for the same slice.
+   */
+  readonly state?: Partial<TableState<TFeatures>>
+}
+
+export interface Table_CoreProperties<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  /**
+   * Table reactivity bindings for interacting with TanStack Store.
+   */
+  readonly _reactivity: TableReactivityBindings
+  /**
+   * Prototype cache for Cell objects - shared by all cells in this table
+   */
+  _cellPrototype?: object
+  /**
+   * Prototype cache for Column objects - shared by all columns in this table
+   */
+  _columnPrototype?: object
+  /**
+   * The features that are enabled for the table.
+   */
+  readonly _features: Partial<CoreFeatures> & TFeatures
+  /**
+   * Prototype cache for Header objects - shared by all headers in this table
+   */
+  _headerPrototype?: object
+  /**
+   * The row model processing functions that are used to process the data by features.
+   */
+  readonly _rowModelFns: RowModelFns<TFeatures, TData>
+  /**
+   * The row models that are enabled for the table.
+   */
+  readonly _rowModels: CachedRowModels<TFeatures, TData>
+  /**
+   * Prototype cache for Row objects - shared by all rows in this table
+   */
+  _rowPrototype?: object
+  /**
+   * The readonly derived atoms for each `TableState` slice. Each derives from
+   * its corresponding `baseAtom` plus, optionally, a per-slice external atom or
+   * external state value (precedence: external atom > external state > base atom).
+   */
+  readonly atoms: Atoms<TFeatures>
+  /**
+   * The internal writable atoms for each `TableState` slice. This is the library's
+   * single write surface — all state mutations from features land here.
+   */
+  readonly baseAtoms: BaseAtoms<TFeatures>
+  /**
+   * This is the resolved initial state of the table.
+   */
+  readonly initialState: TableState<TFeatures>
+  /**
+   * A read-only reference to the table's current options.
+   */
+  readonly options: TableOptions<TFeatures, TData>
+  /**
+   * Writable atom for table options. Only created when `createOptionsStore` is
+   * true on the active core reactivity bindings. Adapters that opt out keep
+   * options as plain resolved data instead of backing them with an atom.
+   */
+  readonly optionsStore?: Atom<TableOptions<TFeatures, TData>> | undefined
+  /**
+   * The readonly flat store for the table state. Derives from `table.atoms`
+   * only; never reads external state directly.
+   */
+  readonly store: ReadonlyStore<TableState<TFeatures>>
+}
+
+export interface Table_Table<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> extends Table_CoreProperties<TFeatures, TData> {
+  /**
+   * Resets the table's internal base atoms to `table.initialState`.
+   *
+   * Prefer feature-specific reset APIs, such as `resetPagination`, when a state
+   * slice may be owned by an external atom or needs that feature's blank/default
+   * reset behavior.
+   */
+  reset: () => void
+  /**
+   * Updates the table options by applying a value or updater to the current
+   * resolved options and then merging them through `options.mergeOptions`.
+   */
+  setOptions: (newOptions: Updater<TableOptions<TFeatures, TData>>) => void
+}

package/src/core/table/coreTablesFeature.utils.ts

@@ -0,0 +1,131 @@
+import { cloneState, functionalUpdate } from '../../utils'
+import type { RowData, Updater } from '../../types/type-utils'
+import type { TableFeatures } from '../../types/TableFeatures'
+import type { Table_Internal } from '../../types/Table'
+import type { TableOptions } from '../../types/TableOptions'
+
+/**
+ * Synchronizes externally controlled state slices into the table's base atoms.
+ *
+ * This keeps legacy `options.state` values reflected in the atom graph so
+ * derived atoms, stores, and table APIs read a consistent snapshot.
+ *
+ * @example
+ * ```ts
+ * table_syncExternalStateToBaseAtoms(table)
+ * ```
+ */
+export function table_syncExternalStateToBaseAtoms<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(table: Table_Internal<TFeatures, TData>): void {
+  const state = table.options.state
+  if (!state) {
+    return
+  }
+
+  table._reactivity.batch(() => {
+    for (const key in state) {
+      const baseAtom = (table.baseAtoms as Record<string, any>)[key]
+      if (!baseAtom) {
+        continue
+      }
+
+      const externalState = state[key as keyof typeof state]
+      if (externalState !== baseAtom.get()) {
+        baseAtom.set(() => externalState)
+      }
+    }
+  })
+}
+
+/**
+ * Resets all internal table base atoms to `table.initialState`.
+ *
+ * This resets internally owned state slices in a single reactivity batch. Use
+ * feature-specific reset APIs when a slice may be externally owned.
+ *
+ * @example
+ * ```ts
+ * table_reset(table)
+ * ```
+ */
+export function table_reset<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(table: Table_Internal<TFeatures, TData>): void {
+  const snap = cloneState(table.initialState)
+  table._reactivity.batch(() => {
+    const keys = Object.keys(snap) as Array<keyof typeof snap>
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i]!
+      ;(table.baseAtoms as any)[key].set(snap[key] as any)
+    }
+  })
+}
+
+/**
+ * Merges new table options with the current resolved options.
+ *
+ * If `options.mergeOptions` is provided, it owns the merge behavior; otherwise
+ * options are shallow-merged.
+ *
+ * @example
+ * ```ts
+ * const options = table_mergeOptions(table, nextOptions)
+ * ```
+ */
+export function table_mergeOptions<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(
+  table: Table_Internal<TFeatures, TData>,
+  newOptions: TableOptions<TFeatures, TData>,
+) {
+  if (table.options.mergeOptions) {
+    return table.options.mergeOptions(table.options, newOptions)
+  }
+
+  return {
+    ...table.options,
+    ...newOptions,
+  }
+}
+
+/**
+ * Updates the table options object.
+ *
+ * The updater receives the current resolved options and the merged result is
+ * immediately assigned to the table instance.
+ *
+ * @example
+ * ```ts
+ * table_setOptions(table, (old) => old)
+ * ```
+ */
+export function table_setOptions<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(
+  table: Table_Internal<TFeatures, TData>,
+  updater: Updater<TableOptions<TFeatures, TData>>,
+): void {
+  const newOptions = functionalUpdate(updater, table.options)
+  // table static options that should never change after initialization
+  const { rowModels, features, atoms, initialState } = table.options
+  const mergedOptions = Object.assign(table_mergeOptions(table, newOptions), {
+    // Once the table instance is created those properties should never change after initialization,
+    // so we assign them back preserving the `table_mergeOptions` object reference
+    rowModels,
+    features,
+    atoms,
+    initialState,
+  })
+
+  if (table.optionsStore) {
+    table.optionsStore.set(() => mergedOptions)
+  } else {
+    table.options = mergedOptions
+  }
+  table_syncExternalStateToBaseAtoms(table)
+}

package/src/features/column-faceting/columnFacetingFeature.ts

@@ -0,0 +1,120 @@
+import {
+  assignPrototypeAPIs,
+  assignTableAPIs,
+  callMemoOrStaticFn,
+} from '../../utils'
+import {
+  column_getFacetedMinMaxValues,
+  column_getFacetedRowModel,
+  column_getFacetedUniqueValues,
+  table_getGlobalFacetedMinMaxValues,
+  table_getGlobalFacetedRowModel,
+  table_getGlobalFacetedUniqueValues,
+} from './columnFacetingFeature.utils'
+import type { RowData } from '../../types/type-utils'
+import type { TableFeature, TableFeatures } from '../../types/TableFeatures'
+import type { Column_Internal } from '../../types/Column'
+// import type {
+//   CachedRowModel_Faceted,
+//   Column_ColumnFaceting,
+//   CreateRowModel_Faceted,
+// } from './columnFacetingFeature.types'
+
+export interface ColumnFacetingFeatureConstructors<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  // CachedRowModel: CachedRowModel_Faceted<TFeatures, TData>
+  // Column: Column_ColumnFaceting<TFeatures, TData>
+  // CreateRowModels: CreateRowModel_Faceted<TFeatures, TData>
+}
+
+/**
+ * Creates the stock column faceting feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
+export function constructColumnFacetingFeature<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(): TableFeature<ColumnFacetingFeatureConstructors<TFeatures, TData>> {
+  return {
+    assignColumnPrototype: (prototype, table) => {
+      assignPrototypeAPIs('columnFacetingFeature', prototype, table, {
+        column_getFacetedRowModel: {
+          memoDeps: () => [
+            table.getPreFilteredRowModel().rows,
+            table.atoms.columnFilters?.get(),
+            table.atoms.globalFilter?.get(),
+            table.getFilteredRowModel().rows,
+          ],
+          fn: (column) => column_getFacetedRowModel(column, column.table),
+        },
+        column_getFacetedMinMaxValues: {
+          memoDeps: (column: Column_Internal<TFeatures, TData>) => [
+            callMemoOrStaticFn(
+              column,
+              'getFacetedRowModel',
+              column_getFacetedRowModel,
+              column.table,
+            ).flatRows,
+          ],
+          fn: (column) => column_getFacetedMinMaxValues(column, column.table),
+        },
+        column_getFacetedUniqueValues: {
+          memoDeps: (column: Column_Internal<TFeatures, TData>) => [
+            callMemoOrStaticFn(
+              column,
+              'getFacetedRowModel',
+              column_getFacetedRowModel,
+              column.table,
+            ).flatRows,
+          ],
+          fn: (column) => column_getFacetedUniqueValues(column, column.table),
+        },
+      })
+    },
+
+    constructTableAPIs: (table) => {
+      assignTableAPIs('columnFacetingFeature', table, {
+        table_getGlobalFacetedRowModel: {
+          memoDeps: () => [
+            table.getPreFilteredRowModel().rows,
+            table.atoms.columnFilters?.get(),
+            table.atoms.globalFilter?.get(),
+            table.getFilteredRowModel().rows,
+          ],
+          fn: () => table_getGlobalFacetedRowModel(table),
+        },
+        table_getGlobalFacetedMinMaxValues: {
+          memoDeps: () => [
+            callMemoOrStaticFn(
+              table,
+              'getGlobalFacetedRowModel',
+              table_getGlobalFacetedRowModel,
+            ).flatRows,
+          ],
+          fn: () => table_getGlobalFacetedMinMaxValues(table),
+        },
+        table_getGlobalFacetedUniqueValues: {
+          memoDeps: () => [
+            callMemoOrStaticFn(
+              table,
+              'getGlobalFacetedRowModel',
+              table_getGlobalFacetedRowModel,
+            ).flatRows,
+          ],
+          fn: () => table_getGlobalFacetedUniqueValues(table),
+        },
+      })
+    },
+  }
+}
+
+/**
+ * The stock column faceting feature.
+ *
+ * Register this feature to add faceted row model, unique value, and min/max
+ * helpers for column and global filter UIs.
+ */
+export const columnFacetingFeature = constructColumnFacetingFeature()

package/src/features/column-faceting/columnFacetingFeature.types.ts

@@ -0,0 +1,109 @@
+import type { Table } from '../../types/Table'
+import type { RowData } from '../../types/type-utils'
+import type { TableFeatures } from '../../types/TableFeatures'
+import type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'
+
+export interface Column_ColumnFaceting<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  /**
+   * Computes min/max numeric facet values for this column.
+   */
+  getFacetedMinMaxValues: () => undefined | [number, number]
+  /**
+   * Computes the row model used to derive this column's facet values.
+   *
+   * Other column filters are applied, while this column's own filter is
+   * excluded.
+   */
+  getFacetedRowModel: () => RowModel<TFeatures, TData>
+  /**
+   * Computes unique facet values and occurrence counts for this column.
+   */
+  getFacetedUniqueValues: () => Map<any, number>
+}
+
+export interface Table_RowModels_Faceted<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  /**
+   * Computes min/max numeric facet values for the active faceting context.
+   *
+   * Requires a `facetedMinMaxValues` row-model factory in `rowModels`.
+   */
+  getFacetedMinMaxValues: () => undefined | [number, number]
+  /**
+   * Computes the row model used to derive facet values.
+   *
+   * Requires a `facetedRowModel` row-model factory in `rowModels`.
+   */
+  getFacetedRowModel: () => RowModel<TFeatures, TData>
+  /**
+   * Computes unique facet values and occurrence counts.
+   *
+   * Requires a `facetedUniqueValues` row-model factory in `rowModels`.
+   */
+  getFacetedUniqueValues: () => Map<any, number>
+}
+
+export interface CreateRowModel_Faceted<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  /**
+   * Factory used to retrieve faceted min/max values. If using server-side
+   * faceting, this is not required. To use client-side faceting, pass
+   * `createFacetedMinMaxValues()` or implement your own factory.
+   */
+  facetedMinMaxValues?: (
+    table: Table<TFeatures, TData>,
+    columnId: string,
+  ) => () => [number, number] | undefined
+  /**
+   * Factory used to retrieve the faceted row model. If using server-side
+   * faceting, this is not required. To use client-side faceting, pass
+   * `createFacetedRowModel()` or implement your own factory.
+   */
+  facetedRowModel?: (
+    table: Table<TFeatures, TData>,
+    columnId: string,
+  ) => () => RowModel<TFeatures, TData>
+  /**
+   * Factory used to retrieve faceted unique values. If using server-side
+   * faceting, this is not required. To use client-side faceting, pass
+   * `createFacetedUniqueValues()` or implement your own factory.
+   */
+  facetedUniqueValues?: (
+    table: Table<TFeatures, TData>,
+    columnId: string,
+  ) => () => Map<any, number>
+}
+
+export interface CachedRowModel_Faceted<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  facetedRowModel?: (columnId: string) => () => RowModel<TFeatures, TData>
+  facetedMinMaxValues?: (columnId: string) => [number, number]
+  facetedUniqueValues?: (columnId: string) => Map<any, number>
+}
+
+export interface Table_ColumnFaceting<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  /**
+   * Returns the min and max values for the global filter.
+   */
+  getGlobalFacetedMinMaxValues: () => undefined | [number, number]
+  /**
+   * Computes the row model used to derive global facet values.
+   */
+  getGlobalFacetedRowModel: () => RowModel<TFeatures, TData>
+  /**
+   * Returns the faceted unique values for the global filter.
+   */
+  getGlobalFacetedUniqueValues: () => Map<any, number>
+}