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

package/dist/features/global-filtering/globalFilteringFeature.cjs

@@ -0,0 +1,41 @@
+const require_utils = require('../../utils.cjs');
+const require_globalFilteringFeature_utils = require('./globalFilteringFeature.utils.cjs');
+
+//#region src/features/global-filtering/globalFilteringFeature.ts
+/**
+* Feature that adds global filtering state, defaults, and global filter APIs.
+*/
+const globalFilteringFeature = {
+	getInitialState: (initialState) => {
+		return {
+			globalFilter: void 0,
+			...initialState
+		};
+	},
+	getDefaultTableOptions: (table) => {
+		return {
+			onGlobalFilterChange: require_utils.makeStateUpdater("globalFilter", table),
+			globalFilterFn: "auto",
+			getColumnCanGlobalFilter: (column) => {
+				var _table$getCoreRowMode;
+				const value = (_table$getCoreRowMode = table.getCoreRowModel().flatRows[0]) === null || _table$getCoreRowMode === void 0 || (_table$getCoreRowMode = _table$getCoreRowMode.getAllCellsByColumnId()[column.id]) === null || _table$getCoreRowMode === void 0 ? void 0 : _table$getCoreRowMode.getValue();
+				return typeof value === "string" || typeof value === "number";
+			}
+		};
+	},
+	assignColumnPrototype: (prototype, table) => {
+		require_utils.assignPrototypeAPIs("globalFilteringFeature", prototype, table, { column_getCanGlobalFilter: { fn: (column) => require_globalFilteringFeature_utils.column_getCanGlobalFilter(column) } });
+	},
+	constructTableAPIs: (table) => {
+		require_utils.assignTableAPIs("globalFilteringFeature", table, {
+			table_getGlobalAutoFilterFn: { fn: () => require_globalFilteringFeature_utils.table_getGlobalAutoFilterFn() },
+			table_getGlobalFilterFn: { fn: () => require_globalFilteringFeature_utils.table_getGlobalFilterFn(table) },
+			table_setGlobalFilter: { fn: (updater) => require_globalFilteringFeature_utils.table_setGlobalFilter(table, updater) },
+			table_resetGlobalFilter: { fn: (defaultState) => require_globalFilteringFeature_utils.table_resetGlobalFilter(table, defaultState) }
+		});
+	}
+};
+
+//#endregion
+exports.globalFilteringFeature = globalFilteringFeature;
+//# sourceMappingURL=globalFilteringFeature.cjs.map

package/dist/features/global-filtering/globalFilteringFeature.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalFilteringFeature.cjs","names":["makeStateUpdater","column_getCanGlobalFilter","table_getGlobalAutoFilterFn","table_getGlobalFilterFn","table_setGlobalFilter","table_resetGlobalFilter"],"sources":["../../../src/features/global-filtering/globalFilteringFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getCanGlobalFilter,\n  table_getGlobalAutoFilterFn,\n  table_getGlobalFilterFn,\n  table_resetGlobalFilter,\n  table_setGlobalFilter,\n} from './globalFilteringFeature.utils'\nimport type { TableFeature } from '../../types/TableFeatures'\n\n/**\n * Feature that adds global filtering state, defaults, and global filter APIs.\n */\nexport const globalFilteringFeature: TableFeature = {\n  getInitialState: (initialState) => {\n    return {\n      globalFilter: undefined,\n      ...initialState,\n    }\n  },\n\n  getDefaultTableOptions: (table) => {\n    return {\n      onGlobalFilterChange: makeStateUpdater('globalFilter', table),\n      globalFilterFn: 'auto',\n      getColumnCanGlobalFilter: (column) => {\n        const value = table\n          .getCoreRowModel()\n          .flatRows[0]?.getAllCellsByColumnId()\n          [column.id]?.getValue()\n\n        return typeof value === 'string' || typeof value === 'number'\n      },\n    }\n  },\n\n  assignColumnPrototype: (prototype, table) => {\n    assignPrototypeAPIs('globalFilteringFeature', prototype, table, {\n      column_getCanGlobalFilter: {\n        fn: (column) => column_getCanGlobalFilter(column),\n      },\n    })\n  },\n\n  constructTableAPIs: (table) => {\n    assignTableAPIs('globalFilteringFeature', table, {\n      table_getGlobalAutoFilterFn: {\n        fn: () => table_getGlobalAutoFilterFn(),\n      },\n      table_getGlobalFilterFn: {\n        fn: () => table_getGlobalFilterFn(table),\n      },\n      table_setGlobalFilter: {\n        fn: (updater) => table_setGlobalFilter(table, updater),\n      },\n      table_resetGlobalFilter: {\n        fn: (defaultState) => table_resetGlobalFilter(table, defaultState),\n      },\n    })\n  },\n}\n"],"mappings":";;;;;;;AAiBA,MAAa,yBAAuC;CAClD,kBAAkB,iBAAiB;EACjC,OAAO;GACL,cAAc;GACd,GAAG;EACL;CACF;CAEA,yBAAyB,UAAU;EACjC,OAAO;GACL,sBAAsBA,+BAAiB,gBAAgB,KAAK;GAC5D,gBAAgB;GAChB,2BAA2B,WAAW;;IACpC,MAAM,iCAAQ,MACX,gBAAgB,CAAC,CACjB,SAAS,mGAAI,sBAAsB,CAAC,CACpC,OAAO,mFAAK,SAAS;IAExB,OAAO,OAAO,UAAU,YAAY,OAAO,UAAU;GACvD;EACF;CACF;CAEA,wBAAwB,WAAW,UAAU;EAC3C,kCAAoB,0BAA0B,WAAW,OAAO,EAC9D,2BAA2B,EACzB,KAAK,WAAWC,+DAA0B,MAAM,EAClD,EACF,CAAC;CACH;CAEA,qBAAqB,UAAU;EAC7B,8BAAgB,0BAA0B,OAAO;GAC/C,6BAA6B,EAC3B,UAAUC,iEAA4B,EACxC;GACA,yBAAyB,EACvB,UAAUC,6DAAwB,KAAK,EACzC;GACA,uBAAuB,EACrB,KAAK,YAAYC,2DAAsB,OAAO,OAAO,EACvD;GACA,yBAAyB,EACvB,KAAK,iBAAiBC,6DAAwB,OAAO,YAAY,EACnE;EACF,CAAC;CACH;AACF"}

package/dist/features/global-filtering/globalFilteringFeature.d.cts

@@ -0,0 +1,10 @@
+import { TableFeature } from "../../types/TableFeatures.cjs";
+
+//#region src/features/global-filtering/globalFilteringFeature.d.ts
+/**
+ * Feature that adds global filtering state, defaults, and global filter APIs.
+ */
+declare const globalFilteringFeature: TableFeature;
+//#endregion
+export { globalFilteringFeature };
+//# sourceMappingURL=globalFilteringFeature.d.cts.map

package/dist/features/global-filtering/globalFilteringFeature.d.ts

@@ -0,0 +1,10 @@
+import { TableFeature } from "../../types/TableFeatures.js";
+
+//#region src/features/global-filtering/globalFilteringFeature.d.ts
+/**
+ * Feature that adds global filtering state, defaults, and global filter APIs.
+ */
+declare const globalFilteringFeature: TableFeature;
+//#endregion
+export { globalFilteringFeature };
+//# sourceMappingURL=globalFilteringFeature.d.ts.map

package/dist/features/global-filtering/globalFilteringFeature.js

@@ -0,0 +1,41 @@
+import { assignPrototypeAPIs, assignTableAPIs, makeStateUpdater } from "../../utils.js";
+import { column_getCanGlobalFilter, table_getGlobalAutoFilterFn, table_getGlobalFilterFn, table_resetGlobalFilter, table_setGlobalFilter } from "./globalFilteringFeature.utils.js";
+
+//#region src/features/global-filtering/globalFilteringFeature.ts
+/**
+* Feature that adds global filtering state, defaults, and global filter APIs.
+*/
+const globalFilteringFeature = {
+	getInitialState: (initialState) => {
+		return {
+			globalFilter: void 0,
+			...initialState
+		};
+	},
+	getDefaultTableOptions: (table) => {
+		return {
+			onGlobalFilterChange: makeStateUpdater("globalFilter", table),
+			globalFilterFn: "auto",
+			getColumnCanGlobalFilter: (column) => {
+				var _table$getCoreRowMode;
+				const value = (_table$getCoreRowMode = table.getCoreRowModel().flatRows[0]) === null || _table$getCoreRowMode === void 0 || (_table$getCoreRowMode = _table$getCoreRowMode.getAllCellsByColumnId()[column.id]) === null || _table$getCoreRowMode === void 0 ? void 0 : _table$getCoreRowMode.getValue();
+				return typeof value === "string" || typeof value === "number";
+			}
+		};
+	},
+	assignColumnPrototype: (prototype, table) => {
+		assignPrototypeAPIs("globalFilteringFeature", prototype, table, { column_getCanGlobalFilter: { fn: (column) => column_getCanGlobalFilter(column) } });
+	},
+	constructTableAPIs: (table) => {
+		assignTableAPIs("globalFilteringFeature", table, {
+			table_getGlobalAutoFilterFn: { fn: () => table_getGlobalAutoFilterFn() },
+			table_getGlobalFilterFn: { fn: () => table_getGlobalFilterFn(table) },
+			table_setGlobalFilter: { fn: (updater) => table_setGlobalFilter(table, updater) },
+			table_resetGlobalFilter: { fn: (defaultState) => table_resetGlobalFilter(table, defaultState) }
+		});
+	}
+};
+
+//#endregion
+export { globalFilteringFeature };
+//# sourceMappingURL=globalFilteringFeature.js.map

package/dist/features/global-filtering/globalFilteringFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalFilteringFeature.js","names":[],"sources":["../../../src/features/global-filtering/globalFilteringFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getCanGlobalFilter,\n  table_getGlobalAutoFilterFn,\n  table_getGlobalFilterFn,\n  table_resetGlobalFilter,\n  table_setGlobalFilter,\n} from './globalFilteringFeature.utils'\nimport type { TableFeature } from '../../types/TableFeatures'\n\n/**\n * Feature that adds global filtering state, defaults, and global filter APIs.\n */\nexport const globalFilteringFeature: TableFeature = {\n  getInitialState: (initialState) => {\n    return {\n      globalFilter: undefined,\n      ...initialState,\n    }\n  },\n\n  getDefaultTableOptions: (table) => {\n    return {\n      onGlobalFilterChange: makeStateUpdater('globalFilter', table),\n      globalFilterFn: 'auto',\n      getColumnCanGlobalFilter: (column) => {\n        const value = table\n          .getCoreRowModel()\n          .flatRows[0]?.getAllCellsByColumnId()\n          [column.id]?.getValue()\n\n        return typeof value === 'string' || typeof value === 'number'\n      },\n    }\n  },\n\n  assignColumnPrototype: (prototype, table) => {\n    assignPrototypeAPIs('globalFilteringFeature', prototype, table, {\n      column_getCanGlobalFilter: {\n        fn: (column) => column_getCanGlobalFilter(column),\n      },\n    })\n  },\n\n  constructTableAPIs: (table) => {\n    assignTableAPIs('globalFilteringFeature', table, {\n      table_getGlobalAutoFilterFn: {\n        fn: () => table_getGlobalAutoFilterFn(),\n      },\n      table_getGlobalFilterFn: {\n        fn: () => table_getGlobalFilterFn(table),\n      },\n      table_setGlobalFilter: {\n        fn: (updater) => table_setGlobalFilter(table, updater),\n      },\n      table_resetGlobalFilter: {\n        fn: (defaultState) => table_resetGlobalFilter(table, defaultState),\n      },\n    })\n  },\n}\n"],"mappings":";;;;;;;AAiBA,MAAa,yBAAuC;CAClD,kBAAkB,iBAAiB;EACjC,OAAO;GACL,cAAc;GACd,GAAG;EACL;CACF;CAEA,yBAAyB,UAAU;EACjC,OAAO;GACL,sBAAsB,iBAAiB,gBAAgB,KAAK;GAC5D,gBAAgB;GAChB,2BAA2B,WAAW;;IACpC,MAAM,iCAAQ,MACX,gBAAgB,CAAC,CACjB,SAAS,mGAAI,sBAAsB,CAAC,CACpC,OAAO,mFAAK,SAAS;IAExB,OAAO,OAAO,UAAU,YAAY,OAAO,UAAU;GACvD;EACF;CACF;CAEA,wBAAwB,WAAW,UAAU;EAC3C,oBAAoB,0BAA0B,WAAW,OAAO,EAC9D,2BAA2B,EACzB,KAAK,WAAW,0BAA0B,MAAM,EAClD,EACF,CAAC;CACH;CAEA,qBAAqB,UAAU;EAC7B,gBAAgB,0BAA0B,OAAO;GAC/C,6BAA6B,EAC3B,UAAU,4BAA4B,EACxC;GACA,yBAAyB,EACvB,UAAU,wBAAwB,KAAK,EACzC;GACA,uBAAuB,EACrB,KAAK,YAAY,sBAAsB,OAAO,OAAO,EACvD;GACA,yBAAyB,EACvB,KAAK,iBAAiB,wBAAwB,OAAO,YAAY,EACnE;EACF,CAAC;CACH;AACF"}

package/dist/features/global-filtering/globalFilteringFeature.types.d.cts

@@ -0,0 +1,71 @@
+import { CellData, OnChangeFn, RowData, Updater } from "../../types/type-utils.cjs";
+import { Column } from "../../types/Column.cjs";
+import { FilterFn, FilterFnOption } from "../column-filtering/columnFilteringFeature.types.cjs";
+import { TableFeatures } from "../../types/TableFeatures.cjs";
+
+//#region src/features/global-filtering/globalFilteringFeature.types.d.ts
+interface TableState_GlobalFiltering {
+  globalFilter: any;
+}
+interface ColumnDef_GlobalFiltering {
+  /**
+   * Allows this column to be scanned by global filtering.
+   *
+   * Defaults to `true`; table-level global filtering and `enableFilters` must
+   * also allow filtering.
+   */
+  enableGlobalFilter?: boolean;
+}
+interface Column_GlobalFiltering {
+  /**
+   * Checks whether this accessor column participates in global filtering.
+   */
+  getCanGlobalFilter: () => boolean;
+}
+interface TableOptions_GlobalFiltering<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Enables global filtering across columns that allow it.
+   */
+  enableGlobalFilter?: boolean;
+  /**
+   * If provided, this function will be called with the column and should return `true` or `false` to indicate whether this column should be used for global filtering.
+   * This is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`).
+   */
+  getColumnCanGlobalFilter?: <TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>) => boolean;
+  /**
+   * The filter function to use for global filtering.
+   * - A `string` referencing a built-in filter function
+   * - A `string` that references a custom filter functions provided via the `tableOptions.filterFns` option
+   * - A custom filter function
+   */
+  globalFilterFn?: FilterFnOption<TFeatures, TData>;
+  /**
+   * Called with an updater when global filter state changes. Pair this with
+   * `state.globalFilter` when using external state; external atoms can own the
+   * slice without this callback.
+   */
+  onGlobalFilterChange?: OnChangeFn<any>;
+}
+interface Table_GlobalFiltering<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Currently, this function returns the built-in `includesString` filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided.
+   */
+  getGlobalAutoFilterFn: () => FilterFn<TFeatures, TData> | undefined;
+  /**
+   * Returns the filter function (either user-defined or automatic, depending on configuration) for the global filter.
+   */
+  getGlobalFilterFn: () => FilterFn<TFeatures, TData> | undefined;
+  /**
+   * Resets `globalFilter` to `initialState.globalFilter`.
+   *
+   * Pass `true` to ignore initial state and reset to `undefined`.
+   */
+  resetGlobalFilter: (defaultState?: boolean) => void;
+  /**
+   * Updates global filter state with a next value or updater function.
+   */
+  setGlobalFilter: (updater: Updater<any>) => void;
+}
+//#endregion
+export { ColumnDef_GlobalFiltering, Column_GlobalFiltering, TableOptions_GlobalFiltering, TableState_GlobalFiltering, Table_GlobalFiltering };
+//# sourceMappingURL=globalFilteringFeature.types.d.cts.map

package/dist/features/global-filtering/globalFilteringFeature.types.d.ts

@@ -0,0 +1,71 @@
+import { CellData, OnChangeFn, RowData, Updater } from "../../types/type-utils.js";
+import { Column } from "../../types/Column.js";
+import { FilterFn, FilterFnOption } from "../column-filtering/columnFilteringFeature.types.js";
+import { TableFeatures } from "../../types/TableFeatures.js";
+
+//#region src/features/global-filtering/globalFilteringFeature.types.d.ts
+interface TableState_GlobalFiltering {
+  globalFilter: any;
+}
+interface ColumnDef_GlobalFiltering {
+  /**
+   * Allows this column to be scanned by global filtering.
+   *
+   * Defaults to `true`; table-level global filtering and `enableFilters` must
+   * also allow filtering.
+   */
+  enableGlobalFilter?: boolean;
+}
+interface Column_GlobalFiltering {
+  /**
+   * Checks whether this accessor column participates in global filtering.
+   */
+  getCanGlobalFilter: () => boolean;
+}
+interface TableOptions_GlobalFiltering<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Enables global filtering across columns that allow it.
+   */
+  enableGlobalFilter?: boolean;
+  /**
+   * If provided, this function will be called with the column and should return `true` or `false` to indicate whether this column should be used for global filtering.
+   * This is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`).
+   */
+  getColumnCanGlobalFilter?: <TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>) => boolean;
+  /**
+   * The filter function to use for global filtering.
+   * - A `string` referencing a built-in filter function
+   * - A `string` that references a custom filter functions provided via the `tableOptions.filterFns` option
+   * - A custom filter function
+   */
+  globalFilterFn?: FilterFnOption<TFeatures, TData>;
+  /**
+   * Called with an updater when global filter state changes. Pair this with
+   * `state.globalFilter` when using external state; external atoms can own the
+   * slice without this callback.
+   */
+  onGlobalFilterChange?: OnChangeFn<any>;
+}
+interface Table_GlobalFiltering<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Currently, this function returns the built-in `includesString` filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided.
+   */
+  getGlobalAutoFilterFn: () => FilterFn<TFeatures, TData> | undefined;
+  /**
+   * Returns the filter function (either user-defined or automatic, depending on configuration) for the global filter.
+   */
+  getGlobalFilterFn: () => FilterFn<TFeatures, TData> | undefined;
+  /**
+   * Resets `globalFilter` to `initialState.globalFilter`.
+   *
+   * Pass `true` to ignore initial state and reset to `undefined`.
+   */
+  resetGlobalFilter: (defaultState?: boolean) => void;
+  /**
+   * Updates global filter state with a next value or updater function.
+   */
+  setGlobalFilter: (updater: Updater<any>) => void;
+}
+//#endregion
+export { ColumnDef_GlobalFiltering, Column_GlobalFiltering, TableOptions_GlobalFiltering, TableState_GlobalFiltering, Table_GlobalFiltering };
+//# sourceMappingURL=globalFilteringFeature.types.d.ts.map

package/dist/features/global-filtering/globalFilteringFeature.utils.cjs

@@ -0,0 +1,88 @@
+const require_utils = require('../../utils.cjs');
+const require_filterFns = require('../../fns/filterFns.cjs');
+
+//#region src/features/global-filtering/globalFilteringFeature.utils.ts
+/**
+* Checks whether this accessor column participates in global filtering.
+*
+* The column must have an accessor and pass column-level, table-level, and
+* optional `getColumnCanGlobalFilter` checks.
+*
+* @example
+* ```ts
+* const canGlobalFilter = column_getCanGlobalFilter(column)
+* ```
+*/
+function column_getCanGlobalFilter(column) {
+	var _column$table$options, _column$table$options2;
+	return (column.columnDef.enableGlobalFilter ?? true) && (column.table.options.enableGlobalFilter ?? true) && (column.table.options.enableFilters ?? true) && (((_column$table$options = (_column$table$options2 = column.table.options).getColumnCanGlobalFilter) === null || _column$table$options === void 0 ? void 0 : _column$table$options.call(_column$table$options2, column)) ?? true) && !!column.accessorFn;
+}
+/**
+* Provides the built-in automatic global filter function.
+*
+* Global filtering defaults to `includesString`, which gives search-box style
+* matching across globally filterable columns.
+*
+* @example
+* ```ts
+* const filterFn = table_getGlobalAutoFilterFn()
+* ```
+*/
+function table_getGlobalAutoFilterFn() {
+	return require_filterFns.filterFn_includesString;
+}
+/**
+* Resolves the filter function used for global filtering.
+*
+* Function-valued `options.globalFilterFn` is returned directly, `'auto'`
+* delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in
+* the table's filter function registry.
+*
+* @example
+* ```ts
+* const filterFn = table_getGlobalFilterFn(table)
+* ```
+*/
+function table_getGlobalFilterFn(table) {
+	const { globalFilterFn } = table.options;
+	const filterFns = table._rowModelFns.filterFns;
+	return require_utils.isFunction(globalFilterFn) ? globalFilterFn : globalFilterFn === "auto" ? table_getGlobalAutoFilterFn() : filterFns === null || filterFns === void 0 ? void 0 : filterFns[globalFilterFn];
+}
+/**
+* Routes a global filter updater through the table's global filter handler.
+*
+* The updater may be a next value or a function of the previous value, matching
+* the instance `table.setGlobalFilter` behavior.
+*
+* @example
+* ```ts
+* table_setGlobalFilter(table, 'search text')
+* ```
+*/
+function table_setGlobalFilter(table, updater) {
+	var _table$options$onGlob, _table$options;
+	(_table$options$onGlob = (_table$options = table.options).onGlobalFilterChange) === null || _table$options$onGlob === void 0 || _table$options$onGlob.call(_table$options, updater);
+}
+/**
+* Resets `globalFilter` to the configured initial state or feature default.
+*
+* With no argument, the reset clones `table.initialState.globalFilter`. Passing
+* `true` ignores initial state and resets to `undefined`.
+*
+* @example
+* ```ts
+* table_resetGlobalFilter(table)
+* table_resetGlobalFilter(table, true)
+* ```
+*/
+function table_resetGlobalFilter(table, defaultState) {
+	table_setGlobalFilter(table, defaultState ? void 0 : require_utils.cloneState(table.initialState.globalFilter));
+}
+
+//#endregion
+exports.column_getCanGlobalFilter = column_getCanGlobalFilter;
+exports.table_getGlobalAutoFilterFn = table_getGlobalAutoFilterFn;
+exports.table_getGlobalFilterFn = table_getGlobalFilterFn;
+exports.table_resetGlobalFilter = table_resetGlobalFilter;
+exports.table_setGlobalFilter = table_setGlobalFilter;
+//# sourceMappingURL=globalFilteringFeature.utils.cjs.map

package/dist/features/global-filtering/globalFilteringFeature.utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalFilteringFeature.utils.cjs","names":["filterFn_includesString","isFunction","cloneState"],"sources":["../../../src/features/global-filtering/globalFilteringFeature.utils.ts"],"sourcesContent":["import { filterFn_includesString } from '../../fns/filterFns'\nimport { cloneState, isFunction } from '../../utils'\nimport type { Column_Internal } from '../../types/Column'\nimport type { FilterFn } from '../column-filtering/columnFilteringFeature.types'\nimport type { CellData, RowData } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\n\n/**\n * Checks whether this accessor column participates in global filtering.\n *\n * The column must have an accessor and pass column-level, table-level, and\n * optional `getColumnCanGlobalFilter` checks.\n *\n * @example\n * ```ts\n * const canGlobalFilter = column_getCanGlobalFilter(column)\n * ```\n */\nexport function column_getCanGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  return (\n    (column.columnDef.enableGlobalFilter ?? true) &&\n    (column.table.options.enableGlobalFilter ?? true) &&\n    (column.table.options.enableFilters ?? true) &&\n    (column.table.options.getColumnCanGlobalFilter?.(column) ?? true) &&\n    !!column.accessorFn\n  )\n}\n\n/**\n * Provides the built-in automatic global filter function.\n *\n * Global filtering defaults to `includesString`, which gives search-box style\n * matching across globally filterable columns.\n *\n * @example\n * ```ts\n * const filterFn = table_getGlobalAutoFilterFn()\n * ```\n */\nexport function table_getGlobalAutoFilterFn() {\n  return filterFn_includesString\n}\n\n/**\n * Resolves the filter function used for global filtering.\n *\n * Function-valued `options.globalFilterFn` is returned directly, `'auto'`\n * delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in\n * the table's filter function registry.\n *\n * @example\n * ```ts\n * const filterFn = table_getGlobalFilterFn(table)\n * ```\n */\nexport function table_getGlobalFilterFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): FilterFn<TFeatures, TData> | undefined {\n  const { globalFilterFn: globalFilterFn } = table.options\n  const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n    table._rowModelFns.filterFns\n\n  const filterFn = isFunction(globalFilterFn)\n    ? globalFilterFn\n    : globalFilterFn === 'auto'\n      ? table_getGlobalAutoFilterFn()\n      : filterFns?.[globalFilterFn as string]\n\n  return filterFn\n}\n\n/**\n * Routes a global filter updater through the table's global filter handler.\n *\n * The updater may be a next value or a function of the previous value, matching\n * the instance `table.setGlobalFilter` behavior.\n *\n * @example\n * ```ts\n * table_setGlobalFilter(table, 'search text')\n * ```\n */\nexport function table_setGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: any) {\n  table.options.onGlobalFilterChange?.(updater)\n}\n\n/**\n * Resets `globalFilter` to the configured initial state or feature default.\n *\n * With no argument, the reset clones `table.initialState.globalFilter`. Passing\n * `true` ignores initial state and resets to `undefined`.\n *\n * @example\n * ```ts\n * table_resetGlobalFilter(table)\n * table_resetGlobalFilter(table, true)\n * ```\n */\nexport function table_resetGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setGlobalFilter(\n    table,\n    defaultState ? undefined : cloneState(table.initialState.globalFilter),\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;AAmBA,SAAgB,0BAId,QAA4D;;CAC5D,QACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,sBAAsB,UAC3C,OAAO,MAAM,QAAQ,iBAAiB,8DACtC,OAAO,MAAM,SAAQ,qIAA2B,MAAM,MAAK,SAC5D,CAAC,CAAC,OAAO;AAEb;;;;;;;;;;;;AAaA,SAAgB,8BAA8B;CAC5C,OAAOA;AACT;;;;;;;;;;;;;AAcA,SAAgB,wBAId,OACwC;CACxC,MAAM,EAAkB,mBAAmB,MAAM;CACjD,MAAM,YACJ,MAAM,aAAa;CAQrB,OANiBC,yBAAW,cAAc,IACtC,iBACA,mBAAmB,SACjB,4BAA4B,0DAC5B,UAAY;AAGpB;;;;;;;;;;;;AAaA,SAAgB,sBAGd,OAAyC,SAAc;;CACvD,iDAAM,SAAQ,iHAAuB,OAAO;AAC9C;;;;;;;;;;;;;AAcA,SAAgB,wBAGd,OAAyC,cAAwB;CACjE,sBACE,OACA,eAAe,SAAYC,yBAAW,MAAM,aAAa,YAAY,CACvE;AACF"}

package/dist/features/global-filtering/globalFilteringFeature.utils.d.cts

@@ -0,0 +1,74 @@
+import { CellData, RowData } from "../../types/type-utils.cjs";
+import { Column_Internal } from "../../types/Column.cjs";
+import { Row } from "../../types/Row.cjs";
+import { FilterFn } from "../column-filtering/columnFilteringFeature.types.cjs";
+import { Table_Internal } from "../../types/Table.cjs";
+import { TableFeatures } from "../../types/TableFeatures.cjs";
+//#region src/features/global-filtering/globalFilteringFeature.utils.d.ts
+/**
+ * Checks whether this accessor column participates in global filtering.
+ *
+ * The column must have an accessor and pass column-level, table-level, and
+ * optional `getColumnCanGlobalFilter` checks.
+ *
+ * @example
+ * ```ts
+ * const canGlobalFilter = column_getCanGlobalFilter(column)
+ * ```
+ */
+declare function column_getCanGlobalFilter<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+/**
+ * Provides the built-in automatic global filter function.
+ *
+ * Global filtering defaults to `includesString`, which gives search-box style
+ * matching across globally filterable columns.
+ *
+ * @example
+ * ```ts
+ * const filterFn = table_getGlobalAutoFilterFn()
+ * ```
+ */
+declare function table_getGlobalAutoFilterFn(): (<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, columnId: string, filterValue: unknown) => boolean) & {
+  autoRemove: (val: any) => boolean;
+};
+/**
+ * Resolves the filter function used for global filtering.
+ *
+ * Function-valued `options.globalFilterFn` is returned directly, `'auto'`
+ * delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in
+ * the table's filter function registry.
+ *
+ * @example
+ * ```ts
+ * const filterFn = table_getGlobalFilterFn(table)
+ * ```
+ */
+declare function table_getGlobalFilterFn<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): FilterFn<TFeatures, TData> | undefined;
+/**
+ * Routes a global filter updater through the table's global filter handler.
+ *
+ * The updater may be a next value or a function of the previous value, matching
+ * the instance `table.setGlobalFilter` behavior.
+ *
+ * @example
+ * ```ts
+ * table_setGlobalFilter(table, 'search text')
+ * ```
+ */
+declare function table_setGlobalFilter<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: any): void;
+/**
+ * Resets `globalFilter` to the configured initial state or feature default.
+ *
+ * With no argument, the reset clones `table.initialState.globalFilter`. Passing
+ * `true` ignores initial state and resets to `undefined`.
+ *
+ * @example
+ * ```ts
+ * table_resetGlobalFilter(table)
+ * table_resetGlobalFilter(table, true)
+ * ```
+ */
+declare function table_resetGlobalFilter<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+//#endregion
+export { column_getCanGlobalFilter, table_getGlobalAutoFilterFn, table_getGlobalFilterFn, table_resetGlobalFilter, table_setGlobalFilter };
+//# sourceMappingURL=globalFilteringFeature.utils.d.cts.map

package/dist/features/global-filtering/globalFilteringFeature.utils.d.ts

@@ -0,0 +1,74 @@
+import { CellData, RowData } from "../../types/type-utils.js";
+import { Column_Internal } from "../../types/Column.js";
+import { Row } from "../../types/Row.js";
+import { FilterFn } from "../column-filtering/columnFilteringFeature.types.js";
+import { Table_Internal } from "../../types/Table.js";
+import { TableFeatures } from "../../types/TableFeatures.js";
+//#region src/features/global-filtering/globalFilteringFeature.utils.d.ts
+/**
+ * Checks whether this accessor column participates in global filtering.
+ *
+ * The column must have an accessor and pass column-level, table-level, and
+ * optional `getColumnCanGlobalFilter` checks.
+ *
+ * @example
+ * ```ts
+ * const canGlobalFilter = column_getCanGlobalFilter(column)
+ * ```
+ */
+declare function column_getCanGlobalFilter<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+/**
+ * Provides the built-in automatic global filter function.
+ *
+ * Global filtering defaults to `includesString`, which gives search-box style
+ * matching across globally filterable columns.
+ *
+ * @example
+ * ```ts
+ * const filterFn = table_getGlobalAutoFilterFn()
+ * ```
+ */
+declare function table_getGlobalAutoFilterFn(): (<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, columnId: string, filterValue: unknown) => boolean) & {
+  autoRemove: (val: any) => boolean;
+};
+/**
+ * Resolves the filter function used for global filtering.
+ *
+ * Function-valued `options.globalFilterFn` is returned directly, `'auto'`
+ * delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in
+ * the table's filter function registry.
+ *
+ * @example
+ * ```ts
+ * const filterFn = table_getGlobalFilterFn(table)
+ * ```
+ */
+declare function table_getGlobalFilterFn<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): FilterFn<TFeatures, TData> | undefined;
+/**
+ * Routes a global filter updater through the table's global filter handler.
+ *
+ * The updater may be a next value or a function of the previous value, matching
+ * the instance `table.setGlobalFilter` behavior.
+ *
+ * @example
+ * ```ts
+ * table_setGlobalFilter(table, 'search text')
+ * ```
+ */
+declare function table_setGlobalFilter<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: any): void;
+/**
+ * Resets `globalFilter` to the configured initial state or feature default.
+ *
+ * With no argument, the reset clones `table.initialState.globalFilter`. Passing
+ * `true` ignores initial state and resets to `undefined`.
+ *
+ * @example
+ * ```ts
+ * table_resetGlobalFilter(table)
+ * table_resetGlobalFilter(table, true)
+ * ```
+ */
+declare function table_resetGlobalFilter<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+//#endregion
+export { column_getCanGlobalFilter, table_getGlobalAutoFilterFn, table_getGlobalFilterFn, table_resetGlobalFilter, table_setGlobalFilter };
+//# sourceMappingURL=globalFilteringFeature.utils.d.ts.map

package/dist/features/global-filtering/globalFilteringFeature.utils.js

@@ -0,0 +1,84 @@
+import { cloneState, isFunction } from "../../utils.js";
+import { filterFn_includesString } from "../../fns/filterFns.js";
+
+//#region src/features/global-filtering/globalFilteringFeature.utils.ts
+/**
+* Checks whether this accessor column participates in global filtering.
+*
+* The column must have an accessor and pass column-level, table-level, and
+* optional `getColumnCanGlobalFilter` checks.
+*
+* @example
+* ```ts
+* const canGlobalFilter = column_getCanGlobalFilter(column)
+* ```
+*/
+function column_getCanGlobalFilter(column) {
+	var _column$table$options, _column$table$options2;
+	return (column.columnDef.enableGlobalFilter ?? true) && (column.table.options.enableGlobalFilter ?? true) && (column.table.options.enableFilters ?? true) && (((_column$table$options = (_column$table$options2 = column.table.options).getColumnCanGlobalFilter) === null || _column$table$options === void 0 ? void 0 : _column$table$options.call(_column$table$options2, column)) ?? true) && !!column.accessorFn;
+}
+/**
+* Provides the built-in automatic global filter function.
+*
+* Global filtering defaults to `includesString`, which gives search-box style
+* matching across globally filterable columns.
+*
+* @example
+* ```ts
+* const filterFn = table_getGlobalAutoFilterFn()
+* ```
+*/
+function table_getGlobalAutoFilterFn() {
+	return filterFn_includesString;
+}
+/**
+* Resolves the filter function used for global filtering.
+*
+* Function-valued `options.globalFilterFn` is returned directly, `'auto'`
+* delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in
+* the table's filter function registry.
+*
+* @example
+* ```ts
+* const filterFn = table_getGlobalFilterFn(table)
+* ```
+*/
+function table_getGlobalFilterFn(table) {
+	const { globalFilterFn } = table.options;
+	const filterFns = table._rowModelFns.filterFns;
+	return isFunction(globalFilterFn) ? globalFilterFn : globalFilterFn === "auto" ? table_getGlobalAutoFilterFn() : filterFns === null || filterFns === void 0 ? void 0 : filterFns[globalFilterFn];
+}
+/**
+* Routes a global filter updater through the table's global filter handler.
+*
+* The updater may be a next value or a function of the previous value, matching
+* the instance `table.setGlobalFilter` behavior.
+*
+* @example
+* ```ts
+* table_setGlobalFilter(table, 'search text')
+* ```
+*/
+function table_setGlobalFilter(table, updater) {
+	var _table$options$onGlob, _table$options;
+	(_table$options$onGlob = (_table$options = table.options).onGlobalFilterChange) === null || _table$options$onGlob === void 0 || _table$options$onGlob.call(_table$options, updater);
+}
+/**
+* Resets `globalFilter` to the configured initial state or feature default.
+*
+* With no argument, the reset clones `table.initialState.globalFilter`. Passing
+* `true` ignores initial state and resets to `undefined`.
+*
+* @example
+* ```ts
+* table_resetGlobalFilter(table)
+* table_resetGlobalFilter(table, true)
+* ```
+*/
+function table_resetGlobalFilter(table, defaultState) {
+	table_setGlobalFilter(table, defaultState ? void 0 : cloneState(table.initialState.globalFilter));
+}
+
+//#endregion
+export { column_getCanGlobalFilter, table_getGlobalAutoFilterFn, table_getGlobalFilterFn, table_resetGlobalFilter, table_setGlobalFilter };
+//# sourceMappingURL=globalFilteringFeature.utils.js.map

package/dist/features/global-filtering/globalFilteringFeature.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalFilteringFeature.utils.js","names":[],"sources":["../../../src/features/global-filtering/globalFilteringFeature.utils.ts"],"sourcesContent":["import { filterFn_includesString } from '../../fns/filterFns'\nimport { cloneState, isFunction } from '../../utils'\nimport type { Column_Internal } from '../../types/Column'\nimport type { FilterFn } from '../column-filtering/columnFilteringFeature.types'\nimport type { CellData, RowData } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\n\n/**\n * Checks whether this accessor column participates in global filtering.\n *\n * The column must have an accessor and pass column-level, table-level, and\n * optional `getColumnCanGlobalFilter` checks.\n *\n * @example\n * ```ts\n * const canGlobalFilter = column_getCanGlobalFilter(column)\n * ```\n */\nexport function column_getCanGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  return (\n    (column.columnDef.enableGlobalFilter ?? true) &&\n    (column.table.options.enableGlobalFilter ?? true) &&\n    (column.table.options.enableFilters ?? true) &&\n    (column.table.options.getColumnCanGlobalFilter?.(column) ?? true) &&\n    !!column.accessorFn\n  )\n}\n\n/**\n * Provides the built-in automatic global filter function.\n *\n * Global filtering defaults to `includesString`, which gives search-box style\n * matching across globally filterable columns.\n *\n * @example\n * ```ts\n * const filterFn = table_getGlobalAutoFilterFn()\n * ```\n */\nexport function table_getGlobalAutoFilterFn() {\n  return filterFn_includesString\n}\n\n/**\n * Resolves the filter function used for global filtering.\n *\n * Function-valued `options.globalFilterFn` is returned directly, `'auto'`\n * delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in\n * the table's filter function registry.\n *\n * @example\n * ```ts\n * const filterFn = table_getGlobalFilterFn(table)\n * ```\n */\nexport function table_getGlobalFilterFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): FilterFn<TFeatures, TData> | undefined {\n  const { globalFilterFn: globalFilterFn } = table.options\n  const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n    table._rowModelFns.filterFns\n\n  const filterFn = isFunction(globalFilterFn)\n    ? globalFilterFn\n    : globalFilterFn === 'auto'\n      ? table_getGlobalAutoFilterFn()\n      : filterFns?.[globalFilterFn as string]\n\n  return filterFn\n}\n\n/**\n * Routes a global filter updater through the table's global filter handler.\n *\n * The updater may be a next value or a function of the previous value, matching\n * the instance `table.setGlobalFilter` behavior.\n *\n * @example\n * ```ts\n * table_setGlobalFilter(table, 'search text')\n * ```\n */\nexport function table_setGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: any) {\n  table.options.onGlobalFilterChange?.(updater)\n}\n\n/**\n * Resets `globalFilter` to the configured initial state or feature default.\n *\n * With no argument, the reset clones `table.initialState.globalFilter`. Passing\n * `true` ignores initial state and resets to `undefined`.\n *\n * @example\n * ```ts\n * table_resetGlobalFilter(table)\n * table_resetGlobalFilter(table, true)\n * ```\n */\nexport function table_resetGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setGlobalFilter(\n    table,\n    defaultState ? undefined : cloneState(table.initialState.globalFilter),\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;AAmBA,SAAgB,0BAId,QAA4D;;CAC5D,QACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,sBAAsB,UAC3C,OAAO,MAAM,QAAQ,iBAAiB,8DACtC,OAAO,MAAM,SAAQ,qIAA2B,MAAM,MAAK,SAC5D,CAAC,CAAC,OAAO;AAEb;;;;;;;;;;;;AAaA,SAAgB,8BAA8B;CAC5C,OAAO;AACT;;;;;;;;;;;;;AAcA,SAAgB,wBAId,OACwC;CACxC,MAAM,EAAkB,mBAAmB,MAAM;CACjD,MAAM,YACJ,MAAM,aAAa;CAQrB,OANiB,WAAW,cAAc,IACtC,iBACA,mBAAmB,SACjB,4BAA4B,0DAC5B,UAAY;AAGpB;;;;;;;;;;;;AAaA,SAAgB,sBAGd,OAAyC,SAAc;;CACvD,iDAAM,SAAQ,iHAAuB,OAAO;AAC9C;;;;;;;;;;;;;AAcA,SAAgB,wBAGd,OAAyC,cAAwB;CACjE,sBACE,OACA,eAAe,SAAY,WAAW,MAAM,aAAa,YAAY,CACvE;AACF"}