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

package/src/core/columns/coreColumnsFeature.utils.ts

@@ -11,6 +11,16 @@ import type {
 } from '../../types/ColumnDef'
 import type { Column } from '../../types/Column'
 
+/**
+ * Returns flat columns for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getFlatColumns(column)
+ * ```
+ */
 export function column_getFlatColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -21,6 +31,16 @@ export function column_getFlatColumns<
   return [column, ...column.columns.flatMap((col) => col.getFlatColumns())]
 }
 
+/**
+ * Returns leaf columns for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getLeafColumns(column)
+ * ```
+ */
 export function column_getLeafColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -43,6 +63,16 @@ export function column_getLeafColumns<
   return [column]
 }
 
+/**
+ * Returns default column def for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getDefaultColumnDef(table)
+ * ```
+ */
 export function table_getDefaultColumnDef<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -72,6 +102,16 @@ export function table_getDefaultColumnDef<
   } as Partial<ColumnDef<TFeatures, TData, unknown>>
 }
 
+/**
+ * Returns all columns for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getAllColumns(table)
+ * ```
+ */
 export function table_getAllColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -103,6 +143,16 @@ export function table_getAllColumns<
   return recurseColumns(table.options.columns)
 }
 
+/**
+ * Returns all flat columns for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getAllFlatColumns(table)
+ * ```
+ */
 export function table_getAllFlatColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -112,21 +162,39 @@ export function table_getAllFlatColumns<
   return table.getAllColumns().flatMap((column) => column.getFlatColumns())
 }
 
+/**
+ * Returns all flat columns by id for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getAllFlatColumnsById(table)
+ * ```
+ */
 export function table_getAllFlatColumnsById<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(
   table: Table_Internal<TFeatures, TData>,
 ): Record<string, Column<TFeatures, TData, unknown>> {
-  return table.getAllFlatColumns().reduce(
-    (acc, column) => {
-      acc[column.id] = column
-      return acc
-    },
-    {} as Record<string, Column<TFeatures, TData, unknown>>,
-  )
+  const result: Record<string, Column<TFeatures, TData, unknown>> = {}
+  for (const column of table.getAllFlatColumns()) {
+    result[column.id] = column
+  }
+  return result
 }
 
+/**
+ * Returns all leaf columns for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getAllLeafColumns(table)
+ * ```
+ */
 export function table_getAllLeafColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -140,9 +208,42 @@ export function table_getAllLeafColumns<
     table,
     'getOrderColumns',
     table_getOrderColumnsFn,
-  )(leafColumns as any) as any
+  )(leafColumns)
+}
+
+/**
+ * Returns all leaf columns by id for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getAllLeafColumnsById(table)
+ * ```
+ */
+export function table_getAllLeafColumnsById<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(
+  table: Table_Internal<TFeatures, TData>,
+): Record<string, Column<TFeatures, TData, unknown>> {
+  const result: Record<string, Column<TFeatures, TData, unknown>> = {}
+  for (const column of table.getAllLeafColumns()) {
+    result[column.id] = column
+  }
+  return result
 }
 
+/**
+ * Returns column for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getColumn(table)
+ * ```
+ */
 export function table_getColumn<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/core/coreFeatures.ts

@@ -16,6 +16,11 @@ export interface CoreFeatures {
   coreTablesFeature: typeof coreTablesFeature
 }
 
+/**
+ * The built-in core feature set required by every table.
+ *
+ * These features provide table, column, row, header, cell, and core row-model behavior before optional feature plugins are added.
+ */
 export const coreFeatures: CoreFeatures = {
   coreCellsFeature,
   coreColumnsFeature,

package/src/core/headers/buildHeaderGroups.ts

@@ -8,6 +8,11 @@ import type { Header } from '../../types/Header'
 import type { HeaderGroup } from '../../types/HeaderGroup'
 import type { Column } from '../../types/Column'
 
+/**
+ * Builds the nested header group structure for a table.
+ *
+ * The result accounts for visible leaf columns, pinned column groups, and placeholder headers needed to render multi-level headers.
+ */
 export function buildHeaderGroups<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -65,7 +70,8 @@ export function buildHeaderGroups<
     headersToGroup.forEach((headerToGroup) => {
       // What is the latest (last) parent column?
 
-      const latestPendingParentHeader = [...pendingParentHeaders].reverse()[0]
+      const latestPendingParentHeader =
+        pendingParentHeaders[pendingParentHeaders.length - 1]
 
       const isLeafHeader = headerToGroup.column.depth === headerGroup.depth
 

package/src/core/headers/constructHeader.ts

@@ -22,6 +22,11 @@ function getHeaderPrototype<
   return table._headerPrototype
 }
 
+/**
+ * Constructs a header instance from normalized table internals.
+ *
+ * This wires core properties, feature prototype APIs, and instance data used by table rendering and row-model operations.
+ */
 export function constructHeader<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/core/headers/coreHeadersFeature.ts

@@ -28,6 +28,11 @@ export interface CoreHeadersFeatureConstructors<
   // Table: Table_Headers<TFeatures, TData>
 }
 
+/**
+ * Creates the stock core headers feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 export function constructCoreHeadersFeature<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/core/headers/coreHeadersFeature.utils.ts

@@ -4,7 +4,10 @@ import {
   table_getLeftHeaderGroups,
   table_getRightHeaderGroups,
 } from '../../features/column-pinning/columnPinningFeature.utils'
-import { table_getVisibleLeafColumns } from '../../features/column-visibility/columnVisibilityFeature.utils'
+import {
+  column_getIsVisible,
+  table_getVisibleLeafColumns,
+} from '../../features/column-visibility/columnVisibilityFeature.utils'
 import { callMemoOrStaticFn } from '../../utils'
 import { buildHeaderGroups } from './buildHeaderGroups'
 import type { Table_Internal } from '../../types/Table'
@@ -14,6 +17,16 @@ import type { TableFeatures } from '../../types/TableFeatures'
 import type { Header_Header } from './coreHeadersFeature.types'
 import type { Column } from '../../types/Column'
 
+/**
+ * Returns leaf headers for a header.
+ *
+ * This is the static implementation behind the matching header instance API and can account for nested header groups.
+ *
+ * @example
+ * ```ts
+ * const value = header_getLeafHeaders(header)
+ * ```
+ */
 export function header_getLeafHeaders<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -33,6 +46,16 @@ export function header_getLeafHeaders<
   return leafHeaders
 }
 
+/**
+ * Returns context for a header.
+ *
+ * This is the static implementation behind the matching header instance API and can account for nested header groups.
+ *
+ * @example
+ * ```ts
+ * const value = header_getContext(header)
+ * ```
+ */
 export function header_getContext<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -45,6 +68,16 @@ export function header_getContext<
   }
 }
 
+/**
+ * Returns header groups for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getHeaderGroups(table)
+ * ```
+ */
 export function table_getHeaderGroups<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -56,15 +89,30 @@ export function table_getHeaderGroups<
     table,
     'getVisibleLeafColumns',
     table_getVisibleLeafColumns,
-  ) as unknown as Array<Column<TFeatures, TData, unknown>>
+  ) as Array<Column<TFeatures, TData, unknown>>
+  const leafColumnsById = table.getAllLeafColumnsById()
 
-  const leftColumns = left
-    .map((columnId) => leafColumns.find((d) => d.id === columnId)!)
-    .filter(Boolean)
+  const leftColumns: typeof leafColumns = []
+  for (const columnId of left) {
+    const column = leafColumnsById[columnId]
+    if (
+      column &&
+      callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible)
+    ) {
+      leftColumns.push(column)
+    }
+  }
 
-  const rightColumns = right
-    .map((columnId) => leafColumns.find((d) => d.id === columnId)!)
-    .filter(Boolean)
+  const rightColumns: typeof leafColumns = []
+  for (const columnId of right) {
+    const column = leafColumnsById[columnId]
+    if (
+      column &&
+      callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible)
+    ) {
+      rightColumns.push(column)
+    }
+  }
 
   const centerColumns = leafColumns.filter(
     (column) => !left.includes(column.id) && !right.includes(column.id),
@@ -79,6 +127,16 @@ export function table_getHeaderGroups<
   return headerGroups
 }
 
+/**
+ * Returns footer groups for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getFooterGroups(table)
+ * ```
+ */
 export function table_getFooterGroups<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -87,6 +145,16 @@ export function table_getFooterGroups<
   return [...headerGroups].reverse()
 }
 
+/**
+ * Returns flat headers for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getFlatHeaders(table)
+ * ```
+ */
 export function table_getFlatHeaders<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -99,6 +167,16 @@ export function table_getFlatHeaders<
     .flat()
 }
 
+/**
+ * Returns leaf headers for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getLeafHeaders(table)
+ * ```
+ */
 export function table_getLeafHeaders<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/core/reactivity/coreReactivityFeature.utils.ts

@@ -2,16 +2,31 @@ import type { Atom, ReadonlyAtom, ReadonlyStore, Store } from '@tanstack/store'
 
 /**
  * Converts a writable atom to the store-compatible shape expected by core.
+ *
+ * @example
+ * ```ts
+ * const store = atomToStore(atom)
+ * ```
  */
 export function atomToStore<T>(atom: Atom<T>): Store<T>
 /**
  * Converts a readonly atom to a readonly store-compatible shape.
+ *
+ * @example
+ * ```ts
+ * const store = atomToStore(atom)
+ * ```
  */
 export function atomToStore<T>(atom: ReadonlyAtom<T>): ReadonlyStore<T>
 /**
  * Bridges atom instances to the `Store`/`ReadonlyStore` API by exposing
  * a `state` getter backed by `atom.get()`, and wiring `setState` for
  * writable atoms.
+ *
+ * @example
+ * ```ts
+ * const store = atomToStore(atom)
+ * ```
  */
 export function atomToStore<T>(
   atom: Atom<T> | ReadonlyAtom<T>,

package/src/core/row-models/coreRowModelsFeature.ts

@@ -24,6 +24,11 @@ export interface CoreRowModelsFeatureConstructors<
   // Table: Table_RowModels<TFeatures, TData>
 }
 
+/**
+ * Creates the stock core row models feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 export function constructCoreRowModelsFeature<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/core/row-models/coreRowModelsFeature.types.ts

@@ -25,7 +25,8 @@ export interface CreateRowModel_Core<
   TData extends RowData,
 > extends CreateRowModel_Plugins {
   /**
-   * This required option is a factory for a function that computes and returns the core row model for the table.
+   * Optional factory for the core row model. When omitted, the built-in
+   * `createCoreRowModel()` factory is used.
    */
   coreRowModel?: (
     table: Table<TFeatures, TData>,

package/src/core/row-models/coreRowModelsFeature.utils.ts

@@ -4,6 +4,16 @@ import type { TableFeatures } from '../../types/TableFeatures'
 import type { RowData } from '../../types/type-utils'
 import type { RowModel } from './coreRowModelsFeature.types'
 
+/**
+ * Returns core row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCoreRowModel(table)
+ * ```
+ */
 export function table_getCoreRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -17,6 +27,16 @@ export function table_getCoreRowModel<
   return table._rowModels.coreRowModel()
 }
 
+/**
+ * Returns pre filtered row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPreFilteredRowModel(table)
+ * ```
+ */
 export function table_getPreFilteredRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -24,6 +44,16 @@ export function table_getPreFilteredRowModel<
   return table.getCoreRowModel()
 }
 
+/**
+ * Returns filtered row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getFilteredRowModel(table)
+ * ```
+ */
 export function table_getFilteredRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -40,6 +70,16 @@ export function table_getFilteredRowModel<
   return table._rowModels.filteredRowModel()
 }
 
+/**
+ * Returns pre grouped row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPreGroupedRowModel(table)
+ * ```
+ */
 export function table_getPreGroupedRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -47,6 +87,16 @@ export function table_getPreGroupedRowModel<
   return table.getFilteredRowModel()
 }
 
+/**
+ * Returns grouped row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getGroupedRowModel(table)
+ * ```
+ */
 export function table_getGroupedRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -63,6 +113,16 @@ export function table_getGroupedRowModel<
   return table._rowModels.groupedRowModel()
 }
 
+/**
+ * Returns pre sorted row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPreSortedRowModel(table)
+ * ```
+ */
 export function table_getPreSortedRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -70,6 +130,16 @@ export function table_getPreSortedRowModel<
   return table.getGroupedRowModel()
 }
 
+/**
+ * Returns sorted row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getSortedRowModel(table)
+ * ```
+ */
 export function table_getSortedRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -86,6 +156,16 @@ export function table_getSortedRowModel<
   return table._rowModels.sortedRowModel()
 }
 
+/**
+ * Returns pre expanded row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPreExpandedRowModel(table)
+ * ```
+ */
 export function table_getPreExpandedRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -93,6 +173,16 @@ export function table_getPreExpandedRowModel<
   return table.getSortedRowModel()
 }
 
+/**
+ * Returns expanded row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getExpandedRowModel(table)
+ * ```
+ */
 export function table_getExpandedRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -109,6 +199,16 @@ export function table_getExpandedRowModel<
   return table._rowModels.expandedRowModel()
 }
 
+/**
+ * Returns pre paginated row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPrePaginatedRowModel(table)
+ * ```
+ */
 export function table_getPrePaginatedRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -116,6 +216,16 @@ export function table_getPrePaginatedRowModel<
   return table.getExpandedRowModel()
 }
 
+/**
+ * Returns paginated row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPaginatedRowModel(table)
+ * ```
+ */
 export function table_getPaginatedRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -132,6 +242,16 @@ export function table_getPaginatedRowModel<
   return table._rowModels.paginatedRowModel()
 }
 
+/**
+ * Returns row model for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getRowModel(table)
+ * ```
+ */
 export function table_getRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/core/row-models/createCoreRowModel.ts

@@ -7,6 +7,11 @@ import type { TableFeatures } from '../../types/TableFeatures'
 import type { Row } from '../../types/Row'
 import type { RowData } from '../../types/type-utils'
 
+/**
+ * Creates a memoized core row model factory.
+ *
+ * The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.
+ */
 export function createCoreRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/core/rows/constructRow.ts

@@ -21,6 +21,11 @@ function getRowPrototype<
   return table._rowPrototype
 }
 
+/**
+ * Constructs a row instance from normalized table internals.
+ *
+ * This wires core properties, feature prototype APIs, and instance data used by table rendering and row-model operations.
+ */
 export const constructRow = <
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/core/rows/coreRowsFeature.ts

@@ -28,6 +28,11 @@ export interface CoreRowsFeatureConstructors<
   // Table: Table_Rows<TFeatures, TData>
 }
 
+/**
+ * Creates the stock core rows feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 export function constructCoreRowsFeature<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/core/rows/coreRowsFeature.types.ts

@@ -48,6 +48,9 @@ export interface Row_Row<
   TFeatures extends TableFeatures,
   TData extends RowData,
 > extends Row_CoreProperties<TFeatures, TData> {
+  /**
+   * Returns all of the cells for the row by column id.
+   */
   getAllCellsByColumnId: () => Record<string, Cell<TFeatures, TData, unknown>>
   /**
    * Returns all of the cells for the row.