@tanstack/table-core 9.0.0-alpha.8 → 9.0.0-beta.10

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

@@ -0,0 +1,212 @@
+const require_utils = require('../../utils.cjs');
+
+//#region src/features/column-filtering/columnFilteringFeature.utils.ts
+/**
+* Creates the default column filter state.
+*
+* 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 filters = getDefaultColumnFiltersState()
+* ```
+*/
+function getDefaultColumnFiltersState() {
+	return [];
+}
+/**
+* Chooses a built-in filter function from the column's first core row value.
+*
+* Strings use `includesString`, numbers use `inNumberRange`, booleans and
+* objects use `equals`, arrays use `arrIncludes`, and unknown values fall back
+* to `weakEquals`.
+*
+* @example
+* ```ts
+* const filterFn = column_getAutoFilterFn(column)
+* ```
+*/
+function column_getAutoFilterFn(column) {
+	const filterFns = column.table._rowModelFns.filterFns;
+	const firstRow = column.table.getCoreRowModel().flatRows[0];
+	const value = firstRow ? firstRow.getValue(column.id) : void 0;
+	if (typeof value === "string") return filterFns === null || filterFns === void 0 ? void 0 : filterFns.includesString;
+	if (typeof value === "number") return filterFns === null || filterFns === void 0 ? void 0 : filterFns.inNumberRange;
+	if (typeof value === "boolean") return filterFns === null || filterFns === void 0 ? void 0 : filterFns.equals;
+	if (value !== null && typeof value === "object") return filterFns === null || filterFns === void 0 ? void 0 : filterFns.equals;
+	if (Array.isArray(value)) return filterFns === null || filterFns === void 0 ? void 0 : filterFns.arrIncludes;
+	return filterFns === null || filterFns === void 0 ? void 0 : filterFns.weakEquals;
+}
+/**
+* Resolves the filter function configured for a column.
+*
+* 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 filterFn = column_getFilterFn(column)
+* ```
+*/
+function column_getFilterFn(column) {
+	let filterFn = null;
+	const filterFns = column.table._rowModelFns.filterFns;
+	filterFn = require_utils.isFunction(column.columnDef.filterFn) ? column.columnDef.filterFn : column.columnDef.filterFn === "auto" ? column_getAutoFilterFn(column) : filterFns === null || filterFns === void 0 ? void 0 : filterFns[column.columnDef.filterFn];
+	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 ?? void 0;
+}
+/**
+* Checks whether column filtering is enabled for this accessor column.
+*
+* 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 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;
+}
+/**
+* Checks whether this column currently has an entry in `state.columnFilters`.
+*
+* This only reflects filter state presence; it does not indicate whether the
+* filter removes any rows.
+*
+* @example
+* ```ts
+* const isFiltered = column_getIsFiltered(column)
+* ```
+*/
+function column_getIsFiltered(column) {
+	return column_getFilterIndex(column) > -1;
+}
+/**
+* Reads this column's current filter value from `state.columnFilters`.
+*
+* Missing filter entries return `undefined`.
+*
+* @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;
+}
+/**
+* Finds this column's position in the ordered `state.columnFilters` array.
+*
+* The result is `-1` when the column has no active filter.
+*
+* @example
+* ```ts
+* const index = 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;
+}
+/**
+* Adds, updates, or removes this column's filter value.
+*
+* 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) => String(old ?? '').trim())
+* ```
+*/
+function column_setFilterValue(column, value) {
+	table_setColumnFilters(column.table, (old) => {
+		const filterFn = column_getFilterFn(column);
+		const previousFilter = old.find((d) => d.id === column.id);
+		const newFilter = require_utils.functionalUpdate(value, previousFilter ? previousFilter.value : void 0);
+		if (shouldAutoRemoveFilter(filterFn, newFilter, column)) return old.filter((d) => d.id !== column.id);
+		const newFilterObj = {
+			id: column.id,
+			value: newFilter
+		};
+		if (previousFilter) return old.map((d) => {
+			if (d.id === column.id) return newFilterObj;
+			return d;
+		});
+		if (old.length) return [...old, newFilterObj];
+		return [newFilterObj];
+	});
+}
+/**
+* Routes a column filter updater through the table's filter change handler.
+*
+* 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.filter((filter) => filter.id !== 'age'))
+* ```
+*/
+function table_setColumnFilters(table, updater) {
+	var _table$options$onColu, _table$options;
+	const leafColumnsById = table.getAllLeafColumnsById();
+	const updateFn = (old) => {
+		return require_utils.functionalUpdate(updater, old).filter((filter) => {
+			const column = leafColumnsById[filter.id];
+			if (column) {
+				if (shouldAutoRemoveFilter(column_getFilterFn(column), filter.value, column)) return false;
+			}
+			return true;
+		});
+	};
+	(_table$options$onColu = (_table$options = table.options).onColumnFiltersChange) === null || _table$options$onColu === void 0 || _table$options$onColu.call(_table$options, updateFn);
+}
+/**
+* Resets `columnFilters` to the configured initial state or feature default.
+*
+* With no argument, the reset clones `table.initialState.columnFilters` when it
+* exists. Passing `true` ignores initial state and resets to `[]`.
+*
+* @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;
+}
+
+//#endregion
+exports.column_getAutoFilterFn = column_getAutoFilterFn;
+exports.column_getCanFilter = column_getCanFilter;
+exports.column_getFilterFn = column_getFilterFn;
+exports.column_getFilterIndex = column_getFilterIndex;
+exports.column_getFilterValue = column_getFilterValue;
+exports.column_getIsFiltered = column_getIsFiltered;
+exports.column_setFilterValue = column_setFilterValue;
+exports.getDefaultColumnFiltersState = getDefaultColumnFiltersState;
+exports.shouldAutoRemoveFilter = shouldAutoRemoveFilter;
+exports.table_resetColumnFilters = table_resetColumnFilters;
+exports.table_setColumnFilters = table_setColumnFilters;
+//# sourceMappingURL=columnFilteringFeature.utils.cjs.map

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

@@ -0,0 +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\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 ?? undefined\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 as Column_Internal<TFeatures, TData>)\n      : false) ||\n    typeof value === 'undefined' ||\n    (typeof value === 'string' && !value)\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;AAqBA,SAAgB,+BAAmD;CACjE,OAAO,CAAC;AACV;;;;;;;;;;;;;AAcA,SAAgB,uBAId,QAAmD;CACnD,MAAM,YACJ,OAAO,MAAM,aAAa;CAE5B,MAAM,WAAW,OAAO,MAAM,gBAAgB,CAAC,CAAC,SAAS;CAEzD,MAAM,QAAQ,WAAW,SAAS,SAAS,OAAO,EAAE,IAAI;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,KAAK,GACrB,6DAAO,UAAW;CAGpB,6DAAO,UAAW;AACpB;;;;;;;;;;;;;AAcA,SAAgB,mBAKd,QACwC;CACxC,IAAI,WAAW;CACf,MAAM,YACJ,OAAO,MAAM,aAAa;CAC5B,WAAWA,yBAAW,OAAO,UAAU,QAAQ,IAC3C,OAAO,UAAU,WACjB,OAAO,UAAU,aAAa,SAC5B,uBAAuB,MAAM,0DAC7B,UAAY,OAAO,UAAU;CAEnC,IAAI,QAAQ,IAAI,aAAa,iBAAiB,CAAC,UAC7C,QAAQ,KACN,oEAAoE,OAAO,GAAG,EAChF;CAGF,OAAO,YAAY;AACrB;;;;;;;;;;;;AAaA,SAAgB,oBAId,QAAmD;CACnD,QACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,uBAAuB,UAC5C,OAAO,MAAM,QAAQ,iBAAiB,SACvC,CAAC,CAAC,OAAO;AAEb;;;;;;;;;;;;AAaA,SAAgB,qBAId,QAAmD;CACnD,OAAO,sBAAsB,MAAM,IAAI;AACzC;;;;;;;;;;;AAYA,SAAgB,sBAId,QAAmD;;CACnD,gCAAO,OAAO,MAAM,MAAM,8GACtB,IAAI,kGACJ,MAAM,MAAM,EAAE,OAAO,OAAO,EAAE,iFAAG;AACvC;;;;;;;;;;;AAYA,SAAgB,sBAId,QAA2D;;CAC3D,kCACE,OAAO,MAAM,MAAM,iHACf,IAAI,mFACJ,WAAW,MAAM,EAAE,OAAO,OAAO,EAAE,MAAK;AAEhD;;;;;;;;;;;;AAaA,SAAgB,sBAId,QAAmD,OAAY;CAC/D,uBAAuB,OAAO,QAAQ,QAAQ;EAC5C,MAAM,WAAW,mBAAmB,MAAM;EAC1C,MAAM,iBAAiB,IAAI,MAAM,MAAM,EAAE,OAAO,OAAO,EAAE;EAEzD,MAAM,YAAYC,+BAChB,OACA,iBAAiB,eAAe,QAAQ,MAC1C;EAEA,IAAI,uBAAuB,UAAU,WAAW,MAAM,GACpD,OAAO,IAAI,QAAQ,MAAM,EAAE,OAAO,OAAO,EAAE;EAG7C,MAAM,eAAe;GAAE,IAAI,OAAO;GAAI,OAAO;EAAU;EAEvD,IAAI,gBACF,OAAO,IAAI,KAAK,MAAM;GACpB,IAAI,EAAE,OAAO,OAAO,IAClB,OAAO;GAET,OAAO;EACT,CAAC;EAGH,IAAI,IAAI,QACN,OAAO,CAAC,GAAG,KAAK,YAAY;EAG9B,OAAO,CAAC,YAAY;CACtB,CAAC;AACH;;;;;;;;;;;;;AAcA,SAAgB,uBAId,OACA,SACA;;CACA,MAAM,kBAAkB,MAAM,sBAAsB;CAEpD,MAAM,YAAY,QAA4B;EAC5C,OAAOA,+BAAiB,SAAS,GAAG,CAAC,CAAC,QAAQ,WAAW;GACvD,MAAM,SAAS,gBAAgB,OAAO;GAEtC,IAAI,QAGF;QAAI,uBAFa,mBAAmB,MAEF,GAAG,OAAO,OAAO,MAAM,GACvD,OAAO;GACT;GAGF,OAAO;EACT,CAAC;CACH;CAEA,iDAAM,SAAQ,kHAAwB,QAAQ;AAChD;;;;;;;;;;;;;AAcA,SAAgB,yBAGd,OAAyC,cAAwB;CACjE,uBACE,OACA,eAAe,CAAC,IAAIC,yBAAW,MAAM,aAAa,iBAAiB,CAAC,CAAC,CACvE;AACF;;;;;;;;;;;AAYA,SAAgB,uBAKd,UACA,OACA,QACA;CACA,QACG,YAAY,SAAS,aAClB,SAAS,WAAW,OAAO,MAA2C,IACtE,UACJ,OAAO,UAAU,eAChB,OAAO,UAAU,YAAY,CAAC;AAEnC"}

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

@@ -0,0 +1,143 @@
+import { CellData, RowData, Updater } from "../../types/type-utils.cjs";
+import { Column_Internal } from "../../types/Column.cjs";
+import { ColumnFiltersState, FilterFn } from "./columnFilteringFeature.types.cjs";
+import { Table_Internal } from "../../types/Table.cjs";
+import { TableFeatures } from "../../types/TableFeatures.cjs";
+
+//#region src/features/column-filtering/columnFilteringFeature.utils.d.ts
+/**
+ * Creates the default column filter state.
+ *
+ * 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 filters = getDefaultColumnFiltersState()
+ * ```
+ */
+declare function getDefaultColumnFiltersState(): ColumnFiltersState;
+/**
+ * Chooses a built-in filter function from the column's first core row value.
+ *
+ * Strings use `includesString`, numbers use `inNumberRange`, booleans and
+ * objects use `equals`, arrays use `arrIncludes`, and unknown values fall back
+ * to `weakEquals`.
+ *
+ * @example
+ * ```ts
+ * 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;
+/**
+ * Resolves the filter function configured for a column.
+ *
+ * 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 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;
+/**
+ * Checks whether column filtering is enabled for this accessor column.
+ *
+ * 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 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;
+/**
+ * Checks whether this column currently has an entry in `state.columnFilters`.
+ *
+ * This only reflects filter state presence; it does not indicate whether the
+ * filter removes any rows.
+ *
+ * @example
+ * ```ts
+ * 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;
+/**
+ * Reads this column's current filter value from `state.columnFilters`.
+ *
+ * Missing filter entries return `undefined`.
+ *
+ * @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;
+/**
+ * Finds this column's position in the ordered `state.columnFilters` array.
+ *
+ * The result is `-1` when the column has no active filter.
+ *
+ * @example
+ * ```ts
+ * 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;
+/**
+ * Adds, updates, or removes this column's filter value.
+ *
+ * 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) => 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;
+/**
+ * Routes a column filter updater through the table's filter change handler.
+ *
+ * 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.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 `columnFilters` to the configured initial state or feature default.
+ *
+ * With no argument, the reset clones `table.initialState.columnFilters` when it
+ * exists. Passing `true` ignores initial state and resets to `[]`.
+ *
+ * @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 };
+//# sourceMappingURL=columnFilteringFeature.utils.d.cts.map

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

@@ -0,0 +1,143 @@
+import { CellData, RowData, Updater } from "../../types/type-utils.js";
+import { Column_Internal } from "../../types/Column.js";
+import { ColumnFiltersState, FilterFn } from "./columnFilteringFeature.types.js";
+import { Table_Internal } from "../../types/Table.js";
+import { TableFeatures } from "../../types/TableFeatures.js";
+
+//#region src/features/column-filtering/columnFilteringFeature.utils.d.ts
+/**
+ * Creates the default column filter state.
+ *
+ * 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 filters = getDefaultColumnFiltersState()
+ * ```
+ */
+declare function getDefaultColumnFiltersState(): ColumnFiltersState;
+/**
+ * Chooses a built-in filter function from the column's first core row value.
+ *
+ * Strings use `includesString`, numbers use `inNumberRange`, booleans and
+ * objects use `equals`, arrays use `arrIncludes`, and unknown values fall back
+ * to `weakEquals`.
+ *
+ * @example
+ * ```ts
+ * 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;
+/**
+ * Resolves the filter function configured for a column.
+ *
+ * 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 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;
+/**
+ * Checks whether column filtering is enabled for this accessor column.
+ *
+ * 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 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;
+/**
+ * Checks whether this column currently has an entry in `state.columnFilters`.
+ *
+ * This only reflects filter state presence; it does not indicate whether the
+ * filter removes any rows.
+ *
+ * @example
+ * ```ts
+ * 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;
+/**
+ * Reads this column's current filter value from `state.columnFilters`.
+ *
+ * Missing filter entries return `undefined`.
+ *
+ * @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;
+/**
+ * Finds this column's position in the ordered `state.columnFilters` array.
+ *
+ * The result is `-1` when the column has no active filter.
+ *
+ * @example
+ * ```ts
+ * 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;
+/**
+ * Adds, updates, or removes this column's filter value.
+ *
+ * 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) => 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;
+/**
+ * Routes a column filter updater through the table's filter change handler.
+ *
+ * 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.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 `columnFilters` to the configured initial state or feature default.
+ *
+ * With no argument, the reset clones `table.initialState.columnFilters` when it
+ * exists. Passing `true` ignores initial state and resets to `[]`.
+ *
+ * @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 };
+//# sourceMappingURL=columnFilteringFeature.utils.d.ts.map