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

package/dist/features/row-expanding/rowExpandingFeature.utils.js

@@ -1,26 +1,97 @@
 import { cloneState } from "../../utils.js";
 
 //#region src/features/row-expanding/rowExpandingFeature.utils.ts
+/**
+* Returns the default expanded state.
+*
+* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+*
+* @example
+* ```ts
+* const initialValue = getDefaultExpandedState()
+* ```
+*/
 function getDefaultExpandedState() {
 	return {};
 }
+/**
+* Schedules an automatic reset for expanded.
+*
+* The reset only runs when the related feature options allow automatic resets for the current table state change.
+*
+* @example
+* ```ts
+* table_autoResetExpanded(table)
+* ```
+*/
 function table_autoResetExpanded(table) {
 	if (table.options.autoResetAll ?? table.options.autoResetExpanded ?? !table.options.manualExpanding) queueMicrotask(() => table_resetExpanded(table));
 }
+/**
+* Updates the table's expanded state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setExpanded(table, (old) => old)
+* ```
+*/
 function table_setExpanded(table, updater) {
 	var _table$options$onExpa, _table$options;
 	(_table$options$onExpa = (_table$options = table.options).onExpandedChange) === null || _table$options$onExpa === void 0 || _table$options$onExpa.call(_table$options, updater);
 }
+/**
+* Toggles all rows expanded for the table.
+*
+* This is the table-level convenience API used by UI controls that affect many columns or rows at once.
+*
+* @example
+* ```ts
+* table_toggleAllRowsExpanded(table)
+* ```
+*/
 function table_toggleAllRowsExpanded(table, expanded) {
 	if (expanded ?? !table_getIsAllRowsExpanded(table)) table_setExpanded(table, true);
 	else table_setExpanded(table, {});
 }
+/**
+* Resets the table's expanded state slice.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @example
+* ```ts
+* table_resetExpanded(table)
+* table_resetExpanded(table, true)
+* ```
+*/
 function table_resetExpanded(table, defaultState) {
 	table_setExpanded(table, defaultState ? {} : cloneState(table.initialState.expanded ?? {}));
 }
+/**
+* Returns can some rows expand 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_getCanSomeRowsExpand(table)
+* ```
+*/
 function table_getCanSomeRowsExpand(table) {
 	return table.getPrePaginatedRowModel().flatRows.some((row) => row_getCanExpand(row));
 }
+/**
+* Returns an event handler for all rows expanded handler.
+*
+* The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.
+*
+* @example
+* ```ts
+* const value = table_getToggleAllRowsExpandedHandler(table)
+* ```
+*/
 function table_getToggleAllRowsExpandedHandler(table) {
 	return (e) => {
 		var _persist;
@@ -28,11 +99,31 @@ function table_getToggleAllRowsExpandedHandler(table) {
 		table_toggleAllRowsExpanded(table);
 	};
 }
+/**
+* Returns is some rows expanded 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_getIsSomeRowsExpanded(table)
+* ```
+*/
 function table_getIsSomeRowsExpanded(table) {
 	var _table$atoms$expanded;
 	const expanded = ((_table$atoms$expanded = table.atoms.expanded) === null || _table$atoms$expanded === void 0 ? void 0 : _table$atoms$expanded.get()) ?? {};
 	return expanded === true || Object.values(expanded).some(Boolean);
 }
+/**
+* Returns is all rows expanded 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_getIsAllRowsExpanded(table)
+* ```
+*/
 function table_getIsAllRowsExpanded(table) {
 	var _table$atoms$expanded2;
 	const expanded = ((_table$atoms$expanded2 = table.atoms.expanded) === null || _table$atoms$expanded2 === void 0 ? void 0 : _table$atoms$expanded2.get()) ?? {};
@@ -41,6 +132,16 @@ function table_getIsAllRowsExpanded(table) {
 	if (table.getRowModel().flatRows.some((row) => !row_getIsExpanded(row))) return false;
 	return true;
 }
+/**
+* Returns expanded depth 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_getExpandedDepth(table)
+* ```
+*/
 function table_getExpandedDepth(table) {
 	var _table$atoms$expanded3, _table$atoms$expanded4;
 	let maxDepth = 0;
@@ -50,6 +151,16 @@ function table_getExpandedDepth(table) {
 	});
 	return maxDepth;
 }
+/**
+* Toggles expanded for a row.
+*
+* The update is routed through the table state updater for the owning feature state slice.
+*
+* @example
+* ```ts
+* row_toggleExpanded(row)
+* ```
+*/
 function row_toggleExpanded(row, expanded) {
 	table_setExpanded(row.table, (old) => {
 		const exists = old === true ? true : !!old[row.id];
@@ -70,15 +181,45 @@ function row_toggleExpanded(row, expanded) {
 		return old;
 	});
 }
+/**
+* Returns is expanded for a row.
+*
+* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+*
+* @example
+* ```ts
+* const value = row_getIsExpanded(row)
+* ```
+*/
 function row_getIsExpanded(row) {
 	var _row$table$atoms$expa, _row$table$options$ge, _row$table$options;
 	const expanded = ((_row$table$atoms$expa = row.table.atoms.expanded) === null || _row$table$atoms$expa === void 0 ? void 0 : _row$table$atoms$expa.get()) ?? {};
 	return !!(((_row$table$options$ge = (_row$table$options = row.table.options).getIsRowExpanded) === null || _row$table$options$ge === void 0 ? void 0 : _row$table$options$ge.call(_row$table$options, row)) ?? (expanded === true || expanded[row.id]));
 }
+/**
+* Returns whether a row can use expand.
+*
+* This evaluates row data, table options, and feature-specific enablement rules.
+*
+* @example
+* ```ts
+* const value = row_getCanExpand(row)
+* ```
+*/
 function row_getCanExpand(row) {
 	var _row$table$options$ge2, _row$table$options2;
 	return ((_row$table$options$ge2 = (_row$table$options2 = row.table.options).getRowCanExpand) === null || _row$table$options$ge2 === void 0 ? void 0 : _row$table$options$ge2.call(_row$table$options2, row)) ?? ((row.table.options.enableExpanding ?? true) && !!row.subRows.length);
 }
+/**
+* Returns is all parents expanded for a row.
+*
+* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+*
+* @example
+* ```ts
+* const value = row_getIsAllParentsExpanded(row)
+* ```
+*/
 function row_getIsAllParentsExpanded(row) {
 	let isFullyExpanded = true;
 	let currentRow = row;
@@ -88,6 +229,16 @@ function row_getIsAllParentsExpanded(row) {
 	}
 	return isFullyExpanded;
 }
+/**
+* Returns an event handler for toggling expanded handler.
+*
+* The handler is intended for direct use in row-level controls such as expansion or selection buttons.
+*
+* @example
+* ```ts
+* const value = row_getToggleExpandedHandler(row)
+* ```
+*/
 function row_getToggleExpandedHandler(row) {
 	const canExpand = row_getCanExpand(row);
 	return () => {

package/dist/features/row-expanding/rowExpandingFeature.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"rowExpandingFeature.utils.js","names":[],"sources":["../../../src/features/row-expanding/rowExpandingFeature.utils.ts"],"sourcesContent":["import { cloneState } 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 { Row } from '../../types/Row'\nimport type {\n  ExpandedState,\n  ExpandedStateList,\n} from './rowExpandingFeature.types'\n\nexport function getDefaultExpandedState(): ExpandedState {\n  return {}\n}\n\nexport function table_autoResetExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  if (\n    table.options.autoResetAll ??\n    table.options.autoResetExpanded ??\n    !table.options.manualExpanding\n  ) {\n    queueMicrotask(() => table_resetExpanded(table))\n  }\n}\n\nexport function table_setExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<ExpandedState>) {\n  table.options.onExpandedChange?.(updater)\n}\n\nexport function table_toggleAllRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, expanded?: boolean) {\n  if (expanded ?? !table_getIsAllRowsExpanded(table)) {\n    table_setExpanded(table, true)\n  } else {\n    table_setExpanded(table, {})\n  }\n}\n\nexport function table_resetExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setExpanded(\n    table,\n    defaultState ? {} : cloneState(table.initialState.expanded ?? {}),\n  )\n}\n\nexport function table_getCanSomeRowsExpand<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table\n    .getPrePaginatedRowModel()\n    .flatRows.some((row) => row_getCanExpand(row))\n}\n\nexport function table_getToggleAllRowsExpandedHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return (e: unknown) => {\n    ;(e as any).persist?.()\n    table_toggleAllRowsExpanded(table)\n  }\n}\n\nexport function table_getIsSomeRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const expanded = table.atoms.expanded?.get() ?? {}\n  return expanded === true || Object.values(expanded).some(Boolean)\n}\n\nexport function table_getIsAllRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const expanded = table.atoms.expanded?.get() ?? {}\n\n  // If expanded is true, save some cycles and return true\n  if (expanded === true) {\n    return true\n  }\n\n  if (!Object.keys(expanded).length) {\n    return false\n  }\n\n  // If any row is not expanded, return false\n  if (table.getRowModel().flatRows.some((row) => !row_getIsExpanded(row))) {\n    return false\n  }\n\n  // They must all be expanded :shrug:\n  return true\n}\n\nexport function table_getExpandedDepth<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  let maxDepth = 0\n\n  const rowIds =\n    table.atoms.expanded?.get() === true\n      ? Object.keys(table.getRowModel().rowsById)\n      : Object.keys(table.atoms.expanded?.get() ?? {})\n\n  rowIds.forEach((id) => {\n    const splitId = id.split('.')\n    maxDepth = Math.max(maxDepth, splitId.length)\n  })\n\n  return maxDepth\n}\n\nexport function row_toggleExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>, expanded?: boolean) {\n  table_setExpanded(row.table, (old) => {\n    const exists = old === true ? true : !!old[row.id]\n\n    let oldExpanded: ExpandedStateList = {}\n\n    if (old === true) {\n      Object.keys(row.table.getRowModel().rowsById).forEach((rowId) => {\n        oldExpanded[rowId] = true\n      })\n    } else {\n      oldExpanded = old\n    }\n\n    expanded = expanded ?? !exists\n\n    if (!exists && expanded) {\n      return {\n        ...oldExpanded,\n        [row.id]: true,\n      }\n    }\n\n    if (exists && !expanded) {\n      const { [row.id]: _, ...rest } = oldExpanded\n      return rest\n    }\n\n    return old\n  })\n}\n\nexport function row_getIsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  const expanded: ExpandedState = row.table.atoms.expanded?.get() ?? {}\n\n  return !!(\n    row.table.options.getIsRowExpanded?.(row) ??\n    (expanded === true || expanded[row.id])\n  )\n}\n\nexport function row_getCanExpand<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  return (\n    row.table.options.getRowCanExpand?.(row) ??\n    ((row.table.options.enableExpanding ?? true) && !!row.subRows.length)\n  )\n}\n\nexport function row_getIsAllParentsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  let isFullyExpanded = true\n  let currentRow = row\n\n  while (isFullyExpanded && currentRow.parentId) {\n    currentRow = row.table.getRow(currentRow.parentId, true)\n    isFullyExpanded = row_getIsExpanded(row)\n  }\n\n  return isFullyExpanded\n}\n\nexport function row_getToggleExpandedHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  const canExpand = row_getCanExpand(row)\n\n  return () => {\n    if (!canExpand) return\n    row_toggleExpanded(row)\n  }\n}\n"],"mappings":";;;AAUA,SAAgB,0BAAyC;AACvD,QAAO,EAAE;;AAGX,SAAgB,wBAGd,OAAyC;AACzC,KACE,MAAM,QAAQ,gBACd,MAAM,QAAQ,qBACd,CAAC,MAAM,QAAQ,gBAEf,sBAAqB,oBAAoB,MAAM,CAAC;;AAIpD,SAAgB,kBAGd,OAAyC,SAAiC;;AAC1E,kDAAM,SAAQ,6GAAmB,QAAQ;;AAG3C,SAAgB,4BAGd,OAAyC,UAAoB;AAC7D,KAAI,YAAY,CAAC,2BAA2B,MAAM,CAChD,mBAAkB,OAAO,KAAK;KAE9B,mBAAkB,OAAO,EAAE,CAAC;;AAIhC,SAAgB,oBAGd,OAAyC,cAAwB;AACjE,mBACE,OACA,eAAe,EAAE,GAAG,WAAW,MAAM,aAAa,YAAY,EAAE,CAAC,CAClE;;AAGH,SAAgB,2BAGd,OAAyC;AACzC,QAAO,MACJ,yBAAyB,CACzB,SAAS,MAAM,QAAQ,iBAAiB,IAAI,CAAC;;AAGlD,SAAgB,sCAGd,OAAyC;AACzC,SAAQ,MAAe;;AACpB,cAAC,EAAU,4DAAW;AACvB,8BAA4B,MAAM;;;AAItC,SAAgB,4BAGd,OAAyC;;CACzC,MAAM,qCAAW,MAAM,MAAM,wFAAU,KAAK,KAAI,EAAE;AAClD,QAAO,aAAa,QAAQ,OAAO,OAAO,SAAS,CAAC,KAAK,QAAQ;;AAGnE,SAAgB,2BAGd,OAAyC;;CACzC,MAAM,sCAAW,MAAM,MAAM,0FAAU,KAAK,KAAI,EAAE;AAGlD,KAAI,aAAa,KACf,QAAO;AAGT,KAAI,CAAC,OAAO,KAAK,SAAS,CAAC,OACzB,QAAO;AAIT,KAAI,MAAM,aAAa,CAAC,SAAS,MAAM,QAAQ,CAAC,kBAAkB,IAAI,CAAC,CACrE,QAAO;AAIT,QAAO;;AAGT,SAAgB,uBAGd,OAAyC;;CACzC,IAAI,WAAW;AAOf,6BAJE,MAAM,MAAM,0FAAU,KAAK,MAAK,OAC5B,OAAO,KAAK,MAAM,aAAa,CAAC,SAAS,GACzC,OAAO,gCAAK,MAAM,MAAM,0FAAU,KAAK,KAAI,EAAE,CAAC,EAE7C,SAAS,OAAO;EACrB,MAAM,UAAU,GAAG,MAAM,IAAI;AAC7B,aAAW,KAAK,IAAI,UAAU,QAAQ,OAAO;GAC7C;AAEF,QAAO;;AAGT,SAAgB,mBAGd,KAA4B,UAAoB;AAChD,mBAAkB,IAAI,QAAQ,QAAQ;EACpC,MAAM,SAAS,QAAQ,OAAO,OAAO,CAAC,CAAC,IAAI,IAAI;EAE/C,IAAI,cAAiC,EAAE;AAEvC,MAAI,QAAQ,KACV,QAAO,KAAK,IAAI,MAAM,aAAa,CAAC,SAAS,CAAC,SAAS,UAAU;AAC/D,eAAY,SAAS;IACrB;MAEF,eAAc;AAGhB,aAAW,YAAY,CAAC;AAExB,MAAI,CAAC,UAAU,SACb,QAAO;GACL,GAAG;IACF,IAAI,KAAK;GACX;AAGH,MAAI,UAAU,CAAC,UAAU;GACvB,MAAM,GAAG,IAAI,KAAK,GAAG,GAAG,SAAS;AACjC,UAAO;;AAGT,SAAO;GACP;;AAGJ,SAAgB,kBAGd,KAA4B;;CAC5B,MAAM,qCAA0B,IAAI,MAAM,MAAM,wFAAU,KAAK,KAAI,EAAE;AAErE,QAAO,CAAC,kDACN,IAAI,MAAM,SAAQ,yHAAmB,IAAI,MACxC,aAAa,QAAQ,SAAS,IAAI;;AAIvC,SAAgB,iBAGd,KAA4B;;AAC5B,0DACE,IAAI,MAAM,SAAQ,2HAAkB,IAAI,OACtC,IAAI,MAAM,QAAQ,mBAAmB,SAAS,CAAC,CAAC,IAAI,QAAQ;;AAIlE,SAAgB,4BAGd,KAA4B;CAC5B,IAAI,kBAAkB;CACtB,IAAI,aAAa;AAEjB,QAAO,mBAAmB,WAAW,UAAU;AAC7C,eAAa,IAAI,MAAM,OAAO,WAAW,UAAU,KAAK;AACxD,oBAAkB,kBAAkB,IAAI;;AAG1C,QAAO;;AAGT,SAAgB,6BAGd,KAA4B;CAC5B,MAAM,YAAY,iBAAiB,IAAI;AAEvC,cAAa;AACX,MAAI,CAAC,UAAW;AAChB,qBAAmB,IAAI"}
+{"version":3,"file":"rowExpandingFeature.utils.js","names":[],"sources":["../../../src/features/row-expanding/rowExpandingFeature.utils.ts"],"sourcesContent":["import { cloneState } 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 { Row } from '../../types/Row'\nimport type {\n  ExpandedState,\n  ExpandedStateList,\n} from './rowExpandingFeature.types'\n\n/**\n * Returns the default expanded 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 = getDefaultExpandedState()\n * ```\n */\nexport function getDefaultExpandedState(): ExpandedState {\n  return {}\n}\n\n/**\n * Schedules an automatic reset for expanded.\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_autoResetExpanded(table)\n * ```\n */\nexport function table_autoResetExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  if (\n    table.options.autoResetAll ??\n    table.options.autoResetExpanded ??\n    !table.options.manualExpanding\n  ) {\n    queueMicrotask(() => table_resetExpanded(table))\n  }\n}\n\n/**\n * Updates the table's expanded 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_setExpanded(table, (old) => old)\n * ```\n */\nexport function table_setExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<ExpandedState>) {\n  table.options.onExpandedChange?.(updater)\n}\n\n/**\n * Toggles all rows expanded for the table.\n *\n * This is the table-level convenience API used by UI controls that affect many columns or rows at once.\n *\n * @example\n * ```ts\n * table_toggleAllRowsExpanded(table)\n * ```\n */\nexport function table_toggleAllRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, expanded?: boolean) {\n  if (expanded ?? !table_getIsAllRowsExpanded(table)) {\n    table_setExpanded(table, true)\n  } else {\n    table_setExpanded(table, {})\n  }\n}\n\n/**\n * Resets the table's expanded 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_resetExpanded(table)\n * table_resetExpanded(table, true)\n * ```\n */\nexport function table_resetExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setExpanded(\n    table,\n    defaultState ? {} : cloneState(table.initialState.expanded ?? {}),\n  )\n}\n\n/**\n * Returns can some rows expand 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_getCanSomeRowsExpand(table)\n * ```\n */\nexport function table_getCanSomeRowsExpand<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table\n    .getPrePaginatedRowModel()\n    .flatRows.some((row) => row_getCanExpand(row))\n}\n\n/**\n * Returns an event handler for all rows expanded handler.\n *\n * The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.\n *\n * @example\n * ```ts\n * const value = table_getToggleAllRowsExpandedHandler(table)\n * ```\n */\nexport function table_getToggleAllRowsExpandedHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return (e: unknown) => {\n    ;(e as any).persist?.()\n    table_toggleAllRowsExpanded(table)\n  }\n}\n\n/**\n * Returns is some rows expanded 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_getIsSomeRowsExpanded(table)\n * ```\n */\nexport function table_getIsSomeRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const expanded = table.atoms.expanded?.get() ?? {}\n  return expanded === true || Object.values(expanded).some(Boolean)\n}\n\n/**\n * Returns is all rows expanded 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_getIsAllRowsExpanded(table)\n * ```\n */\nexport function table_getIsAllRowsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const expanded = table.atoms.expanded?.get() ?? {}\n\n  // If expanded is true, save some cycles and return true\n  if (expanded === true) {\n    return true\n  }\n\n  if (!Object.keys(expanded).length) {\n    return false\n  }\n\n  // If any row is not expanded, return false\n  if (table.getRowModel().flatRows.some((row) => !row_getIsExpanded(row))) {\n    return false\n  }\n\n  // They must all be expanded :shrug:\n  return true\n}\n\n/**\n * Returns expanded depth 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_getExpandedDepth(table)\n * ```\n */\nexport function table_getExpandedDepth<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  let maxDepth = 0\n\n  const rowIds =\n    table.atoms.expanded?.get() === true\n      ? Object.keys(table.getRowModel().rowsById)\n      : Object.keys(table.atoms.expanded?.get() ?? {})\n\n  rowIds.forEach((id) => {\n    const splitId = id.split('.')\n    maxDepth = Math.max(maxDepth, splitId.length)\n  })\n\n  return maxDepth\n}\n\n/**\n * Toggles expanded for a row.\n *\n * The update is routed through the table state updater for the owning feature state slice.\n *\n * @example\n * ```ts\n * row_toggleExpanded(row)\n * ```\n */\nexport function row_toggleExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>, expanded?: boolean) {\n  table_setExpanded(row.table, (old) => {\n    const exists = old === true ? true : !!old[row.id]\n\n    let oldExpanded: ExpandedStateList = {}\n\n    if (old === true) {\n      Object.keys(row.table.getRowModel().rowsById).forEach((rowId) => {\n        oldExpanded[rowId] = true\n      })\n    } else {\n      oldExpanded = old\n    }\n\n    expanded = expanded ?? !exists\n\n    if (!exists && expanded) {\n      return {\n        ...oldExpanded,\n        [row.id]: true,\n      }\n    }\n\n    if (exists && !expanded) {\n      const { [row.id]: _, ...rest } = oldExpanded\n      return rest\n    }\n\n    return old\n  })\n}\n\n/**\n * Returns is expanded for a row.\n *\n * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.\n *\n * @example\n * ```ts\n * const value = row_getIsExpanded(row)\n * ```\n */\nexport function row_getIsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  const expanded: ExpandedState = row.table.atoms.expanded?.get() ?? {}\n\n  return !!(\n    row.table.options.getIsRowExpanded?.(row) ??\n    (expanded === true || expanded[row.id])\n  )\n}\n\n/**\n * Returns whether a row can use expand.\n *\n * This evaluates row data, table options, and feature-specific enablement rules.\n *\n * @example\n * ```ts\n * const value = row_getCanExpand(row)\n * ```\n */\nexport function row_getCanExpand<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  return (\n    row.table.options.getRowCanExpand?.(row) ??\n    ((row.table.options.enableExpanding ?? true) && !!row.subRows.length)\n  )\n}\n\n/**\n * Returns is all parents expanded for a row.\n *\n * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.\n *\n * @example\n * ```ts\n * const value = row_getIsAllParentsExpanded(row)\n * ```\n */\nexport function row_getIsAllParentsExpanded<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  let isFullyExpanded = true\n  let currentRow = row\n\n  while (isFullyExpanded && currentRow.parentId) {\n    currentRow = row.table.getRow(currentRow.parentId, true)\n    isFullyExpanded = row_getIsExpanded(row)\n  }\n\n  return isFullyExpanded\n}\n\n/**\n * Returns an event handler for toggling expanded handler.\n *\n * The handler is intended for direct use in row-level controls such as expansion or selection buttons.\n *\n * @example\n * ```ts\n * const value = row_getToggleExpandedHandler(row)\n * ```\n */\nexport function row_getToggleExpandedHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  const canExpand = row_getCanExpand(row)\n\n  return () => {\n    if (!canExpand) return\n    row_toggleExpanded(row)\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAoBA,SAAgB,0BAAyC;CACvD,OAAO,EAAE;;;;;;;;;;;;AAaX,SAAgB,wBAGd,OAAyC;CACzC,IACE,MAAM,QAAQ,gBACd,MAAM,QAAQ,qBACd,CAAC,MAAM,QAAQ,iBAEf,qBAAqB,oBAAoB,MAAM,CAAC;;;;;;;;;;;;AAcpD,SAAgB,kBAGd,OAAyC,SAAiC;;CAC1E,iDAAM,SAAQ,6GAAmB,QAAQ;;;;;;;;;;;;AAa3C,SAAgB,4BAGd,OAAyC,UAAoB;CAC7D,IAAI,YAAY,CAAC,2BAA2B,MAAM,EAChD,kBAAkB,OAAO,KAAK;MAE9B,kBAAkB,OAAO,EAAE,CAAC;;;;;;;;;;;;;AAehC,SAAgB,oBAGd,OAAyC,cAAwB;CACjE,kBACE,OACA,eAAe,EAAE,GAAG,WAAW,MAAM,aAAa,YAAY,EAAE,CAAC,CAClE;;;;;;;;;;;;AAaH,SAAgB,2BAGd,OAAyC;CACzC,OAAO,MACJ,yBAAyB,CACzB,SAAS,MAAM,QAAQ,iBAAiB,IAAI,CAAC;;;;;;;;;;;;AAalD,SAAgB,sCAGd,OAAyC;CACzC,QAAQ,MAAe;;EACpB,YAAC,EAAU,4DAAW;EACvB,4BAA4B,MAAM;;;;;;;;;;;;;AActC,SAAgB,4BAGd,OAAyC;;CACzC,MAAM,qCAAW,MAAM,MAAM,wFAAU,KAAK,KAAI,EAAE;CAClD,OAAO,aAAa,QAAQ,OAAO,OAAO,SAAS,CAAC,KAAK,QAAQ;;;;;;;;;;;;AAanE,SAAgB,2BAGd,OAAyC;;CACzC,MAAM,sCAAW,MAAM,MAAM,0FAAU,KAAK,KAAI,EAAE;CAGlD,IAAI,aAAa,MACf,OAAO;CAGT,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,QACzB,OAAO;CAIT,IAAI,MAAM,aAAa,CAAC,SAAS,MAAM,QAAQ,CAAC,kBAAkB,IAAI,CAAC,EACrE,OAAO;CAIT,OAAO;;;;;;;;;;;;AAaT,SAAgB,uBAGd,OAAyC;;CACzC,IAAI,WAAW;CAOf,4BAJE,MAAM,MAAM,0FAAU,KAAK,MAAK,OAC5B,OAAO,KAAK,MAAM,aAAa,CAAC,SAAS,GACzC,OAAO,gCAAK,MAAM,MAAM,0FAAU,KAAK,KAAI,EAAE,CAAC,EAE7C,SAAS,OAAO;EACrB,MAAM,UAAU,GAAG,MAAM,IAAI;EAC7B,WAAW,KAAK,IAAI,UAAU,QAAQ,OAAO;GAC7C;CAEF,OAAO;;;;;;;;;;;;AAaT,SAAgB,mBAGd,KAA4B,UAAoB;CAChD,kBAAkB,IAAI,QAAQ,QAAQ;EACpC,MAAM,SAAS,QAAQ,OAAO,OAAO,CAAC,CAAC,IAAI,IAAI;EAE/C,IAAI,cAAiC,EAAE;EAEvC,IAAI,QAAQ,MACV,OAAO,KAAK,IAAI,MAAM,aAAa,CAAC,SAAS,CAAC,SAAS,UAAU;GAC/D,YAAY,SAAS;IACrB;OAEF,cAAc;EAGhB,WAAW,YAAY,CAAC;EAExB,IAAI,CAAC,UAAU,UACb,OAAO;GACL,GAAG;IACF,IAAI,KAAK;GACX;EAGH,IAAI,UAAU,CAAC,UAAU;GACvB,MAAM,GAAG,IAAI,KAAK,GAAG,GAAG,SAAS;GACjC,OAAO;;EAGT,OAAO;GACP;;;;;;;;;;;;AAaJ,SAAgB,kBAGd,KAA4B;;CAC5B,MAAM,qCAA0B,IAAI,MAAM,MAAM,wFAAU,KAAK,KAAI,EAAE;CAErE,OAAO,CAAC,kDACN,IAAI,MAAM,SAAQ,yHAAmB,IAAI,MACxC,aAAa,QAAQ,SAAS,IAAI;;;;;;;;;;;;AAcvC,SAAgB,iBAGd,KAA4B;;CAC5B,yDACE,IAAI,MAAM,SAAQ,2HAAkB,IAAI,OACtC,IAAI,MAAM,QAAQ,mBAAmB,SAAS,CAAC,CAAC,IAAI,QAAQ;;;;;;;;;;;;AAclE,SAAgB,4BAGd,KAA4B;CAC5B,IAAI,kBAAkB;CACtB,IAAI,aAAa;CAEjB,OAAO,mBAAmB,WAAW,UAAU;EAC7C,aAAa,IAAI,MAAM,OAAO,WAAW,UAAU,KAAK;EACxD,kBAAkB,kBAAkB,IAAI;;CAG1C,OAAO;;;;;;;;;;;;AAaT,SAAgB,6BAGd,KAA4B;CAC5B,MAAM,YAAY,iBAAiB,IAAI;CAEvC,aAAa;EACX,IAAI,CAAC,WAAW;EAChB,mBAAmB,IAAI"}

package/dist/features/row-pagination/createPaginatedRowModel.cjs

@@ -3,6 +3,11 @@ const require_rowPaginationFeature_utils = require('./rowPaginationFeature.utils
 const require_createExpandedRowModel = require('../row-expanding/createExpandedRowModel.cjs');
 
 //#region src/features/row-pagination/createPaginatedRowModel.ts
+/**
+* Creates a memoized paginated row model factory.
+*
+* The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.
+*/
 function createPaginatedRowModel() {
 	return (_table) => {
 		const table = _table;

package/dist/features/row-pagination/createPaginatedRowModel.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"createPaginatedRowModel.cjs","names":["tableMemo","getDefaultPaginationState","expandRows"],"sources":["../../../src/features/row-pagination/createPaginatedRowModel.ts"],"sourcesContent":["import { tableMemo } from '../../utils'\nimport { expandRows } from '../row-expanding/createExpandedRowModel'\nimport { getDefaultPaginationState } from './rowPaginationFeature.utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'\nimport type { Table, Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type { RowData } from '../../types/type-utils'\n\nexport function createPaginatedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {\n  return (_table) => {\n    const table: Table_Internal<TFeatures, TData> = _table\n    return tableMemo({\n      feature: 'rowPaginationFeature',\n      table,\n      fnName: 'table.getPaginatedRowModel',\n      memoDeps: () => [\n        table.getPrePaginatedRowModel(),\n        table.atoms.pagination?.get(),\n        table.options.paginateExpandedRows\n          ? table.atoms.expanded?.get()\n          : undefined,\n      ],\n      fn: () => _createPaginatedRowModel(table),\n    })\n  }\n}\n\nfunction _createPaginatedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {\n  const prePaginatedRowModel = table.getPrePaginatedRowModel()\n  const pagination = table.atoms.pagination?.get()\n\n  if (!prePaginatedRowModel.rows.length) {\n    return prePaginatedRowModel\n  }\n\n  const { pageSize, pageIndex } = pagination ?? getDefaultPaginationState()\n  const { rows, flatRows, rowsById } = prePaginatedRowModel\n  const pageStart = pageSize * pageIndex\n  const pageEnd = pageStart + pageSize\n\n  const paginatedRows = rows.slice(pageStart, pageEnd)\n\n  let paginatedRowModel: RowModel<TFeatures, TData>\n\n  if (!table.options.paginateExpandedRows) {\n    paginatedRowModel = expandRows({\n      rows: paginatedRows,\n      flatRows,\n      rowsById,\n    })\n  } else {\n    paginatedRowModel = {\n      rows: paginatedRows,\n      flatRows,\n      rowsById,\n    }\n  }\n\n  paginatedRowModel.flatRows = []\n\n  const handleRow = (row: Row<TFeatures, TData>) => {\n    paginatedRowModel.flatRows.push(row)\n    if (row.subRows.length) {\n      row.subRows.forEach(handleRow)\n    }\n  }\n\n  paginatedRowModel.rows.forEach(handleRow)\n\n  return paginatedRowModel\n}\n"],"mappings":";;;;;AASA,SAAgB,0BAG0D;AACxE,SAAQ,WAAW;EACjB,MAAM,QAA0C;AAChD,SAAOA,wBAAU;GACf,SAAS;GACT;GACA,QAAQ;GACR,gBAAgB;;;KACd,MAAM,yBAAyB;8BAC/B,MAAM,MAAM,0FAAY,KAAK;KAC7B,MAAM,QAAQ,gDACV,MAAM,MAAM,wFAAU,KAAK,GAC3B;KACL;;GACD,UAAU,yBAAyB,MAAM;GAC1C,CAAC;;;AAIN,SAAS,yBAGP,OAAqE;;CACrE,MAAM,uBAAuB,MAAM,yBAAyB;CAC5D,MAAM,uCAAa,MAAM,MAAM,4FAAY,KAAK;AAEhD,KAAI,CAAC,qBAAqB,KAAK,OAC7B,QAAO;CAGT,MAAM,EAAE,UAAU,cAAc,cAAcC,8DAA2B;CACzE,MAAM,EAAE,MAAM,UAAU,aAAa;CACrC,MAAM,YAAY,WAAW;CAC7B,MAAM,UAAU,YAAY;CAE5B,MAAM,gBAAgB,KAAK,MAAM,WAAW,QAAQ;CAEpD,IAAI;AAEJ,KAAI,CAAC,MAAM,QAAQ,qBACjB,qBAAoBC,0CAAW;EAC7B,MAAM;EACN;EACA;EACD,CAAC;KAEF,qBAAoB;EAClB,MAAM;EACN;EACA;EACD;AAGH,mBAAkB,WAAW,EAAE;CAE/B,MAAM,aAAa,QAA+B;AAChD,oBAAkB,SAAS,KAAK,IAAI;AACpC,MAAI,IAAI,QAAQ,OACd,KAAI,QAAQ,QAAQ,UAAU;;AAIlC,mBAAkB,KAAK,QAAQ,UAAU;AAEzC,QAAO"}
+{"version":3,"file":"createPaginatedRowModel.cjs","names":["tableMemo","getDefaultPaginationState","expandRows"],"sources":["../../../src/features/row-pagination/createPaginatedRowModel.ts"],"sourcesContent":["import { tableMemo } from '../../utils'\nimport { expandRows } from '../row-expanding/createExpandedRowModel'\nimport { getDefaultPaginationState } from './rowPaginationFeature.utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'\nimport type { Table, Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type { RowData } from '../../types/type-utils'\n\n/**\n * Creates a memoized paginated row model factory.\n *\n * The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.\n */\nexport function createPaginatedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {\n  return (_table) => {\n    const table: Table_Internal<TFeatures, TData> = _table\n    return tableMemo({\n      feature: 'rowPaginationFeature',\n      table,\n      fnName: 'table.getPaginatedRowModel',\n      memoDeps: () => [\n        table.getPrePaginatedRowModel(),\n        table.atoms.pagination?.get(),\n        table.options.paginateExpandedRows\n          ? table.atoms.expanded?.get()\n          : undefined,\n      ],\n      fn: () => _createPaginatedRowModel(table),\n    })\n  }\n}\n\nfunction _createPaginatedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {\n  const prePaginatedRowModel = table.getPrePaginatedRowModel()\n  const pagination = table.atoms.pagination?.get()\n\n  if (!prePaginatedRowModel.rows.length) {\n    return prePaginatedRowModel\n  }\n\n  const { pageSize, pageIndex } = pagination ?? getDefaultPaginationState()\n  const { rows, flatRows, rowsById } = prePaginatedRowModel\n  const pageStart = pageSize * pageIndex\n  const pageEnd = pageStart + pageSize\n\n  const paginatedRows = rows.slice(pageStart, pageEnd)\n\n  let paginatedRowModel: RowModel<TFeatures, TData>\n\n  if (!table.options.paginateExpandedRows) {\n    paginatedRowModel = expandRows({\n      rows: paginatedRows,\n      flatRows,\n      rowsById,\n    })\n  } else {\n    paginatedRowModel = {\n      rows: paginatedRows,\n      flatRows,\n      rowsById,\n    }\n  }\n\n  paginatedRowModel.flatRows = []\n\n  const handleRow = (row: Row<TFeatures, TData>) => {\n    paginatedRowModel.flatRows.push(row)\n    if (row.subRows.length) {\n      row.subRows.forEach(handleRow)\n    }\n  }\n\n  paginatedRowModel.rows.forEach(handleRow)\n\n  return paginatedRowModel\n}\n"],"mappings":";;;;;;;;;;AAcA,SAAgB,0BAG0D;CACxE,QAAQ,WAAW;EACjB,MAAM,QAA0C;EAChD,OAAOA,wBAAU;GACf,SAAS;GACT;GACA,QAAQ;GACR,gBAAgB;;;KACd,MAAM,yBAAyB;8BAC/B,MAAM,MAAM,0FAAY,KAAK;KAC7B,MAAM,QAAQ,gDACV,MAAM,MAAM,wFAAU,KAAK,GAC3B;KACL;;GACD,UAAU,yBAAyB,MAAM;GAC1C,CAAC;;;AAIN,SAAS,yBAGP,OAAqE;;CACrE,MAAM,uBAAuB,MAAM,yBAAyB;CAC5D,MAAM,uCAAa,MAAM,MAAM,4FAAY,KAAK;CAEhD,IAAI,CAAC,qBAAqB,KAAK,QAC7B,OAAO;CAGT,MAAM,EAAE,UAAU,cAAc,cAAcC,8DAA2B;CACzE,MAAM,EAAE,MAAM,UAAU,aAAa;CACrC,MAAM,YAAY,WAAW;CAC7B,MAAM,UAAU,YAAY;CAE5B,MAAM,gBAAgB,KAAK,MAAM,WAAW,QAAQ;CAEpD,IAAI;CAEJ,IAAI,CAAC,MAAM,QAAQ,sBACjB,oBAAoBC,0CAAW;EAC7B,MAAM;EACN;EACA;EACD,CAAC;MAEF,oBAAoB;EAClB,MAAM;EACN;EACA;EACD;CAGH,kBAAkB,WAAW,EAAE;CAE/B,MAAM,aAAa,QAA+B;EAChD,kBAAkB,SAAS,KAAK,IAAI;EACpC,IAAI,IAAI,QAAQ,QACd,IAAI,QAAQ,QAAQ,UAAU;;CAIlC,kBAAkB,KAAK,QAAQ,UAAU;CAEzC,OAAO"}

package/dist/features/row-pagination/createPaginatedRowModel.d.cts

@@ -4,6 +4,11 @@ import { Table } from "../../types/Table.cjs";
 import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.cjs";
 
 //#region src/features/row-pagination/createPaginatedRowModel.d.ts
+/**
+ * Creates a memoized paginated row model factory.
+ *
+ * The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.
+ */
 declare function createPaginatedRowModel<TFeatures extends TableFeatures, TData extends RowData = any>(): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData>;
 //#endregion
 export { createPaginatedRowModel };

package/dist/features/row-pagination/createPaginatedRowModel.d.ts

@@ -4,6 +4,11 @@ import { Table } from "../../types/Table.js";
 import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.js";
 
 //#region src/features/row-pagination/createPaginatedRowModel.d.ts
+/**
+ * Creates a memoized paginated row model factory.
+ *
+ * The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.
+ */
 declare function createPaginatedRowModel<TFeatures extends TableFeatures, TData extends RowData = any>(): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData>;
 //#endregion
 export { createPaginatedRowModel };

package/dist/features/row-pagination/createPaginatedRowModel.js

@@ -3,6 +3,11 @@ import { getDefaultPaginationState } from "./rowPaginationFeature.utils.js";
 import { expandRows } from "../row-expanding/createExpandedRowModel.js";
 
 //#region src/features/row-pagination/createPaginatedRowModel.ts
+/**
+* Creates a memoized paginated row model factory.
+*
+* The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.
+*/
 function createPaginatedRowModel() {
 	return (_table) => {
 		const table = _table;

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

@@ -1 +1 @@
-{"version":3,"file":"createPaginatedRowModel.js","names":[],"sources":["../../../src/features/row-pagination/createPaginatedRowModel.ts"],"sourcesContent":["import { tableMemo } from '../../utils'\nimport { expandRows } from '../row-expanding/createExpandedRowModel'\nimport { getDefaultPaginationState } from './rowPaginationFeature.utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'\nimport type { Table, Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type { RowData } from '../../types/type-utils'\n\nexport function createPaginatedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {\n  return (_table) => {\n    const table: Table_Internal<TFeatures, TData> = _table\n    return tableMemo({\n      feature: 'rowPaginationFeature',\n      table,\n      fnName: 'table.getPaginatedRowModel',\n      memoDeps: () => [\n        table.getPrePaginatedRowModel(),\n        table.atoms.pagination?.get(),\n        table.options.paginateExpandedRows\n          ? table.atoms.expanded?.get()\n          : undefined,\n      ],\n      fn: () => _createPaginatedRowModel(table),\n    })\n  }\n}\n\nfunction _createPaginatedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {\n  const prePaginatedRowModel = table.getPrePaginatedRowModel()\n  const pagination = table.atoms.pagination?.get()\n\n  if (!prePaginatedRowModel.rows.length) {\n    return prePaginatedRowModel\n  }\n\n  const { pageSize, pageIndex } = pagination ?? getDefaultPaginationState()\n  const { rows, flatRows, rowsById } = prePaginatedRowModel\n  const pageStart = pageSize * pageIndex\n  const pageEnd = pageStart + pageSize\n\n  const paginatedRows = rows.slice(pageStart, pageEnd)\n\n  let paginatedRowModel: RowModel<TFeatures, TData>\n\n  if (!table.options.paginateExpandedRows) {\n    paginatedRowModel = expandRows({\n      rows: paginatedRows,\n      flatRows,\n      rowsById,\n    })\n  } else {\n    paginatedRowModel = {\n      rows: paginatedRows,\n      flatRows,\n      rowsById,\n    }\n  }\n\n  paginatedRowModel.flatRows = []\n\n  const handleRow = (row: Row<TFeatures, TData>) => {\n    paginatedRowModel.flatRows.push(row)\n    if (row.subRows.length) {\n      row.subRows.forEach(handleRow)\n    }\n  }\n\n  paginatedRowModel.rows.forEach(handleRow)\n\n  return paginatedRowModel\n}\n"],"mappings":";;;;;AASA,SAAgB,0BAG0D;AACxE,SAAQ,WAAW;EACjB,MAAM,QAA0C;AAChD,SAAO,UAAU;GACf,SAAS;GACT;GACA,QAAQ;GACR,gBAAgB;;;KACd,MAAM,yBAAyB;8BAC/B,MAAM,MAAM,0FAAY,KAAK;KAC7B,MAAM,QAAQ,gDACV,MAAM,MAAM,wFAAU,KAAK,GAC3B;KACL;;GACD,UAAU,yBAAyB,MAAM;GAC1C,CAAC;;;AAIN,SAAS,yBAGP,OAAqE;;CACrE,MAAM,uBAAuB,MAAM,yBAAyB;CAC5D,MAAM,uCAAa,MAAM,MAAM,4FAAY,KAAK;AAEhD,KAAI,CAAC,qBAAqB,KAAK,OAC7B,QAAO;CAGT,MAAM,EAAE,UAAU,cAAc,cAAc,2BAA2B;CACzE,MAAM,EAAE,MAAM,UAAU,aAAa;CACrC,MAAM,YAAY,WAAW;CAC7B,MAAM,UAAU,YAAY;CAE5B,MAAM,gBAAgB,KAAK,MAAM,WAAW,QAAQ;CAEpD,IAAI;AAEJ,KAAI,CAAC,MAAM,QAAQ,qBACjB,qBAAoB,WAAW;EAC7B,MAAM;EACN;EACA;EACD,CAAC;KAEF,qBAAoB;EAClB,MAAM;EACN;EACA;EACD;AAGH,mBAAkB,WAAW,EAAE;CAE/B,MAAM,aAAa,QAA+B;AAChD,oBAAkB,SAAS,KAAK,IAAI;AACpC,MAAI,IAAI,QAAQ,OACd,KAAI,QAAQ,QAAQ,UAAU;;AAIlC,mBAAkB,KAAK,QAAQ,UAAU;AAEzC,QAAO"}
+{"version":3,"file":"createPaginatedRowModel.js","names":[],"sources":["../../../src/features/row-pagination/createPaginatedRowModel.ts"],"sourcesContent":["import { tableMemo } from '../../utils'\nimport { expandRows } from '../row-expanding/createExpandedRowModel'\nimport { getDefaultPaginationState } from './rowPaginationFeature.utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'\nimport type { Table, Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type { RowData } from '../../types/type-utils'\n\n/**\n * Creates a memoized paginated row model factory.\n *\n * The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.\n */\nexport function createPaginatedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(): (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData> {\n  return (_table) => {\n    const table: Table_Internal<TFeatures, TData> = _table\n    return tableMemo({\n      feature: 'rowPaginationFeature',\n      table,\n      fnName: 'table.getPaginatedRowModel',\n      memoDeps: () => [\n        table.getPrePaginatedRowModel(),\n        table.atoms.pagination?.get(),\n        table.options.paginateExpandedRows\n          ? table.atoms.expanded?.get()\n          : undefined,\n      ],\n      fn: () => _createPaginatedRowModel(table),\n    })\n  }\n}\n\nfunction _createPaginatedRowModel<\n  TFeatures extends TableFeatures,\n  TData extends RowData = any,\n>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData> {\n  const prePaginatedRowModel = table.getPrePaginatedRowModel()\n  const pagination = table.atoms.pagination?.get()\n\n  if (!prePaginatedRowModel.rows.length) {\n    return prePaginatedRowModel\n  }\n\n  const { pageSize, pageIndex } = pagination ?? getDefaultPaginationState()\n  const { rows, flatRows, rowsById } = prePaginatedRowModel\n  const pageStart = pageSize * pageIndex\n  const pageEnd = pageStart + pageSize\n\n  const paginatedRows = rows.slice(pageStart, pageEnd)\n\n  let paginatedRowModel: RowModel<TFeatures, TData>\n\n  if (!table.options.paginateExpandedRows) {\n    paginatedRowModel = expandRows({\n      rows: paginatedRows,\n      flatRows,\n      rowsById,\n    })\n  } else {\n    paginatedRowModel = {\n      rows: paginatedRows,\n      flatRows,\n      rowsById,\n    }\n  }\n\n  paginatedRowModel.flatRows = []\n\n  const handleRow = (row: Row<TFeatures, TData>) => {\n    paginatedRowModel.flatRows.push(row)\n    if (row.subRows.length) {\n      row.subRows.forEach(handleRow)\n    }\n  }\n\n  paginatedRowModel.rows.forEach(handleRow)\n\n  return paginatedRowModel\n}\n"],"mappings":";;;;;;;;;;AAcA,SAAgB,0BAG0D;CACxE,QAAQ,WAAW;EACjB,MAAM,QAA0C;EAChD,OAAO,UAAU;GACf,SAAS;GACT;GACA,QAAQ;GACR,gBAAgB;;;KACd,MAAM,yBAAyB;8BAC/B,MAAM,MAAM,0FAAY,KAAK;KAC7B,MAAM,QAAQ,gDACV,MAAM,MAAM,wFAAU,KAAK,GAC3B;KACL;;GACD,UAAU,yBAAyB,MAAM;GAC1C,CAAC;;;AAIN,SAAS,yBAGP,OAAqE;;CACrE,MAAM,uBAAuB,MAAM,yBAAyB;CAC5D,MAAM,uCAAa,MAAM,MAAM,4FAAY,KAAK;CAEhD,IAAI,CAAC,qBAAqB,KAAK,QAC7B,OAAO;CAGT,MAAM,EAAE,UAAU,cAAc,cAAc,2BAA2B;CACzE,MAAM,EAAE,MAAM,UAAU,aAAa;CACrC,MAAM,YAAY,WAAW;CAC7B,MAAM,UAAU,YAAY;CAE5B,MAAM,gBAAgB,KAAK,MAAM,WAAW,QAAQ;CAEpD,IAAI;CAEJ,IAAI,CAAC,MAAM,QAAQ,sBACjB,oBAAoB,WAAW;EAC7B,MAAM;EACN;EACA;EACD,CAAC;MAEF,oBAAoB;EAClB,MAAM;EACN;EACA;EACD;CAGH,kBAAkB,WAAW,EAAE;CAE/B,MAAM,aAAa,QAA+B;EAChD,kBAAkB,SAAS,KAAK,IAAI;EACpC,IAAI,IAAI,QAAQ,QACd,IAAI,QAAQ,QAAQ,UAAU;;CAIlC,kBAAkB,KAAK,QAAQ,UAAU;CAEzC,OAAO"}

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

@@ -2,6 +2,11 @@ const require_utils = require('../../utils.cjs');
 const require_rowPaginationFeature_utils = require('./rowPaginationFeature.utils.cjs');
 
 //#region src/features/row-pagination/rowPaginationFeature.ts
+/**
+* Creates the stock row pagination feature.
+*
+* The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+*/
 function constructRowPaginationFeature() {
 	return {
 		getInitialState: (initialState) => {
@@ -39,7 +44,10 @@ function constructRowPaginationFeature() {
 	};
 }
 /**
-* The (Row) Pagination feature adds pagination state and APIs to the table object.
+* The stock row pagination feature.
+*
+* Register this feature to add pagination state, page navigation APIs, and
+* pagination-aware row model helpers to a table.
 */
 const rowPaginationFeature = constructRowPaginationFeature();
 

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

@@ -1 +1 @@
-{"version":3,"file":"rowPaginationFeature.cjs","names":["getDefaultPaginationState","makeStateUpdater","table_autoResetPageIndex","table_setPagination","table_resetPagination","table_setPageIndex","table_resetPageIndex","table_setPageSize","table_getPageCount","table_resetPageSize","table_getPageOptions","table_getCanPreviousPage","table_getCanNextPage","table_previousPage","table_nextPage","table_firstPage","table_lastPage","table_getRowCount"],"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\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 (Row) Pagination feature adds pagination state and APIs to the table object.\n */\nexport const rowPaginationFeature = constructRowPaginationFeature()\n"],"mappings":";;;;AAyCA,SAAgB,gCAGsD;AACpE,QAAO;EACL,kBAAkB,iBAAiB;AACjC,UAAO;IACL,GAAG;IACH,YAAY;KACV,GAAGA,8DAA2B;KAC9B,GAAG,aAAa;KACjB;IACF;;EAGH,yBAAyB,UAAU;AACjC,UAAO,EACL,oBAAoBC,+BAAiB,cAAc,MAAM,EAC1D;;EAGH,qBAAqB,UAAU;AAC7B,iCAAgB,wBAAwB,OAAO;IAC7C,0BAA0B,EACxB,UAAUC,4DAAyB,MAAM,EAC1C;IACD,qBAAqB,EACnB,KAAK,YAAYC,uDAAoB,OAAO,QAAQ,EACrD;IACD,uBAAuB,EACrB,KAAK,iBAAiBC,yDAAsB,OAAO,aAAa,EACjE;IACD,oBAAoB,EAClB,KAAK,YAAYC,sDAAmB,OAAO,QAAQ,EACpD;IACD,sBAAsB,EACpB,KAAK,iBAAiBC,wDAAqB,OAAO,aAAa,EAChE;IACD,mBAAmB,EACjB,KAAK,YAAYC,qDAAkB,OAAO,QAAQ,EACnD;IACD,oBAAoB,EAClB,UAAUC,sDAAmB,MAAM,EACpC;IACD,qBAAqB,EACnB,KAAK,iBAAiBC,uDAAoB,OAAO,aAAa,EAC/D;IACD,sBAAsB,EACpB,UAAUC,wDAAqB,MAAM,EACtC;IACD,0BAA0B,EACxB,UAAUC,4DAAyB,MAAM,EAC1C;IACD,sBAAsB,EACpB,UAAUC,wDAAqB,MAAM,EACtC;IACD,oBAAoB,EAClB,UAAUC,sDAAmB,MAAM,EACpC;IACD,gBAAgB,EACd,UAAUC,kDAAe,MAAM,EAChC;IACD,iBAAiB,EACf,UAAUC,mDAAgB,MAAM,EACjC;IACD,gBAAgB,EACd,UAAUC,kDAAe,MAAM,EAChC;IACD,mBAAmB,EACjB,UAAUC,qDAAkB,MAAM,EACnC;IACF,CAAC;;EAEL;;;;;AAMH,MAAa,uBAAuB,+BAA+B"}
+{"version":3,"file":"rowPaginationFeature.cjs","names":["getDefaultPaginationState","makeStateUpdater","table_autoResetPageIndex","table_setPagination","table_resetPagination","table_setPageIndex","table_resetPageIndex","table_setPageSize","table_getPageCount","table_resetPageSize","table_getPageOptions","table_getCanPreviousPage","table_getCanNextPage","table_previousPage","table_nextPage","table_firstPage","table_lastPage","table_getRowCount"],"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,GAAGA,8DAA2B;KAC9B,GAAG,aAAa;KACjB;IACF;;EAGH,yBAAyB,UAAU;GACjC,OAAO,EACL,oBAAoBC,+BAAiB,cAAc,MAAM,EAC1D;;EAGH,qBAAqB,UAAU;GAC7B,8BAAgB,wBAAwB,OAAO;IAC7C,0BAA0B,EACxB,UAAUC,4DAAyB,MAAM,EAC1C;IACD,qBAAqB,EACnB,KAAK,YAAYC,uDAAoB,OAAO,QAAQ,EACrD;IACD,uBAAuB,EACrB,KAAK,iBAAiBC,yDAAsB,OAAO,aAAa,EACjE;IACD,oBAAoB,EAClB,KAAK,YAAYC,sDAAmB,OAAO,QAAQ,EACpD;IACD,sBAAsB,EACpB,KAAK,iBAAiBC,wDAAqB,OAAO,aAAa,EAChE;IACD,mBAAmB,EACjB,KAAK,YAAYC,qDAAkB,OAAO,QAAQ,EACnD;IACD,oBAAoB,EAClB,UAAUC,sDAAmB,MAAM,EACpC;IACD,qBAAqB,EACnB,KAAK,iBAAiBC,uDAAoB,OAAO,aAAa,EAC/D;IACD,sBAAsB,EACpB,UAAUC,wDAAqB,MAAM,EACtC;IACD,0BAA0B,EACxB,UAAUC,4DAAyB,MAAM,EAC1C;IACD,sBAAsB,EACpB,UAAUC,wDAAqB,MAAM,EACtC;IACD,oBAAoB,EAClB,UAAUC,sDAAmB,MAAM,EACpC;IACD,gBAAgB,EACd,UAAUC,kDAAe,MAAM,EAChC;IACD,iBAAiB,EACf,UAAUC,mDAAgB,MAAM,EACjC;IACD,gBAAgB,EACd,UAAUC,kDAAe,MAAM,EAChC;IACD,mBAAmB,EACjB,UAAUC,qDAAkB,MAAM,EACnC;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,uBAAuB,+BAA+B"}

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

@@ -3,9 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.cjs";
 
 //#region src/features/row-pagination/rowPaginationFeature.d.ts
 interface RowPaginationFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock row pagination feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructRowPaginationFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<RowPaginationFeatureConstructors<TFeatures, TData>>;
 /**
- * The (Row) Pagination feature adds pagination state and APIs to the table object.
+ * The stock row pagination feature.
+ *
+ * Register this feature to add pagination state, page navigation APIs, and
+ * pagination-aware row model helpers to a table.
  */
 declare const rowPaginationFeature: TableFeature<RowPaginationFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

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

@@ -3,9 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.js";
 
 //#region src/features/row-pagination/rowPaginationFeature.d.ts
 interface RowPaginationFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock row pagination feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructRowPaginationFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<RowPaginationFeatureConstructors<TFeatures, TData>>;
 /**
- * The (Row) Pagination feature adds pagination state and APIs to the table object.
+ * The stock row pagination feature.
+ *
+ * Register this feature to add pagination state, page navigation APIs, and
+ * pagination-aware row model helpers to a table.
  */
 declare const rowPaginationFeature: TableFeature<RowPaginationFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

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

@@ -2,6 +2,11 @@ import { assignTableAPIs, makeStateUpdater } from "../../utils.js";
 import { 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 } from "./rowPaginationFeature.utils.js";
 
 //#region src/features/row-pagination/rowPaginationFeature.ts
+/**
+* Creates the stock row pagination feature.
+*
+* The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+*/
 function constructRowPaginationFeature() {
 	return {
 		getInitialState: (initialState) => {
@@ -39,7 +44,10 @@ function constructRowPaginationFeature() {
 	};
 }
 /**
-* The (Row) Pagination feature adds pagination state and APIs to the table object.
+* The stock row pagination feature.
+*
+* Register this feature to add pagination state, page navigation APIs, and
+* pagination-aware row model helpers to a table.
 */
 const rowPaginationFeature = constructRowPaginationFeature();
 

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

@@ -1 +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\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 (Row) Pagination feature adds pagination state and APIs to the table object.\n */\nexport const rowPaginationFeature = constructRowPaginationFeature()\n"],"mappings":";;;;AAyCA,SAAgB,gCAGsD;AACpE,QAAO;EACL,kBAAkB,iBAAiB;AACjC,UAAO;IACL,GAAG;IACH,YAAY;KACV,GAAG,2BAA2B;KAC9B,GAAG,aAAa;KACjB;IACF;;EAGH,yBAAyB,UAAU;AACjC,UAAO,EACL,oBAAoB,iBAAiB,cAAc,MAAM,EAC1D;;EAGH,qBAAqB,UAAU;AAC7B,mBAAgB,wBAAwB,OAAO;IAC7C,0BAA0B,EACxB,UAAU,yBAAyB,MAAM,EAC1C;IACD,qBAAqB,EACnB,KAAK,YAAY,oBAAoB,OAAO,QAAQ,EACrD;IACD,uBAAuB,EACrB,KAAK,iBAAiB,sBAAsB,OAAO,aAAa,EACjE;IACD,oBAAoB,EAClB,KAAK,YAAY,mBAAmB,OAAO,QAAQ,EACpD;IACD,sBAAsB,EACpB,KAAK,iBAAiB,qBAAqB,OAAO,aAAa,EAChE;IACD,mBAAmB,EACjB,KAAK,YAAY,kBAAkB,OAAO,QAAQ,EACnD;IACD,oBAAoB,EAClB,UAAU,mBAAmB,MAAM,EACpC;IACD,qBAAqB,EACnB,KAAK,iBAAiB,oBAAoB,OAAO,aAAa,EAC/D;IACD,sBAAsB,EACpB,UAAU,qBAAqB,MAAM,EACtC;IACD,0BAA0B,EACxB,UAAU,yBAAyB,MAAM,EAC1C;IACD,sBAAsB,EACpB,UAAU,qBAAqB,MAAM,EACtC;IACD,oBAAoB,EAClB,UAAU,mBAAmB,MAAM,EACpC;IACD,gBAAgB,EACd,UAAU,eAAe,MAAM,EAChC;IACD,iBAAiB,EACf,UAAU,gBAAgB,MAAM,EACjC;IACD,gBAAgB,EACd,UAAU,eAAe,MAAM,EAChC;IACD,mBAAmB,EACjB,UAAU,kBAAkB,MAAM,EACnC;IACF,CAAC;;EAEL;;;;;AAMH,MAAa,uBAAuB,+BAA+B"}
+{"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,2BAA2B;KAC9B,GAAG,aAAa;KACjB;IACF;;EAGH,yBAAyB,UAAU;GACjC,OAAO,EACL,oBAAoB,iBAAiB,cAAc,MAAM,EAC1D;;EAGH,qBAAqB,UAAU;GAC7B,gBAAgB,wBAAwB,OAAO;IAC7C,0BAA0B,EACxB,UAAU,yBAAyB,MAAM,EAC1C;IACD,qBAAqB,EACnB,KAAK,YAAY,oBAAoB,OAAO,QAAQ,EACrD;IACD,uBAAuB,EACrB,KAAK,iBAAiB,sBAAsB,OAAO,aAAa,EACjE;IACD,oBAAoB,EAClB,KAAK,YAAY,mBAAmB,OAAO,QAAQ,EACpD;IACD,sBAAsB,EACpB,KAAK,iBAAiB,qBAAqB,OAAO,aAAa,EAChE;IACD,mBAAmB,EACjB,KAAK,YAAY,kBAAkB,OAAO,QAAQ,EACnD;IACD,oBAAoB,EAClB,UAAU,mBAAmB,MAAM,EACpC;IACD,qBAAqB,EACnB,KAAK,iBAAiB,oBAAoB,OAAO,aAAa,EAC/D;IACD,sBAAsB,EACpB,UAAU,qBAAqB,MAAM,EACtC;IACD,0BAA0B,EACxB,UAAU,yBAAyB,MAAM,EAC1C;IACD,sBAAsB,EACpB,UAAU,qBAAqB,MAAM,EACtC;IACD,oBAAoB,EAClB,UAAU,mBAAmB,MAAM,EACpC;IACD,gBAAgB,EACd,UAAU,eAAe,MAAM,EAChC;IACD,iBAAiB,EACf,UAAU,gBAAgB,MAAM,EACjC;IACD,gBAAgB,EACd,UAAU,eAAe,MAAM,EAChC;IACD,mBAAmB,EACjB,UAAU,kBAAkB,MAAM,EACnC;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,uBAAuB,+BAA+B"}

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

@@ -21,7 +21,9 @@ interface TableOptions_RowPagination {
    */
   manualPagination?: boolean;
   /**
-   * If this function is provided, it will be called when the pagination state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.pagination` option.
+   * 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>;
   /**
@@ -83,19 +85,20 @@ interface Table_RowPagination<TFeatures extends TableFeatures, TData extends Row
    */
   resetPageSize: (defaultState?: boolean) => void;
   /**
-   * Resets the **pagination** state to `initialState.pagination`, or `true` can be passed to force a default blank state reset to `[]`.
+   * Resets pagination state to `initialState.pagination`. Pass `true` to reset
+   * to the feature default of `{ pageIndex: 0, pageSize: 10 }`.
    */
   resetPagination: (defaultState?: boolean) => void;
   /**
-   * Updates the page index using the provided function or value in the `state.pagination.pageIndex` state.
+   * Updates `pagination.pageIndex` using a value or updater.
    */
   setPageIndex: (updater: Updater<number>) => void;
   /**
-   * Updates the page size using the provided function or value in the `state.pagination.pageSize` state.
+   * Updates `pagination.pageSize` using a value or updater.
    */
   setPageSize: (updater: Updater<number>) => void;
   /**
-   * Sets or updates the `state.pagination` state.
+   * Sets pagination state using a value or updater.
    */
   setPagination: (updater: Updater<PaginationState>) => void;
 }
@@ -111,8 +114,9 @@ interface Table_RowModels_Paginated<TFeatures extends TableFeatures, TData exten
 }
 interface CreateRowModel_Paginated<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Returns the row model after pagination has taken place, but no further.
-   * Pagination columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here.
+   * 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>;
 }

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

@@ -21,7 +21,9 @@ interface TableOptions_RowPagination {
    */
   manualPagination?: boolean;
   /**
-   * If this function is provided, it will be called when the pagination state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.pagination` option.
+   * 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>;
   /**
@@ -83,19 +85,20 @@ interface Table_RowPagination<TFeatures extends TableFeatures, TData extends Row
    */
   resetPageSize: (defaultState?: boolean) => void;
   /**
-   * Resets the **pagination** state to `initialState.pagination`, or `true` can be passed to force a default blank state reset to `[]`.
+   * Resets pagination state to `initialState.pagination`. Pass `true` to reset
+   * to the feature default of `{ pageIndex: 0, pageSize: 10 }`.
    */
   resetPagination: (defaultState?: boolean) => void;
   /**
-   * Updates the page index using the provided function or value in the `state.pagination.pageIndex` state.
+   * Updates `pagination.pageIndex` using a value or updater.
    */
   setPageIndex: (updater: Updater<number>) => void;
   /**
-   * Updates the page size using the provided function or value in the `state.pagination.pageSize` state.
+   * Updates `pagination.pageSize` using a value or updater.
    */
   setPageSize: (updater: Updater<number>) => void;
   /**
-   * Sets or updates the `state.pagination` state.
+   * Sets pagination state using a value or updater.
    */
   setPagination: (updater: Updater<PaginationState>) => void;
 }
@@ -111,8 +114,9 @@ interface Table_RowModels_Paginated<TFeatures extends TableFeatures, TData exten
 }
 interface CreateRowModel_Paginated<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Returns the row model after pagination has taken place, but no further.
-   * Pagination columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here.
+   * 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>;
 }