@tanstack/table-core 9.0.0-alpha.43 → 9.0.0-alpha.47

package/dist/features/row-pinning/rowPinningFeature.types.d.cts

@@ -21,7 +21,9 @@ interface TableOptions_RowPinning<TFeatures extends TableFeatures, TData extends
    */
   keepPinnedRows?: boolean;
   /**
-   * If provided, this function will be called with an `updaterFn` when `state.rowPinning` changes. This overrides the default internal state management, so you will also need to supply `state.rowPinning` from your own managed state.
+   * Called with an updater when row pinning state changes. Pair this with
+   * `state.rowPinning` when using external state; external atoms can own the
+   * slice without this callback.
    */
   onRowPinningChange?: OnChangeFn<RowPinningState>;
 }
@@ -68,7 +70,7 @@ interface Table_RowPinning<TFeatures extends TableFeatures, TData extends RowDat
    */
   resetRowPinning: (defaultState?: boolean) => void;
   /**
-   * Sets or updates the `state.rowPinning` state.
+   * Sets row pinning state using a value or updater.
    */
   setRowPinning: (updater: Updater<RowPinningState>) => void;
 }

package/dist/features/row-pinning/rowPinningFeature.types.d.ts

@@ -21,7 +21,9 @@ interface TableOptions_RowPinning<TFeatures extends TableFeatures, TData extends
    */
   keepPinnedRows?: boolean;
   /**
-   * If provided, this function will be called with an `updaterFn` when `state.rowPinning` changes. This overrides the default internal state management, so you will also need to supply `state.rowPinning` from your own managed state.
+   * Called with an updater when row pinning state changes. Pair this with
+   * `state.rowPinning` when using external state; external atoms can own the
+   * slice without this callback.
    */
   onRowPinningChange?: OnChangeFn<RowPinningState>;
 }
@@ -68,7 +70,7 @@ interface Table_RowPinning<TFeatures extends TableFeatures, TData extends RowDat
    */
   resetRowPinning: (defaultState?: boolean) => void;
   /**
-   * Sets or updates the `state.rowPinning` state.
+   * Sets row pinning state using a value or updater.
    */
   setRowPinning: (updater: Updater<RowPinningState>) => void;
 }

package/dist/features/row-pinning/rowPinningFeature.utils.cjs

@@ -2,19 +2,60 @@ const require_utils = require('../../utils.cjs');
 const require_rowExpandingFeature_utils = require('../row-expanding/rowExpandingFeature.utils.cjs');
 
 //#region src/features/row-pinning/rowPinningFeature.utils.ts
+/**
+* Returns the default row pinning state.
+*
+* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+*
+* @example
+* ```ts
+* const initialValue = getDefaultRowPinningState()
+* ```
+*/
 function getDefaultRowPinningState() {
 	return {
 		top: [],
 		bottom: []
 	};
 }
+/**
+* Updates the table's row pinning state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setRowPinning(table, (old) => old)
+* ```
+*/
 function table_setRowPinning(table, updater) {
 	var _table$options$onRowP, _table$options;
 	(_table$options$onRowP = (_table$options = table.options).onRowPinningChange) === null || _table$options$onRowP === void 0 || _table$options$onRowP.call(_table$options, updater);
 }
+/**
+* Resets the table's row pinning state slice.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @example
+* ```ts
+* table_resetRowPinning(table)
+* table_resetRowPinning(table, true)
+* ```
+*/
 function table_resetRowPinning(table, defaultState) {
 	table_setRowPinning(table, defaultState ? getDefaultRowPinningState() : require_utils.cloneState(table.initialState.rowPinning ?? getDefaultRowPinningState()));
 }
+/**
+* Returns is some rows pinned 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_getIsSomeRowsPinned(table)
+* ```
+*/
 function table_getIsSomeRowsPinned(table, position) {
 	var _table$atoms$rowPinni;
 	const rowPinning = (_table$atoms$rowPinni = table.atoms.rowPinning) === null || _table$atoms$rowPinni === void 0 ? void 0 : _table$atoms$rowPinni.get();
@@ -25,21 +66,57 @@ function table_getPinnedRows(table, position) {
 	var _table$atoms$rowPinni2;
 	const visibleRows = table.getRowModel().rows;
 	const pinnedRowIds = ((_table$atoms$rowPinni2 = table.atoms.rowPinning) === null || _table$atoms$rowPinni2 === void 0 || (_table$atoms$rowPinni2 = _table$atoms$rowPinni2.get()) === null || _table$atoms$rowPinni2 === void 0 ? void 0 : _table$atoms$rowPinni2[position]) ?? [];
-	const filteredRows = (table.options.keepPinnedRows ?? true ? pinnedRowIds.map((rowId) => {
-		const row = table.getRow(rowId, true);
-		return require_rowExpandingFeature_utils.row_getIsAllParentsExpanded(row) ? row : null;
-	}) : pinnedRowIds.map((rowId) => visibleRows.find((row) => row.id === rowId))).filter((r) => !!r);
-	filteredRows.forEach((row) => {
+	const keepPinnedRows = table.options.keepPinnedRows ?? true;
+	const result = [];
+	for (let i = 0; i < pinnedRowIds.length; i++) {
+		const rowId = pinnedRowIds[i];
+		let row;
+		if (keepPinnedRows) {
+			const fullRow = table.getRow(rowId, true);
+			if (require_rowExpandingFeature_utils.row_getIsAllParentsExpanded(fullRow)) row = fullRow;
+		} else row = visibleRows.find((r) => r.id === rowId);
+		if (!row) continue;
 		row.position = position;
-	});
-	return filteredRows;
+		result.push(row);
+	}
+	return result;
 }
+/**
+* Returns top rows 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_getTopRows(table)
+* ```
+*/
 function table_getTopRows(table) {
 	return table_getPinnedRows(table, "top");
 }
+/**
+* Returns bottom rows 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_getBottomRows(table)
+* ```
+*/
 function table_getBottomRows(table) {
 	return table_getPinnedRows(table, "bottom");
 }
+/**
+* Returns center rows 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_getCenterRows(table)
+* ```
+*/
 function table_getCenterRows(table) {
 	var _table$atoms$rowPinni3;
 	const { top, bottom } = ((_table$atoms$rowPinni3 = table.atoms.rowPinning) === null || _table$atoms$rowPinni3 === void 0 ? void 0 : _table$atoms$rowPinni3.get()) ?? getDefaultRowPinningState();
@@ -47,21 +124,62 @@ function table_getCenterRows(table) {
 	const topAndBottom = new Set([...top, ...bottom]);
 	return allRows.filter((d) => !topAndBottom.has(d.id));
 }
+/**
+* Returns whether a row can use pin.
+*
+* This evaluates row data, table options, and feature-specific enablement rules.
+*
+* @example
+* ```ts
+* const value = row_getCanPin(row)
+* ```
+*/
 function row_getCanPin(row) {
 	const { enableRowPinning } = row.table.options;
 	if (typeof enableRowPinning === "function") return enableRowPinning(row);
 	return enableRowPinning ?? true;
 }
+/**
+* Returns is pinned 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_getIsPinned(row)
+* ```
+*/
 function row_getIsPinned(row) {
 	var _row$table$atoms$rowP;
 	const { top, bottom } = ((_row$table$atoms$rowP = row.table.atoms.rowPinning) === null || _row$table$atoms$rowP === void 0 ? void 0 : _row$table$atoms$rowP.get()) ?? getDefaultRowPinningState();
 	return top.includes(row.id) ? "top" : bottom.includes(row.id) ? "bottom" : false;
 }
+/**
+* Returns pinned index 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_getPinnedIndex(row)
+* ```
+*/
 function row_getPinnedIndex(row) {
 	const position = row_getIsPinned(row);
 	if (!position) return -1;
 	return (position === "top" ? require_utils.callMemoOrStaticFn(row.table, "getTopRows", table_getTopRows) : require_utils.callMemoOrStaticFn(row.table, "getBottomRows", table_getBottomRows)).map(({ id }) => id).indexOf(row.id);
 }
+/**
+* Pins or unpins a row.
+*
+* Optional flags let callers include parent rows or leaf rows when updating
+* the row pinning state.
+*
+* @example
+* ```ts
+* row_pin(row, 'top')
+* ```
+*/
 function row_pin(row, position, includeLeafRows, includeParentRows) {
 	const leafRowIds = includeLeafRows ? row.getLeafRows().map(({ id }) => id) : [];
 	const parentRowIds = includeParentRows ? row.getParentRows().map(({ id }) => id) : [];

package/dist/features/row-pinning/rowPinningFeature.utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"rowPinningFeature.utils.cjs","names":["cloneState","row_getIsAllParentsExpanded","callMemoOrStaticFn"],"sources":["../../../src/features/row-pinning/rowPinningFeature.utils.ts"],"sourcesContent":["import { row_getIsAllParentsExpanded } from '../row-expanding/rowExpandingFeature.utils'\nimport { callMemoOrStaticFn, 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  RowPinningPosition,\n  RowPinningState,\n} from './rowPinningFeature.types'\n\n// State Utils\n\nexport function getDefaultRowPinningState(): RowPinningState {\n  return {\n    top: [],\n    bottom: [],\n  }\n}\n\nexport function table_setRowPinning<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<RowPinningState>,\n): void {\n  table.options.onRowPinningChange?.(updater)\n}\n\nexport function table_resetRowPinning<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void {\n  table_setRowPinning(\n    table,\n    defaultState\n      ? getDefaultRowPinningState()\n      : cloneState(\n          table.initialState.rowPinning ?? getDefaultRowPinningState(),\n        ),\n  )\n}\n\n// Table Utils\n\nexport function table_getIsSomeRowsPinned<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  position?: RowPinningPosition,\n): boolean {\n  const rowPinning = table.atoms.rowPinning?.get()\n\n  if (!position) {\n    return Boolean(rowPinning?.top.length || rowPinning?.bottom.length)\n  }\n  return Boolean(rowPinning?.[position].length)\n}\n\nfunction table_getPinnedRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  position: 'top' | 'bottom',\n): Array<Row<TFeatures, TData>> {\n  const visibleRows = table.getRowModel().rows\n  const pinnedRowIds = table.atoms.rowPinning?.get()?.[position] ?? []\n\n  const rows =\n    (table.options.keepPinnedRows ?? true)\n      ? // get all rows that are pinned even if they would not be otherwise visible\n        // account for expanded parent rows, but not pagination or filtering\n        pinnedRowIds.map((rowId) => {\n          const row = table.getRow(rowId, true)\n          return row_getIsAllParentsExpanded(row) ? row : null\n        })\n      : // else get only visible rows that are pinned\n        pinnedRowIds.map(\n          (rowId) => visibleRows.find((row) => row.id === rowId)!,\n        )\n\n  const filteredRows = rows.filter((r) => !!r)\n  // Assign position property directly to preserve prototype chain\n  filteredRows.forEach((row) => {\n    ;(row as any).position = position\n  })\n  return filteredRows\n}\n\nexport function table_getTopRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  return table_getPinnedRows(table, 'top')\n}\n\nexport function table_getBottomRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  return table_getPinnedRows(table, 'bottom')\n}\n\nexport function table_getCenterRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  const { top, bottom } =\n    table.atoms.rowPinning?.get() ?? getDefaultRowPinningState()\n  const allRows = table.getRowModel().rows\n\n  const topAndBottom = new Set([...top, ...bottom])\n  return allRows.filter((d) => !topAndBottom.has(d.id))\n}\n\n// Row Utils\n\nexport function row_getCanPin<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): boolean {\n  const { enableRowPinning } = row.table.options\n  if (typeof enableRowPinning === 'function') {\n    return enableRowPinning(row)\n  }\n  return enableRowPinning ?? true\n}\n\nexport function row_getIsPinned<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): RowPinningPosition {\n  const { top, bottom } =\n    row.table.atoms.rowPinning?.get() ?? getDefaultRowPinningState()\n\n  return top.includes(row.id)\n    ? 'top'\n    : bottom.includes(row.id)\n      ? 'bottom'\n      : false\n}\n\nexport function row_getPinnedIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): number {\n  const position = row_getIsPinned(row)\n  if (!position) return -1\n\n  const visiblePinnedRowIds = (\n    position === 'top'\n      ? callMemoOrStaticFn(row.table, 'getTopRows', table_getTopRows)\n      : callMemoOrStaticFn(row.table, 'getBottomRows', table_getBottomRows)\n  ).map(({ id }) => id)\n\n  return visiblePinnedRowIds.indexOf(row.id)\n}\n\nexport function row_pin<TFeatures extends TableFeatures, TData extends RowData>(\n  row: Row<TFeatures, TData>,\n  position: RowPinningPosition,\n  includeLeafRows?: boolean,\n  includeParentRows?: boolean,\n): void {\n  const leafRowIds = includeLeafRows\n    ? row.getLeafRows().map(({ id }) => id)\n    : []\n  const parentRowIds = includeParentRows\n    ? row.getParentRows().map(({ id }) => id)\n    : []\n  const rowIds: Set<string> = new Set([...parentRowIds, row.id, ...leafRowIds])\n\n  table_setRowPinning(row.table, (old) => {\n    if (position === 'bottom') {\n      return {\n        top: old.top.filter((d) => !rowIds.has(d)),\n        bottom: [\n          ...old.bottom.filter((d) => !rowIds.has(d)),\n          ...Array.from(rowIds),\n        ],\n      }\n    }\n\n    if (position === 'top') {\n      return {\n        top: [...old.top.filter((d) => !rowIds.has(d)), ...Array.from(rowIds)],\n        bottom: old.bottom.filter((d) => !rowIds.has(d)),\n      }\n    }\n\n    return {\n      top: old.top.filter((d) => !rowIds.has(d)),\n      bottom: old.bottom.filter((d) => !rowIds.has(d)),\n    }\n  })\n}\n"],"mappings":";;;;AAaA,SAAgB,4BAA6C;AAC3D,QAAO;EACL,KAAK,EAAE;EACP,QAAQ,EAAE;EACX;;AAGH,SAAgB,oBAId,OACA,SACM;;AACN,kDAAM,SAAQ,+GAAqB,QAAQ;;AAG7C,SAAgB,sBAGd,OAAyC,cAA8B;AACvE,qBACE,OACA,eACI,2BAA2B,GAC3BA,yBACE,MAAM,aAAa,cAAc,2BAA2B,CAC7D,CACN;;AAKH,SAAgB,0BAId,OACA,UACS;;CACT,MAAM,sCAAa,MAAM,MAAM,0FAAY,KAAK;AAEhD,KAAI,CAAC,SACH,QAAO,iEAAQ,WAAY,IAAI,oEAAU,WAAY,OAAO,QAAO;AAErE,QAAO,gEAAQ,WAAa,UAAU,OAAO;;AAG/C,SAAS,oBAIP,OACA,UAC8B;;CAC9B,MAAM,cAAc,MAAM,aAAa,CAAC;CACxC,MAAM,0CAAe,MAAM,MAAM,8GAAY,KAAK,kFAAG,cAAa,EAAE;CAepE,MAAM,gBAZH,MAAM,QAAQ,kBAAkB,OAG7B,aAAa,KAAK,UAAU;EAC1B,MAAM,MAAM,MAAM,OAAO,OAAO,KAAK;AACrC,SAAOC,8DAA4B,IAAI,GAAG,MAAM;GAChD,GAEF,aAAa,KACV,UAAU,YAAY,MAAM,QAAQ,IAAI,OAAO,MAAM,CACvD,EAEmB,QAAQ,MAAM,CAAC,CAAC,EAAE;AAE5C,cAAa,SAAS,QAAQ;AAC3B,EAAC,IAAY,WAAW;GACzB;AACF,QAAO;;AAGT,SAAgB,iBAGd,OAAuE;AACvE,QAAO,oBAAoB,OAAO,MAAM;;AAG1C,SAAgB,oBAGd,OAAuE;AACvE,QAAO,oBAAoB,OAAO,SAAS;;AAG7C,SAAgB,oBAGd,OAAuE;;CACvE,MAAM,EAAE,KAAK,sCACX,MAAM,MAAM,4FAAY,KAAK,KAAI,2BAA2B;CAC9D,MAAM,UAAU,MAAM,aAAa,CAAC;CAEpC,MAAM,eAAe,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,OAAO,CAAC;AACjD,QAAO,QAAQ,QAAQ,MAAM,CAAC,aAAa,IAAI,EAAE,GAAG,CAAC;;AAKvD,SAAgB,cAGd,KAAqC;CACrC,MAAM,EAAE,qBAAqB,IAAI,MAAM;AACvC,KAAI,OAAO,qBAAqB,WAC9B,QAAO,iBAAiB,IAAI;AAE9B,QAAO,oBAAoB;;AAG7B,SAAgB,gBAGd,KAAgD;;CAChD,MAAM,EAAE,KAAK,qCACX,IAAI,MAAM,MAAM,0FAAY,KAAK,KAAI,2BAA2B;AAElE,QAAO,IAAI,SAAS,IAAI,GAAG,GACvB,QACA,OAAO,SAAS,IAAI,GAAG,GACrB,WACA;;AAGR,SAAgB,mBAGd,KAAoC;CACpC,MAAM,WAAW,gBAAgB,IAAI;AACrC,KAAI,CAAC,SAAU,QAAO;AAQtB,SALE,aAAa,QACTC,iCAAmB,IAAI,OAAO,cAAc,iBAAiB,GAC7DA,iCAAmB,IAAI,OAAO,iBAAiB,oBAAoB,EACvE,KAAK,EAAE,SAAS,GAEQ,CAAC,QAAQ,IAAI,GAAG;;AAG5C,SAAgB,QACd,KACA,UACA,iBACA,mBACM;CACN,MAAM,aAAa,kBACf,IAAI,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,GACrC,EAAE;CACN,MAAM,eAAe,oBACjB,IAAI,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,GACvC,EAAE;CACN,MAAM,SAAsB,IAAI,IAAI;EAAC,GAAG;EAAc,IAAI;EAAI,GAAG;EAAW,CAAC;AAE7E,qBAAoB,IAAI,QAAQ,QAAQ;AACtC,MAAI,aAAa,SACf,QAAO;GACL,KAAK,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GAC1C,QAAQ,CACN,GAAG,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,EAC3C,GAAG,MAAM,KAAK,OAAO,CACtB;GACF;AAGH,MAAI,aAAa,MACf,QAAO;GACL,KAAK,CAAC,GAAG,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,MAAM,KAAK,OAAO,CAAC;GACtE,QAAQ,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GACjD;AAGH,SAAO;GACL,KAAK,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GAC1C,QAAQ,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GACjD;GACD"}
+{"version":3,"file":"rowPinningFeature.utils.cjs","names":["cloneState","row_getIsAllParentsExpanded","callMemoOrStaticFn"],"sources":["../../../src/features/row-pinning/rowPinningFeature.utils.ts"],"sourcesContent":["import { row_getIsAllParentsExpanded } from '../row-expanding/rowExpandingFeature.utils'\nimport { callMemoOrStaticFn, 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  RowPinningPosition,\n  RowPinningState,\n} from './rowPinningFeature.types'\n\n// State Utils\n\n/**\n * Returns the default row pinning 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 = getDefaultRowPinningState()\n * ```\n */\nexport function getDefaultRowPinningState(): RowPinningState {\n  return {\n    top: [],\n    bottom: [],\n  }\n}\n\n/**\n * Updates the table's row pinning 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_setRowPinning(table, (old) => old)\n * ```\n */\nexport function table_setRowPinning<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<RowPinningState>,\n): void {\n  table.options.onRowPinningChange?.(updater)\n}\n\n/**\n * Resets the table's row pinning 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_resetRowPinning(table)\n * table_resetRowPinning(table, true)\n * ```\n */\nexport function table_resetRowPinning<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void {\n  table_setRowPinning(\n    table,\n    defaultState\n      ? getDefaultRowPinningState()\n      : cloneState(\n          table.initialState.rowPinning ?? getDefaultRowPinningState(),\n        ),\n  )\n}\n\n// Table Utils\n\n/**\n * Returns is some rows pinned 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_getIsSomeRowsPinned(table)\n * ```\n */\nexport function table_getIsSomeRowsPinned<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  position?: RowPinningPosition,\n): boolean {\n  const rowPinning = table.atoms.rowPinning?.get()\n\n  if (!position) {\n    return Boolean(rowPinning?.top.length || rowPinning?.bottom.length)\n  }\n  return Boolean(rowPinning?.[position].length)\n}\n\nfunction table_getPinnedRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  position: 'top' | 'bottom',\n): Array<Row<TFeatures, TData>> {\n  const visibleRows = table.getRowModel().rows\n  const pinnedRowIds = table.atoms.rowPinning?.get()?.[position] ?? []\n  const keepPinnedRows = table.options.keepPinnedRows ?? true\n\n  const result: Array<Row<TFeatures, TData>> = []\n  for (let i = 0; i < pinnedRowIds.length; i++) {\n    const rowId = pinnedRowIds[i]!\n    let row: Row<TFeatures, TData> | undefined\n    if (keepPinnedRows) {\n      // get all rows that are pinned even if they would not be otherwise\n      // visible; account for expanded parent rows, but not pagination/filtering\n      const fullRow = table.getRow(rowId, true)\n      if (row_getIsAllParentsExpanded(fullRow)) row = fullRow\n    } else {\n      // else get only visible rows that are pinned\n      row = visibleRows.find((r) => r.id === rowId)\n    }\n    if (!row)\n      continue\n      // Assign position property directly to preserve prototype chain\n    ;(row as any).position = position\n    result.push(row)\n  }\n  return result\n}\n\n/**\n * Returns top rows 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_getTopRows(table)\n * ```\n */\nexport function table_getTopRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  return table_getPinnedRows(table, 'top')\n}\n\n/**\n * Returns bottom rows 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_getBottomRows(table)\n * ```\n */\nexport function table_getBottomRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  return table_getPinnedRows(table, 'bottom')\n}\n\n/**\n * Returns center rows 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_getCenterRows(table)\n * ```\n */\nexport function table_getCenterRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  const { top, bottom } =\n    table.atoms.rowPinning?.get() ?? getDefaultRowPinningState()\n  const allRows = table.getRowModel().rows\n\n  const topAndBottom = new Set([...top, ...bottom])\n  return allRows.filter((d) => !topAndBottom.has(d.id))\n}\n\n// Row Utils\n\n/**\n * Returns whether a row can use pin.\n *\n * This evaluates row data, table options, and feature-specific enablement rules.\n *\n * @example\n * ```ts\n * const value = row_getCanPin(row)\n * ```\n */\nexport function row_getCanPin<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): boolean {\n  const { enableRowPinning } = row.table.options\n  if (typeof enableRowPinning === 'function') {\n    return enableRowPinning(row)\n  }\n  return enableRowPinning ?? true\n}\n\n/**\n * Returns is pinned 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_getIsPinned(row)\n * ```\n */\nexport function row_getIsPinned<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): RowPinningPosition {\n  const { top, bottom } =\n    row.table.atoms.rowPinning?.get() ?? getDefaultRowPinningState()\n\n  return top.includes(row.id)\n    ? 'top'\n    : bottom.includes(row.id)\n      ? 'bottom'\n      : false\n}\n\n/**\n * Returns pinned index 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_getPinnedIndex(row)\n * ```\n */\nexport function row_getPinnedIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): number {\n  const position = row_getIsPinned(row)\n  if (!position) return -1\n\n  const visiblePinnedRowIds = (\n    position === 'top'\n      ? callMemoOrStaticFn(row.table, 'getTopRows', table_getTopRows)\n      : callMemoOrStaticFn(row.table, 'getBottomRows', table_getBottomRows)\n  ).map(({ id }) => id)\n\n  return visiblePinnedRowIds.indexOf(row.id)\n}\n\n/**\n * Pins or unpins a row.\n *\n * Optional flags let callers include parent rows or leaf rows when updating\n * the row pinning state.\n *\n * @example\n * ```ts\n * row_pin(row, 'top')\n * ```\n */\nexport function row_pin<TFeatures extends TableFeatures, TData extends RowData>(\n  row: Row<TFeatures, TData>,\n  position: RowPinningPosition,\n  includeLeafRows?: boolean,\n  includeParentRows?: boolean,\n): void {\n  const leafRowIds = includeLeafRows\n    ? row.getLeafRows().map(({ id }) => id)\n    : []\n  const parentRowIds = includeParentRows\n    ? row.getParentRows().map(({ id }) => id)\n    : []\n  const rowIds: Set<string> = new Set([...parentRowIds, row.id, ...leafRowIds])\n\n  table_setRowPinning(row.table, (old) => {\n    if (position === 'bottom') {\n      return {\n        top: old.top.filter((d) => !rowIds.has(d)),\n        bottom: [\n          ...old.bottom.filter((d) => !rowIds.has(d)),\n          ...Array.from(rowIds),\n        ],\n      }\n    }\n\n    if (position === 'top') {\n      return {\n        top: [...old.top.filter((d) => !rowIds.has(d)), ...Array.from(rowIds)],\n        bottom: old.bottom.filter((d) => !rowIds.has(d)),\n      }\n    }\n\n    return {\n      top: old.top.filter((d) => !rowIds.has(d)),\n      bottom: old.bottom.filter((d) => !rowIds.has(d)),\n    }\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;AAuBA,SAAgB,4BAA6C;CAC3D,OAAO;EACL,KAAK,EAAE;EACP,QAAQ,EAAE;EACX;;;;;;;;;;;;AAaH,SAAgB,oBAId,OACA,SACM;;CACN,iDAAM,SAAQ,+GAAqB,QAAQ;;;;;;;;;;;;;AAc7C,SAAgB,sBAGd,OAAyC,cAA8B;CACvE,oBACE,OACA,eACI,2BAA2B,GAC3BA,yBACE,MAAM,aAAa,cAAc,2BAA2B,CAC7D,CACN;;;;;;;;;;;;AAeH,SAAgB,0BAId,OACA,UACS;;CACT,MAAM,sCAAa,MAAM,MAAM,0FAAY,KAAK;CAEhD,IAAI,CAAC,UACH,OAAO,iEAAQ,WAAY,IAAI,oEAAU,WAAY,OAAO,QAAO;CAErE,OAAO,gEAAQ,WAAa,UAAU,OAAO;;AAG/C,SAAS,oBAIP,OACA,UAC8B;;CAC9B,MAAM,cAAc,MAAM,aAAa,CAAC;CACxC,MAAM,0CAAe,MAAM,MAAM,8GAAY,KAAK,kFAAG,cAAa,EAAE;CACpE,MAAM,iBAAiB,MAAM,QAAQ,kBAAkB;CAEvD,MAAM,SAAuC,EAAE;CAC/C,KAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK;EAC5C,MAAM,QAAQ,aAAa;EAC3B,IAAI;EACJ,IAAI,gBAAgB;GAGlB,MAAM,UAAU,MAAM,OAAO,OAAO,KAAK;GACzC,IAAIC,8DAA4B,QAAQ,EAAE,MAAM;SAGhD,MAAM,YAAY,MAAM,MAAM,EAAE,OAAO,MAAM;EAE/C,IAAI,CAAC,KACH;EAED,AAAC,IAAY,WAAW;EACzB,OAAO,KAAK,IAAI;;CAElB,OAAO;;;;;;;;;;;;AAaT,SAAgB,iBAGd,OAAuE;CACvE,OAAO,oBAAoB,OAAO,MAAM;;;;;;;;;;;;AAa1C,SAAgB,oBAGd,OAAuE;CACvE,OAAO,oBAAoB,OAAO,SAAS;;;;;;;;;;;;AAa7C,SAAgB,oBAGd,OAAuE;;CACvE,MAAM,EAAE,KAAK,sCACX,MAAM,MAAM,4FAAY,KAAK,KAAI,2BAA2B;CAC9D,MAAM,UAAU,MAAM,aAAa,CAAC;CAEpC,MAAM,eAAe,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,OAAO,CAAC;CACjD,OAAO,QAAQ,QAAQ,MAAM,CAAC,aAAa,IAAI,EAAE,GAAG,CAAC;;;;;;;;;;;;AAevD,SAAgB,cAGd,KAAqC;CACrC,MAAM,EAAE,qBAAqB,IAAI,MAAM;CACvC,IAAI,OAAO,qBAAqB,YAC9B,OAAO,iBAAiB,IAAI;CAE9B,OAAO,oBAAoB;;;;;;;;;;;;AAa7B,SAAgB,gBAGd,KAAgD;;CAChD,MAAM,EAAE,KAAK,qCACX,IAAI,MAAM,MAAM,0FAAY,KAAK,KAAI,2BAA2B;CAElE,OAAO,IAAI,SAAS,IAAI,GAAG,GACvB,QACA,OAAO,SAAS,IAAI,GAAG,GACrB,WACA;;;;;;;;;;;;AAaR,SAAgB,mBAGd,KAAoC;CACpC,MAAM,WAAW,gBAAgB,IAAI;CACrC,IAAI,CAAC,UAAU,OAAO;CAQtB,QALE,aAAa,QACTC,iCAAmB,IAAI,OAAO,cAAc,iBAAiB,GAC7DA,iCAAmB,IAAI,OAAO,iBAAiB,oBAAoB,EACvE,KAAK,EAAE,SAAS,GAEQ,CAAC,QAAQ,IAAI,GAAG;;;;;;;;;;;;;AAc5C,SAAgB,QACd,KACA,UACA,iBACA,mBACM;CACN,MAAM,aAAa,kBACf,IAAI,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,GACrC,EAAE;CACN,MAAM,eAAe,oBACjB,IAAI,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,GACvC,EAAE;CACN,MAAM,SAAsB,IAAI,IAAI;EAAC,GAAG;EAAc,IAAI;EAAI,GAAG;EAAW,CAAC;CAE7E,oBAAoB,IAAI,QAAQ,QAAQ;EACtC,IAAI,aAAa,UACf,OAAO;GACL,KAAK,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GAC1C,QAAQ,CACN,GAAG,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,EAC3C,GAAG,MAAM,KAAK,OAAO,CACtB;GACF;EAGH,IAAI,aAAa,OACf,OAAO;GACL,KAAK,CAAC,GAAG,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,MAAM,KAAK,OAAO,CAAC;GACtE,QAAQ,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GACjD;EAGH,OAAO;GACL,KAAK,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GAC1C,QAAQ,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GACjD;GACD"}

package/dist/features/row-pinning/rowPinningFeature.utils.d.cts

@@ -5,16 +5,128 @@ import { TableFeatures } from "../../types/TableFeatures.cjs";
 import { Table_Internal } from "../../types/Table.cjs";
 
 //#region src/features/row-pinning/rowPinningFeature.utils.d.ts
+/**
+ * Returns the default row pinning state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultRowPinningState()
+ * ```
+ */
 declare function getDefaultRowPinningState(): RowPinningState;
+/**
+ * Updates the table's row pinning state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setRowPinning(table, (old) => old)
+ * ```
+ */
 declare function table_setRowPinning<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<RowPinningState>): void;
+/**
+ * Resets the table's row pinning state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetRowPinning(table)
+ * table_resetRowPinning(table, true)
+ * ```
+ */
 declare function table_resetRowPinning<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Returns is some rows pinned 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_getIsSomeRowsPinned(table)
+ * ```
+ */
 declare function table_getIsSomeRowsPinned<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, position?: RowPinningPosition): boolean;
+/**
+ * Returns top rows 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_getTopRows(table)
+ * ```
+ */
 declare function table_getTopRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Returns bottom rows 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_getBottomRows(table)
+ * ```
+ */
 declare function table_getBottomRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Returns center rows 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_getCenterRows(table)
+ * ```
+ */
 declare function table_getCenterRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Returns whether a row can use pin.
+ *
+ * This evaluates row data, table options, and feature-specific enablement rules.
+ *
+ * @example
+ * ```ts
+ * const value = row_getCanPin(row)
+ * ```
+ */
 declare function row_getCanPin<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * Returns is pinned 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_getIsPinned(row)
+ * ```
+ */
 declare function row_getIsPinned<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): RowPinningPosition;
+/**
+ * Returns pinned index 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_getPinnedIndex(row)
+ * ```
+ */
 declare function row_getPinnedIndex<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): number;
+/**
+ * Pins or unpins a row.
+ *
+ * Optional flags let callers include parent rows or leaf rows when updating
+ * the row pinning state.
+ *
+ * @example
+ * ```ts
+ * row_pin(row, 'top')
+ * ```
+ */
 declare function row_pin<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, position: RowPinningPosition, includeLeafRows?: boolean, includeParentRows?: boolean): void;
 //#endregion
 export { getDefaultRowPinningState, row_getCanPin, row_getIsPinned, row_getPinnedIndex, row_pin, table_getBottomRows, table_getCenterRows, table_getIsSomeRowsPinned, table_getTopRows, table_resetRowPinning, table_setRowPinning };

package/dist/features/row-pinning/rowPinningFeature.utils.d.ts

@@ -5,16 +5,128 @@ import { TableFeatures } from "../../types/TableFeatures.js";
 import { Table_Internal } from "../../types/Table.js";
 
 //#region src/features/row-pinning/rowPinningFeature.utils.d.ts
+/**
+ * Returns the default row pinning state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultRowPinningState()
+ * ```
+ */
 declare function getDefaultRowPinningState(): RowPinningState;
+/**
+ * Updates the table's row pinning state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setRowPinning(table, (old) => old)
+ * ```
+ */
 declare function table_setRowPinning<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<RowPinningState>): void;
+/**
+ * Resets the table's row pinning state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetRowPinning(table)
+ * table_resetRowPinning(table, true)
+ * ```
+ */
 declare function table_resetRowPinning<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Returns is some rows pinned 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_getIsSomeRowsPinned(table)
+ * ```
+ */
 declare function table_getIsSomeRowsPinned<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, position?: RowPinningPosition): boolean;
+/**
+ * Returns top rows 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_getTopRows(table)
+ * ```
+ */
 declare function table_getTopRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Returns bottom rows 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_getBottomRows(table)
+ * ```
+ */
 declare function table_getBottomRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Returns center rows 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_getCenterRows(table)
+ * ```
+ */
 declare function table_getCenterRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Returns whether a row can use pin.
+ *
+ * This evaluates row data, table options, and feature-specific enablement rules.
+ *
+ * @example
+ * ```ts
+ * const value = row_getCanPin(row)
+ * ```
+ */
 declare function row_getCanPin<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * Returns is pinned 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_getIsPinned(row)
+ * ```
+ */
 declare function row_getIsPinned<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): RowPinningPosition;
+/**
+ * Returns pinned index 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_getPinnedIndex(row)
+ * ```
+ */
 declare function row_getPinnedIndex<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): number;
+/**
+ * Pins or unpins a row.
+ *
+ * Optional flags let callers include parent rows or leaf rows when updating
+ * the row pinning state.
+ *
+ * @example
+ * ```ts
+ * row_pin(row, 'top')
+ * ```
+ */
 declare function row_pin<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, position: RowPinningPosition, includeLeafRows?: boolean, includeParentRows?: boolean): void;
 //#endregion
 export { getDefaultRowPinningState, row_getCanPin, row_getIsPinned, row_getPinnedIndex, row_pin, table_getBottomRows, table_getCenterRows, table_getIsSomeRowsPinned, table_getTopRows, table_resetRowPinning, table_setRowPinning };