@tanstack/table-core 9.0.0-alpha.6 → 9.0.0-beta.1

package/dist/features/row-pagination/rowPaginationFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rowPaginationFeature.js","names":[],"sources":["../../../src/features/row-pagination/rowPaginationFeature.ts"],"sourcesContent":["import { assignTableAPIs, makeStateUpdater } from '../../utils'\nimport {\n  getDefaultPaginationState,\n  table_autoResetPageIndex,\n  table_firstPage,\n  table_getCanNextPage,\n  table_getCanPreviousPage,\n  table_getPageCount,\n  table_getPageOptions,\n  table_getRowCount,\n  table_lastPage,\n  table_nextPage,\n  table_previousPage,\n  table_resetPageIndex,\n  table_resetPageSize,\n  table_resetPagination,\n  table_setPageIndex,\n  table_setPageSize,\n  table_setPagination,\n} from './rowPaginationFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   CachedRowModel_Paginated,\n//   CreateRowModel_Paginated,\n//   TableOptions_RowPagination,\n//   TableState_RowPagination,\n//   Table_RowPagination,\n// } from './rowPaginationFeature.types'\n\nexport interface RowPaginationFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // CachedRowModel: CachedRowModel_Paginated<TFeatures, TData>\n  // CreateRowModels: CreateRowModel_Paginated<TFeatures, TData>\n  // Table: Table_RowPagination<TFeatures, TData>\n  // TableOptions: TableOptions_RowPagination<TFeatures, TData>\n  // TableState: TableState_RowPagination\n}\n\n/**\n * Creates the stock row pagination feature.\n *\n * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.\n */\nexport function constructRowPaginationFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<RowPaginationFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        ...initialState,\n        pagination: {\n          ...getDefaultPaginationState(),\n          ...initialState.pagination,\n        },\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onPaginationChange: makeStateUpdater('pagination', table),\n      }\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('rowPaginationFeature', table, {\n        table_autoResetPageIndex: {\n          fn: () => table_autoResetPageIndex(table),\n        },\n        table_setPagination: {\n          fn: (updater) => table_setPagination(table, updater),\n        },\n        table_resetPagination: {\n          fn: (defaultState) => table_resetPagination(table, defaultState),\n        },\n        table_setPageIndex: {\n          fn: (updater) => table_setPageIndex(table, updater),\n        },\n        table_resetPageIndex: {\n          fn: (defaultState) => table_resetPageIndex(table, defaultState),\n        },\n        table_setPageSize: {\n          fn: (updater) => table_setPageSize(table, updater),\n        },\n        table_getPageCount: {\n          fn: () => table_getPageCount(table),\n        },\n        table_resetPageSize: {\n          fn: (defaultState) => table_resetPageSize(table, defaultState),\n        },\n        table_getPageOptions: {\n          fn: () => table_getPageOptions(table),\n        },\n        table_getCanPreviousPage: {\n          fn: () => table_getCanPreviousPage(table),\n        },\n        table_getCanNextPage: {\n          fn: () => table_getCanNextPage(table),\n        },\n        table_previousPage: {\n          fn: () => table_previousPage(table),\n        },\n        table_nextPage: {\n          fn: () => table_nextPage(table),\n        },\n        table_firstPage: {\n          fn: () => table_firstPage(table),\n        },\n        table_lastPage: {\n          fn: () => table_lastPage(table),\n        },\n        table_getRowCount: {\n          fn: () => table_getRowCount(table),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The stock row pagination feature.\n *\n * Register this feature to add pagination state, page navigation APIs, and\n * pagination-aware row model helpers to a table.\n */\nexport const rowPaginationFeature = constructRowPaginationFeature()\n"],"mappings":";;;;;;;;;AA8CA,SAAgB,gCAGsD;CACpE,OAAO;EACL,kBAAkB,iBAAiB;GACjC,OAAO;IACL,GAAG;IACH,YAAY;KACV,GAAG,0BAA0B;KAC7B,GAAG,aAAa;IAClB;GACF;EACF;EAEA,yBAAyB,UAAU;GACjC,OAAO,EACL,oBAAoB,iBAAiB,cAAc,KAAK,EAC1D;EACF;EAEA,qBAAqB,UAAU;GAC7B,gBAAgB,wBAAwB,OAAO;IAC7C,0BAA0B,EACxB,UAAU,yBAAyB,KAAK,EAC1C;IACA,qBAAqB,EACnB,KAAK,YAAY,oBAAoB,OAAO,OAAO,EACrD;IACA,uBAAuB,EACrB,KAAK,iBAAiB,sBAAsB,OAAO,YAAY,EACjE;IACA,oBAAoB,EAClB,KAAK,YAAY,mBAAmB,OAAO,OAAO,EACpD;IACA,sBAAsB,EACpB,KAAK,iBAAiB,qBAAqB,OAAO,YAAY,EAChE;IACA,mBAAmB,EACjB,KAAK,YAAY,kBAAkB,OAAO,OAAO,EACnD;IACA,oBAAoB,EAClB,UAAU,mBAAmB,KAAK,EACpC;IACA,qBAAqB,EACnB,KAAK,iBAAiB,oBAAoB,OAAO,YAAY,EAC/D;IACA,sBAAsB,EACpB,UAAU,qBAAqB,KAAK,EACtC;IACA,0BAA0B,EACxB,UAAU,yBAAyB,KAAK,EAC1C;IACA,sBAAsB,EACpB,UAAU,qBAAqB,KAAK,EACtC;IACA,oBAAoB,EAClB,UAAU,mBAAmB,KAAK,EACpC;IACA,gBAAgB,EACd,UAAU,eAAe,KAAK,EAChC;IACA,iBAAiB,EACf,UAAU,gBAAgB,KAAK,EACjC;IACA,gBAAgB,EACd,UAAU,eAAe,KAAK,EAChC;IACA,mBAAmB,EACjB,UAAU,kBAAkB,KAAK,EACnC;GACF,CAAC;EACH;CACF;AACF;;;;;;;AAQA,MAAa,uBAAuB,8BAA8B"}

package/dist/features/row-pagination/rowPaginationFeature.types.d.cts

@@ -0,0 +1,135 @@
+import { OnChangeFn, RowData, Updater } from "../../types/type-utils.cjs";
+import { TableFeatures } from "../../types/TableFeatures.cjs";
+import { Table } from "../../types/Table.cjs";
+import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.cjs";
+
+//#region src/features/row-pagination/rowPaginationFeature.types.d.ts
+interface PaginationState {
+  pageIndex: number;
+  pageSize: number;
+}
+interface TableState_RowPagination {
+  pagination: PaginationState;
+}
+interface TableOptions_RowPagination {
+  /**
+   * If set to `true`, pagination will be reset to the first page when page-altering state changes eg. `data` is updated, filters change, grouping changes, etc.
+   */
+  autoResetPageIndex?: boolean;
+  /**
+   * Enables manual pagination. If this option is set to `true`, the table will not automatically paginate rows using `getPaginatedRowModel()` and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation.
+   */
+  manualPagination?: boolean;
+  /**
+   * Called with an updater when pagination state changes. Pair this with
+   * `state.pagination` when using external state; external atoms can own the
+   * slice without this callback.
+   */
+  onPaginationChange?: OnChangeFn<PaginationState>;
+  /**
+   * When manually controlling pagination, you can supply a total `pageCount` value to the table if you know it (Or supply a `rowCount` and `pageCount` will be calculated). If you do not know how many pages there are, you can set this to `-1`.
+   */
+  pageCount?: number;
+  /**
+   * When manually controlling pagination, you can supply a total `rowCount` value to the table if you know it. The `pageCount` can be calculated from this value and the `pageSize`.
+   */
+  rowCount?: number;
+}
+interface PaginationDefaultOptions {
+  onPaginationChange: OnChangeFn<PaginationState>;
+}
+interface Table_RowPagination<TFeatures extends TableFeatures, TData extends RowData> {
+  _autoResetPageIndex: () => void;
+  /**
+   * Checks whether the current page index can move forward.
+   */
+  getCanNextPage: () => boolean;
+  /**
+   * Checks whether the current page index can move backward.
+   */
+  getCanPreviousPage: () => boolean;
+  /**
+   * Resolves the current page count from `options.pageCount` or row count and
+   * page size.
+   */
+  getPageCount: () => number;
+  /**
+   * Resolves the row count used for pagination math.
+   *
+   * `options.rowCount` wins; otherwise the pre-paginated row model is counted.
+   */
+  getRowCount: () => number;
+  /**
+   * Builds zero-based page indexes for the current page count.
+   */
+  getPageOptions: () => Array<number>;
+  /**
+   * Increments the page index by one, if possible.
+   */
+  nextPage: () => void;
+  /**
+   * Decrements the page index by one, if possible.
+   */
+  previousPage: () => void;
+  /**
+   * Sets the page index to `0`.
+   */
+  firstPage: () => void;
+  /**
+   * Sets the page index to the last page.
+   */
+  lastPage: () => void;
+  /**
+   * Resets `pagination.pageIndex` to initial state, or to `0` when
+   * `defaultState` is `true`.
+   */
+  resetPageIndex: (defaultState?: boolean) => void;
+  /**
+   * Resets `pagination.pageSize` to initial state, or to `10` when
+   * `defaultState` is `true`.
+   */
+  resetPageSize: (defaultState?: boolean) => void;
+  /**
+   * Resets `pagination` to `initialState.pagination`.
+   *
+   * Pass `true` to ignore initial state and reset to
+   * `{ pageIndex: 0, pageSize: 10 }`.
+   */
+  resetPagination: (defaultState?: boolean) => void;
+  /**
+   * Updates `pagination.pageIndex` using a value or updater.
+   */
+  setPageIndex: (updater: Updater<number>) => void;
+  /**
+   * Updates `pagination.pageSize` using a value or updater.
+   */
+  setPageSize: (updater: Updater<number>) => void;
+  /**
+   * Updates pagination state with a next state or updater function.
+   */
+  setPagination: (updater: Updater<PaginationState>) => void;
+}
+interface Table_RowModels_Paginated<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Resolves the row model after pagination has sliced the current page.
+   */
+  getPaginatedRowModel: () => RowModel<TFeatures, TData>;
+  /**
+   * Reads the row model immediately before pagination.
+   */
+  getPrePaginatedRowModel: () => RowModel<TFeatures, TData>;
+}
+interface CreateRowModel_Paginated<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Factory used to retrieve the paginated row model. If using server-side
+   * pagination, this is not required. To use client-side pagination, pass
+   * `createPaginatedRowModel()` or implement your own factory.
+   */
+  paginatedRowModel?: (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData>;
+}
+interface CachedRowModel_Paginated<TFeatures extends TableFeatures, TData extends RowData> {
+  paginatedRowModel: () => RowModel<TFeatures, TData>;
+}
+//#endregion
+export { CachedRowModel_Paginated, CreateRowModel_Paginated, PaginationDefaultOptions, PaginationState, TableOptions_RowPagination, TableState_RowPagination, Table_RowModels_Paginated, Table_RowPagination };
+//# sourceMappingURL=rowPaginationFeature.types.d.cts.map

package/dist/features/row-pagination/rowPaginationFeature.types.d.ts

@@ -0,0 +1,135 @@
+import { OnChangeFn, RowData, Updater } from "../../types/type-utils.js";
+import { TableFeatures } from "../../types/TableFeatures.js";
+import { Table } from "../../types/Table.js";
+import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.js";
+
+//#region src/features/row-pagination/rowPaginationFeature.types.d.ts
+interface PaginationState {
+  pageIndex: number;
+  pageSize: number;
+}
+interface TableState_RowPagination {
+  pagination: PaginationState;
+}
+interface TableOptions_RowPagination {
+  /**
+   * If set to `true`, pagination will be reset to the first page when page-altering state changes eg. `data` is updated, filters change, grouping changes, etc.
+   */
+  autoResetPageIndex?: boolean;
+  /**
+   * Enables manual pagination. If this option is set to `true`, the table will not automatically paginate rows using `getPaginatedRowModel()` and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation.
+   */
+  manualPagination?: boolean;
+  /**
+   * Called with an updater when pagination state changes. Pair this with
+   * `state.pagination` when using external state; external atoms can own the
+   * slice without this callback.
+   */
+  onPaginationChange?: OnChangeFn<PaginationState>;
+  /**
+   * When manually controlling pagination, you can supply a total `pageCount` value to the table if you know it (Or supply a `rowCount` and `pageCount` will be calculated). If you do not know how many pages there are, you can set this to `-1`.
+   */
+  pageCount?: number;
+  /**
+   * When manually controlling pagination, you can supply a total `rowCount` value to the table if you know it. The `pageCount` can be calculated from this value and the `pageSize`.
+   */
+  rowCount?: number;
+}
+interface PaginationDefaultOptions {
+  onPaginationChange: OnChangeFn<PaginationState>;
+}
+interface Table_RowPagination<TFeatures extends TableFeatures, TData extends RowData> {
+  _autoResetPageIndex: () => void;
+  /**
+   * Checks whether the current page index can move forward.
+   */
+  getCanNextPage: () => boolean;
+  /**
+   * Checks whether the current page index can move backward.
+   */
+  getCanPreviousPage: () => boolean;
+  /**
+   * Resolves the current page count from `options.pageCount` or row count and
+   * page size.
+   */
+  getPageCount: () => number;
+  /**
+   * Resolves the row count used for pagination math.
+   *
+   * `options.rowCount` wins; otherwise the pre-paginated row model is counted.
+   */
+  getRowCount: () => number;
+  /**
+   * Builds zero-based page indexes for the current page count.
+   */
+  getPageOptions: () => Array<number>;
+  /**
+   * Increments the page index by one, if possible.
+   */
+  nextPage: () => void;
+  /**
+   * Decrements the page index by one, if possible.
+   */
+  previousPage: () => void;
+  /**
+   * Sets the page index to `0`.
+   */
+  firstPage: () => void;
+  /**
+   * Sets the page index to the last page.
+   */
+  lastPage: () => void;
+  /**
+   * Resets `pagination.pageIndex` to initial state, or to `0` when
+   * `defaultState` is `true`.
+   */
+  resetPageIndex: (defaultState?: boolean) => void;
+  /**
+   * Resets `pagination.pageSize` to initial state, or to `10` when
+   * `defaultState` is `true`.
+   */
+  resetPageSize: (defaultState?: boolean) => void;
+  /**
+   * Resets `pagination` to `initialState.pagination`.
+   *
+   * Pass `true` to ignore initial state and reset to
+   * `{ pageIndex: 0, pageSize: 10 }`.
+   */
+  resetPagination: (defaultState?: boolean) => void;
+  /**
+   * Updates `pagination.pageIndex` using a value or updater.
+   */
+  setPageIndex: (updater: Updater<number>) => void;
+  /**
+   * Updates `pagination.pageSize` using a value or updater.
+   */
+  setPageSize: (updater: Updater<number>) => void;
+  /**
+   * Updates pagination state with a next state or updater function.
+   */
+  setPagination: (updater: Updater<PaginationState>) => void;
+}
+interface Table_RowModels_Paginated<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Resolves the row model after pagination has sliced the current page.
+   */
+  getPaginatedRowModel: () => RowModel<TFeatures, TData>;
+  /**
+   * Reads the row model immediately before pagination.
+   */
+  getPrePaginatedRowModel: () => RowModel<TFeatures, TData>;
+}
+interface CreateRowModel_Paginated<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Factory used to retrieve the paginated row model. If using server-side
+   * pagination, this is not required. To use client-side pagination, pass
+   * `createPaginatedRowModel()` or implement your own factory.
+   */
+  paginatedRowModel?: (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData>;
+}
+interface CachedRowModel_Paginated<TFeatures extends TableFeatures, TData extends RowData> {
+  paginatedRowModel: () => RowModel<TFeatures, TData>;
+}
+//#endregion
+export { CachedRowModel_Paginated, CreateRowModel_Paginated, PaginationDefaultOptions, PaginationState, TableOptions_RowPagination, TableState_RowPagination, Table_RowModels_Paginated, Table_RowPagination };
+//# sourceMappingURL=rowPaginationFeature.types.d.ts.map

package/dist/features/row-pagination/rowPaginationFeature.utils.cjs

@@ -0,0 +1,312 @@
+const require_utils = require('../../utils.cjs');
+
+//#region src/features/row-pagination/rowPaginationFeature.utils.ts
+const defaultPageIndex = 0;
+const defaultPageSize = 10;
+/**
+* Creates the default pagination state used by the pagination feature.
+*
+* The feature default starts at the first page with a page size of 10. Reset
+* APIs use this value when `defaultState` is `true`.
+*
+* @example
+* ```ts
+* const pagination = getDefaultPaginationState()
+* ```
+*/
+function getDefaultPaginationState() {
+	return {
+		pageIndex: defaultPageIndex,
+		pageSize: defaultPageSize
+	};
+}
+/**
+* Resets the page index when a page-altering change should return to page 0.
+*
+* The reset runs when `autoResetAll`, `autoResetPageIndex`, or the default
+* client-side pagination behavior allows it. Manual pagination opts out unless
+* the reset options explicitly opt back in.
+*
+* @example
+* ```ts
+* table_autoResetPageIndex(table)
+* ```
+*/
+function table_autoResetPageIndex(table) {
+	if (table.options.autoResetAll ?? table.options.autoResetPageIndex ?? !table.options.manualPagination) table_resetPageIndex(table);
+}
+/**
+* Routes a pagination updater through the table's pagination change handler.
+*
+* The updater may be a next state object or a function of the previous
+* `PaginationState`; controlled state and external atoms observe the same
+* updater path as the instance API.
+*
+* @example
+* ```ts
+* table_setPagination(table, (old) => old)
+* ```
+*/
+function table_setPagination(table, updater) {
+	var _table$options$onPagi, _table$options;
+	const safeUpdater = (old) => {
+		return require_utils.functionalUpdate(updater, old);
+	};
+	return (_table$options$onPagi = (_table$options = table.options).onPaginationChange) === null || _table$options$onPagi === void 0 ? void 0 : _table$options$onPagi.call(_table$options, safeUpdater);
+}
+/**
+* Resets `pagination` to the configured initial state or feature default.
+*
+* With no argument, the reset clones `table.initialState.pagination` when it
+* exists. Passing `true` ignores initial state and resets to
+* `{ pageIndex: 0, pageSize: 10 }`.
+*
+* @example
+* ```ts
+* table_resetPagination(table)
+* table_resetPagination(table, true)
+* ```
+*/
+function table_resetPagination(table, defaultState) {
+	table_setPagination(table, defaultState ? getDefaultPaginationState() : require_utils.cloneState(table.initialState.pagination ?? getDefaultPaginationState()));
+}
+/**
+* Updates `pagination.pageIndex` and clamps it to the known page range.
+*
+* Unknown page counts (`undefined` or `-1`) allow any non-negative page index.
+* Known page counts clamp the index between `0` and `pageCount - 1`.
+*
+* @example
+* ```ts
+* table_setPageIndex(table, (old) => old)
+* ```
+*/
+function table_setPageIndex(table, updater) {
+	table_setPagination(table, (old) => {
+		let pageIndex = require_utils.functionalUpdate(updater, old.pageIndex);
+		const maxPageIndex = typeof table.options.pageCount === "undefined" || table.options.pageCount === -1 ? Number.MAX_SAFE_INTEGER : table.options.pageCount - 1;
+		pageIndex = Math.max(0, Math.min(pageIndex, maxPageIndex));
+		return {
+			...old,
+			pageIndex
+		};
+	});
+}
+/**
+* Resets only `pagination.pageIndex`.
+*
+* With no argument, the reset uses `table.initialState.pagination?.pageIndex`
+* or `0`. Passing `true` always resets the page index to `0`.
+*
+* @example
+* ```ts
+* table_resetPageIndex(table)
+* table_resetPageIndex(table, true)
+* ```
+*/
+function table_resetPageIndex(table, defaultState) {
+	var _table$atoms$paginati, _table$initialState$p;
+	const currentPageIndex = ((_table$atoms$paginati = table.atoms.pagination) === null || _table$atoms$paginati === void 0 || (_table$atoms$paginati = _table$atoms$paginati.get()) === null || _table$atoms$paginati === void 0 ? void 0 : _table$atoms$paginati.pageIndex) ?? defaultPageIndex;
+	const newPageIndex = defaultState ? defaultPageIndex : ((_table$initialState$p = table.initialState.pagination) === null || _table$initialState$p === void 0 ? void 0 : _table$initialState$p.pageIndex) ?? defaultPageIndex;
+	if (newPageIndex === currentPageIndex) return;
+	table_setPageIndex(table, newPageIndex);
+}
+/**
+* Resets only `pagination.pageSize`.
+*
+* With no argument, the reset uses `table.initialState.pagination?.pageSize`
+* or `10`. Passing `true` always resets the page size to `10`.
+*
+* @example
+* ```ts
+* table_resetPageSize(table)
+* table_resetPageSize(table, true)
+* ```
+*/
+function table_resetPageSize(table, defaultState) {
+	var _table$atoms$paginati2, _table$initialState$p2;
+	const currentPageSize = ((_table$atoms$paginati2 = table.atoms.pagination) === null || _table$atoms$paginati2 === void 0 || (_table$atoms$paginati2 = _table$atoms$paginati2.get()) === null || _table$atoms$paginati2 === void 0 ? void 0 : _table$atoms$paginati2.pageSize) ?? defaultPageSize;
+	const newPageSize = defaultState ? defaultPageSize : ((_table$initialState$p2 = table.initialState.pagination) === null || _table$initialState$p2 === void 0 ? void 0 : _table$initialState$p2.pageSize) ?? defaultPageSize;
+	if (newPageSize === currentPageSize) return;
+	table_setPageSize(table, newPageSize);
+}
+/**
+* Updates `pagination.pageSize` while preserving the current top row.
+*
+* The new size is clamped to at least `1`, and `pageIndex` is recalculated so
+* the row that was previously at the top of the page remains in view.
+*
+* @example
+* ```ts
+* table_setPageSize(table, (old) => old)
+* ```
+*/
+function table_setPageSize(table, updater) {
+	table_setPagination(table, (old) => {
+		const pageSize = Math.max(1, require_utils.functionalUpdate(updater, old.pageSize));
+		const topRowIndex = old.pageSize * old.pageIndex;
+		const pageIndex = Math.floor(topRowIndex / pageSize);
+		return {
+			...old,
+			pageIndex,
+			pageSize
+		};
+	});
+}
+/**
+* Builds the zero-based page indexes available for the current page count.
+*
+* Unknown or empty page counts return an empty array; otherwise the result is
+* `[0, 1, ...pageCount - 1]`.
+*
+* @example
+* ```ts
+* const pageIndexes = table_getPageOptions(table)
+* ```
+*/
+function table_getPageOptions(table) {
+	const pageCount = table_getPageCount(table);
+	let pageOptions = [];
+	if (pageCount && pageCount > 0) pageOptions = [...new Array(pageCount)].fill(null).map((_, i) => i);
+	return pageOptions;
+}
+/**
+* Checks whether the current page index can move backward.
+*
+* The first page is page index `0`, so only positive page indexes can navigate
+* to a previous page.
+*
+* @example
+* ```ts
+* const canGoBack = table_getCanPreviousPage(table)
+* ```
+*/
+function table_getCanPreviousPage(table) {
+	var _table$atoms$paginati3;
+	return (((_table$atoms$paginati3 = table.atoms.pagination) === null || _table$atoms$paginati3 === void 0 || (_table$atoms$paginati3 = _table$atoms$paginati3.get()) === null || _table$atoms$paginati3 === void 0 ? void 0 : _table$atoms$paginati3.pageIndex) ?? 0) > 0;
+}
+/**
+* Checks whether the current page index can move forward.
+*
+* A `pageCount` of `-1` means the caller does not know the total page count, so
+* this returns `true`. A page count of `0` returns `false`.
+*
+* @example
+* ```ts
+* const canGoForward = table_getCanNextPage(table)
+* ```
+*/
+function table_getCanNextPage(table) {
+	var _table$atoms$paginati4;
+	const pageIndex = ((_table$atoms$paginati4 = table.atoms.pagination) === null || _table$atoms$paginati4 === void 0 || (_table$atoms$paginati4 = _table$atoms$paginati4.get()) === null || _table$atoms$paginati4 === void 0 ? void 0 : _table$atoms$paginati4.pageIndex) ?? defaultPageIndex;
+	const pageCount = table_getPageCount(table);
+	if (pageCount === -1) return true;
+	if (pageCount === 0) return false;
+	return pageIndex < pageCount - 1;
+}
+/**
+* Moves the table to the previous page.
+*
+* This delegates to `table_setPageIndex` so pagination state ownership and
+* updater semantics remain consistent.
+*
+* @example
+* ```ts
+* table_previousPage(table)
+* ```
+*/
+function table_previousPage(table) {
+	return table_setPageIndex(table, (old) => old - 1);
+}
+/**
+* Moves the table to the next page.
+*
+* This delegates to `table_setPageIndex` so pagination state ownership and
+* updater semantics remain consistent.
+*
+* @example
+* ```ts
+* table_nextPage(table)
+* ```
+*/
+function table_nextPage(table) {
+	return table_setPageIndex(table, (old) => {
+		return old + 1;
+	});
+}
+/**
+* Moves the table to the first page.
+*
+* This is a convenience wrapper around `table_setPageIndex(table, 0)`.
+*
+* @example
+* ```ts
+* table_firstPage(table)
+* ```
+*/
+function table_firstPage(table) {
+	return table_setPageIndex(table, 0);
+}
+/**
+* Moves the table to the last known page.
+*
+* The target page is derived from `table_getPageCount(table) - 1`.
+*
+* @example
+* ```ts
+* table_lastPage(table)
+* ```
+*/
+function table_lastPage(table) {
+	return table_setPageIndex(table, table_getPageCount(table) - 1);
+}
+/**
+* Resolves the number of pages for the current pagination state.
+*
+* `options.pageCount` wins for manual pagination. Otherwise the value is
+* calculated from `table_getRowCount(table)` and the current `pageSize`.
+*
+* @example
+* ```ts
+* const pages = table_getPageCount(table)
+* ```
+*/
+function table_getPageCount(table) {
+	var _table$atoms$paginati5;
+	return table.options.pageCount ?? Math.ceil(table_getRowCount(table) / (((_table$atoms$paginati5 = table.atoms.pagination) === null || _table$atoms$paginati5 === void 0 || (_table$atoms$paginati5 = _table$atoms$paginati5.get()) === null || _table$atoms$paginati5 === void 0 ? void 0 : _table$atoms$paginati5.pageSize) ?? defaultPageSize));
+}
+/**
+* Resolves the total row count used for pagination math.
+*
+* `options.rowCount` wins for manual pagination. Otherwise the count comes
+* from the pre-paginated row model so filtering, grouping, sorting, and
+* expansion are reflected before the page slice is applied.
+*
+* @example
+* ```ts
+* const rows = table_getRowCount(table)
+* ```
+*/
+function table_getRowCount(table) {
+	return table.options.rowCount ?? table.getPrePaginatedRowModel().rows.length;
+}
+
+//#endregion
+exports.getDefaultPaginationState = getDefaultPaginationState;
+exports.table_autoResetPageIndex = table_autoResetPageIndex;
+exports.table_firstPage = table_firstPage;
+exports.table_getCanNextPage = table_getCanNextPage;
+exports.table_getCanPreviousPage = table_getCanPreviousPage;
+exports.table_getPageCount = table_getPageCount;
+exports.table_getPageOptions = table_getPageOptions;
+exports.table_getRowCount = table_getRowCount;
+exports.table_lastPage = table_lastPage;
+exports.table_nextPage = table_nextPage;
+exports.table_previousPage = table_previousPage;
+exports.table_resetPageIndex = table_resetPageIndex;
+exports.table_resetPageSize = table_resetPageSize;
+exports.table_resetPagination = table_resetPagination;
+exports.table_setPageIndex = table_setPageIndex;
+exports.table_setPageSize = table_setPageSize;
+exports.table_setPagination = table_setPagination;
+//# sourceMappingURL=rowPaginationFeature.utils.cjs.map

package/dist/features/row-pagination/rowPaginationFeature.utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rowPaginationFeature.utils.cjs","names":["functionalUpdate","cloneState"],"sources":["../../../src/features/row-pagination/rowPaginationFeature.utils.ts"],"sourcesContent":["import { cloneState, functionalUpdate } from '../../utils'\nimport type { RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { PaginationState } from './rowPaginationFeature.types'\n\nconst defaultPageIndex = 0\nconst defaultPageSize = 10\n\n/**\n * Creates the default pagination state used by the pagination feature.\n *\n * The feature default starts at the first page with a page size of 10. Reset\n * APIs use this value when `defaultState` is `true`.\n *\n * @example\n * ```ts\n * const pagination = getDefaultPaginationState()\n * ```\n */\nexport function getDefaultPaginationState(): PaginationState {\n  return {\n    pageIndex: defaultPageIndex,\n    pageSize: defaultPageSize,\n  }\n}\n\n/**\n * Resets the page index when a page-altering change should return to page 0.\n *\n * The reset runs when `autoResetAll`, `autoResetPageIndex`, or the default\n * client-side pagination behavior allows it. Manual pagination opts out unless\n * the reset options explicitly opt back in.\n *\n * @example\n * ```ts\n * table_autoResetPageIndex(table)\n * ```\n */\nexport function table_autoResetPageIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  if (\n    table.options.autoResetAll ??\n    table.options.autoResetPageIndex ??\n    !table.options.manualPagination\n  ) {\n    table_resetPageIndex(table)\n  }\n}\n\n/**\n * Routes a pagination updater through the table's pagination change handler.\n *\n * The updater may be a next state object or a function of the previous\n * `PaginationState`; controlled state and external atoms observe the same\n * updater path as the instance API.\n *\n * @example\n * ```ts\n * table_setPagination(table, (old) => old)\n * ```\n */\nexport function table_setPagination<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<PaginationState>) {\n  const safeUpdater: Updater<PaginationState> = (old) => {\n    const newState = functionalUpdate(updater, old)\n\n    return newState\n  }\n\n  return table.options.onPaginationChange?.(safeUpdater)\n}\n\n/**\n * Resets `pagination` to the configured initial state or feature default.\n *\n * With no argument, the reset clones `table.initialState.pagination` when it\n * exists. Passing `true` ignores initial state and resets to\n * `{ pageIndex: 0, pageSize: 10 }`.\n *\n * @example\n * ```ts\n * table_resetPagination(table)\n * table_resetPagination(table, true)\n * ```\n */\nexport function table_resetPagination<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setPagination(\n    table,\n    defaultState\n      ? getDefaultPaginationState()\n      : cloneState(\n          table.initialState.pagination ?? getDefaultPaginationState(),\n        ),\n  )\n}\n\n/**\n * Updates `pagination.pageIndex` and clamps it to the known page range.\n *\n * Unknown page counts (`undefined` or `-1`) allow any non-negative page index.\n * Known page counts clamp the index between `0` and `pageCount - 1`.\n *\n * @example\n * ```ts\n * table_setPageIndex(table, (old) => old)\n * ```\n */\nexport function table_setPageIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<number>) {\n  table_setPagination(table, (old) => {\n    let pageIndex = functionalUpdate(updater, old.pageIndex)\n\n    const maxPageIndex =\n      typeof table.options.pageCount === 'undefined' ||\n      table.options.pageCount === -1\n        ? Number.MAX_SAFE_INTEGER\n        : table.options.pageCount - 1\n\n    pageIndex = Math.max(0, Math.min(pageIndex, maxPageIndex))\n\n    return {\n      ...old,\n      pageIndex,\n    }\n  })\n}\n\n/**\n * Resets only `pagination.pageIndex`.\n *\n * With no argument, the reset uses `table.initialState.pagination?.pageIndex`\n * or `0`. Passing `true` always resets the page index to `0`.\n *\n * @example\n * ```ts\n * table_resetPageIndex(table)\n * table_resetPageIndex(table, true)\n * ```\n */\nexport function table_resetPageIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  const currentPageIndex =\n    table.atoms.pagination?.get()?.pageIndex ?? defaultPageIndex\n  const newPageIndex = defaultState\n    ? defaultPageIndex\n    : (table.initialState.pagination?.pageIndex ?? defaultPageIndex)\n  if (newPageIndex === currentPageIndex) return\n  table_setPageIndex(table, newPageIndex)\n}\n\n/**\n * Resets only `pagination.pageSize`.\n *\n * With no argument, the reset uses `table.initialState.pagination?.pageSize`\n * or `10`. Passing `true` always resets the page size to `10`.\n *\n * @example\n * ```ts\n * table_resetPageSize(table)\n * table_resetPageSize(table, true)\n * ```\n */\nexport function table_resetPageSize<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  const currentPageSize =\n    table.atoms.pagination?.get()?.pageSize ?? defaultPageSize\n  const newPageSize = defaultState\n    ? defaultPageSize\n    : (table.initialState.pagination?.pageSize ?? defaultPageSize)\n  if (newPageSize === currentPageSize) return\n  table_setPageSize(table, newPageSize)\n}\n\n/**\n * Updates `pagination.pageSize` while preserving the current top row.\n *\n * The new size is clamped to at least `1`, and `pageIndex` is recalculated so\n * the row that was previously at the top of the page remains in view.\n *\n * @example\n * ```ts\n * table_setPageSize(table, (old) => old)\n * ```\n */\nexport function table_setPageSize<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<number>) {\n  table_setPagination(table, (old) => {\n    const pageSize = Math.max(1, functionalUpdate(updater, old.pageSize))\n    const topRowIndex = old.pageSize * old.pageIndex\n    const pageIndex = Math.floor(topRowIndex / pageSize)\n\n    return {\n      ...old,\n      pageIndex,\n      pageSize,\n    }\n  })\n}\n\n/**\n * Builds the zero-based page indexes available for the current page count.\n *\n * Unknown or empty page counts return an empty array; otherwise the result is\n * `[0, 1, ...pageCount - 1]`.\n *\n * @example\n * ```ts\n * const pageIndexes = table_getPageOptions(table)\n * ```\n */\nexport function table_getPageOptions<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const pageCount = table_getPageCount(table)\n  let pageOptions: Array<number> = []\n  if (pageCount && pageCount > 0) {\n    pageOptions = [...new Array(pageCount)].fill(null).map((_, i) => i)\n  }\n  return pageOptions\n}\n\n/**\n * Checks whether the current page index can move backward.\n *\n * The first page is page index `0`, so only positive page indexes can navigate\n * to a previous page.\n *\n * @example\n * ```ts\n * const canGoBack = table_getCanPreviousPage(table)\n * ```\n */\nexport function table_getCanPreviousPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return (table.atoms.pagination?.get()?.pageIndex ?? 0) > 0\n}\n\n/**\n * Checks whether the current page index can move forward.\n *\n * A `pageCount` of `-1` means the caller does not know the total page count, so\n * this returns `true`. A page count of `0` returns `false`.\n *\n * @example\n * ```ts\n * const canGoForward = table_getCanNextPage(table)\n * ```\n */\nexport function table_getCanNextPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const pageIndex = table.atoms.pagination?.get()?.pageIndex ?? defaultPageIndex\n\n  const pageCount = table_getPageCount(table)\n\n  if (pageCount === -1) {\n    return true\n  }\n\n  if (pageCount === 0) {\n    return false\n  }\n\n  return pageIndex < pageCount - 1\n}\n\n/**\n * Moves the table to the previous page.\n *\n * This delegates to `table_setPageIndex` so pagination state ownership and\n * updater semantics remain consistent.\n *\n * @example\n * ```ts\n * table_previousPage(table)\n * ```\n */\nexport function table_previousPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table_setPageIndex(table, (old) => old - 1)\n}\n\n/**\n * Moves the table to the next page.\n *\n * This delegates to `table_setPageIndex` so pagination state ownership and\n * updater semantics remain consistent.\n *\n * @example\n * ```ts\n * table_nextPage(table)\n * ```\n */\nexport function table_nextPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table_setPageIndex(table, (old) => {\n    return old + 1\n  })\n}\n\n/**\n * Moves the table to the first page.\n *\n * This is a convenience wrapper around `table_setPageIndex(table, 0)`.\n *\n * @example\n * ```ts\n * table_firstPage(table)\n * ```\n */\nexport function table_firstPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table_setPageIndex(table, 0)\n}\n\n/**\n * Moves the table to the last known page.\n *\n * The target page is derived from `table_getPageCount(table) - 1`.\n *\n * @example\n * ```ts\n * table_lastPage(table)\n * ```\n */\nexport function table_lastPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table_setPageIndex(table, table_getPageCount(table) - 1)\n}\n\n/**\n * Resolves the number of pages for the current pagination state.\n *\n * `options.pageCount` wins for manual pagination. Otherwise the value is\n * calculated from `table_getRowCount(table)` and the current `pageSize`.\n *\n * @example\n * ```ts\n * const pages = table_getPageCount(table)\n * ```\n */\nexport function table_getPageCount<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return (\n    table.options.pageCount ??\n    Math.ceil(\n      table_getRowCount(table) /\n        (table.atoms.pagination?.get()?.pageSize ?? defaultPageSize),\n    )\n  )\n}\n\n/**\n * Resolves the total row count used for pagination math.\n *\n * `options.rowCount` wins for manual pagination. Otherwise the count comes\n * from the pre-paginated row model so filtering, grouping, sorting, and\n * expansion are reflected before the page slice is applied.\n *\n * @example\n * ```ts\n * const rows = table_getRowCount(table)\n * ```\n */\nexport function table_getRowCount<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table.options.rowCount ?? table.getPrePaginatedRowModel().rows.length\n}\n"],"mappings":";;;AAMA,MAAM,mBAAmB;AACzB,MAAM,kBAAkB;;;;;;;;;;;;AAaxB,SAAgB,4BAA6C;CAC3D,OAAO;EACL,WAAW;EACX,UAAU;CACZ;AACF;;;;;;;;;;;;;AAcA,SAAgB,yBAGd,OAAyC;CACzC,IACE,MAAM,QAAQ,gBACd,MAAM,QAAQ,sBACd,CAAC,MAAM,QAAQ,kBAEf,qBAAqB,KAAK;AAE9B;;;;;;;;;;;;;AAcA,SAAgB,oBAGd,OAAyC,SAAmC;;CAC5E,MAAM,eAAyC,QAAQ;EAGrD,OAFiBA,+BAAiB,SAAS,GAE7B;CAChB;CAEA,kDAAO,MAAM,SAAQ,uHAAqB,WAAW;AACvD;;;;;;;;;;;;;;AAeA,SAAgB,sBAGd,OAAyC,cAAwB;CACjE,oBACE,OACA,eACI,0BAA0B,IAC1BC,yBACE,MAAM,aAAa,cAAc,0BAA0B,CAC7D,CACN;AACF;;;;;;;;;;;;AAaA,SAAgB,mBAGd,OAAyC,SAA0B;CACnE,oBAAoB,QAAQ,QAAQ;EAClC,IAAI,YAAYD,+BAAiB,SAAS,IAAI,SAAS;EAEvD,MAAM,eACJ,OAAO,MAAM,QAAQ,cAAc,eACnC,MAAM,QAAQ,cAAc,KACxB,OAAO,mBACP,MAAM,QAAQ,YAAY;EAEhC,YAAY,KAAK,IAAI,GAAG,KAAK,IAAI,WAAW,YAAY,CAAC;EAEzD,OAAO;GACL,GAAG;GACH;EACF;CACF,CAAC;AACH;;;;;;;;;;;;;AAcA,SAAgB,qBAGd,OAAyC,cAAwB;;CACjE,MAAM,6CACJ,MAAM,MAAM,2GAAY,IAAI,iFAAG,cAAa;CAC9C,MAAM,eAAe,eACjB,6CACC,MAAM,aAAa,0FAAY,cAAa;CACjD,IAAI,iBAAiB,kBAAkB;CACvC,mBAAmB,OAAO,YAAY;AACxC;;;;;;;;;;;;;AAcA,SAAgB,oBAGd,OAAyC,cAAwB;;CACjE,MAAM,6CACJ,MAAM,MAAM,8GAAY,IAAI,mFAAG,aAAY;CAC7C,MAAM,cAAc,eAChB,6CACC,MAAM,aAAa,4FAAY,aAAY;CAChD,IAAI,gBAAgB,iBAAiB;CACrC,kBAAkB,OAAO,WAAW;AACtC;;;;;;;;;;;;AAaA,SAAgB,kBAGd,OAAyC,SAA0B;CACnE,oBAAoB,QAAQ,QAAQ;EAClC,MAAM,WAAW,KAAK,IAAI,GAAGA,+BAAiB,SAAS,IAAI,QAAQ,CAAC;EACpE,MAAM,cAAc,IAAI,WAAW,IAAI;EACvC,MAAM,YAAY,KAAK,MAAM,cAAc,QAAQ;EAEnD,OAAO;GACL,GAAG;GACH;GACA;EACF;CACF,CAAC;AACH;;;;;;;;;;;;AAaA,SAAgB,qBAGd,OAAyC;CACzC,MAAM,YAAY,mBAAmB,KAAK;CAC1C,IAAI,cAA6B,CAAC;CAClC,IAAI,aAAa,YAAY,GAC3B,cAAc,CAAC,GAAG,IAAI,MAAM,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC;CAEpE,OAAO;AACT;;;;;;;;;;;;AAaA,SAAgB,yBAGd,OAAyC;;CACzC,mCAAQ,MAAM,MAAM,8GAAY,IAAI,mFAAG,cAAa,KAAK;AAC3D;;;;;;;;;;;;AAaA,SAAgB,qBAGd,OAAyC;;CACzC,MAAM,uCAAY,MAAM,MAAM,8GAAY,IAAI,mFAAG,cAAa;CAE9D,MAAM,YAAY,mBAAmB,KAAK;CAE1C,IAAI,cAAc,IAChB,OAAO;CAGT,IAAI,cAAc,GAChB,OAAO;CAGT,OAAO,YAAY,YAAY;AACjC;;;;;;;;;;;;AAaA,SAAgB,mBAGd,OAAyC;CACzC,OAAO,mBAAmB,QAAQ,QAAQ,MAAM,CAAC;AACnD;;;;;;;;;;;;AAaA,SAAgB,eAGd,OAAyC;CACzC,OAAO,mBAAmB,QAAQ,QAAQ;EACxC,OAAO,MAAM;CACf,CAAC;AACH;;;;;;;;;;;AAYA,SAAgB,gBAGd,OAAyC;CACzC,OAAO,mBAAmB,OAAO,CAAC;AACpC;;;;;;;;;;;AAYA,SAAgB,eAGd,OAAyC;CACzC,OAAO,mBAAmB,OAAO,mBAAmB,KAAK,IAAI,CAAC;AAChE;;;;;;;;;;;;AAaA,SAAgB,mBAGd,OAAyC;;CACzC,OACE,MAAM,QAAQ,aACd,KAAK,KACH,kBAAkB,KAAK,gCACpB,MAAM,MAAM,8GAAY,IAAI,mFAAG,aAAY,gBAChD;AAEJ;;;;;;;;;;;;;AAcA,SAAgB,kBAGd,OAAyC;CACzC,OAAO,MAAM,QAAQ,YAAY,MAAM,wBAAwB,CAAC,CAAC,KAAK;AACxE"}