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

package/dist/features/column-grouping/columnGroupingFeature.utils.js

@@ -2,26 +2,86 @@ import { cloneState, isFunction } from "../../utils.js";
 import { table_getColumn } from "../../core/columns/coreColumnsFeature.utils.js";
 
 //#region src/features/column-grouping/columnGroupingFeature.utils.ts
+/**
+* Returns the default grouping state.
+*
+* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+*
+* @example
+* ```ts
+* const initialValue = getDefaultGroupingState()
+* ```
+*/
 function getDefaultGroupingState() {
 	return [];
 }
+/**
+* Toggles grouping for a column.
+*
+* The update is applied through the owning table state slice and respects the feature options for that column.
+*
+* @example
+* ```ts
+* column_toggleGrouping(column)
+* ```
+*/
 function column_toggleGrouping(column) {
 	table_setGrouping(column.table, (old) => {
 		if (old.includes(column.id)) return old.filter((d) => d !== column.id);
 		return [...old, column.id];
 	});
 }
+/**
+* Returns whether a column can use group.
+*
+* This combines column options, table options, and any required accessor or feature state for the capability.
+*
+* @example
+* ```ts
+* const value = column_getCanGroup(column)
+* ```
+*/
 function column_getCanGroup(column) {
 	return (column.columnDef.enableGrouping ?? true) && (column.table.options.enableGrouping ?? true) && (!!column.accessorFn || !!column.columnDef.getGroupingValue);
 }
+/**
+* Returns is grouped 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_getIsGrouped(column)
+* ```
+*/
 function column_getIsGrouped(column) {
 	var _column$table$atoms$g;
 	return !!((_column$table$atoms$g = column.table.atoms.grouping) === null || _column$table$atoms$g === void 0 || (_column$table$atoms$g = _column$table$atoms$g.get()) === null || _column$table$atoms$g === void 0 ? void 0 : _column$table$atoms$g.includes(column.id));
 }
+/**
+* Returns grouped index 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_getGroupedIndex(column)
+* ```
+*/
 function column_getGroupedIndex(column) {
 	var _column$table$atoms$g2;
 	return ((_column$table$atoms$g2 = column.table.atoms.grouping) === null || _column$table$atoms$g2 === void 0 || (_column$table$atoms$g2 = _column$table$atoms$g2.get()) === null || _column$table$atoms$g2 === void 0 ? void 0 : _column$table$atoms$g2.indexOf(column.id)) ?? -1;
 }
+/**
+* Returns an event handler for toggling grouping handler.
+*
+* The handler is intended for direct use in column header controls such as buttons or checkboxes.
+*
+* @example
+* ```ts
+* const value = column_getToggleGroupingHandler(column)
+* ```
+*/
 function column_getToggleGroupingHandler(column) {
 	const canGroup = column_getCanGroup(column);
 	return () => {
@@ -29,6 +89,16 @@ function column_getToggleGroupingHandler(column) {
 		column_toggleGrouping(column);
 	};
 }
+/**
+* Infers aggregation fn for a column.
+*
+* The inference uses the column definition, table options, and sampled row values when needed.
+*
+* @example
+* ```ts
+* const value = column_getAutoAggregationFn(column)
+* ```
+*/
 function column_getAutoAggregationFn(column) {
 	const aggregationFns = column.table._rowModelFns.aggregationFns;
 	const firstRow = column.table.getCoreRowModel().flatRows[0];
@@ -36,20 +106,71 @@ function column_getAutoAggregationFn(column) {
 	if (typeof value === "number") return aggregationFns === null || aggregationFns === void 0 ? void 0 : aggregationFns.sum;
 	if (Object.prototype.toString.call(value) === "[object Date]") return aggregationFns === null || aggregationFns === void 0 ? void 0 : aggregationFns.extent;
 }
+/**
+* Returns aggregation fn 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_getAggregationFn(column)
+* ```
+*/
 function column_getAggregationFn(column) {
 	const aggregationFns = column.table._rowModelFns.aggregationFns;
 	return isFunction(column.columnDef.aggregationFn) ? column.columnDef.aggregationFn : column.columnDef.aggregationFn === "auto" ? column_getAutoAggregationFn(column) : aggregationFns === null || aggregationFns === void 0 ? void 0 : aggregationFns[column.columnDef.aggregationFn];
 }
+/**
+* Updates the table's grouping state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setGrouping(table, (old) => old)
+* ```
+*/
 function table_setGrouping(table, updater) {
 	var _table$options$onGrou, _table$options;
 	(_table$options$onGrou = (_table$options = table.options).onGroupingChange) === null || _table$options$onGrou === void 0 || _table$options$onGrou.call(_table$options, updater);
 }
+/**
+* Resets the table's grouping state slice.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @example
+* ```ts
+* table_resetGrouping(table)
+* table_resetGrouping(table, true)
+* ```
+*/
 function table_resetGrouping(table, defaultState) {
 	table_setGrouping(table, defaultState ? [] : cloneState(table.initialState.grouping ?? []));
 }
+/**
+* Returns is grouped for a row.
+*
+* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+*
+* @example
+* ```ts
+* const value = row_getIsGrouped(row)
+* ```
+*/
 function row_getIsGrouped(row) {
 	return !!row.groupingColumnId;
 }
+/**
+* Returns grouping value for a row.
+*
+* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+*
+* @example
+* ```ts
+* const value = row_getGroupingValue(row)
+* ```
+*/
 function row_getGroupingValue(row, columnId) {
 	var _row$_groupingValuesC, _row$_groupingValuesC2;
 	if ((_row$_groupingValuesC = row._groupingValuesCache) === null || _row$_groupingValuesC === void 0 ? void 0 : _row$_groupingValuesC.hasOwnProperty(columnId)) return row._groupingValuesCache[columnId];
@@ -58,13 +179,43 @@ function row_getGroupingValue(row, columnId) {
 	if (row._groupingValuesCache) row._groupingValuesCache[columnId] = column.columnDef.getGroupingValue(row.original);
 	return (_row$_groupingValuesC2 = row._groupingValuesCache) === null || _row$_groupingValuesC2 === void 0 ? void 0 : _row$_groupingValuesC2[columnId];
 }
+/**
+* Returns is grouped for a cell.
+*
+* This is the static implementation behind the matching cell instance API and uses the owning row and column context.
+*
+* @example
+* ```ts
+* const value = cell_getIsGrouped(cell)
+* ```
+*/
 function cell_getIsGrouped(cell) {
 	const row = cell.row;
 	return column_getIsGrouped(cell.column) && cell.column.id === row.groupingColumnId;
 }
+/**
+* Returns is placeholder for a cell.
+*
+* This is the static implementation behind the matching cell instance API and uses the owning row and column context.
+*
+* @example
+* ```ts
+* const value = cell_getIsPlaceholder(cell)
+* ```
+*/
 function cell_getIsPlaceholder(cell) {
 	return !cell_getIsGrouped(cell) && column_getIsGrouped(cell.column);
 }
+/**
+* Returns is aggregated for a cell.
+*
+* This is the static implementation behind the matching cell instance API and uses the owning row and column context.
+*
+* @example
+* ```ts
+* const value = cell_getIsAggregated(cell)
+* ```
+*/
 function cell_getIsAggregated(cell) {
 	return !cell_getIsGrouped(cell) && !cell_getIsPlaceholder(cell) && !!cell.row.subRows.length;
 }

package/dist/features/column-grouping/columnGroupingFeature.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"columnGroupingFeature.utils.js","names":[],"sources":["../../../src/features/column-grouping/columnGroupingFeature.utils.ts"],"sourcesContent":["import { cloneState, isFunction } from '../../utils'\nimport { table_getColumn } from '../../core/columns/coreColumnsFeature.utils'\nimport type { Column_Internal } from '../../types/Column'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type { Cell } from '../../types/Cell'\nimport type {\n  AggregationFn,\n  GroupingState,\n  Row_ColumnGrouping,\n} from './columnGroupingFeature.types'\n\nexport function getDefaultGroupingState(): GroupingState {\n  return []\n}\n\nexport function column_toggleGrouping<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  table_setGrouping(column.table, (old) => {\n    // Find any existing grouping for this column\n    if (old.includes(column.id)) {\n      return old.filter((d) => d !== column.id)\n    }\n\n    return [...old, column.id]\n  })\n}\n\nexport function column_getCanGroup<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (\n    (column.columnDef.enableGrouping ?? true) &&\n    (column.table.options.enableGrouping ?? true) &&\n    (!!column.accessorFn || !!column.columnDef.getGroupingValue)\n  )\n}\n\nexport function column_getIsGrouped<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  return !!column.table.atoms.grouping?.get()?.includes(column.id)\n}\n\nexport function column_getGroupedIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): number {\n  return column.table.atoms.grouping?.get()?.indexOf(column.id) ?? -1\n}\n\nexport function column_getToggleGroupingHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const canGroup = column_getCanGroup(column)\n\n  return () => {\n    if (!canGroup) return\n    column_toggleGrouping(column)\n  }\n}\n\nexport function column_getAutoAggregationFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const aggregationFns:\n    | Record<string, AggregationFn<TFeatures, TData>>\n    | undefined = column.table._rowModelFns.aggregationFns\n\n  const firstRow = column.table.getCoreRowModel().flatRows[0]\n\n  const value = firstRow?.getValue(column.id)\n\n  if (typeof value === 'number') {\n    return aggregationFns?.sum\n  }\n\n  if (Object.prototype.toString.call(value) === '[object Date]') {\n    return aggregationFns?.extent\n  }\n}\n\nexport function column_getAggregationFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const aggregationFns:\n    | Record<string, AggregationFn<TFeatures, TData>>\n    | undefined = column.table._rowModelFns.aggregationFns\n\n  return isFunction(column.columnDef.aggregationFn)\n    ? column.columnDef.aggregationFn\n    : column.columnDef.aggregationFn === 'auto'\n      ? column_getAutoAggregationFn(column)\n      : aggregationFns?.[column.columnDef.aggregationFn as string]\n}\n\nexport function table_setGrouping<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<GroupingState>) {\n  table.options.onGroupingChange?.(updater)\n}\n\nexport function table_resetGrouping<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setGrouping(\n    table,\n    defaultState ? [] : cloneState(table.initialState.grouping ?? []),\n  )\n}\n\nexport function row_getIsGrouped<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData> & Partial<Row_ColumnGrouping>) {\n  return !!row.groupingColumnId\n}\n\nexport function row_getGroupingValue<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData> & Partial<Row_ColumnGrouping>, columnId: string) {\n  if (row._groupingValuesCache?.hasOwnProperty(columnId)) {\n    return row._groupingValuesCache[columnId]\n  }\n\n  const column = table_getColumn(row.table, columnId) as Column_Internal<\n    TFeatures,\n    TData\n  >\n\n  if (!column.columnDef.getGroupingValue) {\n    return row.getValue(columnId)\n  }\n\n  if (row._groupingValuesCache) {\n    row._groupingValuesCache[columnId] = column.columnDef.getGroupingValue(\n      row.original,\n    )\n  }\n\n  return row._groupingValuesCache?.[columnId]\n}\n\nexport function cell_getIsGrouped<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(cell: Cell<TFeatures, TData, TValue>) {\n  const row = cell.row as Row<TFeatures, TData> & Partial<Row_ColumnGrouping>\n  return (\n    column_getIsGrouped(cell.column) && cell.column.id === row.groupingColumnId\n  )\n}\n\nexport function cell_getIsPlaceholder<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(cell: Cell<TFeatures, TData, TValue>) {\n  return !cell_getIsGrouped(cell) && column_getIsGrouped(cell.column)\n}\n\nexport function cell_getIsAggregated<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(cell: Cell<TFeatures, TData, TValue>) {\n  return (\n    !cell_getIsGrouped(cell) &&\n    !cell_getIsPlaceholder(cell) &&\n    !!cell.row.subRows.length\n  )\n}\n"],"mappings":";;;;AAcA,SAAgB,0BAAyC;AACvD,QAAO,EAAE;;AAGX,SAAgB,sBAId,QAAmD;AACnD,mBAAkB,OAAO,QAAQ,QAAQ;AAEvC,MAAI,IAAI,SAAS,OAAO,GAAG,CACzB,QAAO,IAAI,QAAQ,MAAM,MAAM,OAAO,GAAG;AAG3C,SAAO,CAAC,GAAG,KAAK,OAAO,GAAG;GAC1B;;AAGJ,SAAgB,mBAId,QAAmD;AACnD,SACG,OAAO,UAAU,kBAAkB,UACnC,OAAO,MAAM,QAAQ,kBAAkB,UACvC,CAAC,CAAC,OAAO,cAAc,CAAC,CAAC,OAAO,UAAU;;AAI/C,SAAgB,oBAId,QAA4D;;AAC5D,QAAO,CAAC,2BAAC,OAAO,MAAM,MAAM,yGAAU,KAAK,gFAAE,SAAS,OAAO,GAAG;;AAGlE,SAAgB,uBAId,QAA2D;;AAC3D,mCAAO,OAAO,MAAM,MAAM,4GAAU,KAAK,kFAAE,QAAQ,OAAO,GAAG,KAAI;;AAGnE,SAAgB,gCAId,QAAmD;CACnD,MAAM,WAAW,mBAAmB,OAAO;AAE3C,cAAa;AACX,MAAI,CAAC,SAAU;AACf,wBAAsB,OAAO;;;AAIjC,SAAgB,4BAId,QAAmD;CACnD,MAAM,iBAEU,OAAO,MAAM,aAAa;CAE1C,MAAM,WAAW,OAAO,MAAM,iBAAiB,CAAC,SAAS;CAEzD,MAAM,4DAAQ,SAAU,SAAS,OAAO,GAAG;AAE3C,KAAI,OAAO,UAAU,SACnB,wEAAO,eAAgB;AAGzB,KAAI,OAAO,UAAU,SAAS,KAAK,MAAM,KAAK,gBAC5C,wEAAO,eAAgB;;AAI3B,SAAgB,wBAId,QAAmD;CACnD,MAAM,iBAEU,OAAO,MAAM,aAAa;AAE1C,QAAO,WAAW,OAAO,UAAU,cAAc,GAC7C,OAAO,UAAU,gBACjB,OAAO,UAAU,kBAAkB,SACjC,4BAA4B,OAAO,mEACnC,eAAiB,OAAO,UAAU;;AAG1C,SAAgB,kBAGd,OAAyC,SAAiC;;AAC1E,kDAAM,SAAQ,6GAAmB,QAAQ;;AAG3C,SAAgB,oBAGd,OAAyC,cAAwB;AACjE,mBACE,OACA,eAAe,EAAE,GAAG,WAAW,MAAM,aAAa,YAAY,EAAE,CAAC,CAClE;;AAGH,SAAgB,iBAGd,KAA0D;AAC1D,QAAO,CAAC,CAAC,IAAI;;AAGf,SAAgB,qBAGd,KAA0D,UAAkB;;AAC5E,8BAAI,IAAI,oGAAsB,eAAe,SAAS,CACpD,QAAO,IAAI,qBAAqB;CAGlC,MAAM,SAAS,gBAAgB,IAAI,OAAO,SAAS;AAKnD,KAAI,CAAC,OAAO,UAAU,iBACpB,QAAO,IAAI,SAAS,SAAS;AAG/B,KAAI,IAAI,qBACN,KAAI,qBAAqB,YAAY,OAAO,UAAU,iBACpD,IAAI,SACL;AAGH,kCAAO,IAAI,sGAAuB;;AAGpC,SAAgB,kBAId,MAAsC;CACtC,MAAM,MAAM,KAAK;AACjB,QACE,oBAAoB,KAAK,OAAO,IAAI,KAAK,OAAO,OAAO,IAAI;;AAI/D,SAAgB,sBAId,MAAsC;AACtC,QAAO,CAAC,kBAAkB,KAAK,IAAI,oBAAoB,KAAK,OAAO;;AAGrE,SAAgB,qBAId,MAAsC;AACtC,QACE,CAAC,kBAAkB,KAAK,IACxB,CAAC,sBAAsB,KAAK,IAC5B,CAAC,CAAC,KAAK,IAAI,QAAQ"}
+{"version":3,"file":"columnGroupingFeature.utils.js","names":[],"sources":["../../../src/features/column-grouping/columnGroupingFeature.utils.ts"],"sourcesContent":["import { cloneState, isFunction } from '../../utils'\nimport { table_getColumn } from '../../core/columns/coreColumnsFeature.utils'\nimport type { Column_Internal } from '../../types/Column'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type { Cell } from '../../types/Cell'\nimport type {\n  AggregationFn,\n  GroupingState,\n  Row_ColumnGrouping,\n} from './columnGroupingFeature.types'\n\n/**\n * Returns the default grouping state.\n *\n * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.\n *\n * @example\n * ```ts\n * const initialValue = getDefaultGroupingState()\n * ```\n */\nexport function getDefaultGroupingState(): GroupingState {\n  return []\n}\n\n/**\n * Toggles grouping for a column.\n *\n * The update is applied through the owning table state slice and respects the feature options for that column.\n *\n * @example\n * ```ts\n * column_toggleGrouping(column)\n * ```\n */\nexport function column_toggleGrouping<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  table_setGrouping(column.table, (old) => {\n    // Find any existing grouping for this column\n    if (old.includes(column.id)) {\n      return old.filter((d) => d !== column.id)\n    }\n\n    return [...old, column.id]\n  })\n}\n\n/**\n * Returns whether a column can use group.\n *\n * This combines column options, table options, and any required accessor or feature state for the capability.\n *\n * @example\n * ```ts\n * const value = column_getCanGroup(column)\n * ```\n */\nexport function column_getCanGroup<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (\n    (column.columnDef.enableGrouping ?? true) &&\n    (column.table.options.enableGrouping ?? true) &&\n    (!!column.accessorFn || !!column.columnDef.getGroupingValue)\n  )\n}\n\n/**\n * Returns is grouped 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_getIsGrouped(column)\n * ```\n */\nexport function column_getIsGrouped<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  return !!column.table.atoms.grouping?.get()?.includes(column.id)\n}\n\n/**\n * Returns grouped index 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_getGroupedIndex(column)\n * ```\n */\nexport function column_getGroupedIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): number {\n  return column.table.atoms.grouping?.get()?.indexOf(column.id) ?? -1\n}\n\n/**\n * Returns an event handler for toggling grouping handler.\n *\n * The handler is intended for direct use in column header controls such as buttons or checkboxes.\n *\n * @example\n * ```ts\n * const value = column_getToggleGroupingHandler(column)\n * ```\n */\nexport function column_getToggleGroupingHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const canGroup = column_getCanGroup(column)\n\n  return () => {\n    if (!canGroup) return\n    column_toggleGrouping(column)\n  }\n}\n\n/**\n * Infers aggregation fn for a column.\n *\n * The inference uses the column definition, table options, and sampled row values when needed.\n *\n * @example\n * ```ts\n * const value = column_getAutoAggregationFn(column)\n * ```\n */\nexport function column_getAutoAggregationFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const aggregationFns:\n    | Record<string, AggregationFn<TFeatures, TData>>\n    | undefined = column.table._rowModelFns.aggregationFns\n\n  const firstRow = column.table.getCoreRowModel().flatRows[0]\n\n  const value = firstRow?.getValue(column.id)\n\n  if (typeof value === 'number') {\n    return aggregationFns?.sum\n  }\n\n  if (Object.prototype.toString.call(value) === '[object Date]') {\n    return aggregationFns?.extent\n  }\n}\n\n/**\n * Returns aggregation fn 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_getAggregationFn(column)\n * ```\n */\nexport function column_getAggregationFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const aggregationFns:\n    | Record<string, AggregationFn<TFeatures, TData>>\n    | undefined = column.table._rowModelFns.aggregationFns\n\n  return isFunction(column.columnDef.aggregationFn)\n    ? column.columnDef.aggregationFn\n    : column.columnDef.aggregationFn === 'auto'\n      ? column_getAutoAggregationFn(column)\n      : aggregationFns?.[column.columnDef.aggregationFn as string]\n}\n\n/**\n * Updates the table's grouping state slice.\n *\n * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.\n *\n * @example\n * ```ts\n * table_setGrouping(table, (old) => old)\n * ```\n */\nexport function table_setGrouping<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<GroupingState>) {\n  table.options.onGroupingChange?.(updater)\n}\n\n/**\n * Resets the table's grouping state slice.\n *\n * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.\n *\n * @example\n * ```ts\n * table_resetGrouping(table)\n * table_resetGrouping(table, true)\n * ```\n */\nexport function table_resetGrouping<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setGrouping(\n    table,\n    defaultState ? [] : cloneState(table.initialState.grouping ?? []),\n  )\n}\n\n/**\n * Returns is grouped for a row.\n *\n * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.\n *\n * @example\n * ```ts\n * const value = row_getIsGrouped(row)\n * ```\n */\nexport function row_getIsGrouped<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData> & Partial<Row_ColumnGrouping>) {\n  return !!row.groupingColumnId\n}\n\n/**\n * Returns grouping value for a row.\n *\n * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.\n *\n * @example\n * ```ts\n * const value = row_getGroupingValue(row)\n * ```\n */\nexport function row_getGroupingValue<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData> & Partial<Row_ColumnGrouping>, columnId: string) {\n  if (row._groupingValuesCache?.hasOwnProperty(columnId)) {\n    return row._groupingValuesCache[columnId]\n  }\n\n  const column = table_getColumn(row.table, columnId) as Column_Internal<\n    TFeatures,\n    TData\n  >\n\n  if (!column.columnDef.getGroupingValue) {\n    return row.getValue(columnId)\n  }\n\n  if (row._groupingValuesCache) {\n    row._groupingValuesCache[columnId] = column.columnDef.getGroupingValue(\n      row.original,\n    )\n  }\n\n  return row._groupingValuesCache?.[columnId]\n}\n\n/**\n * Returns is grouped for a cell.\n *\n * This is the static implementation behind the matching cell instance API and uses the owning row and column context.\n *\n * @example\n * ```ts\n * const value = cell_getIsGrouped(cell)\n * ```\n */\nexport function cell_getIsGrouped<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(cell: Cell<TFeatures, TData, TValue>) {\n  const row = cell.row as Row<TFeatures, TData> & Partial<Row_ColumnGrouping>\n  return (\n    column_getIsGrouped(cell.column) && cell.column.id === row.groupingColumnId\n  )\n}\n\n/**\n * Returns is placeholder for a cell.\n *\n * This is the static implementation behind the matching cell instance API and uses the owning row and column context.\n *\n * @example\n * ```ts\n * const value = cell_getIsPlaceholder(cell)\n * ```\n */\nexport function cell_getIsPlaceholder<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(cell: Cell<TFeatures, TData, TValue>) {\n  return !cell_getIsGrouped(cell) && column_getIsGrouped(cell.column)\n}\n\n/**\n * Returns is aggregated for a cell.\n *\n * This is the static implementation behind the matching cell instance API and uses the owning row and column context.\n *\n * @example\n * ```ts\n * const value = cell_getIsAggregated(cell)\n * ```\n */\nexport function cell_getIsAggregated<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(cell: Cell<TFeatures, TData, TValue>) {\n  return (\n    !cell_getIsGrouped(cell) &&\n    !cell_getIsPlaceholder(cell) &&\n    !!cell.row.subRows.length\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;AAwBA,SAAgB,0BAAyC;CACvD,OAAO,EAAE;;;;;;;;;;;;AAaX,SAAgB,sBAId,QAAmD;CACnD,kBAAkB,OAAO,QAAQ,QAAQ;EAEvC,IAAI,IAAI,SAAS,OAAO,GAAG,EACzB,OAAO,IAAI,QAAQ,MAAM,MAAM,OAAO,GAAG;EAG3C,OAAO,CAAC,GAAG,KAAK,OAAO,GAAG;GAC1B;;;;;;;;;;;;AAaJ,SAAgB,mBAId,QAAmD;CACnD,QACG,OAAO,UAAU,kBAAkB,UACnC,OAAO,MAAM,QAAQ,kBAAkB,UACvC,CAAC,CAAC,OAAO,cAAc,CAAC,CAAC,OAAO,UAAU;;;;;;;;;;;;AAc/C,SAAgB,oBAId,QAA4D;;CAC5D,OAAO,CAAC,2BAAC,OAAO,MAAM,MAAM,yGAAU,KAAK,gFAAE,SAAS,OAAO,GAAG;;;;;;;;;;;;AAalE,SAAgB,uBAId,QAA2D;;CAC3D,kCAAO,OAAO,MAAM,MAAM,4GAAU,KAAK,kFAAE,QAAQ,OAAO,GAAG,KAAI;;;;;;;;;;;;AAanE,SAAgB,gCAId,QAAmD;CACnD,MAAM,WAAW,mBAAmB,OAAO;CAE3C,aAAa;EACX,IAAI,CAAC,UAAU;EACf,sBAAsB,OAAO;;;;;;;;;;;;;AAcjC,SAAgB,4BAId,QAAmD;CACnD,MAAM,iBAEU,OAAO,MAAM,aAAa;CAE1C,MAAM,WAAW,OAAO,MAAM,iBAAiB,CAAC,SAAS;CAEzD,MAAM,4DAAQ,SAAU,SAAS,OAAO,GAAG;CAE3C,IAAI,OAAO,UAAU,UACnB,uEAAO,eAAgB;CAGzB,IAAI,OAAO,UAAU,SAAS,KAAK,MAAM,KAAK,iBAC5C,uEAAO,eAAgB;;;;;;;;;;;;AAc3B,SAAgB,wBAId,QAAmD;CACnD,MAAM,iBAEU,OAAO,MAAM,aAAa;CAE1C,OAAO,WAAW,OAAO,UAAU,cAAc,GAC7C,OAAO,UAAU,gBACjB,OAAO,UAAU,kBAAkB,SACjC,4BAA4B,OAAO,mEACnC,eAAiB,OAAO,UAAU;;;;;;;;;;;;AAa1C,SAAgB,kBAGd,OAAyC,SAAiC;;CAC1E,iDAAM,SAAQ,6GAAmB,QAAQ;;;;;;;;;;;;;AAc3C,SAAgB,oBAGd,OAAyC,cAAwB;CACjE,kBACE,OACA,eAAe,EAAE,GAAG,WAAW,MAAM,aAAa,YAAY,EAAE,CAAC,CAClE;;;;;;;;;;;;AAaH,SAAgB,iBAGd,KAA0D;CAC1D,OAAO,CAAC,CAAC,IAAI;;;;;;;;;;;;AAaf,SAAgB,qBAGd,KAA0D,UAAkB;;CAC5E,6BAAI,IAAI,oGAAsB,eAAe,SAAS,EACpD,OAAO,IAAI,qBAAqB;CAGlC,MAAM,SAAS,gBAAgB,IAAI,OAAO,SAAS;CAKnD,IAAI,CAAC,OAAO,UAAU,kBACpB,OAAO,IAAI,SAAS,SAAS;CAG/B,IAAI,IAAI,sBACN,IAAI,qBAAqB,YAAY,OAAO,UAAU,iBACpD,IAAI,SACL;CAGH,iCAAO,IAAI,sGAAuB;;;;;;;;;;;;AAapC,SAAgB,kBAId,MAAsC;CACtC,MAAM,MAAM,KAAK;CACjB,OACE,oBAAoB,KAAK,OAAO,IAAI,KAAK,OAAO,OAAO,IAAI;;;;;;;;;;;;AAc/D,SAAgB,sBAId,MAAsC;CACtC,OAAO,CAAC,kBAAkB,KAAK,IAAI,oBAAoB,KAAK,OAAO;;;;;;;;;;;;AAarE,SAAgB,qBAId,MAAsC;CACtC,OACE,CAAC,kBAAkB,KAAK,IACxB,CAAC,sBAAsB,KAAK,IAC5B,CAAC,CAAC,KAAK,IAAI,QAAQ"}

package/dist/features/column-grouping/createGroupedRowModel.cjs

@@ -6,6 +6,11 @@ const require_columnGroupingFeature_utils = require('./columnGroupingFeature.uti
 const require_rowExpandingFeature_utils = require('../row-expanding/rowExpandingFeature.utils.cjs');
 
 //#region src/features/column-grouping/createGroupedRowModel.ts
+/**
+* Creates a memoized grouped 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.
+*/
 function createGroupedRowModel(aggregationFns) {
 	return (_table) => {
 		const table = _table;

package/dist/features/column-grouping/createGroupedRowModel.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"createGroupedRowModel.cjs","names":["tableMemo","table_getColumn","flattenBy","constructRow","column_getAggregationFn","row_getGroupingValue"],"sources":["../../../src/features/column-grouping/createGroupedRowModel.ts"],"sourcesContent":["import { flattenBy, tableMemo } from '../../utils'\nimport { constructRow } from '../../core/rows/constructRow'\nimport { table_getColumn } from '../../core/columns/coreColumnsFeature.utils'\nimport { table_autoResetExpanded } from '../row-expanding/rowExpandingFeature.utils'\nimport { table_autoResetPageIndex } from '../row-pagination/rowPaginationFeature.utils'\nimport {\n  column_getAggregationFn,\n  row_getGroupingValue,\n} from './columnGroupingFeature.utils'\nimport type { Column } from '../../types/Column'\nimport type {\n  AggregationFn,\n  AggregationFns,\n  Row_ColumnGrouping,\n} from './columnGroupingFeature.types'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'\nimport type { Table, Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type { RowData } from '../../types/type-utils'\n\nexport function createGroupedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(\n  aggregationFns: Record<keyof AggregationFns, AggregationFn<TFeatures, TData>>,\n): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {\n  return (_table) => {\n    const table: Table_Internal<TFeatures, TData> = _table\n    if (!table._rowModelFns.aggregationFns)\n      table._rowModelFns.aggregationFns = aggregationFns\n    return tableMemo({\n      feature: 'columnGroupingFeature',\n      table,\n      fnName: 'table.getGroupedRowModel',\n      memoDeps: () => [\n        table.atoms.grouping?.get(),\n        table.getPreGroupedRowModel(),\n      ],\n      fn: () => _createGroupedRowModel(table),\n      onAfterUpdate: () => {\n        table_autoResetExpanded(table)\n        table_autoResetPageIndex(table)\n      },\n    })\n  }\n}\n\nfunction _createGroupedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {\n  const rowModel = table.getPreGroupedRowModel()\n  const grouping = table.atoms.grouping?.get()\n\n  if (!rowModel.rows.length || !grouping?.length) {\n    rowModel.rows.forEach((row) => {\n      row.depth = 0\n      row.parentId = undefined\n    })\n    return rowModel\n  }\n\n  // Filter the grouping list down to columns that exist\n  const existingGrouping = grouping.filter((columnId) =>\n    table_getColumn(table, columnId),\n  )\n\n  const groupedFlatRows: Array<Row<TFeatures, TData>> &\n    Partial<Row_ColumnGrouping> = []\n  const groupedRowsById: Record<string, Row<TFeatures, TData>> = {}\n\n  // Recursively group the data\n  const groupUpRecursively = (\n    rows: Array<Row<TFeatures, TData>>,\n    depth = 0,\n    parentId?: string,\n  ) => {\n    // Grouping depth has been been met\n    // Stop grouping and simply rewrite thd depth and row relationships\n    if (depth >= existingGrouping.length) {\n      return rows.map((row) => {\n        row.depth = depth\n\n        groupedFlatRows.push(row)\n        groupedRowsById[row.id] = row\n\n        if (row.subRows.length) {\n          row.subRows = groupUpRecursively(row.subRows, depth + 1, row.id)\n        }\n\n        return row\n      })\n    }\n\n    const columnId = existingGrouping[depth] as string\n\n    // Group the rows together for this level\n    const rowGroupsMap = groupBy(rows, columnId)\n\n    // Perform aggregations for each group\n    const aggregatedGroupedRows = Array.from(rowGroupsMap.entries()).map(\n      ([groupingValue, groupedRows], index) => {\n        let id = `${columnId}:${groupingValue}`\n        id = parentId ? `${parentId}>${id}` : id\n\n        // First, Recurse to group sub rows before aggregation\n        const subRows = groupUpRecursively(groupedRows, depth + 1, id)\n\n        subRows.forEach((subRow) => {\n          subRow.parentId = id\n        })\n\n        // Flatten the leaf rows of the rows in this group\n        const leafRows = depth\n          ? flattenBy(groupedRows, (row) => row.subRows)\n          : groupedRows\n\n        const row = constructRow(\n          table,\n          id,\n          leafRows[0]!.original,\n          index,\n          depth,\n          undefined,\n          parentId,\n        ) as Row<TFeatures, TData> & Partial<Row_ColumnGrouping>\n\n        Object.assign(row, {\n          groupingColumnId: columnId,\n          groupingValue,\n          subRows,\n          leafRows,\n          getValue: (colId: string) => {\n            // Don't aggregate columns that are in the grouping\n            if (existingGrouping.includes(colId)) {\n              if (row._valuesCache.hasOwnProperty(colId)) {\n                return row._valuesCache[colId]\n              }\n\n              if (groupedRows[0]) {\n                row._valuesCache[colId] =\n                  groupedRows[0].getValue(colId) ?? undefined\n              }\n\n              return row._valuesCache[colId]\n            }\n\n            if (row._groupingValuesCache?.hasOwnProperty(colId)) {\n              return row._groupingValuesCache[colId]\n            }\n\n            // Aggregate the values\n            const column = table.getColumn(colId)\n            const aggregateFn = column_getAggregationFn(\n              column as Column<TFeatures, TData, unknown>,\n            )\n\n            if (!row._groupingValuesCache) row._groupingValuesCache = {}\n\n            if (aggregateFn) {\n              row._groupingValuesCache[colId] = aggregateFn(\n                colId,\n                leafRows,\n                groupedRows,\n              )\n\n              return row._groupingValuesCache[colId]\n            }\n          },\n        })\n\n        subRows.forEach((subRow) => {\n          groupedFlatRows.push(subRow)\n          groupedRowsById[subRow.id] = subRow\n        })\n\n        return row\n      },\n    )\n\n    return aggregatedGroupedRows\n  }\n\n  const groupedRows = groupUpRecursively(rowModel.rows, 0)\n\n  groupedRows.forEach((subRow) => {\n    groupedFlatRows.push(subRow)\n    groupedRowsById[subRow.id] = subRow\n  })\n\n  return {\n    rows: groupedRows,\n    flatRows: groupedFlatRows,\n    rowsById: groupedRowsById,\n  }\n}\n\nfunction groupBy<TFeatures extends TableFeatures, TData extends RowData = any>(\n  rows: Array<Row<TFeatures, TData>>,\n  columnId: string,\n) {\n  const groupMap = new Map<any, Array<Row<TFeatures, TData>>>()\n\n  return rows.reduce((map, row) => {\n    const resKey = `${row_getGroupingValue(row, columnId)}`\n    const previous = map.get(resKey)\n    if (!previous) {\n      map.set(resKey, [row])\n    } else {\n      previous.push(row)\n    }\n    return map\n  }, groupMap)\n}\n"],"mappings":";;;;;;;;AAqBA,SAAgB,sBAId,gBACsE;AACtE,SAAQ,WAAW;EACjB,MAAM,QAA0C;AAChD,MAAI,CAAC,MAAM,aAAa,eACtB,OAAM,aAAa,iBAAiB;AACtC,SAAOA,wBAAU;GACf,SAAS;GACT;GACA,QAAQ;GACR,gBAAgB;;qCACd,MAAM,MAAM,wFAAU,KAAK,EAC3B,MAAM,uBAAuB,CAC9B;;GACD,UAAU,uBAAuB,MAAM;GACvC,qBAAqB;AACnB,8DAAwB,MAAM;AAC9B,gEAAyB,MAAM;;GAElC,CAAC;;;AAIN,SAAS,uBAGP,OAAqE;;CACrE,MAAM,WAAW,MAAM,uBAAuB;CAC9C,MAAM,qCAAW,MAAM,MAAM,0FAAU,KAAK;AAE5C,KAAI,CAAC,SAAS,KAAK,UAAU,sDAAC,SAAU,SAAQ;AAC9C,WAAS,KAAK,SAAS,QAAQ;AAC7B,OAAI,QAAQ;AACZ,OAAI,WAAW;IACf;AACF,SAAO;;CAIT,MAAM,mBAAmB,SAAS,QAAQ,aACxCC,iDAAgB,OAAO,SAAS,CACjC;CAED,MAAM,kBAC0B,EAAE;CAClC,MAAM,kBAAyD,EAAE;CAGjE,MAAM,sBACJ,MACA,QAAQ,GACR,aACG;AAGH,MAAI,SAAS,iBAAiB,OAC5B,QAAO,KAAK,KAAK,QAAQ;AACvB,OAAI,QAAQ;AAEZ,mBAAgB,KAAK,IAAI;AACzB,mBAAgB,IAAI,MAAM;AAE1B,OAAI,IAAI,QAAQ,OACd,KAAI,UAAU,mBAAmB,IAAI,SAAS,QAAQ,GAAG,IAAI,GAAG;AAGlE,UAAO;IACP;EAGJ,MAAM,WAAW,iBAAiB;EAGlC,MAAM,eAAe,QAAQ,MAAM,SAAS;AAmF5C,SAhF8B,MAAM,KAAK,aAAa,SAAS,CAAC,CAAC,KAC9D,CAAC,eAAe,cAAc,UAAU;GACvC,IAAI,KAAK,GAAG,SAAS,GAAG;AACxB,QAAK,WAAW,GAAG,SAAS,GAAG,OAAO;GAGtC,MAAM,UAAU,mBAAmB,aAAa,QAAQ,GAAG,GAAG;AAE9D,WAAQ,SAAS,WAAW;AAC1B,WAAO,WAAW;KAClB;GAGF,MAAM,WAAW,QACbC,wBAAU,cAAc,QAAQ,IAAI,QAAQ,GAC5C;GAEJ,MAAM,MAAMC,kCACV,OACA,IACA,SAAS,GAAI,UACb,OACA,OACA,QACA,SACD;AAED,UAAO,OAAO,KAAK;IACjB,kBAAkB;IAClB;IACA;IACA;IACA,WAAW,UAAkB;;AAE3B,SAAI,iBAAiB,SAAS,MAAM,EAAE;AACpC,UAAI,IAAI,aAAa,eAAe,MAAM,CACxC,QAAO,IAAI,aAAa;AAG1B,UAAI,YAAY,GACd,KAAI,aAAa,SACf,YAAY,GAAG,SAAS,MAAM,IAAI;AAGtC,aAAO,IAAI,aAAa;;AAG1B,kCAAI,IAAI,oGAAsB,eAAe,MAAM,CACjD,QAAO,IAAI,qBAAqB;KAKlC,MAAM,cAAcC,4DADL,MAAM,UAAU,MAEvB,CACP;AAED,SAAI,CAAC,IAAI,qBAAsB,KAAI,uBAAuB,EAAE;AAE5D,SAAI,aAAa;AACf,UAAI,qBAAqB,SAAS,YAChC,OACA,UACA,YACD;AAED,aAAO,IAAI,qBAAqB;;;IAGrC,CAAC;AAEF,WAAQ,SAAS,WAAW;AAC1B,oBAAgB,KAAK,OAAO;AAC5B,oBAAgB,OAAO,MAAM;KAC7B;AAEF,UAAO;IAIiB;;CAG9B,MAAM,cAAc,mBAAmB,SAAS,MAAM,EAAE;AAExD,aAAY,SAAS,WAAW;AAC9B,kBAAgB,KAAK,OAAO;AAC5B,kBAAgB,OAAO,MAAM;GAC7B;AAEF,QAAO;EACL,MAAM;EACN,UAAU;EACV,UAAU;EACX;;AAGH,SAAS,QACP,MACA,UACA;CACA,MAAM,2BAAW,IAAI,KAAwC;AAE7D,QAAO,KAAK,QAAQ,KAAK,QAAQ;EAC/B,MAAM,SAAS,GAAGC,yDAAqB,KAAK,SAAS;EACrD,MAAM,WAAW,IAAI,IAAI,OAAO;AAChC,MAAI,CAAC,SACH,KAAI,IAAI,QAAQ,CAAC,IAAI,CAAC;MAEtB,UAAS,KAAK,IAAI;AAEpB,SAAO;IACN,SAAS"}
+{"version":3,"file":"createGroupedRowModel.cjs","names":["tableMemo","table_getColumn","flattenBy","constructRow","column_getAggregationFn","row_getGroupingValue"],"sources":["../../../src/features/column-grouping/createGroupedRowModel.ts"],"sourcesContent":["import { flattenBy, tableMemo } from '../../utils'\nimport { constructRow } from '../../core/rows/constructRow'\nimport { table_getColumn } from '../../core/columns/coreColumnsFeature.utils'\nimport { table_autoResetExpanded } from '../row-expanding/rowExpandingFeature.utils'\nimport { table_autoResetPageIndex } from '../row-pagination/rowPaginationFeature.utils'\nimport {\n  column_getAggregationFn,\n  row_getGroupingValue,\n} from './columnGroupingFeature.utils'\nimport type { Column } from '../../types/Column'\nimport type {\n  AggregationFn,\n  AggregationFns,\n  Row_ColumnGrouping,\n} from './columnGroupingFeature.types'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'\nimport type { Table, Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type { RowData } from '../../types/type-utils'\n\n/**\n * Creates a memoized grouped row model factory.\n *\n * The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.\n */\nexport function createGroupedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(\n  aggregationFns: Record<keyof AggregationFns, AggregationFn<TFeatures, TData>>,\n): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {\n  return (_table) => {\n    const table: Table_Internal<TFeatures, TData> = _table\n    if (!table._rowModelFns.aggregationFns)\n      table._rowModelFns.aggregationFns = aggregationFns\n    return tableMemo({\n      feature: 'columnGroupingFeature',\n      table,\n      fnName: 'table.getGroupedRowModel',\n      memoDeps: () => [\n        table.atoms.grouping?.get(),\n        table.getPreGroupedRowModel(),\n      ],\n      fn: () => _createGroupedRowModel(table),\n      onAfterUpdate: () => {\n        table_autoResetExpanded(table)\n        table_autoResetPageIndex(table)\n      },\n    })\n  }\n}\n\nfunction _createGroupedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {\n  const rowModel = table.getPreGroupedRowModel()\n  const grouping = table.atoms.grouping?.get()\n\n  if (!rowModel.rows.length || !grouping?.length) {\n    rowModel.rows.forEach((row) => {\n      row.depth = 0\n      row.parentId = undefined\n    })\n    return rowModel\n  }\n\n  // Filter the grouping list down to columns that exist\n  const existingGrouping = grouping.filter((columnId) =>\n    table_getColumn(table, columnId),\n  )\n\n  const groupedFlatRows: Array<Row<TFeatures, TData>> &\n    Partial<Row_ColumnGrouping> = []\n  const groupedRowsById: Record<string, Row<TFeatures, TData>> = {}\n\n  // Recursively group the data\n  const groupUpRecursively = (\n    rows: Array<Row<TFeatures, TData>>,\n    depth = 0,\n    parentId?: string,\n  ) => {\n    // Grouping depth has been been met\n    // Stop grouping and simply rewrite thd depth and row relationships\n    if (depth >= existingGrouping.length) {\n      return rows.map((row) => {\n        row.depth = depth\n\n        groupedFlatRows.push(row)\n        groupedRowsById[row.id] = row\n\n        if (row.subRows.length) {\n          row.subRows = groupUpRecursively(row.subRows, depth + 1, row.id)\n        }\n\n        return row\n      })\n    }\n\n    const columnId = existingGrouping[depth] as string\n\n    // Group the rows together for this level\n    const rowGroupsMap = groupBy(rows, columnId)\n\n    // Perform aggregations for each group\n    const aggregatedGroupedRows = Array.from(rowGroupsMap.entries()).map(\n      ([groupingValue, groupedRows], index) => {\n        let id = `${columnId}:${groupingValue}`\n        id = parentId ? `${parentId}>${id}` : id\n\n        // First, Recurse to group sub rows before aggregation\n        const subRows = groupUpRecursively(groupedRows, depth + 1, id)\n\n        subRows.forEach((subRow) => {\n          subRow.parentId = id\n        })\n\n        // Flatten the leaf rows of the rows in this group\n        const leafRows = depth\n          ? flattenBy(groupedRows, (row) => row.subRows)\n          : groupedRows\n\n        const row = constructRow(\n          table,\n          id,\n          leafRows[0]!.original,\n          index,\n          depth,\n          undefined,\n          parentId,\n        ) as Row<TFeatures, TData> & Partial<Row_ColumnGrouping>\n\n        Object.assign(row, {\n          groupingColumnId: columnId,\n          groupingValue,\n          subRows,\n          leafRows,\n          getValue: (colId: string) => {\n            // Don't aggregate columns that are in the grouping\n            if (existingGrouping.includes(colId)) {\n              if (row._valuesCache.hasOwnProperty(colId)) {\n                return row._valuesCache[colId]\n              }\n\n              if (groupedRows[0]) {\n                row._valuesCache[colId] =\n                  groupedRows[0].getValue(colId) ?? undefined\n              }\n\n              return row._valuesCache[colId]\n            }\n\n            if (row._groupingValuesCache?.hasOwnProperty(colId)) {\n              return row._groupingValuesCache[colId]\n            }\n\n            // Aggregate the values\n            const column = table.getColumn(colId)\n            const aggregateFn = column_getAggregationFn(\n              column as Column<TFeatures, TData, unknown>,\n            )\n\n            if (!row._groupingValuesCache) row._groupingValuesCache = {}\n\n            if (aggregateFn) {\n              row._groupingValuesCache[colId] = aggregateFn(\n                colId,\n                leafRows,\n                groupedRows,\n              )\n\n              return row._groupingValuesCache[colId]\n            }\n          },\n        })\n\n        subRows.forEach((subRow) => {\n          groupedFlatRows.push(subRow)\n          groupedRowsById[subRow.id] = subRow\n        })\n\n        return row\n      },\n    )\n\n    return aggregatedGroupedRows\n  }\n\n  const groupedRows = groupUpRecursively(rowModel.rows, 0)\n\n  groupedRows.forEach((subRow) => {\n    groupedFlatRows.push(subRow)\n    groupedRowsById[subRow.id] = subRow\n  })\n\n  return {\n    rows: groupedRows,\n    flatRows: groupedFlatRows,\n    rowsById: groupedRowsById,\n  }\n}\n\nfunction groupBy<TFeatures extends TableFeatures, TData extends RowData = any>(\n  rows: Array<Row<TFeatures, TData>>,\n  columnId: string,\n) {\n  const groupMap = new Map<any, Array<Row<TFeatures, TData>>>()\n\n  return rows.reduce((map, row) => {\n    const resKey = `${row_getGroupingValue(row, columnId)}`\n    const previous = map.get(resKey)\n    if (!previous) {\n      map.set(resKey, [row])\n    } else {\n      previous.push(row)\n    }\n    return map\n  }, groupMap)\n}\n"],"mappings":";;;;;;;;;;;;;AA0BA,SAAgB,sBAId,gBACsE;CACtE,QAAQ,WAAW;EACjB,MAAM,QAA0C;EAChD,IAAI,CAAC,MAAM,aAAa,gBACtB,MAAM,aAAa,iBAAiB;EACtC,OAAOA,wBAAU;GACf,SAAS;GACT;GACA,QAAQ;GACR,gBAAgB;;qCACd,MAAM,MAAM,wFAAU,KAAK,EAC3B,MAAM,uBAAuB,CAC9B;;GACD,UAAU,uBAAuB,MAAM;GACvC,qBAAqB;IACnB,0DAAwB,MAAM;IAC9B,4DAAyB,MAAM;;GAElC,CAAC;;;AAIN,SAAS,uBAGP,OAAqE;;CACrE,MAAM,WAAW,MAAM,uBAAuB;CAC9C,MAAM,qCAAW,MAAM,MAAM,0FAAU,KAAK;CAE5C,IAAI,CAAC,SAAS,KAAK,UAAU,sDAAC,SAAU,SAAQ;EAC9C,SAAS,KAAK,SAAS,QAAQ;GAC7B,IAAI,QAAQ;GACZ,IAAI,WAAW;IACf;EACF,OAAO;;CAIT,MAAM,mBAAmB,SAAS,QAAQ,aACxCC,iDAAgB,OAAO,SAAS,CACjC;CAED,MAAM,kBAC0B,EAAE;CAClC,MAAM,kBAAyD,EAAE;CAGjE,MAAM,sBACJ,MACA,QAAQ,GACR,aACG;EAGH,IAAI,SAAS,iBAAiB,QAC5B,OAAO,KAAK,KAAK,QAAQ;GACvB,IAAI,QAAQ;GAEZ,gBAAgB,KAAK,IAAI;GACzB,gBAAgB,IAAI,MAAM;GAE1B,IAAI,IAAI,QAAQ,QACd,IAAI,UAAU,mBAAmB,IAAI,SAAS,QAAQ,GAAG,IAAI,GAAG;GAGlE,OAAO;IACP;EAGJ,MAAM,WAAW,iBAAiB;EAGlC,MAAM,eAAe,QAAQ,MAAM,SAAS;EAmF5C,OAhF8B,MAAM,KAAK,aAAa,SAAS,CAAC,CAAC,KAC9D,CAAC,eAAe,cAAc,UAAU;GACvC,IAAI,KAAK,GAAG,SAAS,GAAG;GACxB,KAAK,WAAW,GAAG,SAAS,GAAG,OAAO;GAGtC,MAAM,UAAU,mBAAmB,aAAa,QAAQ,GAAG,GAAG;GAE9D,QAAQ,SAAS,WAAW;IAC1B,OAAO,WAAW;KAClB;GAGF,MAAM,WAAW,QACbC,wBAAU,cAAc,QAAQ,IAAI,QAAQ,GAC5C;GAEJ,MAAM,MAAMC,kCACV,OACA,IACA,SAAS,GAAI,UACb,OACA,OACA,QACA,SACD;GAED,OAAO,OAAO,KAAK;IACjB,kBAAkB;IAClB;IACA;IACA;IACA,WAAW,UAAkB;;KAE3B,IAAI,iBAAiB,SAAS,MAAM,EAAE;MACpC,IAAI,IAAI,aAAa,eAAe,MAAM,EACxC,OAAO,IAAI,aAAa;MAG1B,IAAI,YAAY,IACd,IAAI,aAAa,SACf,YAAY,GAAG,SAAS,MAAM,IAAI;MAGtC,OAAO,IAAI,aAAa;;KAG1B,6BAAI,IAAI,oGAAsB,eAAe,MAAM,EACjD,OAAO,IAAI,qBAAqB;KAKlC,MAAM,cAAcC,4DADL,MAAM,UAAU,MAEvB,CACP;KAED,IAAI,CAAC,IAAI,sBAAsB,IAAI,uBAAuB,EAAE;KAE5D,IAAI,aAAa;MACf,IAAI,qBAAqB,SAAS,YAChC,OACA,UACA,YACD;MAED,OAAO,IAAI,qBAAqB;;;IAGrC,CAAC;GAEF,QAAQ,SAAS,WAAW;IAC1B,gBAAgB,KAAK,OAAO;IAC5B,gBAAgB,OAAO,MAAM;KAC7B;GAEF,OAAO;IAIiB;;CAG9B,MAAM,cAAc,mBAAmB,SAAS,MAAM,EAAE;CAExD,YAAY,SAAS,WAAW;EAC9B,gBAAgB,KAAK,OAAO;EAC5B,gBAAgB,OAAO,MAAM;GAC7B;CAEF,OAAO;EACL,MAAM;EACN,UAAU;EACV,UAAU;EACX;;AAGH,SAAS,QACP,MACA,UACA;CACA,MAAM,2BAAW,IAAI,KAAwC;CAE7D,OAAO,KAAK,QAAQ,KAAK,QAAQ;EAC/B,MAAM,SAAS,GAAGC,yDAAqB,KAAK,SAAS;EACrD,MAAM,WAAW,IAAI,IAAI,OAAO;EAChC,IAAI,CAAC,UACH,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC;OAEtB,SAAS,KAAK,IAAI;EAEpB,OAAO;IACN,SAAS"}

package/dist/features/column-grouping/createGroupedRowModel.d.cts

@@ -5,6 +5,11 @@ import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.cjs";
 import { AggregationFn, AggregationFns } from "./columnGroupingFeature.types.cjs";
 
 //#region src/features/column-grouping/createGroupedRowModel.d.ts
+/**
+ * Creates a memoized grouped 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.
+ */
 declare function createGroupedRowModel<TFeatures extends TableFeatures, TData extends RowData = any>(aggregationFns: Record<keyof AggregationFns, AggregationFn<TFeatures, TData>>): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData>;
 //#endregion
 export { createGroupedRowModel };

package/dist/features/column-grouping/createGroupedRowModel.d.ts

@@ -5,6 +5,11 @@ import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.js";
 import { AggregationFn, AggregationFns } from "./columnGroupingFeature.types.js";
 
 //#region src/features/column-grouping/createGroupedRowModel.d.ts
+/**
+ * Creates a memoized grouped 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.
+ */
 declare function createGroupedRowModel<TFeatures extends TableFeatures, TData extends RowData = any>(aggregationFns: Record<keyof AggregationFns, AggregationFn<TFeatures, TData>>): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData>;
 //#endregion
 export { createGroupedRowModel };

package/dist/features/column-grouping/createGroupedRowModel.js

@@ -6,6 +6,11 @@ import { column_getAggregationFn, row_getGroupingValue } from "./columnGroupingF
 import { table_autoResetExpanded } from "../row-expanding/rowExpandingFeature.utils.js";
 
 //#region src/features/column-grouping/createGroupedRowModel.ts
+/**
+* Creates a memoized grouped 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.
+*/
 function createGroupedRowModel(aggregationFns) {
 	return (_table) => {
 		const table = _table;

package/dist/features/column-grouping/createGroupedRowModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"createGroupedRowModel.js","names":[],"sources":["../../../src/features/column-grouping/createGroupedRowModel.ts"],"sourcesContent":["import { flattenBy, tableMemo } from '../../utils'\nimport { constructRow } from '../../core/rows/constructRow'\nimport { table_getColumn } from '../../core/columns/coreColumnsFeature.utils'\nimport { table_autoResetExpanded } from '../row-expanding/rowExpandingFeature.utils'\nimport { table_autoResetPageIndex } from '../row-pagination/rowPaginationFeature.utils'\nimport {\n  column_getAggregationFn,\n  row_getGroupingValue,\n} from './columnGroupingFeature.utils'\nimport type { Column } from '../../types/Column'\nimport type {\n  AggregationFn,\n  AggregationFns,\n  Row_ColumnGrouping,\n} from './columnGroupingFeature.types'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'\nimport type { Table, Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type { RowData } from '../../types/type-utils'\n\nexport function createGroupedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(\n  aggregationFns: Record<keyof AggregationFns, AggregationFn<TFeatures, TData>>,\n): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {\n  return (_table) => {\n    const table: Table_Internal<TFeatures, TData> = _table\n    if (!table._rowModelFns.aggregationFns)\n      table._rowModelFns.aggregationFns = aggregationFns\n    return tableMemo({\n      feature: 'columnGroupingFeature',\n      table,\n      fnName: 'table.getGroupedRowModel',\n      memoDeps: () => [\n        table.atoms.grouping?.get(),\n        table.getPreGroupedRowModel(),\n      ],\n      fn: () => _createGroupedRowModel(table),\n      onAfterUpdate: () => {\n        table_autoResetExpanded(table)\n        table_autoResetPageIndex(table)\n      },\n    })\n  }\n}\n\nfunction _createGroupedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {\n  const rowModel = table.getPreGroupedRowModel()\n  const grouping = table.atoms.grouping?.get()\n\n  if (!rowModel.rows.length || !grouping?.length) {\n    rowModel.rows.forEach((row) => {\n      row.depth = 0\n      row.parentId = undefined\n    })\n    return rowModel\n  }\n\n  // Filter the grouping list down to columns that exist\n  const existingGrouping = grouping.filter((columnId) =>\n    table_getColumn(table, columnId),\n  )\n\n  const groupedFlatRows: Array<Row<TFeatures, TData>> &\n    Partial<Row_ColumnGrouping> = []\n  const groupedRowsById: Record<string, Row<TFeatures, TData>> = {}\n\n  // Recursively group the data\n  const groupUpRecursively = (\n    rows: Array<Row<TFeatures, TData>>,\n    depth = 0,\n    parentId?: string,\n  ) => {\n    // Grouping depth has been been met\n    // Stop grouping and simply rewrite thd depth and row relationships\n    if (depth >= existingGrouping.length) {\n      return rows.map((row) => {\n        row.depth = depth\n\n        groupedFlatRows.push(row)\n        groupedRowsById[row.id] = row\n\n        if (row.subRows.length) {\n          row.subRows = groupUpRecursively(row.subRows, depth + 1, row.id)\n        }\n\n        return row\n      })\n    }\n\n    const columnId = existingGrouping[depth] as string\n\n    // Group the rows together for this level\n    const rowGroupsMap = groupBy(rows, columnId)\n\n    // Perform aggregations for each group\n    const aggregatedGroupedRows = Array.from(rowGroupsMap.entries()).map(\n      ([groupingValue, groupedRows], index) => {\n        let id = `${columnId}:${groupingValue}`\n        id = parentId ? `${parentId}>${id}` : id\n\n        // First, Recurse to group sub rows before aggregation\n        const subRows = groupUpRecursively(groupedRows, depth + 1, id)\n\n        subRows.forEach((subRow) => {\n          subRow.parentId = id\n        })\n\n        // Flatten the leaf rows of the rows in this group\n        const leafRows = depth\n          ? flattenBy(groupedRows, (row) => row.subRows)\n          : groupedRows\n\n        const row = constructRow(\n          table,\n          id,\n          leafRows[0]!.original,\n          index,\n          depth,\n          undefined,\n          parentId,\n        ) as Row<TFeatures, TData> & Partial<Row_ColumnGrouping>\n\n        Object.assign(row, {\n          groupingColumnId: columnId,\n          groupingValue,\n          subRows,\n          leafRows,\n          getValue: (colId: string) => {\n            // Don't aggregate columns that are in the grouping\n            if (existingGrouping.includes(colId)) {\n              if (row._valuesCache.hasOwnProperty(colId)) {\n                return row._valuesCache[colId]\n              }\n\n              if (groupedRows[0]) {\n                row._valuesCache[colId] =\n                  groupedRows[0].getValue(colId) ?? undefined\n              }\n\n              return row._valuesCache[colId]\n            }\n\n            if (row._groupingValuesCache?.hasOwnProperty(colId)) {\n              return row._groupingValuesCache[colId]\n            }\n\n            // Aggregate the values\n            const column = table.getColumn(colId)\n            const aggregateFn = column_getAggregationFn(\n              column as Column<TFeatures, TData, unknown>,\n            )\n\n            if (!row._groupingValuesCache) row._groupingValuesCache = {}\n\n            if (aggregateFn) {\n              row._groupingValuesCache[colId] = aggregateFn(\n                colId,\n                leafRows,\n                groupedRows,\n              )\n\n              return row._groupingValuesCache[colId]\n            }\n          },\n        })\n\n        subRows.forEach((subRow) => {\n          groupedFlatRows.push(subRow)\n          groupedRowsById[subRow.id] = subRow\n        })\n\n        return row\n      },\n    )\n\n    return aggregatedGroupedRows\n  }\n\n  const groupedRows = groupUpRecursively(rowModel.rows, 0)\n\n  groupedRows.forEach((subRow) => {\n    groupedFlatRows.push(subRow)\n    groupedRowsById[subRow.id] = subRow\n  })\n\n  return {\n    rows: groupedRows,\n    flatRows: groupedFlatRows,\n    rowsById: groupedRowsById,\n  }\n}\n\nfunction groupBy<TFeatures extends TableFeatures, TData extends RowData = any>(\n  rows: Array<Row<TFeatures, TData>>,\n  columnId: string,\n) {\n  const groupMap = new Map<any, Array<Row<TFeatures, TData>>>()\n\n  return rows.reduce((map, row) => {\n    const resKey = `${row_getGroupingValue(row, columnId)}`\n    const previous = map.get(resKey)\n    if (!previous) {\n      map.set(resKey, [row])\n    } else {\n      previous.push(row)\n    }\n    return map\n  }, groupMap)\n}\n"],"mappings":";;;;;;;;AAqBA,SAAgB,sBAId,gBACsE;AACtE,SAAQ,WAAW;EACjB,MAAM,QAA0C;AAChD,MAAI,CAAC,MAAM,aAAa,eACtB,OAAM,aAAa,iBAAiB;AACtC,SAAO,UAAU;GACf,SAAS;GACT;GACA,QAAQ;GACR,gBAAgB;;qCACd,MAAM,MAAM,wFAAU,KAAK,EAC3B,MAAM,uBAAuB,CAC9B;;GACD,UAAU,uBAAuB,MAAM;GACvC,qBAAqB;AACnB,4BAAwB,MAAM;AAC9B,6BAAyB,MAAM;;GAElC,CAAC;;;AAIN,SAAS,uBAGP,OAAqE;;CACrE,MAAM,WAAW,MAAM,uBAAuB;CAC9C,MAAM,qCAAW,MAAM,MAAM,0FAAU,KAAK;AAE5C,KAAI,CAAC,SAAS,KAAK,UAAU,sDAAC,SAAU,SAAQ;AAC9C,WAAS,KAAK,SAAS,QAAQ;AAC7B,OAAI,QAAQ;AACZ,OAAI,WAAW;IACf;AACF,SAAO;;CAIT,MAAM,mBAAmB,SAAS,QAAQ,aACxC,gBAAgB,OAAO,SAAS,CACjC;CAED,MAAM,kBAC0B,EAAE;CAClC,MAAM,kBAAyD,EAAE;CAGjE,MAAM,sBACJ,MACA,QAAQ,GACR,aACG;AAGH,MAAI,SAAS,iBAAiB,OAC5B,QAAO,KAAK,KAAK,QAAQ;AACvB,OAAI,QAAQ;AAEZ,mBAAgB,KAAK,IAAI;AACzB,mBAAgB,IAAI,MAAM;AAE1B,OAAI,IAAI,QAAQ,OACd,KAAI,UAAU,mBAAmB,IAAI,SAAS,QAAQ,GAAG,IAAI,GAAG;AAGlE,UAAO;IACP;EAGJ,MAAM,WAAW,iBAAiB;EAGlC,MAAM,eAAe,QAAQ,MAAM,SAAS;AAmF5C,SAhF8B,MAAM,KAAK,aAAa,SAAS,CAAC,CAAC,KAC9D,CAAC,eAAe,cAAc,UAAU;GACvC,IAAI,KAAK,GAAG,SAAS,GAAG;AACxB,QAAK,WAAW,GAAG,SAAS,GAAG,OAAO;GAGtC,MAAM,UAAU,mBAAmB,aAAa,QAAQ,GAAG,GAAG;AAE9D,WAAQ,SAAS,WAAW;AAC1B,WAAO,WAAW;KAClB;GAGF,MAAM,WAAW,QACb,UAAU,cAAc,QAAQ,IAAI,QAAQ,GAC5C;GAEJ,MAAM,MAAM,aACV,OACA,IACA,SAAS,GAAI,UACb,OACA,OACA,QACA,SACD;AAED,UAAO,OAAO,KAAK;IACjB,kBAAkB;IAClB;IACA;IACA;IACA,WAAW,UAAkB;;AAE3B,SAAI,iBAAiB,SAAS,MAAM,EAAE;AACpC,UAAI,IAAI,aAAa,eAAe,MAAM,CACxC,QAAO,IAAI,aAAa;AAG1B,UAAI,YAAY,GACd,KAAI,aAAa,SACf,YAAY,GAAG,SAAS,MAAM,IAAI;AAGtC,aAAO,IAAI,aAAa;;AAG1B,kCAAI,IAAI,oGAAsB,eAAe,MAAM,CACjD,QAAO,IAAI,qBAAqB;KAKlC,MAAM,cAAc,wBADL,MAAM,UAAU,MAEvB,CACP;AAED,SAAI,CAAC,IAAI,qBAAsB,KAAI,uBAAuB,EAAE;AAE5D,SAAI,aAAa;AACf,UAAI,qBAAqB,SAAS,YAChC,OACA,UACA,YACD;AAED,aAAO,IAAI,qBAAqB;;;IAGrC,CAAC;AAEF,WAAQ,SAAS,WAAW;AAC1B,oBAAgB,KAAK,OAAO;AAC5B,oBAAgB,OAAO,MAAM;KAC7B;AAEF,UAAO;IAIiB;;CAG9B,MAAM,cAAc,mBAAmB,SAAS,MAAM,EAAE;AAExD,aAAY,SAAS,WAAW;AAC9B,kBAAgB,KAAK,OAAO;AAC5B,kBAAgB,OAAO,MAAM;GAC7B;AAEF,QAAO;EACL,MAAM;EACN,UAAU;EACV,UAAU;EACX;;AAGH,SAAS,QACP,MACA,UACA;CACA,MAAM,2BAAW,IAAI,KAAwC;AAE7D,QAAO,KAAK,QAAQ,KAAK,QAAQ;EAC/B,MAAM,SAAS,GAAG,qBAAqB,KAAK,SAAS;EACrD,MAAM,WAAW,IAAI,IAAI,OAAO;AAChC,MAAI,CAAC,SACH,KAAI,IAAI,QAAQ,CAAC,IAAI,CAAC;MAEtB,UAAS,KAAK,IAAI;AAEpB,SAAO;IACN,SAAS"}
+{"version":3,"file":"createGroupedRowModel.js","names":[],"sources":["../../../src/features/column-grouping/createGroupedRowModel.ts"],"sourcesContent":["import { flattenBy, tableMemo } from '../../utils'\nimport { constructRow } from '../../core/rows/constructRow'\nimport { table_getColumn } from '../../core/columns/coreColumnsFeature.utils'\nimport { table_autoResetExpanded } from '../row-expanding/rowExpandingFeature.utils'\nimport { table_autoResetPageIndex } from '../row-pagination/rowPaginationFeature.utils'\nimport {\n  column_getAggregationFn,\n  row_getGroupingValue,\n} from './columnGroupingFeature.utils'\nimport type { Column } from '../../types/Column'\nimport type {\n  AggregationFn,\n  AggregationFns,\n  Row_ColumnGrouping,\n} from './columnGroupingFeature.types'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'\nimport type { Table, Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type { RowData } from '../../types/type-utils'\n\n/**\n * Creates a memoized grouped row model factory.\n *\n * The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.\n */\nexport function createGroupedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(\n  aggregationFns: Record<keyof AggregationFns, AggregationFn<TFeatures, TData>>,\n): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {\n  return (_table) => {\n    const table: Table_Internal<TFeatures, TData> = _table\n    if (!table._rowModelFns.aggregationFns)\n      table._rowModelFns.aggregationFns = aggregationFns\n    return tableMemo({\n      feature: 'columnGroupingFeature',\n      table,\n      fnName: 'table.getGroupedRowModel',\n      memoDeps: () => [\n        table.atoms.grouping?.get(),\n        table.getPreGroupedRowModel(),\n      ],\n      fn: () => _createGroupedRowModel(table),\n      onAfterUpdate: () => {\n        table_autoResetExpanded(table)\n        table_autoResetPageIndex(table)\n      },\n    })\n  }\n}\n\nfunction _createGroupedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {\n  const rowModel = table.getPreGroupedRowModel()\n  const grouping = table.atoms.grouping?.get()\n\n  if (!rowModel.rows.length || !grouping?.length) {\n    rowModel.rows.forEach((row) => {\n      row.depth = 0\n      row.parentId = undefined\n    })\n    return rowModel\n  }\n\n  // Filter the grouping list down to columns that exist\n  const existingGrouping = grouping.filter((columnId) =>\n    table_getColumn(table, columnId),\n  )\n\n  const groupedFlatRows: Array<Row<TFeatures, TData>> &\n    Partial<Row_ColumnGrouping> = []\n  const groupedRowsById: Record<string, Row<TFeatures, TData>> = {}\n\n  // Recursively group the data\n  const groupUpRecursively = (\n    rows: Array<Row<TFeatures, TData>>,\n    depth = 0,\n    parentId?: string,\n  ) => {\n    // Grouping depth has been been met\n    // Stop grouping and simply rewrite thd depth and row relationships\n    if (depth >= existingGrouping.length) {\n      return rows.map((row) => {\n        row.depth = depth\n\n        groupedFlatRows.push(row)\n        groupedRowsById[row.id] = row\n\n        if (row.subRows.length) {\n          row.subRows = groupUpRecursively(row.subRows, depth + 1, row.id)\n        }\n\n        return row\n      })\n    }\n\n    const columnId = existingGrouping[depth] as string\n\n    // Group the rows together for this level\n    const rowGroupsMap = groupBy(rows, columnId)\n\n    // Perform aggregations for each group\n    const aggregatedGroupedRows = Array.from(rowGroupsMap.entries()).map(\n      ([groupingValue, groupedRows], index) => {\n        let id = `${columnId}:${groupingValue}`\n        id = parentId ? `${parentId}>${id}` : id\n\n        // First, Recurse to group sub rows before aggregation\n        const subRows = groupUpRecursively(groupedRows, depth + 1, id)\n\n        subRows.forEach((subRow) => {\n          subRow.parentId = id\n        })\n\n        // Flatten the leaf rows of the rows in this group\n        const leafRows = depth\n          ? flattenBy(groupedRows, (row) => row.subRows)\n          : groupedRows\n\n        const row = constructRow(\n          table,\n          id,\n          leafRows[0]!.original,\n          index,\n          depth,\n          undefined,\n          parentId,\n        ) as Row<TFeatures, TData> & Partial<Row_ColumnGrouping>\n\n        Object.assign(row, {\n          groupingColumnId: columnId,\n          groupingValue,\n          subRows,\n          leafRows,\n          getValue: (colId: string) => {\n            // Don't aggregate columns that are in the grouping\n            if (existingGrouping.includes(colId)) {\n              if (row._valuesCache.hasOwnProperty(colId)) {\n                return row._valuesCache[colId]\n              }\n\n              if (groupedRows[0]) {\n                row._valuesCache[colId] =\n                  groupedRows[0].getValue(colId) ?? undefined\n              }\n\n              return row._valuesCache[colId]\n            }\n\n            if (row._groupingValuesCache?.hasOwnProperty(colId)) {\n              return row._groupingValuesCache[colId]\n            }\n\n            // Aggregate the values\n            const column = table.getColumn(colId)\n            const aggregateFn = column_getAggregationFn(\n              column as Column<TFeatures, TData, unknown>,\n            )\n\n            if (!row._groupingValuesCache) row._groupingValuesCache = {}\n\n            if (aggregateFn) {\n              row._groupingValuesCache[colId] = aggregateFn(\n                colId,\n                leafRows,\n                groupedRows,\n              )\n\n              return row._groupingValuesCache[colId]\n            }\n          },\n        })\n\n        subRows.forEach((subRow) => {\n          groupedFlatRows.push(subRow)\n          groupedRowsById[subRow.id] = subRow\n        })\n\n        return row\n      },\n    )\n\n    return aggregatedGroupedRows\n  }\n\n  const groupedRows = groupUpRecursively(rowModel.rows, 0)\n\n  groupedRows.forEach((subRow) => {\n    groupedFlatRows.push(subRow)\n    groupedRowsById[subRow.id] = subRow\n  })\n\n  return {\n    rows: groupedRows,\n    flatRows: groupedFlatRows,\n    rowsById: groupedRowsById,\n  }\n}\n\nfunction groupBy<TFeatures extends TableFeatures, TData extends RowData = any>(\n  rows: Array<Row<TFeatures, TData>>,\n  columnId: string,\n) {\n  const groupMap = new Map<any, Array<Row<TFeatures, TData>>>()\n\n  return rows.reduce((map, row) => {\n    const resKey = `${row_getGroupingValue(row, columnId)}`\n    const previous = map.get(resKey)\n    if (!previous) {\n      map.set(resKey, [row])\n    } else {\n      previous.push(row)\n    }\n    return map\n  }, groupMap)\n}\n"],"mappings":";;;;;;;;;;;;;AA0BA,SAAgB,sBAId,gBACsE;CACtE,QAAQ,WAAW;EACjB,MAAM,QAA0C;EAChD,IAAI,CAAC,MAAM,aAAa,gBACtB,MAAM,aAAa,iBAAiB;EACtC,OAAO,UAAU;GACf,SAAS;GACT;GACA,QAAQ;GACR,gBAAgB;;qCACd,MAAM,MAAM,wFAAU,KAAK,EAC3B,MAAM,uBAAuB,CAC9B;;GACD,UAAU,uBAAuB,MAAM;GACvC,qBAAqB;IACnB,wBAAwB,MAAM;IAC9B,yBAAyB,MAAM;;GAElC,CAAC;;;AAIN,SAAS,uBAGP,OAAqE;;CACrE,MAAM,WAAW,MAAM,uBAAuB;CAC9C,MAAM,qCAAW,MAAM,MAAM,0FAAU,KAAK;CAE5C,IAAI,CAAC,SAAS,KAAK,UAAU,sDAAC,SAAU,SAAQ;EAC9C,SAAS,KAAK,SAAS,QAAQ;GAC7B,IAAI,QAAQ;GACZ,IAAI,WAAW;IACf;EACF,OAAO;;CAIT,MAAM,mBAAmB,SAAS,QAAQ,aACxC,gBAAgB,OAAO,SAAS,CACjC;CAED,MAAM,kBAC0B,EAAE;CAClC,MAAM,kBAAyD,EAAE;CAGjE,MAAM,sBACJ,MACA,QAAQ,GACR,aACG;EAGH,IAAI,SAAS,iBAAiB,QAC5B,OAAO,KAAK,KAAK,QAAQ;GACvB,IAAI,QAAQ;GAEZ,gBAAgB,KAAK,IAAI;GACzB,gBAAgB,IAAI,MAAM;GAE1B,IAAI,IAAI,QAAQ,QACd,IAAI,UAAU,mBAAmB,IAAI,SAAS,QAAQ,GAAG,IAAI,GAAG;GAGlE,OAAO;IACP;EAGJ,MAAM,WAAW,iBAAiB;EAGlC,MAAM,eAAe,QAAQ,MAAM,SAAS;EAmF5C,OAhF8B,MAAM,KAAK,aAAa,SAAS,CAAC,CAAC,KAC9D,CAAC,eAAe,cAAc,UAAU;GACvC,IAAI,KAAK,GAAG,SAAS,GAAG;GACxB,KAAK,WAAW,GAAG,SAAS,GAAG,OAAO;GAGtC,MAAM,UAAU,mBAAmB,aAAa,QAAQ,GAAG,GAAG;GAE9D,QAAQ,SAAS,WAAW;IAC1B,OAAO,WAAW;KAClB;GAGF,MAAM,WAAW,QACb,UAAU,cAAc,QAAQ,IAAI,QAAQ,GAC5C;GAEJ,MAAM,MAAM,aACV,OACA,IACA,SAAS,GAAI,UACb,OACA,OACA,QACA,SACD;GAED,OAAO,OAAO,KAAK;IACjB,kBAAkB;IAClB;IACA;IACA;IACA,WAAW,UAAkB;;KAE3B,IAAI,iBAAiB,SAAS,MAAM,EAAE;MACpC,IAAI,IAAI,aAAa,eAAe,MAAM,EACxC,OAAO,IAAI,aAAa;MAG1B,IAAI,YAAY,IACd,IAAI,aAAa,SACf,YAAY,GAAG,SAAS,MAAM,IAAI;MAGtC,OAAO,IAAI,aAAa;;KAG1B,6BAAI,IAAI,oGAAsB,eAAe,MAAM,EACjD,OAAO,IAAI,qBAAqB;KAKlC,MAAM,cAAc,wBADL,MAAM,UAAU,MAEvB,CACP;KAED,IAAI,CAAC,IAAI,sBAAsB,IAAI,uBAAuB,EAAE;KAE5D,IAAI,aAAa;MACf,IAAI,qBAAqB,SAAS,YAChC,OACA,UACA,YACD;MAED,OAAO,IAAI,qBAAqB;;;IAGrC,CAAC;GAEF,QAAQ,SAAS,WAAW;IAC1B,gBAAgB,KAAK,OAAO;IAC5B,gBAAgB,OAAO,MAAM;KAC7B;GAEF,OAAO;IAIiB;;CAG9B,MAAM,cAAc,mBAAmB,SAAS,MAAM,EAAE;CAExD,YAAY,SAAS,WAAW;EAC9B,gBAAgB,KAAK,OAAO;EAC5B,gBAAgB,OAAO,MAAM;GAC7B;CAEF,OAAO;EACL,MAAM;EACN,UAAU;EACV,UAAU;EACX;;AAGH,SAAS,QACP,MACA,UACA;CACA,MAAM,2BAAW,IAAI,KAAwC;CAE7D,OAAO,KAAK,QAAQ,KAAK,QAAQ;EAC/B,MAAM,SAAS,GAAG,qBAAqB,KAAK,SAAS;EACrD,MAAM,WAAW,IAAI,IAAI,OAAO;EAChC,IAAI,CAAC,UACH,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC;OAEtB,SAAS,KAAK,IAAI;EAEpB,OAAO;IACN,SAAS"}

package/dist/features/column-ordering/columnOrderingFeature.cjs

@@ -2,6 +2,11 @@ const require_utils = require('../../utils.cjs');
 const require_columnOrderingFeature_utils = require('./columnOrderingFeature.utils.cjs');
 
 //#region src/features/column-ordering/columnOrderingFeature.ts
+/**
+* Creates the stock column ordering feature.
+*
+* The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+*/
 function constructColumnOrderingFeature() {
 	return {
 		getInitialState: (initialState) => {
@@ -18,12 +23,13 @@ function constructColumnOrderingFeature() {
 				column_getIndex: {
 					fn: (column, position) => require_columnOrderingFeature_utils.column_getIndex(column, position),
 					memoDeps: (column, position) => {
-						var _column$table$atoms$c, _column$table$atoms$c2, _column$table$atoms$g;
+						var _column$table$atoms$c, _column$table$atoms$c2, _column$table$atoms$g, _column$table$atoms$c3;
 						return [
 							position,
 							(_column$table$atoms$c = column.table.atoms.columnOrder) === null || _column$table$atoms$c === void 0 ? void 0 : _column$table$atoms$c.get(),
 							(_column$table$atoms$c2 = column.table.atoms.columnPinning) === null || _column$table$atoms$c2 === void 0 ? void 0 : _column$table$atoms$c2.get(),
-							(_column$table$atoms$g = column.table.atoms.grouping) === null || _column$table$atoms$g === void 0 ? void 0 : _column$table$atoms$g.get()
+							(_column$table$atoms$g = column.table.atoms.grouping) === null || _column$table$atoms$g === void 0 ? void 0 : _column$table$atoms$g.get(),
+							(_column$table$atoms$c3 = column.table.atoms.columnVisibility) === null || _column$table$atoms$c3 === void 0 ? void 0 : _column$table$atoms$c3.get()
 						];
 					}
 				},
@@ -51,7 +57,10 @@ function constructColumnOrderingFeature() {
 	};
 }
 /**
-* The Column Ordering feature adds column ordering state and APIs to the table and column objects.
+* The stock column ordering feature.
+*
+* Register this feature to add column order state and APIs for deriving the
+* ordered leaf column list alongside grouping and pinning.
 */
 const columnOrderingFeature = constructColumnOrderingFeature();
 

package/dist/features/column-ordering/columnOrderingFeature.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"columnOrderingFeature.cjs","names":["getDefaultColumnOrderState","makeStateUpdater","column_getIndex","column_getIsFirstColumn","column_getIsLastColumn","table_setColumnOrder","table_resetColumnOrder","table_getOrderColumnsFn"],"sources":["../../../src/features/column-ordering/columnOrderingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getIndex,\n  column_getIsFirstColumn,\n  column_getIsLastColumn,\n  getDefaultColumnOrderState,\n  table_getOrderColumnsFn,\n  table_resetColumnOrder,\n  table_setColumnOrder,\n} from './columnOrderingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Column_ColumnOrdering,\n//   TableOptions_ColumnOrdering,\n//   TableState_ColumnOrdering,\n//   Table_ColumnOrdering,\n// } from './columnOrderingFeature.types'\n\nexport interface ColumnOrderingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_ColumnOrdering\n  // Table: Table_ColumnOrdering<TFeatures, TData>\n  // TableOptions: TableOptions_ColumnOrdering\n  // TableState: TableState_ColumnOrdering\n}\n\nexport function constructColumnOrderingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnOrderingFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        columnOrder: getDefaultColumnOrderState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onColumnOrderChange: makeStateUpdater('columnOrder', table),\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnOrderingFeature', prototype, table, {\n        column_getIndex: {\n          fn: (column, position) => column_getIndex(column, position),\n          memoDeps: (column, position) => [\n            position,\n            column.table.atoms.columnOrder?.get(),\n            column.table.atoms.columnPinning?.get(),\n            column.table.atoms.grouping?.get(),\n          ],\n        },\n        column_getIsFirstColumn: {\n          fn: (column, position) => column_getIsFirstColumn(column, position),\n        },\n        column_getIsLastColumn: {\n          fn: (column, position) => column_getIsLastColumn(column, position),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnOrderingFeature', table, {\n        table_setColumnOrder: {\n          fn: (updater) => table_setColumnOrder(table, updater),\n        },\n        table_resetColumnOrder: {\n          fn: (defaultState) => table_resetColumnOrder(table, defaultState),\n        },\n        table_getOrderColumnsFn: {\n          fn: () => table_getOrderColumnsFn(table),\n          memoDeps: () => [\n            table.atoms.columnOrder?.get(),\n            table.atoms.grouping?.get(),\n            table.options.groupedColumnMode,\n          ],\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Column Ordering feature adds column ordering state and APIs to the table and column objects.\n */\nexport const columnOrderingFeature = constructColumnOrderingFeature()\n"],"mappings":";;;;AAiCA,SAAgB,iCAGuD;AACrE,QAAO;EACL,kBAAkB,iBAAiB;AACjC,UAAO;IACL,aAAaA,gEAA4B;IACzC,GAAG;IACJ;;EAGH,yBAAyB,UAAU;AACjC,UAAO,EACL,qBAAqBC,+BAAiB,eAAe,MAAM,EAC5D;;EAGH,wBAAwB,WAAW,UAAU;AAC3C,qCAAoB,yBAAyB,WAAW,OAAO;IAC7D,iBAAiB;KACf,KAAK,QAAQ,aAAaC,oDAAgB,QAAQ,SAAS;KAC3D,WAAW,QAAQ,aAAa;;;OAC9B;gCACA,OAAO,MAAM,MAAM,2FAAa,KAAK;iCACrC,OAAO,MAAM,MAAM,+FAAe,KAAK;gCACvC,OAAO,MAAM,MAAM,wFAAU,KAAK;OACnC;;KACF;IACD,yBAAyB,EACvB,KAAK,QAAQ,aAAaC,4DAAwB,QAAQ,SAAS,EACpE;IACD,wBAAwB,EACtB,KAAK,QAAQ,aAAaC,2DAAuB,QAAQ,SAAS,EACnE;IACF,CAAC;;EAGJ,qBAAqB,UAAU;AAC7B,iCAAgB,yBAAyB,OAAO;IAC9C,sBAAsB,EACpB,KAAK,YAAYC,yDAAqB,OAAO,QAAQ,EACtD;IACD,wBAAwB,EACtB,KAAK,iBAAiBC,2DAAuB,OAAO,aAAa,EAClE;IACD,yBAAyB;KACvB,UAAUC,4DAAwB,MAAM;KACxC,gBAAgB;;;gCACd,MAAM,MAAM,2FAAa,KAAK;gCAC9B,MAAM,MAAM,wFAAU,KAAK;OAC3B,MAAM,QAAQ;OACf;;KACF;IACF,CAAC;;EAEL;;;;;AAMH,MAAa,wBAAwB,gCAAgC"}
+{"version":3,"file":"columnOrderingFeature.cjs","names":["getDefaultColumnOrderState","makeStateUpdater","column_getIndex","column_getIsFirstColumn","column_getIsLastColumn","table_setColumnOrder","table_resetColumnOrder","table_getOrderColumnsFn"],"sources":["../../../src/features/column-ordering/columnOrderingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getIndex,\n  column_getIsFirstColumn,\n  column_getIsLastColumn,\n  getDefaultColumnOrderState,\n  table_getOrderColumnsFn,\n  table_resetColumnOrder,\n  table_setColumnOrder,\n} from './columnOrderingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Column_ColumnOrdering,\n//   TableOptions_ColumnOrdering,\n//   TableState_ColumnOrdering,\n//   Table_ColumnOrdering,\n// } from './columnOrderingFeature.types'\n\nexport interface ColumnOrderingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_ColumnOrdering\n  // Table: Table_ColumnOrdering<TFeatures, TData>\n  // TableOptions: TableOptions_ColumnOrdering\n  // TableState: TableState_ColumnOrdering\n}\n\n/**\n * Creates the stock column ordering feature.\n *\n * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.\n */\nexport function constructColumnOrderingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnOrderingFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        columnOrder: getDefaultColumnOrderState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onColumnOrderChange: makeStateUpdater('columnOrder', table),\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnOrderingFeature', prototype, table, {\n        column_getIndex: {\n          fn: (column, position) => column_getIndex(column, position),\n          memoDeps: (column, position) => [\n            position,\n            column.table.atoms.columnOrder?.get(),\n            column.table.atoms.columnPinning?.get(),\n            column.table.atoms.grouping?.get(),\n            column.table.atoms.columnVisibility?.get(),\n          ],\n        },\n        column_getIsFirstColumn: {\n          fn: (column, position) => column_getIsFirstColumn(column, position),\n        },\n        column_getIsLastColumn: {\n          fn: (column, position) => column_getIsLastColumn(column, position),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnOrderingFeature', table, {\n        table_setColumnOrder: {\n          fn: (updater) => table_setColumnOrder(table, updater),\n        },\n        table_resetColumnOrder: {\n          fn: (defaultState) => table_resetColumnOrder(table, defaultState),\n        },\n        table_getOrderColumnsFn: {\n          fn: () => table_getOrderColumnsFn(table),\n          memoDeps: () => [\n            table.atoms.columnOrder?.get(),\n            table.atoms.grouping?.get(),\n            table.options.groupedColumnMode,\n          ],\n        },\n      })\n    },\n  }\n}\n\n/**\n * The stock column ordering feature.\n *\n * Register this feature to add column order state and APIs for deriving the\n * ordered leaf column list alongside grouping and pinning.\n */\nexport const columnOrderingFeature = constructColumnOrderingFeature()\n"],"mappings":";;;;;;;;;AAsCA,SAAgB,iCAGuD;CACrE,OAAO;EACL,kBAAkB,iBAAiB;GACjC,OAAO;IACL,aAAaA,gEAA4B;IACzC,GAAG;IACJ;;EAGH,yBAAyB,UAAU;GACjC,OAAO,EACL,qBAAqBC,+BAAiB,eAAe,MAAM,EAC5D;;EAGH,wBAAwB,WAAW,UAAU;GAC3C,kCAAoB,yBAAyB,WAAW,OAAO;IAC7D,iBAAiB;KACf,KAAK,QAAQ,aAAaC,oDAAgB,QAAQ,SAAS;KAC3D,WAAW,QAAQ,aAAa;;;OAC9B;gCACA,OAAO,MAAM,MAAM,2FAAa,KAAK;iCACrC,OAAO,MAAM,MAAM,+FAAe,KAAK;gCACvC,OAAO,MAAM,MAAM,wFAAU,KAAK;iCAClC,OAAO,MAAM,MAAM,kGAAkB,KAAK;OAC3C;;KACF;IACD,yBAAyB,EACvB,KAAK,QAAQ,aAAaC,4DAAwB,QAAQ,SAAS,EACpE;IACD,wBAAwB,EACtB,KAAK,QAAQ,aAAaC,2DAAuB,QAAQ,SAAS,EACnE;IACF,CAAC;;EAGJ,qBAAqB,UAAU;GAC7B,8BAAgB,yBAAyB,OAAO;IAC9C,sBAAsB,EACpB,KAAK,YAAYC,yDAAqB,OAAO,QAAQ,EACtD;IACD,wBAAwB,EACtB,KAAK,iBAAiBC,2DAAuB,OAAO,aAAa,EAClE;IACD,yBAAyB;KACvB,UAAUC,4DAAwB,MAAM;KACxC,gBAAgB;;;gCACd,MAAM,MAAM,2FAAa,KAAK;gCAC9B,MAAM,MAAM,wFAAU,KAAK;OAC3B,MAAM,QAAQ;OACf;;KACF;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,wBAAwB,gCAAgC"}

package/dist/features/column-ordering/columnOrderingFeature.d.cts

@@ -3,9 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.cjs";
 
 //#region src/features/column-ordering/columnOrderingFeature.d.ts
 interface ColumnOrderingFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock column ordering feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructColumnOrderingFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<ColumnOrderingFeatureConstructors<TFeatures, TData>>;
 /**
- * The Column Ordering feature adds column ordering state and APIs to the table and column objects.
+ * The stock column ordering feature.
+ *
+ * Register this feature to add column order state and APIs for deriving the
+ * ordered leaf column list alongside grouping and pinning.
  */
 declare const columnOrderingFeature: TableFeature<ColumnOrderingFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

package/dist/features/column-ordering/columnOrderingFeature.d.ts

@@ -3,9 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.js";
 
 //#region src/features/column-ordering/columnOrderingFeature.d.ts
 interface ColumnOrderingFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock column ordering feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructColumnOrderingFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<ColumnOrderingFeatureConstructors<TFeatures, TData>>;
 /**
- * The Column Ordering feature adds column ordering state and APIs to the table and column objects.
+ * The stock column ordering feature.
+ *
+ * Register this feature to add column order state and APIs for deriving the
+ * ordered leaf column list alongside grouping and pinning.
  */
 declare const columnOrderingFeature: TableFeature<ColumnOrderingFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

package/dist/features/column-ordering/columnOrderingFeature.js

@@ -2,6 +2,11 @@ import { assignPrototypeAPIs, assignTableAPIs, makeStateUpdater } from "../../ut
 import { column_getIndex, column_getIsFirstColumn, column_getIsLastColumn, getDefaultColumnOrderState, table_getOrderColumnsFn, table_resetColumnOrder, table_setColumnOrder } from "./columnOrderingFeature.utils.js";
 
 //#region src/features/column-ordering/columnOrderingFeature.ts
+/**
+* Creates the stock column ordering feature.
+*
+* The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+*/
 function constructColumnOrderingFeature() {
 	return {
 		getInitialState: (initialState) => {
@@ -18,12 +23,13 @@ function constructColumnOrderingFeature() {
 				column_getIndex: {
 					fn: (column, position) => column_getIndex(column, position),
 					memoDeps: (column, position) => {
-						var _column$table$atoms$c, _column$table$atoms$c2, _column$table$atoms$g;
+						var _column$table$atoms$c, _column$table$atoms$c2, _column$table$atoms$g, _column$table$atoms$c3;
 						return [
 							position,
 							(_column$table$atoms$c = column.table.atoms.columnOrder) === null || _column$table$atoms$c === void 0 ? void 0 : _column$table$atoms$c.get(),
 							(_column$table$atoms$c2 = column.table.atoms.columnPinning) === null || _column$table$atoms$c2 === void 0 ? void 0 : _column$table$atoms$c2.get(),
-							(_column$table$atoms$g = column.table.atoms.grouping) === null || _column$table$atoms$g === void 0 ? void 0 : _column$table$atoms$g.get()
+							(_column$table$atoms$g = column.table.atoms.grouping) === null || _column$table$atoms$g === void 0 ? void 0 : _column$table$atoms$g.get(),
+							(_column$table$atoms$c3 = column.table.atoms.columnVisibility) === null || _column$table$atoms$c3 === void 0 ? void 0 : _column$table$atoms$c3.get()
 						];
 					}
 				},
@@ -51,7 +57,10 @@ function constructColumnOrderingFeature() {
 	};
 }
 /**
-* The Column Ordering feature adds column ordering state and APIs to the table and column objects.
+* The stock column ordering feature.
+*
+* Register this feature to add column order state and APIs for deriving the
+* ordered leaf column list alongside grouping and pinning.
 */
 const columnOrderingFeature = constructColumnOrderingFeature();
 

package/dist/features/column-ordering/columnOrderingFeature.js.map

@@ -1 +1 @@
-{"version":3,"file":"columnOrderingFeature.js","names":[],"sources":["../../../src/features/column-ordering/columnOrderingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getIndex,\n  column_getIsFirstColumn,\n  column_getIsLastColumn,\n  getDefaultColumnOrderState,\n  table_getOrderColumnsFn,\n  table_resetColumnOrder,\n  table_setColumnOrder,\n} from './columnOrderingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Column_ColumnOrdering,\n//   TableOptions_ColumnOrdering,\n//   TableState_ColumnOrdering,\n//   Table_ColumnOrdering,\n// } from './columnOrderingFeature.types'\n\nexport interface ColumnOrderingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_ColumnOrdering\n  // Table: Table_ColumnOrdering<TFeatures, TData>\n  // TableOptions: TableOptions_ColumnOrdering\n  // TableState: TableState_ColumnOrdering\n}\n\nexport function constructColumnOrderingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnOrderingFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        columnOrder: getDefaultColumnOrderState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onColumnOrderChange: makeStateUpdater('columnOrder', table),\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnOrderingFeature', prototype, table, {\n        column_getIndex: {\n          fn: (column, position) => column_getIndex(column, position),\n          memoDeps: (column, position) => [\n            position,\n            column.table.atoms.columnOrder?.get(),\n            column.table.atoms.columnPinning?.get(),\n            column.table.atoms.grouping?.get(),\n          ],\n        },\n        column_getIsFirstColumn: {\n          fn: (column, position) => column_getIsFirstColumn(column, position),\n        },\n        column_getIsLastColumn: {\n          fn: (column, position) => column_getIsLastColumn(column, position),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnOrderingFeature', table, {\n        table_setColumnOrder: {\n          fn: (updater) => table_setColumnOrder(table, updater),\n        },\n        table_resetColumnOrder: {\n          fn: (defaultState) => table_resetColumnOrder(table, defaultState),\n        },\n        table_getOrderColumnsFn: {\n          fn: () => table_getOrderColumnsFn(table),\n          memoDeps: () => [\n            table.atoms.columnOrder?.get(),\n            table.atoms.grouping?.get(),\n            table.options.groupedColumnMode,\n          ],\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Column Ordering feature adds column ordering state and APIs to the table and column objects.\n */\nexport const columnOrderingFeature = constructColumnOrderingFeature()\n"],"mappings":";;;;AAiCA,SAAgB,iCAGuD;AACrE,QAAO;EACL,kBAAkB,iBAAiB;AACjC,UAAO;IACL,aAAa,4BAA4B;IACzC,GAAG;IACJ;;EAGH,yBAAyB,UAAU;AACjC,UAAO,EACL,qBAAqB,iBAAiB,eAAe,MAAM,EAC5D;;EAGH,wBAAwB,WAAW,UAAU;AAC3C,uBAAoB,yBAAyB,WAAW,OAAO;IAC7D,iBAAiB;KACf,KAAK,QAAQ,aAAa,gBAAgB,QAAQ,SAAS;KAC3D,WAAW,QAAQ,aAAa;;;OAC9B;gCACA,OAAO,MAAM,MAAM,2FAAa,KAAK;iCACrC,OAAO,MAAM,MAAM,+FAAe,KAAK;gCACvC,OAAO,MAAM,MAAM,wFAAU,KAAK;OACnC;;KACF;IACD,yBAAyB,EACvB,KAAK,QAAQ,aAAa,wBAAwB,QAAQ,SAAS,EACpE;IACD,wBAAwB,EACtB,KAAK,QAAQ,aAAa,uBAAuB,QAAQ,SAAS,EACnE;IACF,CAAC;;EAGJ,qBAAqB,UAAU;AAC7B,mBAAgB,yBAAyB,OAAO;IAC9C,sBAAsB,EACpB,KAAK,YAAY,qBAAqB,OAAO,QAAQ,EACtD;IACD,wBAAwB,EACtB,KAAK,iBAAiB,uBAAuB,OAAO,aAAa,EAClE;IACD,yBAAyB;KACvB,UAAU,wBAAwB,MAAM;KACxC,gBAAgB;;;gCACd,MAAM,MAAM,2FAAa,KAAK;gCAC9B,MAAM,MAAM,wFAAU,KAAK;OAC3B,MAAM,QAAQ;OACf;;KACF;IACF,CAAC;;EAEL;;;;;AAMH,MAAa,wBAAwB,gCAAgC"}
+{"version":3,"file":"columnOrderingFeature.js","names":[],"sources":["../../../src/features/column-ordering/columnOrderingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getIndex,\n  column_getIsFirstColumn,\n  column_getIsLastColumn,\n  getDefaultColumnOrderState,\n  table_getOrderColumnsFn,\n  table_resetColumnOrder,\n  table_setColumnOrder,\n} from './columnOrderingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Column_ColumnOrdering,\n//   TableOptions_ColumnOrdering,\n//   TableState_ColumnOrdering,\n//   Table_ColumnOrdering,\n// } from './columnOrderingFeature.types'\n\nexport interface ColumnOrderingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_ColumnOrdering\n  // Table: Table_ColumnOrdering<TFeatures, TData>\n  // TableOptions: TableOptions_ColumnOrdering\n  // TableState: TableState_ColumnOrdering\n}\n\n/**\n * Creates the stock column ordering feature.\n *\n * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.\n */\nexport function constructColumnOrderingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnOrderingFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        columnOrder: getDefaultColumnOrderState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onColumnOrderChange: makeStateUpdater('columnOrder', table),\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnOrderingFeature', prototype, table, {\n        column_getIndex: {\n          fn: (column, position) => column_getIndex(column, position),\n          memoDeps: (column, position) => [\n            position,\n            column.table.atoms.columnOrder?.get(),\n            column.table.atoms.columnPinning?.get(),\n            column.table.atoms.grouping?.get(),\n            column.table.atoms.columnVisibility?.get(),\n          ],\n        },\n        column_getIsFirstColumn: {\n          fn: (column, position) => column_getIsFirstColumn(column, position),\n        },\n        column_getIsLastColumn: {\n          fn: (column, position) => column_getIsLastColumn(column, position),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnOrderingFeature', table, {\n        table_setColumnOrder: {\n          fn: (updater) => table_setColumnOrder(table, updater),\n        },\n        table_resetColumnOrder: {\n          fn: (defaultState) => table_resetColumnOrder(table, defaultState),\n        },\n        table_getOrderColumnsFn: {\n          fn: () => table_getOrderColumnsFn(table),\n          memoDeps: () => [\n            table.atoms.columnOrder?.get(),\n            table.atoms.grouping?.get(),\n            table.options.groupedColumnMode,\n          ],\n        },\n      })\n    },\n  }\n}\n\n/**\n * The stock column ordering feature.\n *\n * Register this feature to add column order state and APIs for deriving the\n * ordered leaf column list alongside grouping and pinning.\n */\nexport const columnOrderingFeature = constructColumnOrderingFeature()\n"],"mappings":";;;;;;;;;AAsCA,SAAgB,iCAGuD;CACrE,OAAO;EACL,kBAAkB,iBAAiB;GACjC,OAAO;IACL,aAAa,4BAA4B;IACzC,GAAG;IACJ;;EAGH,yBAAyB,UAAU;GACjC,OAAO,EACL,qBAAqB,iBAAiB,eAAe,MAAM,EAC5D;;EAGH,wBAAwB,WAAW,UAAU;GAC3C,oBAAoB,yBAAyB,WAAW,OAAO;IAC7D,iBAAiB;KACf,KAAK,QAAQ,aAAa,gBAAgB,QAAQ,SAAS;KAC3D,WAAW,QAAQ,aAAa;;;OAC9B;gCACA,OAAO,MAAM,MAAM,2FAAa,KAAK;iCACrC,OAAO,MAAM,MAAM,+FAAe,KAAK;gCACvC,OAAO,MAAM,MAAM,wFAAU,KAAK;iCAClC,OAAO,MAAM,MAAM,kGAAkB,KAAK;OAC3C;;KACF;IACD,yBAAyB,EACvB,KAAK,QAAQ,aAAa,wBAAwB,QAAQ,SAAS,EACpE;IACD,wBAAwB,EACtB,KAAK,QAAQ,aAAa,uBAAuB,QAAQ,SAAS,EACnE;IACF,CAAC;;EAGJ,qBAAqB,UAAU;GAC7B,gBAAgB,yBAAyB,OAAO;IAC9C,sBAAsB,EACpB,KAAK,YAAY,qBAAqB,OAAO,QAAQ,EACtD;IACD,wBAAwB,EACtB,KAAK,iBAAiB,uBAAuB,OAAO,aAAa,EAClE;IACD,yBAAyB;KACvB,UAAU,wBAAwB,MAAM;KACxC,gBAAgB;;;gCACd,MAAM,MAAM,2FAAa,KAAK;gCAC9B,MAAM,MAAM,wFAAU,KAAK;OAC3B,MAAM,QAAQ;OACf;;KACF;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,wBAAwB,gCAAgC"}

package/dist/features/column-ordering/columnOrderingFeature.types.d.cts

@@ -9,7 +9,9 @@ interface TableState_ColumnOrdering {
 }
 interface TableOptions_ColumnOrdering {
   /**
-   * If provided, this function will be called with an `updaterFn` when `state.columnOrder` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.
+   * Called with an updater when column order state changes. Pair this with
+   * `state.columnOrder` when using external state; external atoms can own the
+   * slice without this callback.
    */
   onColumnOrderChange?: OnChangeFn<ColumnOrderState>;
 }
@@ -36,7 +38,7 @@ interface Table_ColumnOrdering<TFeatures extends TableFeatures, TData extends Ro
    */
   resetColumnOrder: (defaultState?: boolean) => void;
   /**
-   * Sets or updates the `state.columnOrder` state.
+   * Sets column order state using a value or updater.
    */
   setColumnOrder: (updater: Updater<ColumnOrderState>) => void;
 }