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

package/dist/features/column-filtering/columnFilteringFeature.utils.d.ts

@@ -6,64 +6,71 @@ import { Table_Internal } from "../../types/Table.js";
 
 //#region src/features/column-filtering/columnFilteringFeature.utils.d.ts
 /**
- * Returns the default column filters state.
+ * Creates the default column filter state.
  *
- * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ * The feature default is an empty array, meaning no column filters are active.
+ * Reset APIs use this value when `defaultState` is `true`.
  *
  * @example
  * ```ts
- * const initialValue = getDefaultColumnFiltersState()
+ * const filters = getDefaultColumnFiltersState()
  * ```
  */
 declare function getDefaultColumnFiltersState(): ColumnFiltersState;
 /**
- * Infers filter fn for a column.
+ * Chooses a built-in filter function from the column's first core row value.
  *
- * The inference uses the column definition, table options, and sampled row values when needed.
+ * Strings use `includesString`, numbers use `inNumberRange`, booleans and
+ * objects use `equals`, arrays use `arrIncludes`, and unknown values fall back
+ * to `weakEquals`.
  *
  * @example
  * ```ts
- * const value = column_getAutoFilterFn(column)
+ * const filterFn = column_getAutoFilterFn(column)
  * ```
  */
 declare function column_getAutoFilterFn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): FilterFn<TFeatures, TData> | undefined;
 /**
- * Returns filter fn for a column.
+ * Resolves the filter function configured for a column.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * Function-valued `columnDef.filterFn` is returned directly, `'auto'` delegates
+ * to `column_getAutoFilterFn`, and string values are looked up in the table's
+ * filter function registry.
  *
  * @example
  * ```ts
- * const value = column_getFilterFn(column)
+ * const filterFn = column_getFilterFn(column)
  * ```
  */
 declare function column_getFilterFn<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): FilterFn<TFeatures, TData> | undefined;
 /**
- * Returns whether a column can use filter.
+ * Checks whether column filtering is enabled for this accessor column.
  *
- * This combines column options, table options, and any required accessor or feature state for the capability.
+ * The column must have an accessor and filtering must be enabled by the column
+ * definition, `enableColumnFilters`, and the table-wide `enableFilters` option.
  *
  * @example
  * ```ts
- * const value = column_getCanFilter(column)
+ * const canFilter = column_getCanFilter(column)
  * ```
  */
 declare function column_getCanFilter<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
 /**
- * Returns is filtered for a column.
+ * Checks whether this column currently has an entry in `state.columnFilters`.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * This only reflects filter state presence; it does not indicate whether the
+ * filter removes any rows.
  *
  * @example
  * ```ts
- * const value = column_getIsFiltered(column)
+ * const isFiltered = column_getIsFiltered(column)
  * ```
  */
 declare function column_getIsFiltered<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
 /**
- * Returns filter value for a column.
+ * Reads this column's current filter value from `state.columnFilters`.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * Missing filter entries return `undefined`.
  *
  * @example
  * ```ts
@@ -72,42 +79,46 @@ declare function column_getIsFiltered<TFeatures extends TableFeatures, TData ext
  */
 declare function column_getFilterValue<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): unknown;
 /**
- * Returns filter index for a column.
+ * Finds this column's position in the ordered `state.columnFilters` array.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * The result is `-1` when the column has no active filter.
  *
  * @example
  * ```ts
- * const value = column_getFilterIndex(column)
+ * const index = column_getFilterIndex(column)
  * ```
  */
 declare function column_getFilterIndex<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): number;
 /**
- * Updates filter value for a column.
+ * Adds, updates, or removes this column's filter value.
  *
- * This delegates to the owning table state updater so external state, external atoms, and internal state stay synchronized.
+ * The incoming value may be an updater. After resolution, `autoRemove` rules
+ * decide whether the filter should be removed instead of stored.
  *
  * @example
  * ```ts
- * column_setFilterValue(column, (old) => old)
+ * column_setFilterValue(column, (old) => String(old ?? '').trim())
  * ```
  */
 declare function column_setFilterValue<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, value: any): void;
 /**
- * Updates the table's column filters state slice.
+ * Routes a column filter updater through the table's filter change handler.
  *
- * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ * The resolved filters are cleaned before they are emitted: filters for known
+ * columns are removed when their filter function says the value should be
+ * auto-removed.
  *
  * @example
  * ```ts
- * table_setColumnFilters(table, (old) => old)
+ * table_setColumnFilters(table, (old) => old.filter((filter) => filter.id !== 'age'))
  * ```
  */
 declare function table_setColumnFilters<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<ColumnFiltersState>): void;
 /**
- * Resets the table's column filters state slice.
+ * Resets `columnFilters` to the configured initial state or feature default.
  *
- * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ * With no argument, the reset clones `table.initialState.columnFilters` when it
+ * exists. Passing `true` ignores initial state and resets to `[]`.
  *
  * @example
  * ```ts

package/dist/features/column-filtering/columnFilteringFeature.utils.js

@@ -2,26 +2,29 @@ import { cloneState, functionalUpdate, isFunction } from "../../utils.js";
 
 //#region src/features/column-filtering/columnFilteringFeature.utils.ts
 /**
-* Returns the default column filters state.
+* Creates the default column filter state.
 *
-* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+* The feature default is an empty array, meaning no column filters are active.
+* Reset APIs use this value when `defaultState` is `true`.
 *
 * @example
 * ```ts
-* const initialValue = getDefaultColumnFiltersState()
+* const filters = getDefaultColumnFiltersState()
 * ```
 */
 function getDefaultColumnFiltersState() {
 	return [];
 }
 /**
-* Infers filter fn for a column.
+* Chooses a built-in filter function from the column's first core row value.
 *
-* The inference uses the column definition, table options, and sampled row values when needed.
+* Strings use `includesString`, numbers use `inNumberRange`, booleans and
+* objects use `equals`, arrays use `arrIncludes`, and unknown values fall back
+* to `weakEquals`.
 *
 * @example
 * ```ts
-* const value = column_getAutoFilterFn(column)
+* const filterFn = column_getAutoFilterFn(column)
 * ```
 */
 function column_getAutoFilterFn(column) {
@@ -36,13 +39,15 @@ function column_getAutoFilterFn(column) {
 	return filterFns === null || filterFns === void 0 ? void 0 : filterFns.weakEquals;
 }
 /**
-* Returns filter fn for a column.
+* Resolves the filter function configured for a column.
 *
-* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+* Function-valued `columnDef.filterFn` is returned directly, `'auto'` delegates
+* to `column_getAutoFilterFn`, and string values are looked up in the table's
+* filter function registry.
 *
 * @example
 * ```ts
-* const value = column_getFilterFn(column)
+* const filterFn = column_getFilterFn(column)
 * ```
 */
 function column_getFilterFn(column) {
@@ -53,35 +58,37 @@ function column_getFilterFn(column) {
 	return filterFn;
 }
 /**
-* Returns whether a column can use filter.
+* Checks whether column filtering is enabled for this accessor column.
 *
-* This combines column options, table options, and any required accessor or feature state for the capability.
+* The column must have an accessor and filtering must be enabled by the column
+* definition, `enableColumnFilters`, and the table-wide `enableFilters` option.
 *
 * @example
 * ```ts
-* const value = column_getCanFilter(column)
+* const canFilter = column_getCanFilter(column)
 * ```
 */
 function column_getCanFilter(column) {
 	return (column.columnDef.enableColumnFilter ?? true) && (column.table.options.enableColumnFilters ?? true) && (column.table.options.enableFilters ?? true) && !!column.accessorFn;
 }
 /**
-* Returns is filtered for a column.
+* Checks whether this column currently has an entry in `state.columnFilters`.
 *
-* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+* This only reflects filter state presence; it does not indicate whether the
+* filter removes any rows.
 *
 * @example
 * ```ts
-* const value = column_getIsFiltered(column)
+* const isFiltered = column_getIsFiltered(column)
 * ```
 */
 function column_getIsFiltered(column) {
 	return column_getFilterIndex(column) > -1;
 }
 /**
-* Returns filter value for a column.
+* Reads this column's current filter value from `state.columnFilters`.
 *
-* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+* Missing filter entries return `undefined`.
 *
 * @example
 * ```ts
@@ -93,13 +100,13 @@ function column_getFilterValue(column) {
 	return (_column$table$atoms$c = column.table.atoms.columnFilters) === null || _column$table$atoms$c === void 0 || (_column$table$atoms$c = _column$table$atoms$c.get()) === null || _column$table$atoms$c === void 0 || (_column$table$atoms$c = _column$table$atoms$c.find((d) => d.id === column.id)) === null || _column$table$atoms$c === void 0 ? void 0 : _column$table$atoms$c.value;
 }
 /**
-* Returns filter index for a column.
+* Finds this column's position in the ordered `state.columnFilters` array.
 *
-* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+* The result is `-1` when the column has no active filter.
 *
 * @example
 * ```ts
-* const value = column_getFilterIndex(column)
+* const index = column_getFilterIndex(column)
 * ```
 */
 function column_getFilterIndex(column) {
@@ -107,13 +114,14 @@ function column_getFilterIndex(column) {
 	return ((_column$table$atoms$c2 = column.table.atoms.columnFilters) === null || _column$table$atoms$c2 === void 0 || (_column$table$atoms$c2 = _column$table$atoms$c2.get()) === null || _column$table$atoms$c2 === void 0 ? void 0 : _column$table$atoms$c2.findIndex((d) => d.id === column.id)) ?? -1;
 }
 /**
-* Updates filter value for a column.
+* Adds, updates, or removes this column's filter value.
 *
-* This delegates to the owning table state updater so external state, external atoms, and internal state stay synchronized.
+* The incoming value may be an updater. After resolution, `autoRemove` rules
+* decide whether the filter should be removed instead of stored.
 *
 * @example
 * ```ts
-* column_setFilterValue(column, (old) => old)
+* column_setFilterValue(column, (old) => String(old ?? '').trim())
 * ```
 */
 function column_setFilterValue(column, value) {
@@ -135,13 +143,15 @@ function column_setFilterValue(column, value) {
 	});
 }
 /**
-* Updates the table's column filters state slice.
+* Routes a column filter updater through the table's filter change handler.
 *
-* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+* The resolved filters are cleaned before they are emitted: filters for known
+* columns are removed when their filter function says the value should be
+* auto-removed.
 *
 * @example
 * ```ts
-* table_setColumnFilters(table, (old) => old)
+* table_setColumnFilters(table, (old) => old.filter((filter) => filter.id !== 'age'))
 * ```
 */
 function table_setColumnFilters(table, updater) {
@@ -159,9 +169,10 @@ function table_setColumnFilters(table, updater) {
 	(_table$options$onColu = (_table$options = table.options).onColumnFiltersChange) === null || _table$options$onColu === void 0 || _table$options$onColu.call(_table$options, updateFn);
 }
 /**
-* Resets the table's column filters state slice.
+* Resets `columnFilters` to the configured initial state or feature default.
 *
-* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+* With no argument, the reset clones `table.initialState.columnFilters` when it
+* exists. Passing `true` ignores initial state and resets to `[]`.
 *
 * @example
 * ```ts

package/dist/features/column-filtering/columnFilteringFeature.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"columnFilteringFeature.utils.js","names":[],"sources":["../../../src/features/column-filtering/columnFilteringFeature.utils.ts"],"sourcesContent":["import { cloneState, functionalUpdate, isFunction } from '../../utils'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Column_Internal } from '../../types/Column'\nimport type {\n  ColumnFiltersState,\n  FilterFn,\n} from './columnFilteringFeature.types'\n\n/**\n * Returns the default column filters 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 = getDefaultColumnFiltersState()\n * ```\n */\nexport function getDefaultColumnFiltersState(): ColumnFiltersState {\n  return []\n}\n\n/**\n * Infers filter 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_getAutoFilterFn(column)\n * ```\n */\nexport function column_getAutoFilterFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n    column.table._rowModelFns.filterFns\n\n  const firstRow = column.table.getCoreRowModel().flatRows[0]\n\n  const value = firstRow ? firstRow.getValue(column.id) : undefined\n\n  if (typeof value === 'string') {\n    return filterFns?.includesString\n  }\n\n  if (typeof value === 'number') {\n    return filterFns?.inNumberRange\n  }\n\n  if (typeof value === 'boolean') {\n    return filterFns?.equals\n  }\n\n  if (value !== null && typeof value === 'object') {\n    return filterFns?.equals\n  }\n\n  if (Array.isArray(value)) {\n    return filterFns?.arrIncludes\n  }\n\n  return filterFns?.weakEquals\n}\n\n/**\n * Returns filter 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_getFilterFn(column)\n * ```\n */\nexport function column_getFilterFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(\n  column: Column_Internal<TFeatures, TData, TValue>,\n): FilterFn<TFeatures, TData> | undefined {\n  let filterFn = null\n  const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n    column.table._rowModelFns.filterFns\n  filterFn = isFunction(column.columnDef.filterFn)\n    ? column.columnDef.filterFn\n    : column.columnDef.filterFn === 'auto'\n      ? column_getAutoFilterFn(column)\n      : filterFns?.[column.columnDef.filterFn as string]\n\n  if (process.env.NODE_ENV === 'development' && !filterFn) {\n    console.warn(\n      `Could not find a valid 'column.filterFn' for column with the ID: ${column.id}.`,\n    )\n  }\n\n  return filterFn\n}\n\n/**\n * Returns whether a column can use filter.\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_getCanFilter(column)\n * ```\n */\nexport function column_getCanFilter<\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.enableColumnFilter ?? true) &&\n    (column.table.options.enableColumnFilters ?? true) &&\n    (column.table.options.enableFilters ?? true) &&\n    !!column.accessorFn\n  )\n}\n\n/**\n * Returns is filtered 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_getIsFiltered(column)\n * ```\n */\nexport function column_getIsFiltered<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return column_getFilterIndex(column) > -1\n}\n\n/**\n * Returns filter value 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_getFilterValue(column)\n * ```\n */\nexport function column_getFilterValue<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return column.table.atoms.columnFilters\n    ?.get()\n    ?.find((d) => d.id === column.id)?.value\n}\n\n/**\n * Returns filter 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_getFilterIndex(column)\n * ```\n */\nexport function column_getFilterIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): number {\n  return (\n    column.table.atoms.columnFilters\n      ?.get()\n      ?.findIndex((d) => d.id === column.id) ?? -1\n  )\n}\n\n/**\n * Updates filter value for a column.\n *\n * This delegates to the owning table state updater so external state, external atoms, and internal state stay synchronized.\n *\n * @example\n * ```ts\n * column_setFilterValue(column, (old) => old)\n * ```\n */\nexport function column_setFilterValue<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>, value: any) {\n  table_setColumnFilters(column.table, (old) => {\n    const filterFn = column_getFilterFn(column)\n    const previousFilter = old.find((d) => d.id === column.id)\n\n    const newFilter = functionalUpdate(\n      value,\n      previousFilter ? previousFilter.value : undefined,\n    )\n\n    if (shouldAutoRemoveFilter(filterFn, newFilter, column)) {\n      return old.filter((d) => d.id !== column.id)\n    }\n\n    const newFilterObj = { id: column.id, value: newFilter }\n\n    if (previousFilter) {\n      return old.map((d) => {\n        if (d.id === column.id) {\n          return newFilterObj\n        }\n        return d\n      })\n    }\n\n    if (old.length) {\n      return [...old, newFilterObj]\n    }\n\n    return [newFilterObj]\n  })\n}\n\n/**\n * Updates the table's column filters 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_setColumnFilters(table, (old) => old)\n * ```\n */\nexport function table_setColumnFilters<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<ColumnFiltersState>,\n) {\n  const leafColumnsById = table.getAllLeafColumnsById()\n\n  const updateFn = (old: ColumnFiltersState) => {\n    return functionalUpdate(updater, old).filter((filter) => {\n      const column = leafColumnsById[filter.id]\n\n      if (column) {\n        const filterFn = column_getFilterFn(column)\n\n        if (shouldAutoRemoveFilter(filterFn, filter.value, column)) {\n          return false\n        }\n      }\n\n      return true\n    })\n  }\n\n  table.options.onColumnFiltersChange?.(updateFn)\n}\n\n/**\n * Resets the table's column filters 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_resetColumnFilters(table)\n * table_resetColumnFilters(table, true)\n * ```\n */\nexport function table_resetColumnFilters<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setColumnFilters(\n    table,\n    defaultState ? [] : cloneState(table.initialState.columnFilters ?? []),\n  )\n}\n\n/**\n * Returns whether a filter value should be removed from filter state.\n *\n * This checks the filter function's `autoRemove` hook and built-in empty-value rules.\n *\n * @example\n * ```ts\n * const removeFilter = shouldAutoRemoveFilter(filterFn, value, column)\n * ```\n */\nexport function shouldAutoRemoveFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(\n  filterFn?: FilterFn<TFeatures, TData>,\n  value?: any,\n  column?: Column_Internal<TFeatures, TData, TValue>,\n) {\n  return (\n    (filterFn && filterFn.autoRemove\n      ? filterFn.autoRemove(value, column)\n      : false) ||\n    typeof value === 'undefined' ||\n    (typeof value === 'string' && !value)\n  )\n}\n"],"mappings":";;;;;;;;;;;;;AAoBA,SAAgB,+BAAmD;CACjE,OAAO,EAAE;;;;;;;;;;;;AAaX,SAAgB,uBAId,QAAmD;CACnD,MAAM,YACJ,OAAO,MAAM,aAAa;CAE5B,MAAM,WAAW,OAAO,MAAM,iBAAiB,CAAC,SAAS;CAEzD,MAAM,QAAQ,WAAW,SAAS,SAAS,OAAO,GAAG,GAAG;CAExD,IAAI,OAAO,UAAU,UACnB,6DAAO,UAAW;CAGpB,IAAI,OAAO,UAAU,UACnB,6DAAO,UAAW;CAGpB,IAAI,OAAO,UAAU,WACnB,6DAAO,UAAW;CAGpB,IAAI,UAAU,QAAQ,OAAO,UAAU,UACrC,6DAAO,UAAW;CAGpB,IAAI,MAAM,QAAQ,MAAM,EACtB,6DAAO,UAAW;CAGpB,6DAAO,UAAW;;;;;;;;;;;;AAapB,SAAgB,mBAKd,QACwC;CACxC,IAAI,WAAW;CACf,MAAM,YACJ,OAAO,MAAM,aAAa;CAC5B,WAAW,WAAW,OAAO,UAAU,SAAS,GAC5C,OAAO,UAAU,WACjB,OAAO,UAAU,aAAa,SAC5B,uBAAuB,OAAO,yDAC9B,UAAY,OAAO,UAAU;CAEnC,IAAI,QAAQ,IAAI,aAAa,iBAAiB,CAAC,UAC7C,QAAQ,KACN,oEAAoE,OAAO,GAAG,GAC/E;CAGH,OAAO;;;;;;;;;;;;AAaT,SAAgB,oBAId,QAAmD;CACnD,QACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,uBAAuB,UAC5C,OAAO,MAAM,QAAQ,iBAAiB,SACvC,CAAC,CAAC,OAAO;;;;;;;;;;;;AAcb,SAAgB,qBAId,QAAmD;CACnD,OAAO,sBAAsB,OAAO,GAAG;;;;;;;;;;;;AAazC,SAAgB,sBAId,QAAmD;;CACnD,gCAAO,OAAO,MAAM,MAAM,8GACtB,KAAK,iGACL,MAAM,MAAM,EAAE,OAAO,OAAO,GAAG,gFAAE;;;;;;;;;;;;AAavC,SAAgB,sBAId,QAA2D;;CAC3D,kCACE,OAAO,MAAM,MAAM,iHACf,KAAK,kFACL,WAAW,MAAM,EAAE,OAAO,OAAO,GAAG,KAAI;;;;;;;;;;;;AAchD,SAAgB,sBAId,QAAmD,OAAY;CAC/D,uBAAuB,OAAO,QAAQ,QAAQ;EAC5C,MAAM,WAAW,mBAAmB,OAAO;EAC3C,MAAM,iBAAiB,IAAI,MAAM,MAAM,EAAE,OAAO,OAAO,GAAG;EAE1D,MAAM,YAAY,iBAChB,OACA,iBAAiB,eAAe,QAAQ,OACzC;EAED,IAAI,uBAAuB,UAAU,WAAW,OAAO,EACrD,OAAO,IAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,GAAG;EAG9C,MAAM,eAAe;GAAE,IAAI,OAAO;GAAI,OAAO;GAAW;EAExD,IAAI,gBACF,OAAO,IAAI,KAAK,MAAM;GACpB,IAAI,EAAE,OAAO,OAAO,IAClB,OAAO;GAET,OAAO;IACP;EAGJ,IAAI,IAAI,QACN,OAAO,CAAC,GAAG,KAAK,aAAa;EAG/B,OAAO,CAAC,aAAa;GACrB;;;;;;;;;;;;AAaJ,SAAgB,uBAId,OACA,SACA;;CACA,MAAM,kBAAkB,MAAM,uBAAuB;CAErD,MAAM,YAAY,QAA4B;EAC5C,OAAO,iBAAiB,SAAS,IAAI,CAAC,QAAQ,WAAW;GACvD,MAAM,SAAS,gBAAgB,OAAO;GAEtC,IAAI,QAGF;QAAI,uBAFa,mBAAmB,OAED,EAAE,OAAO,OAAO,OAAO,EACxD,OAAO;;GAIX,OAAO;IACP;;CAGJ,iDAAM,SAAQ,kHAAwB,SAAS;;;;;;;;;;;;;AAcjD,SAAgB,yBAGd,OAAyC,cAAwB;CACjE,uBACE,OACA,eAAe,EAAE,GAAG,WAAW,MAAM,aAAa,iBAAiB,EAAE,CAAC,CACvE;;;;;;;;;;;;AAaH,SAAgB,uBAKd,UACA,OACA,QACA;CACA,QACG,YAAY,SAAS,aAClB,SAAS,WAAW,OAAO,OAAO,GAClC,UACJ,OAAO,UAAU,eAChB,OAAO,UAAU,YAAY,CAAC"}
+{"version":3,"file":"columnFilteringFeature.utils.js","names":[],"sources":["../../../src/features/column-filtering/columnFilteringFeature.utils.ts"],"sourcesContent":["import { cloneState, functionalUpdate, isFunction } from '../../utils'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Column_Internal } from '../../types/Column'\nimport type {\n  ColumnFiltersState,\n  FilterFn,\n} from './columnFilteringFeature.types'\n\n/**\n * Creates the default column filter state.\n *\n * The feature default is an empty array, meaning no column filters are active.\n * Reset APIs use this value when `defaultState` is `true`.\n *\n * @example\n * ```ts\n * const filters = getDefaultColumnFiltersState()\n * ```\n */\nexport function getDefaultColumnFiltersState(): ColumnFiltersState {\n  return []\n}\n\n/**\n * Chooses a built-in filter function from the column's first core row value.\n *\n * Strings use `includesString`, numbers use `inNumberRange`, booleans and\n * objects use `equals`, arrays use `arrIncludes`, and unknown values fall back\n * to `weakEquals`.\n *\n * @example\n * ```ts\n * const filterFn = column_getAutoFilterFn(column)\n * ```\n */\nexport function column_getAutoFilterFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n    column.table._rowModelFns.filterFns\n\n  const firstRow = column.table.getCoreRowModel().flatRows[0]\n\n  const value = firstRow ? firstRow.getValue(column.id) : undefined\n\n  if (typeof value === 'string') {\n    return filterFns?.includesString\n  }\n\n  if (typeof value === 'number') {\n    return filterFns?.inNumberRange\n  }\n\n  if (typeof value === 'boolean') {\n    return filterFns?.equals\n  }\n\n  if (value !== null && typeof value === 'object') {\n    return filterFns?.equals\n  }\n\n  if (Array.isArray(value)) {\n    return filterFns?.arrIncludes\n  }\n\n  return filterFns?.weakEquals\n}\n\n/**\n * Resolves the filter function configured for a column.\n *\n * Function-valued `columnDef.filterFn` is returned directly, `'auto'` delegates\n * to `column_getAutoFilterFn`, and string values are looked up in the table's\n * filter function registry.\n *\n * @example\n * ```ts\n * const filterFn = column_getFilterFn(column)\n * ```\n */\nexport function column_getFilterFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(\n  column: Column_Internal<TFeatures, TData, TValue>,\n): FilterFn<TFeatures, TData> | undefined {\n  let filterFn = null\n  const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n    column.table._rowModelFns.filterFns\n  filterFn = isFunction(column.columnDef.filterFn)\n    ? column.columnDef.filterFn\n    : column.columnDef.filterFn === 'auto'\n      ? column_getAutoFilterFn(column)\n      : filterFns?.[column.columnDef.filterFn as string]\n\n  if (process.env.NODE_ENV === 'development' && !filterFn) {\n    console.warn(\n      `Could not find a valid 'column.filterFn' for column with the ID: ${column.id}.`,\n    )\n  }\n\n  return filterFn\n}\n\n/**\n * Checks whether column filtering is enabled for this accessor column.\n *\n * The column must have an accessor and filtering must be enabled by the column\n * definition, `enableColumnFilters`, and the table-wide `enableFilters` option.\n *\n * @example\n * ```ts\n * const canFilter = column_getCanFilter(column)\n * ```\n */\nexport function column_getCanFilter<\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.enableColumnFilter ?? true) &&\n    (column.table.options.enableColumnFilters ?? true) &&\n    (column.table.options.enableFilters ?? true) &&\n    !!column.accessorFn\n  )\n}\n\n/**\n * Checks whether this column currently has an entry in `state.columnFilters`.\n *\n * This only reflects filter state presence; it does not indicate whether the\n * filter removes any rows.\n *\n * @example\n * ```ts\n * const isFiltered = column_getIsFiltered(column)\n * ```\n */\nexport function column_getIsFiltered<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return column_getFilterIndex(column) > -1\n}\n\n/**\n * Reads this column's current filter value from `state.columnFilters`.\n *\n * Missing filter entries return `undefined`.\n *\n * @example\n * ```ts\n * const value = column_getFilterValue(column)\n * ```\n */\nexport function column_getFilterValue<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return column.table.atoms.columnFilters\n    ?.get()\n    ?.find((d) => d.id === column.id)?.value\n}\n\n/**\n * Finds this column's position in the ordered `state.columnFilters` array.\n *\n * The result is `-1` when the column has no active filter.\n *\n * @example\n * ```ts\n * const index = column_getFilterIndex(column)\n * ```\n */\nexport function column_getFilterIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): number {\n  return (\n    column.table.atoms.columnFilters\n      ?.get()\n      ?.findIndex((d) => d.id === column.id) ?? -1\n  )\n}\n\n/**\n * Adds, updates, or removes this column's filter value.\n *\n * The incoming value may be an updater. After resolution, `autoRemove` rules\n * decide whether the filter should be removed instead of stored.\n *\n * @example\n * ```ts\n * column_setFilterValue(column, (old) => String(old ?? '').trim())\n * ```\n */\nexport function column_setFilterValue<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>, value: any) {\n  table_setColumnFilters(column.table, (old) => {\n    const filterFn = column_getFilterFn(column)\n    const previousFilter = old.find((d) => d.id === column.id)\n\n    const newFilter = functionalUpdate(\n      value,\n      previousFilter ? previousFilter.value : undefined,\n    )\n\n    if (shouldAutoRemoveFilter(filterFn, newFilter, column)) {\n      return old.filter((d) => d.id !== column.id)\n    }\n\n    const newFilterObj = { id: column.id, value: newFilter }\n\n    if (previousFilter) {\n      return old.map((d) => {\n        if (d.id === column.id) {\n          return newFilterObj\n        }\n        return d\n      })\n    }\n\n    if (old.length) {\n      return [...old, newFilterObj]\n    }\n\n    return [newFilterObj]\n  })\n}\n\n/**\n * Routes a column filter updater through the table's filter change handler.\n *\n * The resolved filters are cleaned before they are emitted: filters for known\n * columns are removed when their filter function says the value should be\n * auto-removed.\n *\n * @example\n * ```ts\n * table_setColumnFilters(table, (old) => old.filter((filter) => filter.id !== 'age'))\n * ```\n */\nexport function table_setColumnFilters<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<ColumnFiltersState>,\n) {\n  const leafColumnsById = table.getAllLeafColumnsById()\n\n  const updateFn = (old: ColumnFiltersState) => {\n    return functionalUpdate(updater, old).filter((filter) => {\n      const column = leafColumnsById[filter.id]\n\n      if (column) {\n        const filterFn = column_getFilterFn(column)\n\n        if (shouldAutoRemoveFilter(filterFn, filter.value, column)) {\n          return false\n        }\n      }\n\n      return true\n    })\n  }\n\n  table.options.onColumnFiltersChange?.(updateFn)\n}\n\n/**\n * Resets `columnFilters` to the configured initial state or feature default.\n *\n * With no argument, the reset clones `table.initialState.columnFilters` when it\n * exists. Passing `true` ignores initial state and resets to `[]`.\n *\n * @example\n * ```ts\n * table_resetColumnFilters(table)\n * table_resetColumnFilters(table, true)\n * ```\n */\nexport function table_resetColumnFilters<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setColumnFilters(\n    table,\n    defaultState ? [] : cloneState(table.initialState.columnFilters ?? []),\n  )\n}\n\n/**\n * Returns whether a filter value should be removed from filter state.\n *\n * This checks the filter function's `autoRemove` hook and built-in empty-value rules.\n *\n * @example\n * ```ts\n * const removeFilter = shouldAutoRemoveFilter(filterFn, value, column)\n * ```\n */\nexport function shouldAutoRemoveFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(\n  filterFn?: FilterFn<TFeatures, TData>,\n  value?: any,\n  column?: Column_Internal<TFeatures, TData, TValue>,\n) {\n  return (\n    (filterFn && filterFn.autoRemove\n      ? filterFn.autoRemove(value, column)\n      : false) ||\n    typeof value === 'undefined' ||\n    (typeof value === 'string' && !value)\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;AAqBA,SAAgB,+BAAmD;CACjE,OAAO,EAAE;;;;;;;;;;;;;;AAeX,SAAgB,uBAId,QAAmD;CACnD,MAAM,YACJ,OAAO,MAAM,aAAa;CAE5B,MAAM,WAAW,OAAO,MAAM,iBAAiB,CAAC,SAAS;CAEzD,MAAM,QAAQ,WAAW,SAAS,SAAS,OAAO,GAAG,GAAG;CAExD,IAAI,OAAO,UAAU,UACnB,6DAAO,UAAW;CAGpB,IAAI,OAAO,UAAU,UACnB,6DAAO,UAAW;CAGpB,IAAI,OAAO,UAAU,WACnB,6DAAO,UAAW;CAGpB,IAAI,UAAU,QAAQ,OAAO,UAAU,UACrC,6DAAO,UAAW;CAGpB,IAAI,MAAM,QAAQ,MAAM,EACtB,6DAAO,UAAW;CAGpB,6DAAO,UAAW;;;;;;;;;;;;;;AAepB,SAAgB,mBAKd,QACwC;CACxC,IAAI,WAAW;CACf,MAAM,YACJ,OAAO,MAAM,aAAa;CAC5B,WAAW,WAAW,OAAO,UAAU,SAAS,GAC5C,OAAO,UAAU,WACjB,OAAO,UAAU,aAAa,SAC5B,uBAAuB,OAAO,yDAC9B,UAAY,OAAO,UAAU;CAEnC,IAAI,QAAQ,IAAI,aAAa,iBAAiB,CAAC,UAC7C,QAAQ,KACN,oEAAoE,OAAO,GAAG,GAC/E;CAGH,OAAO;;;;;;;;;;;;;AAcT,SAAgB,oBAId,QAAmD;CACnD,QACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,uBAAuB,UAC5C,OAAO,MAAM,QAAQ,iBAAiB,SACvC,CAAC,CAAC,OAAO;;;;;;;;;;;;;AAeb,SAAgB,qBAId,QAAmD;CACnD,OAAO,sBAAsB,OAAO,GAAG;;;;;;;;;;;;AAazC,SAAgB,sBAId,QAAmD;;CACnD,gCAAO,OAAO,MAAM,MAAM,8GACtB,KAAK,iGACL,MAAM,MAAM,EAAE,OAAO,OAAO,GAAG,gFAAE;;;;;;;;;;;;AAavC,SAAgB,sBAId,QAA2D;;CAC3D,kCACE,OAAO,MAAM,MAAM,iHACf,KAAK,kFACL,WAAW,MAAM,EAAE,OAAO,OAAO,GAAG,KAAI;;;;;;;;;;;;;AAehD,SAAgB,sBAId,QAAmD,OAAY;CAC/D,uBAAuB,OAAO,QAAQ,QAAQ;EAC5C,MAAM,WAAW,mBAAmB,OAAO;EAC3C,MAAM,iBAAiB,IAAI,MAAM,MAAM,EAAE,OAAO,OAAO,GAAG;EAE1D,MAAM,YAAY,iBAChB,OACA,iBAAiB,eAAe,QAAQ,OACzC;EAED,IAAI,uBAAuB,UAAU,WAAW,OAAO,EACrD,OAAO,IAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,GAAG;EAG9C,MAAM,eAAe;GAAE,IAAI,OAAO;GAAI,OAAO;GAAW;EAExD,IAAI,gBACF,OAAO,IAAI,KAAK,MAAM;GACpB,IAAI,EAAE,OAAO,OAAO,IAClB,OAAO;GAET,OAAO;IACP;EAGJ,IAAI,IAAI,QACN,OAAO,CAAC,GAAG,KAAK,aAAa;EAG/B,OAAO,CAAC,aAAa;GACrB;;;;;;;;;;;;;;AAeJ,SAAgB,uBAId,OACA,SACA;;CACA,MAAM,kBAAkB,MAAM,uBAAuB;CAErD,MAAM,YAAY,QAA4B;EAC5C,OAAO,iBAAiB,SAAS,IAAI,CAAC,QAAQ,WAAW;GACvD,MAAM,SAAS,gBAAgB,OAAO;GAEtC,IAAI,QAGF;QAAI,uBAFa,mBAAmB,OAED,EAAE,OAAO,OAAO,OAAO,EACxD,OAAO;;GAIX,OAAO;IACP;;CAGJ,iDAAM,SAAQ,kHAAwB,SAAS;;;;;;;;;;;;;;AAejD,SAAgB,yBAGd,OAAyC,cAAwB;CACjE,uBACE,OACA,eAAe,EAAE,GAAG,WAAW,MAAM,aAAa,iBAAiB,EAAE,CAAC,CACvE;;;;;;;;;;;;AAaH,SAAgB,uBAKd,UACA,OACA,QACA;CACA,QACG,YAAY,SAAS,aAClB,SAAS,WAAW,OAAO,OAAO,GAClC,UACJ,OAAO,UAAU,eAChB,OAAO,UAAU,YAAY,CAAC"}

package/dist/features/column-grouping/columnGroupingFeature.types.d.cts

@@ -29,7 +29,9 @@ interface ColumnDef_ColumnGrouping<TFeatures extends TableFeatures, TData extend
    */
   aggregationFn?: AggregationFnOption<TFeatures, TData>;
   /**
-   * Enables/disables grouping for this column.
+   * Allows this column to be added to grouping state.
+   *
+   * Defaults to `true`; table-level `enableGrouping` must also allow grouping.
    */
   enableGrouping?: boolean;
   /**
@@ -47,15 +49,15 @@ interface Column_ColumnGrouping<TFeatures extends TableFeatures, TData extends R
    */
   getAutoAggregationFn: () => AggregationFn<TFeatures, TData> | undefined;
   /**
-   * Returns whether or not the column can be grouped.
+   * Checks whether this column can currently be grouped.
    */
   getCanGroup: () => boolean;
   /**
-   * Returns the index of the column in the grouping state.
+   * Finds this column's position in the ordered grouping state.
    */
   getGroupedIndex: () => number;
   /**
-   * Returns whether or not the column is currently grouped.
+   * Checks whether this column id is present in grouping state.
    */
   getIsGrouped: () => boolean;
   /**
@@ -70,11 +72,11 @@ interface Column_ColumnGrouping<TFeatures extends TableFeatures, TData extends R
 interface Row_ColumnGrouping {
   _groupingValuesCache: Record<string, any>;
   /**
-   * Returns the grouping value for any row and column (including leaf rows).
+   * Reads the value used to group this row for a column id.
    */
   getGroupingValue: (columnId: string) => unknown;
   /**
-   * Returns whether or not the row is currently grouped.
+   * Checks whether this row represents a grouped row.
    */
   getIsGrouped: () => boolean;
   /**
@@ -88,15 +90,15 @@ interface Row_ColumnGrouping {
 }
 interface Cell_ColumnGrouping {
   /**
-   * Returns whether or not the cell is currently aggregated.
+   * Checks whether this cell should render an aggregated value.
    */
   getIsAggregated: () => boolean;
   /**
-   * Returns whether or not the cell is currently grouped.
+   * Checks whether this cell represents the active grouping column.
    */
   getIsGrouped: () => boolean;
   /**
-   * Returns whether or not the cell is currently a placeholder cell.
+   * Checks whether this cell is hidden as a grouping placeholder.
    */
   getIsPlaceholder: () => boolean;
 }
@@ -106,7 +108,7 @@ interface ColumnDefaultOptions {
 }
 interface TableOptions_ColumnGrouping {
   /**
-   * Enables/disables grouping for the table.
+   * Allows columns to be grouped for this table.
    */
   enableGrouping?: boolean;
   /**
@@ -127,21 +129,23 @@ interface TableOptions_ColumnGrouping {
 type GroupingColumnMode = false | 'reorder' | 'remove';
 interface Table_ColumnGrouping<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Resets the **grouping** state to `initialState.grouping`, or `true` can be passed to force a default blank state reset to `[]`.
+   * Resets `grouping` to `initialState.grouping`.
+   *
+   * Pass `true` to ignore initial state and reset to `[]`.
    */
   resetGrouping: (defaultState?: boolean) => void;
   /**
-   * Sets grouping state using a value or updater.
+   * Updates grouping state with a next ordered id array or updater function.
    */
   setGrouping: (updater: Updater<GroupingState>) => void;
 }
 interface Table_RowModels_Grouped<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Returns the row model for the table after grouping has been applied.
+   * Resolves the row model after grouping and aggregation have been applied.
    */
   getGroupedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns the row model for the table before any grouping has been applied.
+   * Reads the row model immediately before grouping.
    */
   getPreGroupedRowModel: () => RowModel<TFeatures, TData>;
 }

package/dist/features/column-grouping/columnGroupingFeature.types.d.ts

@@ -29,7 +29,9 @@ interface ColumnDef_ColumnGrouping<TFeatures extends TableFeatures, TData extend
    */
   aggregationFn?: AggregationFnOption<TFeatures, TData>;
   /**
-   * Enables/disables grouping for this column.
+   * Allows this column to be added to grouping state.
+   *
+   * Defaults to `true`; table-level `enableGrouping` must also allow grouping.
    */
   enableGrouping?: boolean;
   /**
@@ -47,15 +49,15 @@ interface Column_ColumnGrouping<TFeatures extends TableFeatures, TData extends R
    */
   getAutoAggregationFn: () => AggregationFn<TFeatures, TData> | undefined;
   /**
-   * Returns whether or not the column can be grouped.
+   * Checks whether this column can currently be grouped.
    */
   getCanGroup: () => boolean;
   /**
-   * Returns the index of the column in the grouping state.
+   * Finds this column's position in the ordered grouping state.
    */
   getGroupedIndex: () => number;
   /**
-   * Returns whether or not the column is currently grouped.
+   * Checks whether this column id is present in grouping state.
    */
   getIsGrouped: () => boolean;
   /**
@@ -70,11 +72,11 @@ interface Column_ColumnGrouping<TFeatures extends TableFeatures, TData extends R
 interface Row_ColumnGrouping {
   _groupingValuesCache: Record<string, any>;
   /**
-   * Returns the grouping value for any row and column (including leaf rows).
+   * Reads the value used to group this row for a column id.
    */
   getGroupingValue: (columnId: string) => unknown;
   /**
-   * Returns whether or not the row is currently grouped.
+   * Checks whether this row represents a grouped row.
    */
   getIsGrouped: () => boolean;
   /**
@@ -88,15 +90,15 @@ interface Row_ColumnGrouping {
 }
 interface Cell_ColumnGrouping {
   /**
-   * Returns whether or not the cell is currently aggregated.
+   * Checks whether this cell should render an aggregated value.
    */
   getIsAggregated: () => boolean;
   /**
-   * Returns whether or not the cell is currently grouped.
+   * Checks whether this cell represents the active grouping column.
    */
   getIsGrouped: () => boolean;
   /**
-   * Returns whether or not the cell is currently a placeholder cell.
+   * Checks whether this cell is hidden as a grouping placeholder.
    */
   getIsPlaceholder: () => boolean;
 }
@@ -106,7 +108,7 @@ interface ColumnDefaultOptions {
 }
 interface TableOptions_ColumnGrouping {
   /**
-   * Enables/disables grouping for the table.
+   * Allows columns to be grouped for this table.
    */
   enableGrouping?: boolean;
   /**
@@ -127,21 +129,23 @@ interface TableOptions_ColumnGrouping {
 type GroupingColumnMode = false | 'reorder' | 'remove';
 interface Table_ColumnGrouping<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Resets the **grouping** state to `initialState.grouping`, or `true` can be passed to force a default blank state reset to `[]`.
+   * Resets `grouping` to `initialState.grouping`.
+   *
+   * Pass `true` to ignore initial state and reset to `[]`.
    */
   resetGrouping: (defaultState?: boolean) => void;
   /**
-   * Sets grouping state using a value or updater.
+   * Updates grouping state with a next ordered id array or updater function.
    */
   setGrouping: (updater: Updater<GroupingState>) => void;
 }
 interface Table_RowModels_Grouped<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Returns the row model for the table after grouping has been applied.
+   * Resolves the row model after grouping and aggregation have been applied.
    */
   getGroupedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns the row model for the table before any grouping has been applied.
+   * Reads the row model immediately before grouping.
    */
   getPreGroupedRowModel: () => RowModel<TFeatures, TData>;
 }