@tanstack/table-core 9.0.0-alpha.46 → 9.0.0-alpha.48

package/src/helpers/tableOptions.ts

@@ -3,9 +3,10 @@ import type { TableFeatures } from '../types/TableFeatures'
 import type { TableOptions } from '../types/TableOptions'
 
 /**
- * Returns table options while preserving generic inference.
+ * Preserves table option inference when reusable options omit `columns`.
  *
- * This helper is useful when composing reusable table options outside of a framework adapter call.
+ * This is useful for composing shared options that will receive columns later
+ * from a framework adapter or table factory.
  */
 export function tableOptions<
   TFeatures extends TableFeatures,
@@ -19,7 +20,7 @@ export function tableOptions<
 }
 
 /**
- * Returns table options while preserving generic inference when `data` is supplied later.
+ * Preserves table option inference when reusable options omit `data`.
  */
 export function tableOptions<
   TFeatures extends TableFeatures,
@@ -33,7 +34,8 @@ export function tableOptions<
 }
 
 /**
- * Returns table options while preserving generic inference when both `data` and `columns` are supplied later.
+ * Preserves table option inference when reusable options omit both `data` and
+ * `columns`.
  */
 export function tableOptions<
   TFeatures extends TableFeatures,
@@ -47,7 +49,7 @@ export function tableOptions<
 }
 
 /**
- * Returns a fully specified table options object without changing its runtime value.
+ * Preserves inference for a fully specified table options object.
  */
 export function tableOptions<
   TFeatures extends TableFeatures,
@@ -55,7 +57,7 @@ export function tableOptions<
 >(options: TableOptions<TFeatures, TData>): TableOptions<TFeatures, TData>
 
 /**
- * Returns table options while preserving generic inference when `_features` is supplied by a wrapper.
+ * Preserves inference when a wrapper supplies `_features`.
  */
 export function tableOptions<
   TFeatures extends TableFeatures,
@@ -65,7 +67,7 @@ export function tableOptions<
 ): Omit<TableOptions<TFeatures, TData>, '_features'>
 
 /**
- * Returns table options while preserving generic inference when `data` and `_features` are supplied by a wrapper.
+ * Preserves inference when a wrapper supplies both `data` and `_features`.
  */
 export function tableOptions<
   TFeatures extends TableFeatures,
@@ -75,7 +77,7 @@ export function tableOptions<
 ): Omit<TableOptions<TFeatures, TData>, 'data' | '_features'>
 
 /**
- * Returns table options while preserving generic inference when `columns` and `_features` are supplied by a wrapper.
+ * Preserves inference when a wrapper supplies both `columns` and `_features`.
  */
 export function tableOptions<
   TFeatures extends TableFeatures,
@@ -85,7 +87,8 @@ export function tableOptions<
 ): Omit<TableOptions<TFeatures, TData>, 'columns' | '_features'>
 
 /**
- * Returns table options while preserving generic inference when `data`, `columns`, and `_features` are supplied by a wrapper.
+ * Preserves inference when a wrapper supplies `data`, `columns`, and
+ * `_features`.
  */
 export function tableOptions<
   TFeatures extends TableFeatures,

package/src/store-reactivity-bindings.ts

@@ -20,6 +20,7 @@ export function storeReactivityBindings(): TableReactivityBindings {
   return {
     createOptionsStore: true,
     batch,
+    schedule: (fn) => queueMicrotask(fn),
     untrack: (fn) => fn(),
     createReadonlyAtom: (fn, options) => {
       return createAtom(() => fn(), {

package/src/types/ColumnDef.ts

@@ -27,11 +27,23 @@ export interface ColumnMeta<
   TValue extends CellData = CellData,
 > {}
 
+/**
+ * Reads a cell value from an original row object.
+ *
+ * The row index is provided for accessors that need stable position-aware
+ * derived values.
+ */
 export type AccessorFn<
   TData extends RowData,
   TValue extends CellData = CellData,
 > = (originalRow: TData, index: number) => TValue
 
+/**
+ * A renderable column template value.
+ *
+ * Strings render directly; functions receive the relevant cell/header context
+ * and can return framework-specific render output.
+ */
 export type ColumnDefTemplate<TProps extends object> =
   | string
   | ((props: TProps) => any)
@@ -43,7 +55,13 @@ export type StringOrTemplateHeader<
 > = string | ColumnDefTemplate<HeaderContext<TFeatures, TData, TValue>>
 
 export interface StringHeaderIdentifier {
+  /**
+   * Header text used both for rendering and as a fallback column id.
+   */
   header: string
+  /**
+   * Optional explicit id that overrides the header-derived id.
+   */
   id?: string
 }
 
@@ -52,7 +70,13 @@ export interface IdIdentifier<
   TData extends RowData,
   TValue extends CellData = CellData,
 > {
+  /**
+   * Explicit stable column id.
+   */
   id: string
+  /**
+   * Header text or template used to render this column's header.
+   */
   header?: StringOrTemplateHeader<TFeatures, TData, TValue>
 }
 type ColumnIdentifiers<
@@ -66,9 +90,23 @@ interface ColumnDefBase_Core<
   TData extends RowData,
   TValue extends CellData = CellData,
 > {
+  /**
+   * Produces the values used by faceting/grouping for this column.
+   *
+   * When omitted, the normal accessor value is wrapped in a single-item array.
+   */
   getUniqueValues?: AccessorFn<TData, Array<unknown>>
+  /**
+   * Footer template rendered with header context.
+   */
   footer?: ColumnDefTemplate<HeaderContext<TFeatures, TData, TValue>>
+  /**
+   * Cell template rendered with cell context.
+   */
   cell?: ColumnDefTemplate<CellContext<TFeatures, TData, TValue>>
+  /**
+   * User-defined metadata available on the resolved column definition.
+   */
   meta?: ColumnMeta<TFeatures, TData, TValue>
 }
 

package/src/types/TableOptions.ts

@@ -24,6 +24,10 @@ export interface TableOptions_Plugins<
   TData extends RowData,
 > {}
 
+/**
+ * Core options that are always available on a table, before optional feature
+ * options are mixed in.
+ */
 export interface TableOptions_Core<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -48,6 +52,13 @@ export type DebugOptions<TFeatures extends TableFeatures> = {
   debugTable?: boolean
 } & DebugKeysFor<CoreFeatures & TFeatures>
 
+/**
+ * Complete table options for a specific feature set.
+ *
+ * Feature options are included only when their feature is present in
+ * `TFeatures`, then custom feature/plugin options and debug options are mixed
+ * in.
+ */
 export type TableOptions<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -104,6 +115,10 @@ export type TableOptions<
 //   ExtractFeatureTypes<'TableOptions', TFeatures> &
 //   TableOptions_Plugins<TFeatures, TData>
 
+/**
+ * Internal broad option shape used where feature code may need to read options
+ * from features that are not present in the current generic feature set.
+ */
 export type TableOptions_All<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/types/TableState.ts

@@ -20,6 +20,12 @@ import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
  */
 export interface TableState_Plugins<TFeatures extends TableFeatures> {}
 
+/**
+ * Complete table state for a specific feature set.
+ *
+ * State slices are included only when their feature is present in `TFeatures`,
+ * then custom feature/plugin state is mixed in.
+ */
 export type TableState<TFeatures extends TableFeatures> = UnionToIntersection<
   | ('columnFilteringFeature' extends keyof TFeatures
       ? TableState_ColumnFiltering
@@ -71,6 +77,12 @@ export type TableState<TFeatures extends TableFeatures> = UnionToIntersection<
 // > &
 //   TableState_Plugins<TFeatures>
 
+/**
+ * Internal broad state shape containing every stock feature state slice.
+ *
+ * Feature internals use this when they may need to inspect optional slices owned
+ * by other features.
+ */
 export type TableState_All = Partial<
   TableState_ColumnFiltering &
     TableState_ColumnGrouping &

package/src/utils.ts

@@ -32,8 +32,10 @@ export function cloneState<T>(value: T): T {
     }
 
     const copy: Record<string, unknown> = {}
+    const keys = Object.keys(value)
 
-    for (const key of Object.keys(value)) {
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i]!
       copy[key] = cloneState((value as Record<string, unknown>)[key])
     }
 
@@ -43,11 +45,6 @@ export function cloneState<T>(value: T): T {
   return value
 }
 
-/**
- * A no-operation function used as a safe default callback.
- */
-export function noop() {}
-
 /**
  * Creates a table state updater for a single state slice.
  *
@@ -73,13 +70,6 @@ export function isFunction<T extends AnyFunction>(d: any): d is T {
   return d instanceof Function
 }
 
-/**
- * Returns whether a value is an array containing only numbers.
- */
-export function isNumberArray(d: any): d is Array<number> {
-  return Array.isArray(d) && d.every((val) => typeof val === 'number')
-}
-
 /**
  * Flattens a tree of nodes by recursively reading child nodes.
  *
@@ -106,29 +96,6 @@ export function flattenBy<TNode>(
   return flat
 }
 
-/**
- * Symbol used to attach internal memo metadata to wrapped functions.
- *
- * This is exported so diagnostics can recognize memoized functions without
- * depending on a string property name.
- */
-export const $internalMemoFnMeta = Symbol('memoFnMeta')
-export type MemoFnMeta = { originalArgsLength?: number }
-
-/**
- * @internal
- */
-function setMemoFnMeta(fn: Function, meta: MemoFnMeta) {
-  Object.defineProperty(fn, $internalMemoFnMeta, { value: meta })
-}
-
-/**
- * @internal
- */
-export function getMemoFnMeta(fn: any): MemoFnMeta | null {
-  return (typeof fn === 'function' && fn[$internalMemoFnMeta]) ?? null
-}
-
 interface MemoOptions<TDeps extends ReadonlyArray<any>, TDepArgs, TResult> {
   fn: (...args: NoInfer<TDeps>) => TResult
   memoDeps?: (depArgs?: TDepArgs) => [...TDeps] | undefined
@@ -159,10 +126,15 @@ export const memo = <TDeps extends ReadonlyArray<any>, TDepArgs, TResult>({
   const memoizedFn = (depArgs?: TDepArgs): TResult => {
     onBeforeCompare?.()
     const newDeps = memoDeps?.(depArgs)
-    const depsChanged =
-      !newDeps ||
-      newDeps.length !== deps?.length ||
-      newDeps.some((dep: any, index: number) => deps?.[index] !== dep)
+    let depsChanged = !newDeps || newDeps.length !== deps?.length
+    if (!depsChanged && newDeps) {
+      for (let i = 0; i < newDeps.length; i++) {
+        if (newDeps[i] !== deps![i]) {
+          depsChanged = true
+          break
+        }
+      }
+    }
     onAfterCompare?.(depsChanged)
 
     if (!depsChanged) {
@@ -178,8 +150,6 @@ export const memo = <TDeps extends ReadonlyArray<any>, TDepArgs, TResult>({
     return result
   }
 
-  setMemoFnMeta(memoizedFn, { originalArgsLength: fn.length })
-
   return memoizedFn
 }
 
@@ -283,6 +253,11 @@ export function tableMemo<
     console.groupEnd()
   }
 
+  const onAfterUpdateHandler = () => {
+    const { schedule, untrack } = table._reactivity
+    schedule(() => untrack(() => onAfterUpdate?.()))
+  }
+
   const debugOptions =
     process.env.NODE_ENV === 'development'
       ? {
@@ -313,12 +288,12 @@ export function tableMemo<
                 Math.round((endCalcTime - startCalcTime) * 100) / 100
               logTime(executionTime, true)
             }
-            queueMicrotask(() => onAfterUpdate?.())
+            onAfterUpdateHandler()
           },
         }
       : {
           onAfterUpdate: () => {
-            queueMicrotask(() => onAfterUpdate?.())
+            onAfterUpdateHandler()
           },
         }
 
@@ -440,8 +415,6 @@ export function assignPrototypeAPIs<
         return fn(this, ...args)
       }
     }
-
-    setMemoFnMeta(prototype[fnKey], { originalArgsLength: fn.length })
   }
 }