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

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

@@ -107,7 +107,9 @@ interface TableOptions_ColumnFiltering<TFeatures extends TableFeatures, TData ex
      */
   maxLeafRowFilterDepth?: number;
   /**
-   * If provided, this function will be called with an `updaterFn` when `state.columnFilters` 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 filter state changes. Pair this with
+   * `state.columnFilters` when using external state; external atoms can own the
+   * slice without this callback.
    */
   onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>;
 }
@@ -117,7 +119,7 @@ interface Table_ColumnFiltering {
    */
   resetColumnFilters: (defaultState?: boolean) => void;
   /**
-   * Sets or updates the `state.columnFilters` state.
+   * Sets column filter state using a value or updater.
    */
   setColumnFilters: (updater: Updater<ColumnFiltersState>) => void;
 }
@@ -133,9 +135,10 @@ interface Table_RowModels_Filtered<TFeatures extends TableFeatures, TData extend
 }
 interface CreateRowModel_Filtered<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * If provided, this function is called **once** per table and should return a **new function** which will calculate and return the row model for the table when it's filtered.
+   * If provided, this factory is called once per table and should return a
+   * function that calculates the filtered row model.
    * - For server-side filtering, this function is unnecessary and can be ignored since the server should already return the filtered row model.
-   * - For client-side filtering, this function is required. A default implementation is provided via any table adapter's `{ getFilteredRowModel }` export.
+   * - For client-side filtering, pass the exported `createFilteredRowModel()` or implement your own factory.
    */
   filteredRowModel?: (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData>;
 }

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

@@ -1,9 +1,29 @@
 const require_utils = require('../../utils.cjs');
 
 //#region src/features/column-filtering/columnFilteringFeature.utils.ts
+/**
+* Returns the default column filters state.
+*
+* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+*
+* @example
+* ```ts
+* const initialValue = getDefaultColumnFiltersState()
+* ```
+*/
 function getDefaultColumnFiltersState() {
 	return [];
 }
+/**
+* Infers filter fn for a column.
+*
+* The inference uses the column definition, table options, and sampled row values when needed.
+*
+* @example
+* ```ts
+* const value = column_getAutoFilterFn(column)
+* ```
+*/
 function column_getAutoFilterFn(column) {
 	const filterFns = column.table._rowModelFns.filterFns;
 	const firstRow = column.table.getCoreRowModel().flatRows[0];
@@ -15,6 +35,16 @@ function column_getAutoFilterFn(column) {
 	if (Array.isArray(value)) return filterFns === null || filterFns === void 0 ? void 0 : filterFns.arrIncludes;
 	return filterFns === null || filterFns === void 0 ? void 0 : filterFns.weakEquals;
 }
+/**
+* Returns filter 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_getFilterFn(column)
+* ```
+*/
 function column_getFilterFn(column) {
 	let filterFn = null;
 	const filterFns = column.table._rowModelFns.filterFns;
@@ -22,20 +52,70 @@ function column_getFilterFn(column) {
 	if (process.env.NODE_ENV === "development" && !filterFn) console.warn(`Could not find a valid 'column.filterFn' for column with the ID: ${column.id}.`);
 	return filterFn;
 }
+/**
+* Returns whether a column can use filter.
+*
+* This combines column options, table options, and any required accessor or feature state for the capability.
+*
+* @example
+* ```ts
+* const value = 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.
+*
+* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+*
+* @example
+* ```ts
+* const value = column_getIsFiltered(column)
+* ```
+*/
 function column_getIsFiltered(column) {
 	return column_getFilterIndex(column) > -1;
 }
+/**
+* Returns filter value 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_getFilterValue(column)
+* ```
+*/
 function column_getFilterValue(column) {
 	var _column$table$atoms$c;
 	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.
+*
+* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+*
+* @example
+* ```ts
+* const value = column_getFilterIndex(column)
+* ```
+*/
 function column_getFilterIndex(column) {
 	var _column$table$atoms$c2;
 	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.
+*
+* This delegates to the owning table state updater so external state, external atoms, and internal state stay synchronized.
+*
+* @example
+* ```ts
+* column_setFilterValue(column, (old) => old)
+* ```
+*/
 function column_setFilterValue(column, value) {
 	table_setColumnFilters(column.table, (old) => {
 		const filterFn = column_getFilterFn(column);
@@ -54,12 +134,22 @@ function column_setFilterValue(column, value) {
 		return [newFilterObj];
 	});
 }
+/**
+* Updates the table's column filters state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setColumnFilters(table, (old) => old)
+* ```
+*/
 function table_setColumnFilters(table, updater) {
 	var _table$options$onColu, _table$options;
-	const leafColumns = table.getAllLeafColumns();
+	const leafColumnsById = table.getAllLeafColumnsById();
 	const updateFn = (old) => {
 		return require_utils.functionalUpdate(updater, old).filter((filter) => {
-			const column = leafColumns.find((d) => d.id === filter.id);
+			const column = leafColumnsById[filter.id];
 			if (column) {
 				if (shouldAutoRemoveFilter(column_getFilterFn(column), filter.value, column)) return false;
 			}
@@ -68,9 +158,30 @@ 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.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @example
+* ```ts
+* table_resetColumnFilters(table)
+* table_resetColumnFilters(table, true)
+* ```
+*/
 function table_resetColumnFilters(table, defaultState) {
 	table_setColumnFilters(table, defaultState ? [] : require_utils.cloneState(table.initialState.columnFilters ?? []));
 }
+/**
+* Returns whether a filter value should be removed from filter state.
+*
+* This checks the filter function's `autoRemove` hook and built-in empty-value rules.
+*
+* @example
+* ```ts
+* const removeFilter = shouldAutoRemoveFilter(filterFn, value, column)
+* ```
+*/
 function shouldAutoRemoveFilter(filterFn, value, column) {
 	return (filterFn && filterFn.autoRemove ? filterFn.autoRemove(value, column) : false) || typeof value === "undefined" || typeof value === "string" && !value;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"columnFilteringFeature.utils.cjs","names":["isFunction","functionalUpdate","cloneState"],"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\nexport function getDefaultColumnFiltersState(): ColumnFiltersState {\n  return []\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\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\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\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\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\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\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\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 leafColumns = table.getAllLeafColumns()\n\n  const updateFn = (old: ColumnFiltersState) => {\n    return functionalUpdate(updater, old).filter((filter) => {\n      const column = leafColumns.find((d) => d.id === 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\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\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":";;;AAUA,SAAgB,+BAAmD;AACjE,QAAO,EAAE;;AAGX,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;AAExD,KAAI,OAAO,UAAU,SACnB,8DAAO,UAAW;AAGpB,KAAI,OAAO,UAAU,SACnB,8DAAO,UAAW;AAGpB,KAAI,OAAO,UAAU,UACnB,8DAAO,UAAW;AAGpB,KAAI,UAAU,QAAQ,OAAO,UAAU,SACrC,8DAAO,UAAW;AAGpB,KAAI,MAAM,QAAQ,MAAM,CACtB,8DAAO,UAAW;AAGpB,8DAAO,UAAW;;AAGpB,SAAgB,mBAKd,QACwC;CACxC,IAAI,WAAW;CACf,MAAM,YACJ,OAAO,MAAM,aAAa;AAC5B,YAAWA,yBAAW,OAAO,UAAU,SAAS,GAC5C,OAAO,UAAU,WACjB,OAAO,UAAU,aAAa,SAC5B,uBAAuB,OAAO,yDAC9B,UAAY,OAAO,UAAU;AAEnC,KAAI,QAAQ,IAAI,aAAa,iBAAiB,CAAC,SAC7C,SAAQ,KACN,oEAAoE,OAAO,GAAG,GAC/E;AAGH,QAAO;;AAGT,SAAgB,oBAId,QAAmD;AACnD,SACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,uBAAuB,UAC5C,OAAO,MAAM,QAAQ,iBAAiB,SACvC,CAAC,CAAC,OAAO;;AAIb,SAAgB,qBAId,QAAmD;AACnD,QAAO,sBAAsB,OAAO,GAAG;;AAGzC,SAAgB,sBAId,QAAmD;;AACnD,iCAAO,OAAO,MAAM,MAAM,8GACtB,KAAK,iGACL,MAAM,MAAM,EAAE,OAAO,OAAO,GAAG,gFAAE;;AAGvC,SAAgB,sBAId,QAA2D;;AAC3D,mCACE,OAAO,MAAM,MAAM,iHACf,KAAK,kFACL,WAAW,MAAM,EAAE,OAAO,OAAO,GAAG,KAAI;;AAIhD,SAAgB,sBAId,QAAmD,OAAY;AAC/D,wBAAuB,OAAO,QAAQ,QAAQ;EAC5C,MAAM,WAAW,mBAAmB,OAAO;EAC3C,MAAM,iBAAiB,IAAI,MAAM,MAAM,EAAE,OAAO,OAAO,GAAG;EAE1D,MAAM,YAAYC,+BAChB,OACA,iBAAiB,eAAe,QAAQ,OACzC;AAED,MAAI,uBAAuB,UAAU,WAAW,OAAO,CACrD,QAAO,IAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,GAAG;EAG9C,MAAM,eAAe;GAAE,IAAI,OAAO;GAAI,OAAO;GAAW;AAExD,MAAI,eACF,QAAO,IAAI,KAAK,MAAM;AACpB,OAAI,EAAE,OAAO,OAAO,GAClB,QAAO;AAET,UAAO;IACP;AAGJ,MAAI,IAAI,OACN,QAAO,CAAC,GAAG,KAAK,aAAa;AAG/B,SAAO,CAAC,aAAa;GACrB;;AAGJ,SAAgB,uBAId,OACA,SACA;;CACA,MAAM,cAAc,MAAM,mBAAmB;CAE7C,MAAM,YAAY,QAA4B;AAC5C,SAAOA,+BAAiB,SAAS,IAAI,CAAC,QAAQ,WAAW;GACvD,MAAM,SAAS,YAAY,MAAM,MAAM,EAAE,OAAO,OAAO,GAAG;AAE1D,OAAI,QAGF;QAAI,uBAFa,mBAAmB,OAED,EAAE,OAAO,OAAO,OAAO,CACxD,QAAO;;AAIX,UAAO;IACP;;AAGJ,kDAAM,SAAQ,kHAAwB,SAAS;;AAGjD,SAAgB,yBAGd,OAAyC,cAAwB;AACjE,wBACE,OACA,eAAe,EAAE,GAAGC,yBAAW,MAAM,aAAa,iBAAiB,EAAE,CAAC,CACvE;;AAGH,SAAgB,uBAKd,UACA,OACA,QACA;AACA,SACG,YAAY,SAAS,aAClB,SAAS,WAAW,OAAO,OAAO,GAClC,UACJ,OAAO,UAAU,eAChB,OAAO,UAAU,YAAY,CAAC"}
+{"version":3,"file":"columnFilteringFeature.utils.cjs","names":["isFunction","functionalUpdate","cloneState"],"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,WAAWA,yBAAW,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,YAAYC,+BAChB,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,OAAOA,+BAAiB,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,GAAGC,yBAAW,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-filtering/columnFilteringFeature.utils.d.cts

@@ -5,16 +5,127 @@ import { TableFeatures } from "../../types/TableFeatures.cjs";
 import { Table_Internal } from "../../types/Table.cjs";
 
 //#region src/features/column-filtering/columnFilteringFeature.utils.d.ts
+/**
+ * Returns the default column filters state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultColumnFiltersState()
+ * ```
+ */
 declare function getDefaultColumnFiltersState(): ColumnFiltersState;
+/**
+ * Infers filter fn for a column.
+ *
+ * The inference uses the column definition, table options, and sampled row values when needed.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * This combines column options, table options, and any required accessor or feature state for the capability.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getFilterValue(column)
+ * ```
+ */
 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.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * This delegates to the owning table state updater so external state, external atoms, and internal state stay synchronized.
+ *
+ * @example
+ * ```ts
+ * column_setFilterValue(column, (old) => old)
+ * ```
+ */
 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.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setColumnFilters(table, (old) => old)
+ * ```
+ */
 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.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetColumnFilters(table)
+ * table_resetColumnFilters(table, true)
+ * ```
+ */
 declare function table_resetColumnFilters<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Returns whether a filter value should be removed from filter state.
+ *
+ * This checks the filter function's `autoRemove` hook and built-in empty-value rules.
+ *
+ * @example
+ * ```ts
+ * const removeFilter = shouldAutoRemoveFilter(filterFn, value, column)
+ * ```
+ */
 declare function shouldAutoRemoveFilter<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(filterFn?: FilterFn<TFeatures, TData>, value?: any, column?: Column_Internal<TFeatures, TData, TValue>): boolean;
 //#endregion
 export { column_getAutoFilterFn, column_getCanFilter, column_getFilterFn, column_getFilterIndex, column_getFilterValue, column_getIsFiltered, column_setFilterValue, getDefaultColumnFiltersState, shouldAutoRemoveFilter, table_resetColumnFilters, table_setColumnFilters };

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

@@ -5,16 +5,127 @@ import { TableFeatures } from "../../types/TableFeatures.js";
 import { Table_Internal } from "../../types/Table.js";
 
 //#region src/features/column-filtering/columnFilteringFeature.utils.d.ts
+/**
+ * Returns the default column filters state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultColumnFiltersState()
+ * ```
+ */
 declare function getDefaultColumnFiltersState(): ColumnFiltersState;
+/**
+ * Infers filter fn for a column.
+ *
+ * The inference uses the column definition, table options, and sampled row values when needed.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * This combines column options, table options, and any required accessor or feature state for the capability.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getFilterValue(column)
+ * ```
+ */
 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.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * This delegates to the owning table state updater so external state, external atoms, and internal state stay synchronized.
+ *
+ * @example
+ * ```ts
+ * column_setFilterValue(column, (old) => old)
+ * ```
+ */
 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.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setColumnFilters(table, (old) => old)
+ * ```
+ */
 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.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetColumnFilters(table)
+ * table_resetColumnFilters(table, true)
+ * ```
+ */
 declare function table_resetColumnFilters<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Returns whether a filter value should be removed from filter state.
+ *
+ * This checks the filter function's `autoRemove` hook and built-in empty-value rules.
+ *
+ * @example
+ * ```ts
+ * const removeFilter = shouldAutoRemoveFilter(filterFn, value, column)
+ * ```
+ */
 declare function shouldAutoRemoveFilter<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(filterFn?: FilterFn<TFeatures, TData>, value?: any, column?: Column_Internal<TFeatures, TData, TValue>): boolean;
 //#endregion
 export { column_getAutoFilterFn, column_getCanFilter, column_getFilterFn, column_getFilterIndex, column_getFilterValue, column_getIsFiltered, column_setFilterValue, getDefaultColumnFiltersState, shouldAutoRemoveFilter, table_resetColumnFilters, table_setColumnFilters };

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

@@ -1,9 +1,29 @@
 import { cloneState, functionalUpdate, isFunction } from "../../utils.js";
 
 //#region src/features/column-filtering/columnFilteringFeature.utils.ts
+/**
+* Returns the default column filters state.
+*
+* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+*
+* @example
+* ```ts
+* const initialValue = getDefaultColumnFiltersState()
+* ```
+*/
 function getDefaultColumnFiltersState() {
 	return [];
 }
+/**
+* Infers filter fn for a column.
+*
+* The inference uses the column definition, table options, and sampled row values when needed.
+*
+* @example
+* ```ts
+* const value = column_getAutoFilterFn(column)
+* ```
+*/
 function column_getAutoFilterFn(column) {
 	const filterFns = column.table._rowModelFns.filterFns;
 	const firstRow = column.table.getCoreRowModel().flatRows[0];
@@ -15,6 +35,16 @@ function column_getAutoFilterFn(column) {
 	if (Array.isArray(value)) return filterFns === null || filterFns === void 0 ? void 0 : filterFns.arrIncludes;
 	return filterFns === null || filterFns === void 0 ? void 0 : filterFns.weakEquals;
 }
+/**
+* Returns filter 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_getFilterFn(column)
+* ```
+*/
 function column_getFilterFn(column) {
 	let filterFn = null;
 	const filterFns = column.table._rowModelFns.filterFns;
@@ -22,20 +52,70 @@ function column_getFilterFn(column) {
 	if (process.env.NODE_ENV === "development" && !filterFn) console.warn(`Could not find a valid 'column.filterFn' for column with the ID: ${column.id}.`);
 	return filterFn;
 }
+/**
+* Returns whether a column can use filter.
+*
+* This combines column options, table options, and any required accessor or feature state for the capability.
+*
+* @example
+* ```ts
+* const value = 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.
+*
+* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+*
+* @example
+* ```ts
+* const value = column_getIsFiltered(column)
+* ```
+*/
 function column_getIsFiltered(column) {
 	return column_getFilterIndex(column) > -1;
 }
+/**
+* Returns filter value 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_getFilterValue(column)
+* ```
+*/
 function column_getFilterValue(column) {
 	var _column$table$atoms$c;
 	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.
+*
+* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+*
+* @example
+* ```ts
+* const value = column_getFilterIndex(column)
+* ```
+*/
 function column_getFilterIndex(column) {
 	var _column$table$atoms$c2;
 	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.
+*
+* This delegates to the owning table state updater so external state, external atoms, and internal state stay synchronized.
+*
+* @example
+* ```ts
+* column_setFilterValue(column, (old) => old)
+* ```
+*/
 function column_setFilterValue(column, value) {
 	table_setColumnFilters(column.table, (old) => {
 		const filterFn = column_getFilterFn(column);
@@ -54,12 +134,22 @@ function column_setFilterValue(column, value) {
 		return [newFilterObj];
 	});
 }
+/**
+* Updates the table's column filters state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setColumnFilters(table, (old) => old)
+* ```
+*/
 function table_setColumnFilters(table, updater) {
 	var _table$options$onColu, _table$options;
-	const leafColumns = table.getAllLeafColumns();
+	const leafColumnsById = table.getAllLeafColumnsById();
 	const updateFn = (old) => {
 		return functionalUpdate(updater, old).filter((filter) => {
-			const column = leafColumns.find((d) => d.id === filter.id);
+			const column = leafColumnsById[filter.id];
 			if (column) {
 				if (shouldAutoRemoveFilter(column_getFilterFn(column), filter.value, column)) return false;
 			}
@@ -68,9 +158,30 @@ 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.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @example
+* ```ts
+* table_resetColumnFilters(table)
+* table_resetColumnFilters(table, true)
+* ```
+*/
 function table_resetColumnFilters(table, defaultState) {
 	table_setColumnFilters(table, defaultState ? [] : cloneState(table.initialState.columnFilters ?? []));
 }
+/**
+* Returns whether a filter value should be removed from filter state.
+*
+* This checks the filter function's `autoRemove` hook and built-in empty-value rules.
+*
+* @example
+* ```ts
+* const removeFilter = shouldAutoRemoveFilter(filterFn, value, column)
+* ```
+*/
 function shouldAutoRemoveFilter(filterFn, value, column) {
 	return (filterFn && filterFn.autoRemove ? filterFn.autoRemove(value, column) : false) || typeof value === "undefined" || typeof value === "string" && !value;
 }