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

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

@@ -3,15 +3,45 @@ const require_utils = require('../../utils.cjs');
 //#region src/features/row-pagination/rowPaginationFeature.utils.ts
 const defaultPageIndex = 0;
 const defaultPageSize = 10;
+/**
+* Returns the default pagination state.
+*
+* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+*
+* @example
+* ```ts
+* const initialValue = getDefaultPaginationState()
+* ```
+*/
 function getDefaultPaginationState() {
 	return {
 		pageIndex: defaultPageIndex,
 		pageSize: defaultPageSize
 	};
 }
+/**
+* Schedules an automatic reset for page index.
+*
+* The reset only runs when the related feature options allow automatic resets for the current table state change.
+*
+* @example
+* ```ts
+* table_autoResetPageIndex(table)
+* ```
+*/
 function table_autoResetPageIndex(table) {
 	if (table.options.autoResetAll ?? table.options.autoResetPageIndex ?? !table.options.manualPagination) table_resetPageIndex(table);
 }
+/**
+* Updates the table's pagination state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setPagination(table, (old) => old)
+* ```
+*/
 function table_setPagination(table, updater) {
 	var _table$options$onPagi, _table$options;
 	const safeUpdater = (old) => {
@@ -19,9 +49,30 @@ function table_setPagination(table, updater) {
 	};
 	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 the table's pagination state slice.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @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 the table's page index state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setPageIndex(table, (old) => old)
+* ```
+*/
 function table_setPageIndex(table, updater) {
 	table_setPagination(table, (old) => {
 		let pageIndex = require_utils.functionalUpdate(updater, old.pageIndex);
@@ -33,6 +84,17 @@ function table_setPageIndex(table, updater) {
 		};
 	});
 }
+/**
+* Resets the table's page index state slice.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @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;
@@ -40,6 +102,17 @@ function table_resetPageIndex(table, defaultState) {
 	if (newPageIndex === currentPageIndex) return;
 	table_setPageIndex(table, newPageIndex);
 }
+/**
+* Resets the table's page size state slice.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @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;
@@ -47,6 +120,16 @@ function table_resetPageSize(table, defaultState) {
 	if (newPageSize === currentPageSize) return;
 	table_setPageSize(table, newPageSize);
 }
+/**
+* Updates the table's page size state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @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));
@@ -59,16 +142,46 @@ function table_setPageSize(table, updater) {
 		};
 	});
 }
+/**
+* Returns page options for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = 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;
 }
+/**
+* Returns can previous page for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = 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;
 }
+/**
+* Returns can next page for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = 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;
@@ -77,24 +190,86 @@ function table_getCanNextPage(table) {
 	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);
 }
+/**
+* Returns page count for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = 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));
 }
+/**
+* Returns row count for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getRowCount(table)
+* ```
+*/
 function table_getRowCount(table) {
 	return table.options.rowCount ?? table.getPrePaginatedRowModel().rows.length;
 }

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

@@ -1 +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\nexport function getDefaultPaginationState(): PaginationState {\n  return {\n    pageIndex: defaultPageIndex,\n    pageSize: defaultPageSize,\n  }\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\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\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\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\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\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\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\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\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\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\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\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\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\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\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\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;AAExB,SAAgB,4BAA6C;AAC3D,QAAO;EACL,WAAW;EACX,UAAU;EACX;;AAGH,SAAgB,yBAGd,OAAyC;AACzC,KACE,MAAM,QAAQ,gBACd,MAAM,QAAQ,sBACd,CAAC,MAAM,QAAQ,iBAEf,sBAAqB,MAAM;;AAI/B,SAAgB,oBAGd,OAAyC,SAAmC;;CAC5E,MAAM,eAAyC,QAAQ;AAGrD,SAFiBA,+BAAiB,SAAS,IAE5B;;AAGjB,mDAAO,MAAM,SAAQ,uHAAqB,YAAY;;AAGxD,SAAgB,sBAGd,OAAyC,cAAwB;AACjE,qBACE,OACA,eACI,2BAA2B,GAC3BC,yBACE,MAAM,aAAa,cAAc,2BAA2B,CAC7D,CACN;;AAGH,SAAgB,mBAGd,OAAyC,SAA0B;AACnE,qBAAoB,QAAQ,QAAQ;EAClC,IAAI,YAAYD,+BAAiB,SAAS,IAAI,UAAU;EAExD,MAAM,eACJ,OAAO,MAAM,QAAQ,cAAc,eACnC,MAAM,QAAQ,cAAc,KACxB,OAAO,mBACP,MAAM,QAAQ,YAAY;AAEhC,cAAY,KAAK,IAAI,GAAG,KAAK,IAAI,WAAW,aAAa,CAAC;AAE1D,SAAO;GACL,GAAG;GACH;GACD;GACD;;AAGJ,SAAgB,qBAGd,OAAyC,cAAwB;;CACjE,MAAM,6CACJ,MAAM,MAAM,2GAAY,KAAK,gFAAE,cAAa;CAC9C,MAAM,eAAe,eACjB,6CACC,MAAM,aAAa,0FAAY,cAAa;AACjD,KAAI,iBAAiB,iBAAkB;AACvC,oBAAmB,OAAO,aAAa;;AAGzC,SAAgB,oBAGd,OAAyC,cAAwB;;CACjE,MAAM,6CACJ,MAAM,MAAM,8GAAY,KAAK,kFAAE,aAAY;CAC7C,MAAM,cAAc,eAChB,6CACC,MAAM,aAAa,4FAAY,aAAY;AAChD,KAAI,gBAAgB,gBAAiB;AACrC,mBAAkB,OAAO,YAAY;;AAGvC,SAAgB,kBAGd,OAAyC,SAA0B;AACnE,qBAAoB,QAAQ,QAAQ;EAClC,MAAM,WAAW,KAAK,IAAI,GAAGA,+BAAiB,SAAS,IAAI,SAAS,CAAC;EACrE,MAAM,cAAc,IAAI,WAAW,IAAI;EACvC,MAAM,YAAY,KAAK,MAAM,cAAc,SAAS;AAEpD,SAAO;GACL,GAAG;GACH;GACA;GACD;GACD;;AAGJ,SAAgB,qBAGd,OAAyC;CACzC,MAAM,YAAY,mBAAmB,MAAM;CAC3C,IAAI,cAA6B,EAAE;AACnC,KAAI,aAAa,YAAY,EAC3B,eAAc,CAAC,GAAG,IAAI,MAAM,UAAU,CAAC,CAAC,KAAK,KAAK,CAAC,KAAK,GAAG,MAAM,EAAE;AAErE,QAAO;;AAGT,SAAgB,yBAGd,OAAyC;;AACzC,oCAAQ,MAAM,MAAM,8GAAY,KAAK,kFAAE,cAAa,KAAK;;AAG3D,SAAgB,qBAGd,OAAyC;;CACzC,MAAM,uCAAY,MAAM,MAAM,8GAAY,KAAK,kFAAE,cAAa;CAE9D,MAAM,YAAY,mBAAmB,MAAM;AAE3C,KAAI,cAAc,GAChB,QAAO;AAGT,KAAI,cAAc,EAChB,QAAO;AAGT,QAAO,YAAY,YAAY;;AAGjC,SAAgB,mBAGd,OAAyC;AACzC,QAAO,mBAAmB,QAAQ,QAAQ,MAAM,EAAE;;AAGpD,SAAgB,eAGd,OAAyC;AACzC,QAAO,mBAAmB,QAAQ,QAAQ;AACxC,SAAO,MAAM;GACb;;AAGJ,SAAgB,gBAGd,OAAyC;AACzC,QAAO,mBAAmB,OAAO,EAAE;;AAGrC,SAAgB,eAGd,OAAyC;AACzC,QAAO,mBAAmB,OAAO,mBAAmB,MAAM,GAAG,EAAE;;AAGjE,SAAgB,mBAGd,OAAyC;;AACzC,QACE,MAAM,QAAQ,aACd,KAAK,KACH,kBAAkB,MAAM,+BACrB,MAAM,MAAM,8GAAY,KAAK,kFAAE,aAAY,iBAC/C;;AAIL,SAAgB,kBAGd,OAAyC;AACzC,QAAO,MAAM,QAAQ,YAAY,MAAM,yBAAyB,CAAC,KAAK"}
+{"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 * Returns the default pagination state.\n *\n * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.\n *\n * @example\n * ```ts\n * const initialValue = getDefaultPaginationState()\n * ```\n */\nexport function getDefaultPaginationState(): PaginationState {\n  return {\n    pageIndex: defaultPageIndex,\n    pageSize: defaultPageSize,\n  }\n}\n\n/**\n * Schedules an automatic reset for page index.\n *\n * The reset only runs when the related feature options allow automatic resets for the current table state change.\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 * Updates the table's pagination state slice.\n *\n * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.\n *\n * @example\n * ```ts\n * table_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 the table's pagination state slice.\n *\n * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.\n *\n * @example\n * ```ts\n * table_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 the table's page index state slice.\n *\n * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.\n *\n * @example\n * ```ts\n * table_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 the table's page index state slice.\n *\n * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.\n *\n * @example\n * ```ts\n * table_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 the table's page size state slice.\n *\n * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.\n *\n * @example\n * ```ts\n * table_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 the table's page size state slice.\n *\n * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.\n *\n * @example\n * ```ts\n * table_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 * Returns page options for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = 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 * Returns can previous page for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = 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 * Returns can next page for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = 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 * Returns page count for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = 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 * Returns row count for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = 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;;;;;;;;;;;AAYxB,SAAgB,4BAA6C;CAC3D,OAAO;EACL,WAAW;EACX,UAAU;EACX;;;;;;;;;;;;AAaH,SAAgB,yBAGd,OAAyC;CACzC,IACE,MAAM,QAAQ,gBACd,MAAM,QAAQ,sBACd,CAAC,MAAM,QAAQ,kBAEf,qBAAqB,MAAM;;;;;;;;;;;;AAc/B,SAAgB,oBAGd,OAAyC,SAAmC;;CAC5E,MAAM,eAAyC,QAAQ;EAGrD,OAFiBA,+BAAiB,SAAS,IAE5B;;CAGjB,kDAAO,MAAM,SAAQ,uHAAqB,YAAY;;;;;;;;;;;;;AAcxD,SAAgB,sBAGd,OAAyC,cAAwB;CACjE,oBACE,OACA,eACI,2BAA2B,GAC3BC,yBACE,MAAM,aAAa,cAAc,2BAA2B,CAC7D,CACN;;;;;;;;;;;;AAaH,SAAgB,mBAGd,OAAyC,SAA0B;CACnE,oBAAoB,QAAQ,QAAQ;EAClC,IAAI,YAAYD,+BAAiB,SAAS,IAAI,UAAU;EAExD,MAAM,eACJ,OAAO,MAAM,QAAQ,cAAc,eACnC,MAAM,QAAQ,cAAc,KACxB,OAAO,mBACP,MAAM,QAAQ,YAAY;EAEhC,YAAY,KAAK,IAAI,GAAG,KAAK,IAAI,WAAW,aAAa,CAAC;EAE1D,OAAO;GACL,GAAG;GACH;GACD;GACD;;;;;;;;;;;;;AAcJ,SAAgB,qBAGd,OAAyC,cAAwB;;CACjE,MAAM,6CACJ,MAAM,MAAM,2GAAY,KAAK,gFAAE,cAAa;CAC9C,MAAM,eAAe,eACjB,6CACC,MAAM,aAAa,0FAAY,cAAa;CACjD,IAAI,iBAAiB,kBAAkB;CACvC,mBAAmB,OAAO,aAAa;;;;;;;;;;;;;AAczC,SAAgB,oBAGd,OAAyC,cAAwB;;CACjE,MAAM,6CACJ,MAAM,MAAM,8GAAY,KAAK,kFAAE,aAAY;CAC7C,MAAM,cAAc,eAChB,6CACC,MAAM,aAAa,4FAAY,aAAY;CAChD,IAAI,gBAAgB,iBAAiB;CACrC,kBAAkB,OAAO,YAAY;;;;;;;;;;;;AAavC,SAAgB,kBAGd,OAAyC,SAA0B;CACnE,oBAAoB,QAAQ,QAAQ;EAClC,MAAM,WAAW,KAAK,IAAI,GAAGA,+BAAiB,SAAS,IAAI,SAAS,CAAC;EACrE,MAAM,cAAc,IAAI,WAAW,IAAI;EACvC,MAAM,YAAY,KAAK,MAAM,cAAc,SAAS;EAEpD,OAAO;GACL,GAAG;GACH;GACA;GACD;GACD;;;;;;;;;;;;AAaJ,SAAgB,qBAGd,OAAyC;CACzC,MAAM,YAAY,mBAAmB,MAAM;CAC3C,IAAI,cAA6B,EAAE;CACnC,IAAI,aAAa,YAAY,GAC3B,cAAc,CAAC,GAAG,IAAI,MAAM,UAAU,CAAC,CAAC,KAAK,KAAK,CAAC,KAAK,GAAG,MAAM,EAAE;CAErE,OAAO;;;;;;;;;;;;AAaT,SAAgB,yBAGd,OAAyC;;CACzC,mCAAQ,MAAM,MAAM,8GAAY,KAAK,kFAAE,cAAa,KAAK;;;;;;;;;;;;AAa3D,SAAgB,qBAGd,OAAyC;;CACzC,MAAM,uCAAY,MAAM,MAAM,8GAAY,KAAK,kFAAE,cAAa;CAE9D,MAAM,YAAY,mBAAmB,MAAM;CAE3C,IAAI,cAAc,IAChB,OAAO;CAGT,IAAI,cAAc,GAChB,OAAO;CAGT,OAAO,YAAY,YAAY;;;;;;;;;;;;;AAcjC,SAAgB,mBAGd,OAAyC;CACzC,OAAO,mBAAmB,QAAQ,QAAQ,MAAM,EAAE;;;;;;;;;;;;;AAcpD,SAAgB,eAGd,OAAyC;CACzC,OAAO,mBAAmB,QAAQ,QAAQ;EACxC,OAAO,MAAM;GACb;;;;;;;;;;;;AAaJ,SAAgB,gBAGd,OAAyC;CACzC,OAAO,mBAAmB,OAAO,EAAE;;;;;;;;;;;;AAarC,SAAgB,eAGd,OAAyC;CACzC,OAAO,mBAAmB,OAAO,mBAAmB,MAAM,GAAG,EAAE;;;;;;;;;;;;AAajE,SAAgB,mBAGd,OAAyC;;CACzC,OACE,MAAM,QAAQ,aACd,KAAK,KACH,kBAAkB,MAAM,+BACrB,MAAM,MAAM,8GAAY,KAAK,kFAAE,aAAY,iBAC/C;;;;;;;;;;;;AAcL,SAAgB,kBAGd,OAAyC;CACzC,OAAO,MAAM,QAAQ,YAAY,MAAM,yBAAyB,CAAC,KAAK"}

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

@@ -4,22 +4,197 @@ import { TableFeatures } from "../../types/TableFeatures.cjs";
 import { Table_Internal } from "../../types/Table.cjs";
 
 //#region src/features/row-pagination/rowPaginationFeature.utils.d.ts
+/**
+ * Returns the default pagination state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultPaginationState()
+ * ```
+ */
 declare function getDefaultPaginationState(): PaginationState;
+/**
+ * Schedules an automatic reset for page index.
+ *
+ * The reset only runs when the related feature options allow automatic resets for the current table state change.
+ *
+ * @example
+ * ```ts
+ * table_autoResetPageIndex(table)
+ * ```
+ */
 declare function table_autoResetPageIndex<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+/**
+ * Updates the table's pagination state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setPagination(table, (old) => old)
+ * ```
+ */
 declare function table_setPagination<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<PaginationState>): void | undefined;
+/**
+ * Resets the table's pagination state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetPagination(table)
+ * table_resetPagination(table, true)
+ * ```
+ */
 declare function table_resetPagination<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Updates the table's page index state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setPageIndex(table, (old) => old)
+ * ```
+ */
 declare function table_setPageIndex<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<number>): void;
+/**
+ * Resets the table's page index state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetPageIndex(table)
+ * table_resetPageIndex(table, true)
+ * ```
+ */
 declare function table_resetPageIndex<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Resets the table's page size state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetPageSize(table)
+ * table_resetPageSize(table, true)
+ * ```
+ */
 declare function table_resetPageSize<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Updates the table's page size state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setPageSize(table, (old) => old)
+ * ```
+ */
 declare function table_setPageSize<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<number>): void;
+/**
+ * Returns page options for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPageOptions(table)
+ * ```
+ */
 declare function table_getPageOptions<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): number[];
+/**
+ * Returns can previous page for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCanPreviousPage(table)
+ * ```
+ */
 declare function table_getCanPreviousPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * Returns can next page for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCanNextPage(table)
+ * ```
+ */
 declare function table_getCanNextPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function table_previousPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+/**
+ * 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)
+ * ```
+ */
 declare function table_nextPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+/**
+ * Moves the table to the first page.
+ *
+ * This is a convenience wrapper around `table_setPageIndex(table, 0)`.
+ *
+ * @example
+ * ```ts
+ * table_firstPage(table)
+ * ```
+ */
 declare function table_firstPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+/**
+ * Moves the table to the last known page.
+ *
+ * The target page is derived from `table_getPageCount(table) - 1`.
+ *
+ * @example
+ * ```ts
+ * table_lastPage(table)
+ * ```
+ */
 declare function table_lastPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+/**
+ * Returns page count for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPageCount(table)
+ * ```
+ */
 declare function table_getPageCount<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): number;
+/**
+ * Returns row count for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getRowCount(table)
+ * ```
+ */
 declare function table_getRowCount<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): number;
 //#endregion
 export { getDefaultPaginationState, table_autoResetPageIndex, table_firstPage, table_getCanNextPage, table_getCanPreviousPage, table_getPageCount, table_getPageOptions, table_getRowCount, table_lastPage, table_nextPage, table_previousPage, table_resetPageIndex, table_resetPageSize, table_resetPagination, table_setPageIndex, table_setPageSize, table_setPagination };