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

package/dist/core/columns/coreColumnsFeature.utils.d.cts

@@ -6,101 +6,111 @@ import { Table_Internal } from "../../types/Table.cjs";
 
 //#region src/core/columns/coreColumnsFeature.utils.d.ts
 /**
- * Returns flat columns for a column.
+ * Flattens this column and every descendant column into a single array.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * Group columns appear before their child columns, which matches the normalized
+ * column hierarchy produced during table construction.
  *
  * @example
  * ```ts
- * const value = column_getFlatColumns(column)
+ * const flatColumns = column_getFlatColumns(column)
  * ```
  */
 declare function column_getFlatColumns<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>): Array<Column<TFeatures, TData, TValue>>;
 /**
- * Returns leaf columns for a column.
+ * Collects the terminal leaf columns below this column.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * Group columns return their ordered descendants. Non-group columns return an
+ * array containing only the column itself.
  *
  * @example
  * ```ts
- * const value = column_getLeafColumns(column)
+ * const leafColumns = column_getLeafColumns(column)
  * ```
  */
 declare function column_getLeafColumns<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>): Array<Column<TFeatures, TData, TValue>>;
 /**
- * Returns default column def for the table.
+ * Merges built-in, feature, and user default column definitions.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Built-in defaults provide a header and fallback cell renderer, feature
+ * defaults can add feature-specific column options, and
+ * `options.defaultColumn` wins last.
  *
  * @example
  * ```ts
- * const value = table_getDefaultColumnDef(table)
+ * const defaultColumn = table_getDefaultColumnDef(table)
  * ```
  */
 declare function table_getDefaultColumnDef<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Partial<ColumnDef<TFeatures, TData, unknown>>;
 /**
- * Returns all columns for the table.
+ * Normalizes `options.columns` into the table's nested column tree.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Each column definition is constructed with its parent and depth, and group
+ * column children are recursively constructed.
  *
  * @example
  * ```ts
- * const value = table_getAllColumns(table)
+ * const columns = table_getAllColumns(table)
  * ```
  */
 declare function table_getAllColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Column<TFeatures, TData, unknown>>;
 /**
- * Returns all flat columns for the table.
+ * Flattens every table column, including group columns and leaf columns.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Use this when parent/group columns must be included in addition to data leaf
+ * columns.
  *
  * @example
  * ```ts
- * const value = table_getAllFlatColumns(table)
+ * const flatColumns = table_getAllFlatColumns(table)
  * ```
  */
 declare function table_getAllFlatColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Column<TFeatures, TData, unknown>>;
 /**
- * Returns all flat columns by id for the table.
+ * Builds an id lookup for every flat column in the table.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Group columns and leaf columns are included. Later columns with the same id
+ * replace earlier entries.
  *
  * @example
  * ```ts
- * const value = table_getAllFlatColumnsById(table)
+ * const columnsById = table_getAllFlatColumnsById(table)
  * ```
  */
 declare function table_getAllFlatColumnsById<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Record<string, Column<TFeatures, TData, unknown>>;
 /**
- * Returns all leaf columns for the table.
+ * Collects all terminal leaf columns in their current table order.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Column ordering features can reorder the collected leaves before the result
+ * is returned.
  *
  * @example
  * ```ts
- * const value = table_getAllLeafColumns(table)
+ * const leafColumns = table_getAllLeafColumns(table)
  * ```
  */
 declare function table_getAllLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Column<TFeatures, TData, unknown>>;
 /**
- * Returns all leaf columns by id for the table.
+ * Builds an id lookup for terminal leaf columns only.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Parent/group columns are excluded, making this lookup appropriate for row
+ * cells and feature state keyed by data columns.
  *
  * @example
  * ```ts
- * const value = table_getAllLeafColumnsById(table)
+ * const leavesById = table_getAllLeafColumnsById(table)
  * ```
  */
 declare function table_getAllLeafColumnsById<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Record<string, Column<TFeatures, TData, unknown>>;
 /**
- * Returns column for the table.
+ * Looks up a column by id from the flat column map.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * The lookup can return group columns or leaf columns. In development, a
+ * missing id logs a warning to help catch stale column references.
  *
  * @example
  * ```ts
- * const value = table_getColumn(table)
+ * const column = table_getColumn(table, 'firstName')
  * ```
  */
 declare function table_getColumn<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, columnId: string): Column<TFeatures, TData, unknown> | undefined;

package/dist/core/columns/coreColumnsFeature.utils.d.ts

@@ -6,101 +6,111 @@ import { Table_Internal } from "../../types/Table.js";
 
 //#region src/core/columns/coreColumnsFeature.utils.d.ts
 /**
- * Returns flat columns for a column.
+ * Flattens this column and every descendant column into a single array.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * Group columns appear before their child columns, which matches the normalized
+ * column hierarchy produced during table construction.
  *
  * @example
  * ```ts
- * const value = column_getFlatColumns(column)
+ * const flatColumns = column_getFlatColumns(column)
  * ```
  */
 declare function column_getFlatColumns<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>): Array<Column<TFeatures, TData, TValue>>;
 /**
- * Returns leaf columns for a column.
+ * Collects the terminal leaf columns below this column.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * Group columns return their ordered descendants. Non-group columns return an
+ * array containing only the column itself.
  *
  * @example
  * ```ts
- * const value = column_getLeafColumns(column)
+ * const leafColumns = column_getLeafColumns(column)
  * ```
  */
 declare function column_getLeafColumns<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>): Array<Column<TFeatures, TData, TValue>>;
 /**
- * Returns default column def for the table.
+ * Merges built-in, feature, and user default column definitions.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Built-in defaults provide a header and fallback cell renderer, feature
+ * defaults can add feature-specific column options, and
+ * `options.defaultColumn` wins last.
  *
  * @example
  * ```ts
- * const value = table_getDefaultColumnDef(table)
+ * const defaultColumn = table_getDefaultColumnDef(table)
  * ```
  */
 declare function table_getDefaultColumnDef<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Partial<ColumnDef<TFeatures, TData, unknown>>;
 /**
- * Returns all columns for the table.
+ * Normalizes `options.columns` into the table's nested column tree.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Each column definition is constructed with its parent and depth, and group
+ * column children are recursively constructed.
  *
  * @example
  * ```ts
- * const value = table_getAllColumns(table)
+ * const columns = table_getAllColumns(table)
  * ```
  */
 declare function table_getAllColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Column<TFeatures, TData, unknown>>;
 /**
- * Returns all flat columns for the table.
+ * Flattens every table column, including group columns and leaf columns.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Use this when parent/group columns must be included in addition to data leaf
+ * columns.
  *
  * @example
  * ```ts
- * const value = table_getAllFlatColumns(table)
+ * const flatColumns = table_getAllFlatColumns(table)
  * ```
  */
 declare function table_getAllFlatColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Column<TFeatures, TData, unknown>>;
 /**
- * Returns all flat columns by id for the table.
+ * Builds an id lookup for every flat column in the table.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Group columns and leaf columns are included. Later columns with the same id
+ * replace earlier entries.
  *
  * @example
  * ```ts
- * const value = table_getAllFlatColumnsById(table)
+ * const columnsById = table_getAllFlatColumnsById(table)
  * ```
  */
 declare function table_getAllFlatColumnsById<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Record<string, Column<TFeatures, TData, unknown>>;
 /**
- * Returns all leaf columns for the table.
+ * Collects all terminal leaf columns in their current table order.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Column ordering features can reorder the collected leaves before the result
+ * is returned.
  *
  * @example
  * ```ts
- * const value = table_getAllLeafColumns(table)
+ * const leafColumns = table_getAllLeafColumns(table)
  * ```
  */
 declare function table_getAllLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Column<TFeatures, TData, unknown>>;
 /**
- * Returns all leaf columns by id for the table.
+ * Builds an id lookup for terminal leaf columns only.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Parent/group columns are excluded, making this lookup appropriate for row
+ * cells and feature state keyed by data columns.
  *
  * @example
  * ```ts
- * const value = table_getAllLeafColumnsById(table)
+ * const leavesById = table_getAllLeafColumnsById(table)
  * ```
  */
 declare function table_getAllLeafColumnsById<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Record<string, Column<TFeatures, TData, unknown>>;
 /**
- * Returns column for the table.
+ * Looks up a column by id from the flat column map.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * The lookup can return group columns or leaf columns. In development, a
+ * missing id logs a warning to help catch stale column references.
  *
  * @example
  * ```ts
- * const value = table_getColumn(table)
+ * const column = table_getColumn(table, 'firstName')
  * ```
  */
 declare function table_getColumn<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, columnId: string): Column<TFeatures, TData, unknown> | undefined;

package/dist/core/columns/coreColumnsFeature.utils.js

@@ -4,26 +4,28 @@ import { constructColumn } from "./constructColumn.js";
 
 //#region src/core/columns/coreColumnsFeature.utils.ts
 /**
-* Returns flat columns for a column.
+* Flattens this column and every descendant column into a single array.
 *
-* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+* Group columns appear before their child columns, which matches the normalized
+* column hierarchy produced during table construction.
 *
 * @example
 * ```ts
-* const value = column_getFlatColumns(column)
+* const flatColumns = column_getFlatColumns(column)
 * ```
 */
 function column_getFlatColumns(column) {
 	return [column, ...column.columns.flatMap((col) => col.getFlatColumns())];
 }
 /**
-* Returns leaf columns for a column.
+* Collects the terminal leaf columns below this column.
 *
-* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+* Group columns return their ordered descendants. Non-group columns return an
+* array containing only the column itself.
 *
 * @example
 * ```ts
-* const value = column_getLeafColumns(column)
+* const leafColumns = column_getLeafColumns(column)
 * ```
 */
 function column_getLeafColumns(column) {
@@ -34,13 +36,15 @@ function column_getLeafColumns(column) {
 	return [column];
 }
 /**
-* Returns default column def for the table.
+* Merges built-in, feature, and user default column definitions.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* Built-in defaults provide a header and fallback cell renderer, feature
+* defaults can add feature-specific column options, and
+* `options.defaultColumn` wins last.
 *
 * @example
 * ```ts
-* const value = table_getDefaultColumnDef(table)
+* const defaultColumn = table_getDefaultColumnDef(table)
 * ```
 */
 function table_getDefaultColumnDef(table) {
@@ -63,13 +67,14 @@ function table_getDefaultColumnDef(table) {
 	};
 }
 /**
-* Returns all columns for the table.
+* Normalizes `options.columns` into the table's nested column tree.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* Each column definition is constructed with its parent and depth, and group
+* column children are recursively constructed.
 *
 * @example
 * ```ts
-* const value = table_getAllColumns(table)
+* const columns = table_getAllColumns(table)
 * ```
 */
 function table_getAllColumns(table) {
@@ -84,26 +89,28 @@ function table_getAllColumns(table) {
 	return recurseColumns(table.options.columns);
 }
 /**
-* Returns all flat columns for the table.
+* Flattens every table column, including group columns and leaf columns.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* Use this when parent/group columns must be included in addition to data leaf
+* columns.
 *
 * @example
 * ```ts
-* const value = table_getAllFlatColumns(table)
+* const flatColumns = table_getAllFlatColumns(table)
 * ```
 */
 function table_getAllFlatColumns(table) {
 	return table.getAllColumns().flatMap((column) => column.getFlatColumns());
 }
 /**
-* Returns all flat columns by id for the table.
+* Builds an id lookup for every flat column in the table.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* Group columns and leaf columns are included. Later columns with the same id
+* replace earlier entries.
 *
 * @example
 * ```ts
-* const value = table_getAllFlatColumnsById(table)
+* const columnsById = table_getAllFlatColumnsById(table)
 * ```
 */
 function table_getAllFlatColumnsById(table) {
@@ -116,13 +123,14 @@ function table_getAllFlatColumnsById(table) {
 	return result;
 }
 /**
-* Returns all leaf columns for the table.
+* Collects all terminal leaf columns in their current table order.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* Column ordering features can reorder the collected leaves before the result
+* is returned.
 *
 * @example
 * ```ts
-* const value = table_getAllLeafColumns(table)
+* const leafColumns = table_getAllLeafColumns(table)
 * ```
 */
 function table_getAllLeafColumns(table) {
@@ -130,13 +138,14 @@ function table_getAllLeafColumns(table) {
 	return callMemoOrStaticFn(table, "getOrderColumns", table_getOrderColumnsFn)(leafColumns);
 }
 /**
-* Returns all leaf columns by id for the table.
+* Builds an id lookup for terminal leaf columns only.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* Parent/group columns are excluded, making this lookup appropriate for row
+* cells and feature state keyed by data columns.
 *
 * @example
 * ```ts
-* const value = table_getAllLeafColumnsById(table)
+* const leavesById = table_getAllLeafColumnsById(table)
 * ```
 */
 function table_getAllLeafColumnsById(table) {
@@ -149,13 +158,14 @@ function table_getAllLeafColumnsById(table) {
 	return result;
 }
 /**
-* Returns column for the table.
+* Looks up a column by id from the flat column map.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* The lookup can return group columns or leaf columns. In development, a
+* missing id logs a warning to help catch stale column references.
 *
 * @example
 * ```ts
-* const value = table_getColumn(table)
+* const column = table_getColumn(table, 'firstName')
 * ```
 */
 function table_getColumn(table, columnId) {

package/dist/core/columns/coreColumnsFeature.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"coreColumnsFeature.utils.js","names":[],"sources":["../../../src/core/columns/coreColumnsFeature.utils.ts"],"sourcesContent":["import { callMemoOrStaticFn } from '../../utils'\nimport { table_getOrderColumnsFn } from '../../features/column-ordering/columnOrderingFeature.utils'\nimport { constructColumn } from './constructColumn'\nimport type { Table_Internal } from '../../types/Table'\nimport type { CellData, RowData } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type {\n  ColumnDef,\n  ColumnDefResolved,\n  GroupColumnDef,\n} from '../../types/ColumnDef'\nimport type { Column } from '../../types/Column'\n\n/**\n * Returns flat columns for a column.\n *\n * This derives the value from the column definition, table options, and the feature state atoms registered on the table.\n *\n * @example\n * ```ts\n * const value = column_getFlatColumns(column)\n * ```\n */\nexport function column_getFlatColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(\n  column: Column<TFeatures, TData, TValue>,\n): Array<Column<TFeatures, TData, TValue>> {\n  return [column, ...column.columns.flatMap((col) => col.getFlatColumns())]\n}\n\n/**\n * Returns leaf columns for a column.\n *\n * This derives the value from the column definition, table options, and the feature state atoms registered on the table.\n *\n * @example\n * ```ts\n * const value = column_getLeafColumns(column)\n * ```\n */\nexport function column_getLeafColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(\n  column: Column<TFeatures, TData, TValue>,\n): Array<Column<TFeatures, TData, TValue>> {\n  if (column.columns.length) {\n    const leafColumns = column.columns.flatMap(\n      (col) => col.getLeafColumns(), // recursive\n    )\n\n    return callMemoOrStaticFn(\n      column.table,\n      'getOrderColumns',\n      table_getOrderColumnsFn,\n    )(leafColumns as any) as any\n  }\n\n  return [column]\n}\n\n/**\n * Returns default column def for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getDefaultColumnDef(table)\n * ```\n */\nexport function table_getDefaultColumnDef<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Partial<ColumnDef<TFeatures, TData, unknown>> {\n  return {\n    header: (props) => {\n      const resolvedColumnDef = props.header.column\n        .columnDef as ColumnDefResolved<{}, TData>\n\n      if (resolvedColumnDef.accessorKey) {\n        return resolvedColumnDef.accessorKey\n      }\n\n      if (resolvedColumnDef.accessorFn) {\n        return resolvedColumnDef.id\n      }\n\n      return null\n    },\n    cell: (props) => props.renderValue<any>()?.toString?.() ?? null,\n    ...Object.values(table._features).reduce((obj, feature) => {\n      return Object.assign(obj, feature.getDefaultColumnDef?.())\n    }, {}),\n    ...table.options.defaultColumn,\n  } as Partial<ColumnDef<TFeatures, TData, unknown>>\n}\n\n/**\n * Returns all columns for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getAllColumns(table)\n * ```\n */\nexport function table_getAllColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Array<Column<TFeatures, TData, unknown>> {\n  const recurseColumns = (\n    colDefs: ReadonlyArray<ColumnDef<TFeatures, TData, unknown>>,\n    parent?: Column<TFeatures, TData, unknown>,\n    depth = 0,\n  ): Array<Column<TFeatures, TData, unknown>> => {\n    return colDefs.map((columnDef) => {\n      const column = constructColumn(table, columnDef, depth, parent)\n\n      const groupingColumnDef = columnDef as GroupColumnDef<\n        TFeatures,\n        TData,\n        unknown\n      >\n\n      column.columns = groupingColumnDef.columns\n        ? recurseColumns(groupingColumnDef.columns, column, depth + 1)\n        : []\n\n      return column\n    })\n  }\n\n  return recurseColumns(table.options.columns)\n}\n\n/**\n * Returns all flat columns for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getAllFlatColumns(table)\n * ```\n */\nexport function table_getAllFlatColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Array<Column<TFeatures, TData, unknown>> {\n  return table.getAllColumns().flatMap((column) => column.getFlatColumns())\n}\n\n/**\n * Returns all flat columns by id for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getAllFlatColumnsById(table)\n * ```\n */\nexport function table_getAllFlatColumnsById<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Record<string, Column<TFeatures, TData, unknown>> {\n  const result: Record<string, Column<TFeatures, TData, unknown>> = {}\n  const flatColumns = table.getAllFlatColumns()\n  for (let i = 0; i < flatColumns.length; i++) {\n    const column = flatColumns[i]!\n    result[column.id] = column\n  }\n  return result\n}\n\n/**\n * Returns all leaf columns for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getAllLeafColumns(table)\n * ```\n */\nexport function table_getAllLeafColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Array<Column<TFeatures, TData, unknown>> {\n  const leafColumns = table.getAllColumns().flatMap(\n    (c) => c.getLeafColumns(), // recursive\n  )\n  return callMemoOrStaticFn(\n    table,\n    'getOrderColumns',\n    table_getOrderColumnsFn,\n  )(leafColumns)\n}\n\n/**\n * Returns all leaf columns by id for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getAllLeafColumnsById(table)\n * ```\n */\nexport function table_getAllLeafColumnsById<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Record<string, Column<TFeatures, TData, unknown>> {\n  const result: Record<string, Column<TFeatures, TData, unknown>> = {}\n  const leafColumns = table.getAllLeafColumns()\n  for (let i = 0; i < leafColumns.length; i++) {\n    const column = leafColumns[i]!\n    result[column.id] = column\n  }\n  return result\n}\n\n/**\n * Returns column for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getColumn(table)\n * ```\n */\nexport function table_getColumn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  columnId: string,\n): Column<TFeatures, TData, unknown> | undefined {\n  const column = table.getAllFlatColumnsById()[columnId]\n\n  if (process.env.NODE_ENV === 'development' && !column) {\n    console.warn(`[Table] Column with id '${columnId}' does not exist.`)\n  }\n\n  return column\n}\n"],"mappings":";;;;;;;;;;;;;;;AAuBA,SAAgB,sBAKd,QACyC;CACzC,OAAO,CAAC,QAAQ,GAAG,OAAO,QAAQ,SAAS,QAAQ,IAAI,gBAAgB,CAAC,CAAC;;;;;;;;;;;;AAa3E,SAAgB,sBAKd,QACyC;CACzC,IAAI,OAAO,QAAQ,QAAQ;EACzB,MAAM,cAAc,OAAO,QAAQ,SAChC,QAAQ,IAAI,gBAAgB,CAC9B;EAED,OAAO,mBACL,OAAO,OACP,mBACA,wBACD,CAAC,YAAmB;;CAGvB,OAAO,CAAC,OAAO;;;;;;;;;;;;AAajB,SAAgB,0BAId,OAC+C;CAC/C,OAAO;EACL,SAAS,UAAU;GACjB,MAAM,oBAAoB,MAAM,OAAO,OACpC;GAEH,IAAI,kBAAkB,aACpB,OAAO,kBAAkB;GAG3B,IAAI,kBAAkB,YACpB,OAAO,kBAAkB;GAG3B,OAAO;;EAET,OAAO,UAAU;;uCAAM,aAAkB,2FAAE,gHAAY,KAAI;;EAC3D,GAAG,OAAO,OAAO,MAAM,UAAU,CAAC,QAAQ,KAAK,YAAY;;GACzD,OAAO,OAAO,OAAO,8BAAK,QAAQ,gHAAuB,CAAC;KACzD,EAAE,CAAC;EACN,GAAG,MAAM,QAAQ;EAClB;;;;;;;;;;;;AAaH,SAAgB,oBAId,OAC0C;CAC1C,MAAM,kBACJ,SACA,QACA,QAAQ,MACqC;EAC7C,OAAO,QAAQ,KAAK,cAAc;GAChC,MAAM,SAAS,gBAAgB,OAAO,WAAW,OAAO,OAAO;GAE/D,MAAM,oBAAoB;GAM1B,OAAO,UAAU,kBAAkB,UAC/B,eAAe,kBAAkB,SAAS,QAAQ,QAAQ,EAAE,GAC5D,EAAE;GAEN,OAAO;IACP;;CAGJ,OAAO,eAAe,MAAM,QAAQ,QAAQ;;;;;;;;;;;;AAa9C,SAAgB,wBAId,OAC0C;CAC1C,OAAO,MAAM,eAAe,CAAC,SAAS,WAAW,OAAO,gBAAgB,CAAC;;;;;;;;;;;;AAa3E,SAAgB,4BAId,OACmD;CACnD,MAAM,SAA4D,EAAE;CACpE,MAAM,cAAc,MAAM,mBAAmB;CAC7C,KAAK,IAAI,IAAI,GAAG,IAAI,YAAY,QAAQ,KAAK;EAC3C,MAAM,SAAS,YAAY;EAC3B,OAAO,OAAO,MAAM;;CAEtB,OAAO;;;;;;;;;;;;AAaT,SAAgB,wBAId,OAC0C;CAC1C,MAAM,cAAc,MAAM,eAAe,CAAC,SACvC,MAAM,EAAE,gBAAgB,CAC1B;CACD,OAAO,mBACL,OACA,mBACA,wBACD,CAAC,YAAY;;;;;;;;;;;;AAahB,SAAgB,4BAId,OACmD;CACnD,MAAM,SAA4D,EAAE;CACpE,MAAM,cAAc,MAAM,mBAAmB;CAC7C,KAAK,IAAI,IAAI,GAAG,IAAI,YAAY,QAAQ,KAAK;EAC3C,MAAM,SAAS,YAAY;EAC3B,OAAO,OAAO,MAAM;;CAEtB,OAAO;;;;;;;;;;;;AAaT,SAAgB,gBAId,OACA,UAC+C;CAC/C,MAAM,SAAS,MAAM,uBAAuB,CAAC;CAE7C,IAAI,QAAQ,IAAI,aAAa,iBAAiB,CAAC,QAC7C,QAAQ,KAAK,2BAA2B,SAAS,mBAAmB;CAGtE,OAAO"}
+{"version":3,"file":"coreColumnsFeature.utils.js","names":[],"sources":["../../../src/core/columns/coreColumnsFeature.utils.ts"],"sourcesContent":["import { callMemoOrStaticFn } from '../../utils'\nimport { table_getOrderColumnsFn } from '../../features/column-ordering/columnOrderingFeature.utils'\nimport { constructColumn } from './constructColumn'\nimport type { Table_Internal } from '../../types/Table'\nimport type { CellData, RowData } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type {\n  ColumnDef,\n  ColumnDefResolved,\n  GroupColumnDef,\n} from '../../types/ColumnDef'\nimport type { Column } from '../../types/Column'\n\n/**\n * Flattens this column and every descendant column into a single array.\n *\n * Group columns appear before their child columns, which matches the normalized\n * column hierarchy produced during table construction.\n *\n * @example\n * ```ts\n * const flatColumns = column_getFlatColumns(column)\n * ```\n */\nexport function column_getFlatColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(\n  column: Column<TFeatures, TData, TValue>,\n): Array<Column<TFeatures, TData, TValue>> {\n  return [column, ...column.columns.flatMap((col) => col.getFlatColumns())]\n}\n\n/**\n * Collects the terminal leaf columns below this column.\n *\n * Group columns return their ordered descendants. Non-group columns return an\n * array containing only the column itself.\n *\n * @example\n * ```ts\n * const leafColumns = column_getLeafColumns(column)\n * ```\n */\nexport function column_getLeafColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(\n  column: Column<TFeatures, TData, TValue>,\n): Array<Column<TFeatures, TData, TValue>> {\n  if (column.columns.length) {\n    const leafColumns = column.columns.flatMap(\n      (col) => col.getLeafColumns(), // recursive\n    )\n\n    return callMemoOrStaticFn(\n      column.table,\n      'getOrderColumns',\n      table_getOrderColumnsFn,\n    )(leafColumns as any) as any\n  }\n\n  return [column]\n}\n\n/**\n * Merges built-in, feature, and user default column definitions.\n *\n * Built-in defaults provide a header and fallback cell renderer, feature\n * defaults can add feature-specific column options, and\n * `options.defaultColumn` wins last.\n *\n * @example\n * ```ts\n * const defaultColumn = table_getDefaultColumnDef(table)\n * ```\n */\nexport function table_getDefaultColumnDef<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Partial<ColumnDef<TFeatures, TData, unknown>> {\n  return {\n    header: (props) => {\n      const resolvedColumnDef = props.header.column\n        .columnDef as ColumnDefResolved<{}, TData>\n\n      if (resolvedColumnDef.accessorKey) {\n        return resolvedColumnDef.accessorKey\n      }\n\n      if (resolvedColumnDef.accessorFn) {\n        return resolvedColumnDef.id\n      }\n\n      return null\n    },\n    cell: (props) => props.renderValue<any>()?.toString?.() ?? null,\n    ...Object.values(table._features).reduce((obj, feature) => {\n      return Object.assign(obj, feature.getDefaultColumnDef?.())\n    }, {}),\n    ...table.options.defaultColumn,\n  } as Partial<ColumnDef<TFeatures, TData, unknown>>\n}\n\n/**\n * Normalizes `options.columns` into the table's nested column tree.\n *\n * Each column definition is constructed with its parent and depth, and group\n * column children are recursively constructed.\n *\n * @example\n * ```ts\n * const columns = table_getAllColumns(table)\n * ```\n */\nexport function table_getAllColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Array<Column<TFeatures, TData, unknown>> {\n  const recurseColumns = (\n    colDefs: ReadonlyArray<ColumnDef<TFeatures, TData, unknown>>,\n    parent?: Column<TFeatures, TData, unknown>,\n    depth = 0,\n  ): Array<Column<TFeatures, TData, unknown>> => {\n    return colDefs.map((columnDef) => {\n      const column = constructColumn(table, columnDef, depth, parent)\n\n      const groupingColumnDef = columnDef as GroupColumnDef<\n        TFeatures,\n        TData,\n        unknown\n      >\n\n      column.columns = groupingColumnDef.columns\n        ? recurseColumns(groupingColumnDef.columns, column, depth + 1)\n        : []\n\n      return column\n    })\n  }\n\n  return recurseColumns(table.options.columns)\n}\n\n/**\n * Flattens every table column, including group columns and leaf columns.\n *\n * Use this when parent/group columns must be included in addition to data leaf\n * columns.\n *\n * @example\n * ```ts\n * const flatColumns = table_getAllFlatColumns(table)\n * ```\n */\nexport function table_getAllFlatColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Array<Column<TFeatures, TData, unknown>> {\n  return table.getAllColumns().flatMap((column) => column.getFlatColumns())\n}\n\n/**\n * Builds an id lookup for every flat column in the table.\n *\n * Group columns and leaf columns are included. Later columns with the same id\n * replace earlier entries.\n *\n * @example\n * ```ts\n * const columnsById = table_getAllFlatColumnsById(table)\n * ```\n */\nexport function table_getAllFlatColumnsById<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Record<string, Column<TFeatures, TData, unknown>> {\n  const result: Record<string, Column<TFeatures, TData, unknown>> = {}\n  const flatColumns = table.getAllFlatColumns()\n  for (let i = 0; i < flatColumns.length; i++) {\n    const column = flatColumns[i]!\n    result[column.id] = column\n  }\n  return result\n}\n\n/**\n * Collects all terminal leaf columns in their current table order.\n *\n * Column ordering features can reorder the collected leaves before the result\n * is returned.\n *\n * @example\n * ```ts\n * const leafColumns = table_getAllLeafColumns(table)\n * ```\n */\nexport function table_getAllLeafColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Array<Column<TFeatures, TData, unknown>> {\n  const leafColumns = table.getAllColumns().flatMap(\n    (c) => c.getLeafColumns(), // recursive\n  )\n  return callMemoOrStaticFn(\n    table,\n    'getOrderColumns',\n    table_getOrderColumnsFn,\n  )(leafColumns)\n}\n\n/**\n * Builds an id lookup for terminal leaf columns only.\n *\n * Parent/group columns are excluded, making this lookup appropriate for row\n * cells and feature state keyed by data columns.\n *\n * @example\n * ```ts\n * const leavesById = table_getAllLeafColumnsById(table)\n * ```\n */\nexport function table_getAllLeafColumnsById<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): Record<string, Column<TFeatures, TData, unknown>> {\n  const result: Record<string, Column<TFeatures, TData, unknown>> = {}\n  const leafColumns = table.getAllLeafColumns()\n  for (let i = 0; i < leafColumns.length; i++) {\n    const column = leafColumns[i]!\n    result[column.id] = column\n  }\n  return result\n}\n\n/**\n * Looks up a column by id from the flat column map.\n *\n * The lookup can return group columns or leaf columns. In development, a\n * missing id logs a warning to help catch stale column references.\n *\n * @example\n * ```ts\n * const column = table_getColumn(table, 'firstName')\n * ```\n */\nexport function table_getColumn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  columnId: string,\n): Column<TFeatures, TData, unknown> | undefined {\n  const column = table.getAllFlatColumnsById()[columnId]\n\n  if (process.env.NODE_ENV === 'development' && !column) {\n    console.warn(`[Table] Column with id '${columnId}' does not exist.`)\n  }\n\n  return column\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAwBA,SAAgB,sBAKd,QACyC;CACzC,OAAO,CAAC,QAAQ,GAAG,OAAO,QAAQ,SAAS,QAAQ,IAAI,gBAAgB,CAAC,CAAC;;;;;;;;;;;;;AAc3E,SAAgB,sBAKd,QACyC;CACzC,IAAI,OAAO,QAAQ,QAAQ;EACzB,MAAM,cAAc,OAAO,QAAQ,SAChC,QAAQ,IAAI,gBAAgB,CAC9B;EAED,OAAO,mBACL,OAAO,OACP,mBACA,wBACD,CAAC,YAAmB;;CAGvB,OAAO,CAAC,OAAO;;;;;;;;;;;;;;AAejB,SAAgB,0BAId,OAC+C;CAC/C,OAAO;EACL,SAAS,UAAU;GACjB,MAAM,oBAAoB,MAAM,OAAO,OACpC;GAEH,IAAI,kBAAkB,aACpB,OAAO,kBAAkB;GAG3B,IAAI,kBAAkB,YACpB,OAAO,kBAAkB;GAG3B,OAAO;;EAET,OAAO,UAAU;;uCAAM,aAAkB,2FAAE,gHAAY,KAAI;;EAC3D,GAAG,OAAO,OAAO,MAAM,UAAU,CAAC,QAAQ,KAAK,YAAY;;GACzD,OAAO,OAAO,OAAO,8BAAK,QAAQ,gHAAuB,CAAC;KACzD,EAAE,CAAC;EACN,GAAG,MAAM,QAAQ;EAClB;;;;;;;;;;;;;AAcH,SAAgB,oBAId,OAC0C;CAC1C,MAAM,kBACJ,SACA,QACA,QAAQ,MACqC;EAC7C,OAAO,QAAQ,KAAK,cAAc;GAChC,MAAM,SAAS,gBAAgB,OAAO,WAAW,OAAO,OAAO;GAE/D,MAAM,oBAAoB;GAM1B,OAAO,UAAU,kBAAkB,UAC/B,eAAe,kBAAkB,SAAS,QAAQ,QAAQ,EAAE,GAC5D,EAAE;GAEN,OAAO;IACP;;CAGJ,OAAO,eAAe,MAAM,QAAQ,QAAQ;;;;;;;;;;;;;AAc9C,SAAgB,wBAId,OAC0C;CAC1C,OAAO,MAAM,eAAe,CAAC,SAAS,WAAW,OAAO,gBAAgB,CAAC;;;;;;;;;;;;;AAc3E,SAAgB,4BAId,OACmD;CACnD,MAAM,SAA4D,EAAE;CACpE,MAAM,cAAc,MAAM,mBAAmB;CAC7C,KAAK,IAAI,IAAI,GAAG,IAAI,YAAY,QAAQ,KAAK;EAC3C,MAAM,SAAS,YAAY;EAC3B,OAAO,OAAO,MAAM;;CAEtB,OAAO;;;;;;;;;;;;;AAcT,SAAgB,wBAId,OAC0C;CAC1C,MAAM,cAAc,MAAM,eAAe,CAAC,SACvC,MAAM,EAAE,gBAAgB,CAC1B;CACD,OAAO,mBACL,OACA,mBACA,wBACD,CAAC,YAAY;;;;;;;;;;;;;AAchB,SAAgB,4BAId,OACmD;CACnD,MAAM,SAA4D,EAAE;CACpE,MAAM,cAAc,MAAM,mBAAmB;CAC7C,KAAK,IAAI,IAAI,GAAG,IAAI,YAAY,QAAQ,KAAK;EAC3C,MAAM,SAAS,YAAY;EAC3B,OAAO,OAAO,MAAM;;CAEtB,OAAO;;;;;;;;;;;;;AAcT,SAAgB,gBAId,OACA,UAC+C;CAC/C,MAAM,SAAS,MAAM,uBAAuB,CAAC;CAE7C,IAAI,QAAQ,IAAI,aAAa,iBAAiB,CAAC,QAC7C,QAAQ,KAAK,2BAA2B,SAAS,mBAAmB;CAGtE,OAAO"}

package/dist/core/headers/coreHeadersFeature.types.d.cts

@@ -8,19 +8,21 @@ import { Table } from "../../types/Table.cjs";
 //#region src/core/headers/coreHeadersFeature.types.d.ts
 interface Table_Headers<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Returns all header groups for the table.
+   * Builds the visible header groups for the current column tree, visibility,
+   * and pinning state.
    */
   getHeaderGroups: () => Array<HeaderGroup<TFeatures, TData>>;
   /**
-   * Returns the footer groups for the table.
+   * Builds footer groups by reversing the current header group order.
    */
   getFooterGroups: () => Array<HeaderGroup<TFeatures, TData>>;
   /**
-   * Returns headers for all columns in the table, including parent headers.
+   * Flattens every header from every header group, including parent and
+   * placeholder headers.
    */
   getFlatHeaders: () => Array<Header<TFeatures, TData, unknown>>;
   /**
-   * Returns headers for all leaf columns in the table, (not including parent headers).
+   * Collects only leaf headers, excluding parent/group headers.
    */
   getLeafHeaders: () => Array<Header<TFeatures, TData, unknown>>;
 }

package/dist/core/headers/coreHeadersFeature.types.d.ts

@@ -8,19 +8,21 @@ import { Table } from "../../types/Table.js";
 //#region src/core/headers/coreHeadersFeature.types.d.ts
 interface Table_Headers<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Returns all header groups for the table.
+   * Builds the visible header groups for the current column tree, visibility,
+   * and pinning state.
    */
   getHeaderGroups: () => Array<HeaderGroup<TFeatures, TData>>;
   /**
-   * Returns the footer groups for the table.
+   * Builds footer groups by reversing the current header group order.
    */
   getFooterGroups: () => Array<HeaderGroup<TFeatures, TData>>;
   /**
-   * Returns headers for all columns in the table, including parent headers.
+   * Flattens every header from every header group, including parent and
+   * placeholder headers.
    */
   getFlatHeaders: () => Array<Header<TFeatures, TData, unknown>>;
   /**
-   * Returns headers for all leaf columns in the table, (not including parent headers).
+   * Collects only leaf headers, excluding parent/group headers.
    */
   getLeafHeaders: () => Array<Header<TFeatures, TData, unknown>>;
 }