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

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

@@ -0,0 +1,83 @@
+import { OnChangeFn, RowData, Updater } from "../../types/type-utils.js";
+import { Row } from "../../types/Row.js";
+import { TableFeatures } from "../../types/TableFeatures.js";
+
+//#region src/features/row-pinning/rowPinningFeature.types.d.ts
+type RowPinningPosition = false | 'top' | 'bottom';
+interface RowPinningState {
+  bottom: Array<string>;
+  top: Array<string>;
+}
+interface TableState_RowPinning {
+  rowPinning: RowPinningState;
+}
+interface TableOptions_RowPinning<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Allows rows to be pinned to top or bottom regions.
+   *
+   * Provide a predicate to decide per row. Defaults to `true`.
+   */
+  enableRowPinning?: boolean | ((row: Row<TFeatures, TData>) => boolean);
+  /**
+   * When `false`, pinned rows will not be visible if they are filtered or paginated out of the table. When `true`, pinned rows will always be visible regardless of filtering or pagination. Defaults to `true`.
+   */
+  keepPinnedRows?: boolean;
+  /**
+   * 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>;
+}
+interface RowPinningDefaultOptions {
+  onRowPinningChange: OnChangeFn<RowPinningState>;
+}
+interface Row_RowPinning {
+  /**
+   * Checks whether this row can be pinned.
+   */
+  getCanPin: () => boolean;
+  /**
+   * Returns the pinned position of the row. (`'top'`, `'bottom'` or `false`)
+   */
+  getIsPinned: () => RowPinningPosition;
+  /**
+   * Returns the numeric pinned index of the row within a pinned row group.
+   */
+  getPinnedIndex: () => number;
+  /**
+   * Pins a row to the `'top'` or `'bottom'`, or unpins the row to the center if `false` is passed.
+   */
+  pin: (position: RowPinningPosition, includeLeafRows?: boolean, includeParentRows?: boolean) => void;
+}
+interface Table_RowPinning<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Gets rows pinned to the bottom region.
+   */
+  getBottomRows: () => Array<Row<TFeatures, TData>>;
+  /**
+   * Gets rows that are not pinned to the top or bottom region.
+   */
+  getCenterRows: () => Array<Row<TFeatures, TData>>;
+  /**
+   * Checks whether any rows are pinned, optionally limited to one region.
+   */
+  getIsSomeRowsPinned: (position?: RowPinningPosition) => boolean;
+  /**
+   * Gets rows pinned to the top region.
+   */
+  getTopRows: () => Array<Row<TFeatures, TData>>;
+  /**
+   * Resets `rowPinning` to `initialState.rowPinning`.
+   *
+   * Pass `true` to ignore initial state and reset to empty top/bottom arrays.
+   */
+  resetRowPinning: (defaultState?: boolean) => void;
+  /**
+   * Updates row pinning state with a next state or updater function.
+   */
+  setRowPinning: (updater: Updater<RowPinningState>) => void;
+}
+//#endregion
+export { RowPinningDefaultOptions, RowPinningPosition, RowPinningState, Row_RowPinning, TableOptions_RowPinning, TableState_RowPinning, Table_RowPinning };
+//# sourceMappingURL=rowPinningFeature.types.d.ts.map

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

@@ -0,0 +1,229 @@
+const require_utils = require('../../utils.cjs');
+const require_rowExpandingFeature_utils = require('../row-expanding/rowExpandingFeature.utils.cjs');
+
+//#region src/features/row-pinning/rowPinningFeature.utils.ts
+/**
+* Creates the default row pinning state.
+*
+* Both pinning regions start empty. Reset APIs use this value when
+* `defaultState` is `true`.
+*
+* @example
+* ```ts
+* const pinning = getDefaultRowPinningState()
+* ```
+*/
+function getDefaultRowPinningState() {
+	return {
+		top: [],
+		bottom: []
+	};
+}
+/**
+* Routes a row pinning updater through the table's row-pinning change handler.
+*
+* The updater may be a next `{ top, bottom }` state or a function of the
+* previous state, matching the instance `table.setRowPinning` behavior.
+*
+* @example
+* ```ts
+* table_setRowPinning(table, (old) => ({ ...old, top: [rowId] }))
+* ```
+*/
+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 `rowPinning` to the configured initial state or feature default.
+*
+* With no argument, the reset clones `table.initialState.rowPinning` when it
+* exists. Passing `true` ignores initial state and resets to empty top/bottom
+* arrays.
+*
+* @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()));
+}
+/**
+* Checks whether any rows are pinned.
+*
+* Omit `position` to check both regions, or pass `'top'`/`'bottom'` to inspect
+* one region.
+*
+* @example
+* ```ts
+* const hasPinnedRows = 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();
+	if (!position) return Boolean((rowPinning === null || rowPinning === void 0 ? void 0 : rowPinning.top.length) || (rowPinning === null || rowPinning === void 0 ? void 0 : rowPinning.bottom.length));
+	return Boolean(rowPinning === null || rowPinning === void 0 ? void 0 : rowPinning[position].length);
+}
+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 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;
+		result.push(row);
+	}
+	return result;
+}
+/**
+* Resolves the visible rows pinned to the top region.
+*
+* The result follows `state.rowPinning.top` order and marks each row with
+* `position = 'top'`.
+*
+* @example
+* ```ts
+* const rows = table_getTopRows(table)
+* ```
+*/
+function table_getTopRows(table) {
+	return table_getPinnedRows(table, "top");
+}
+/**
+* Resolves the visible rows pinned to the bottom region.
+*
+* The result follows `state.rowPinning.bottom` order and marks each row with
+* `position = 'bottom'`.
+*
+* @example
+* ```ts
+* const rows = table_getBottomRows(table)
+* ```
+*/
+function table_getBottomRows(table) {
+	return table_getPinnedRows(table, "bottom");
+}
+/**
+* Resolves rows that are not pinned to top or bottom.
+*
+* The current row model is filtered by `state.rowPinning.top` and
+* `state.rowPinning.bottom`.
+*
+* @example
+* ```ts
+* const rows = 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();
+	const allRows = table.getRowModel().rows;
+	const topAndBottom = new Set([...top, ...bottom]);
+	return allRows.filter((d) => !topAndBottom.has(d.id));
+}
+/**
+* Checks whether this row can be pinned.
+*
+* `options.enableRowPinning` may be a boolean or a row predicate; it defaults
+* to `true`.
+*
+* @example
+* ```ts
+* const canPin = row_getCanPin(row)
+* ```
+*/
+function row_getCanPin(row) {
+	const { enableRowPinning } = row.table.options;
+	if (typeof enableRowPinning === "function") return enableRowPinning(row);
+	return enableRowPinning ?? true;
+}
+/**
+* Reads this row's current pinning region.
+*
+* Rows listed in `state.rowPinning.top` return `'top'`, rows listed in
+* `bottom` return `'bottom'`, and unpinned rows return `false`.
+*
+* @example
+* ```ts
+* const position = 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;
+}
+/**
+* Finds this row's visible index within its pinned region.
+*
+* Unpinned rows return `-1`.
+*
+* @example
+* ```ts
+* const index = 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) : [];
+	const rowIds = new Set([
+		...parentRowIds,
+		row.id,
+		...leafRowIds
+	]);
+	table_setRowPinning(row.table, (old) => {
+		if (position === "bottom") return {
+			top: old.top.filter((d) => !rowIds.has(d)),
+			bottom: [...old.bottom.filter((d) => !rowIds.has(d)), ...Array.from(rowIds)]
+		};
+		if (position === "top") return {
+			top: [...old.top.filter((d) => !rowIds.has(d)), ...Array.from(rowIds)],
+			bottom: old.bottom.filter((d) => !rowIds.has(d))
+		};
+		return {
+			top: old.top.filter((d) => !rowIds.has(d)),
+			bottom: old.bottom.filter((d) => !rowIds.has(d))
+		};
+	});
+}
+
+//#endregion
+exports.getDefaultRowPinningState = getDefaultRowPinningState;
+exports.row_getCanPin = row_getCanPin;
+exports.row_getIsPinned = row_getIsPinned;
+exports.row_getPinnedIndex = row_getPinnedIndex;
+exports.row_pin = row_pin;
+exports.table_getBottomRows = table_getBottomRows;
+exports.table_getCenterRows = table_getCenterRows;
+exports.table_getIsSomeRowsPinned = table_getIsSomeRowsPinned;
+exports.table_getTopRows = table_getTopRows;
+exports.table_resetRowPinning = table_resetRowPinning;
+exports.table_setRowPinning = table_setRowPinning;
+//# sourceMappingURL=rowPinningFeature.utils.cjs.map

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

@@ -0,0 +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\n/**\n * Creates the default row pinning state.\n *\n * Both pinning regions start empty. Reset APIs use this value when\n * `defaultState` is `true`.\n *\n * @example\n * ```ts\n * const pinning = getDefaultRowPinningState()\n * ```\n */\nexport function getDefaultRowPinningState(): RowPinningState {\n  return {\n    top: [],\n    bottom: [],\n  }\n}\n\n/**\n * Routes a row pinning updater through the table's row-pinning change handler.\n *\n * The updater may be a next `{ top, bottom }` state or a function of the\n * previous state, matching the instance `table.setRowPinning` behavior.\n *\n * @example\n * ```ts\n * table_setRowPinning(table, (old) => ({ ...old, top: [rowId] }))\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 `rowPinning` to the configured initial state or feature default.\n *\n * With no argument, the reset clones `table.initialState.rowPinning` when it\n * exists. Passing `true` ignores initial state and resets to empty top/bottom\n * arrays.\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 * Checks whether any rows are pinned.\n *\n * Omit `position` to check both regions, or pass `'top'`/`'bottom'` to inspect\n * one region.\n *\n * @example\n * ```ts\n * const hasPinnedRows = 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 * Resolves the visible rows pinned to the top region.\n *\n * The result follows `state.rowPinning.top` order and marks each row with\n * `position = 'top'`.\n *\n * @example\n * ```ts\n * const rows = 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 * Resolves the visible rows pinned to the bottom region.\n *\n * The result follows `state.rowPinning.bottom` order and marks each row with\n * `position = 'bottom'`.\n *\n * @example\n * ```ts\n * const rows = 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 * Resolves rows that are not pinned to top or bottom.\n *\n * The current row model is filtered by `state.rowPinning.top` and\n * `state.rowPinning.bottom`.\n *\n * @example\n * ```ts\n * const rows = 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 * Checks whether this row can be pinned.\n *\n * `options.enableRowPinning` may be a boolean or a row predicate; it defaults\n * to `true`.\n *\n * @example\n * ```ts\n * const canPin = 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 * Reads this row's current pinning region.\n *\n * Rows listed in `state.rowPinning.top` return `'top'`, rows listed in\n * `bottom` return `'bottom'`, and unpinned rows return `false`.\n *\n * @example\n * ```ts\n * const position = 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 * Finds this row's visible index within its pinned region.\n *\n * Unpinned rows return `-1`.\n *\n * @example\n * ```ts\n * const index = 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":";;;;;;;;;;;;;;;AAwBA,SAAgB,4BAA6C;CAC3D,OAAO;EACL,KAAK,CAAC;EACN,QAAQ,CAAC;CACX;AACF;;;;;;;;;;;;AAaA,SAAgB,oBAId,OACA,SACM;;CACN,iDAAM,SAAQ,+GAAqB,OAAO;AAC5C;;;;;;;;;;;;;;AAeA,SAAgB,sBAGd,OAAyC,cAA8B;CACvE,oBACE,OACA,eACI,0BAA0B,IAC1BA,yBACE,MAAM,aAAa,cAAc,0BAA0B,CAC7D,CACN;AACF;;;;;;;;;;;;AAeA,SAAgB,0BAId,OACA,UACS;;CACT,MAAM,sCAAa,MAAM,MAAM,0FAAY,IAAI;CAE/C,IAAI,CAAC,UACH,OAAO,iEAAQ,WAAY,IAAI,oEAAU,WAAY,OAAO,OAAM;CAEpE,OAAO,gEAAQ,WAAa,SAAS,CAAC,MAAM;AAC9C;AAEA,SAAS,oBAIP,OACA,UAC8B;;CAC9B,MAAM,cAAc,MAAM,YAAY,CAAC,CAAC;CACxC,MAAM,0CAAe,MAAM,MAAM,8GAAY,IAAI,mFAAI,cAAa,CAAC;CACnE,MAAM,iBAAiB,MAAM,QAAQ,kBAAkB;CAEvD,MAAM,SAAuC,CAAC;CAC9C,KAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK;EAC5C,MAAM,QAAQ,aAAa;EAC3B,IAAI;EACJ,IAAI,gBAAgB;GAGlB,MAAM,UAAU,MAAM,OAAO,OAAO,IAAI;GACxC,IAAIC,8DAA4B,OAAO,GAAG,MAAM;EAClD,OAEE,MAAM,YAAY,MAAM,MAAM,EAAE,OAAO,KAAK;EAE9C,IAAI,CAAC,KACH;EAED,AAAC,IAAY,WAAW;EACzB,OAAO,KAAK,GAAG;CACjB;CACA,OAAO;AACT;;;;;;;;;;;;AAaA,SAAgB,iBAGd,OAAuE;CACvE,OAAO,oBAAoB,OAAO,KAAK;AACzC;;;;;;;;;;;;AAaA,SAAgB,oBAGd,OAAuE;CACvE,OAAO,oBAAoB,OAAO,QAAQ;AAC5C;;;;;;;;;;;;AAaA,SAAgB,oBAGd,OAAuE;;CACvE,MAAM,EAAE,KAAK,sCACX,MAAM,MAAM,4FAAY,IAAI,MAAK,0BAA0B;CAC7D,MAAM,UAAU,MAAM,YAAY,CAAC,CAAC;CAEpC,MAAM,eAAe,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC;CAChD,OAAO,QAAQ,QAAQ,MAAM,CAAC,aAAa,IAAI,EAAE,EAAE,CAAC;AACtD;;;;;;;;;;;;AAeA,SAAgB,cAGd,KAAqC;CACrC,MAAM,EAAE,qBAAqB,IAAI,MAAM;CACvC,IAAI,OAAO,qBAAqB,YAC9B,OAAO,iBAAiB,GAAG;CAE7B,OAAO,oBAAoB;AAC7B;;;;;;;;;;;;AAaA,SAAgB,gBAGd,KAAgD;;CAChD,MAAM,EAAE,KAAK,qCACX,IAAI,MAAM,MAAM,0FAAY,IAAI,MAAK,0BAA0B;CAEjE,OAAO,IAAI,SAAS,IAAI,EAAE,IACtB,QACA,OAAO,SAAS,IAAI,EAAE,IACpB,WACA;AACR;;;;;;;;;;;AAYA,SAAgB,mBAGd,KAAoC;CACpC,MAAM,WAAW,gBAAgB,GAAG;CACpC,IAAI,CAAC,UAAU,OAAO;CAQtB,QALE,aAAa,QACTC,iCAAmB,IAAI,OAAO,cAAc,gBAAgB,IAC5DA,iCAAmB,IAAI,OAAO,iBAAiB,mBAAmB,EAAC,CACvE,KAAK,EAAE,SAAS,EAEO,CAAC,CAAC,QAAQ,IAAI,EAAE;AAC3C;;;;;;;;;;;;AAaA,SAAgB,QACd,KACA,UACA,iBACA,mBACM;CACN,MAAM,aAAa,kBACf,IAAI,YAAY,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,IACpC,CAAC;CACL,MAAM,eAAe,oBACjB,IAAI,cAAc,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,IACtC,CAAC;CACL,MAAM,SAAsB,IAAI,IAAI;EAAC,GAAG;EAAc,IAAI;EAAI,GAAG;CAAU,CAAC;CAE5E,oBAAoB,IAAI,QAAQ,QAAQ;EACtC,IAAI,aAAa,UACf,OAAO;GACL,KAAK,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;GACzC,QAAQ,CACN,GAAG,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,GAC1C,GAAG,MAAM,KAAK,MAAM,CACtB;EACF;EAGF,IAAI,aAAa,OACf,OAAO;GACL,KAAK,CAAC,GAAG,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,GAAG,MAAM,KAAK,MAAM,CAAC;GACrE,QAAQ,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;EACjD;EAGF,OAAO;GACL,KAAK,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;GACzC,QAAQ,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;EACjD;CACF,CAAC;AACH"}

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

@@ -0,0 +1,143 @@
+import { RowData, Updater } from "../../types/type-utils.cjs";
+import { RowPinningPosition, RowPinningState } from "./rowPinningFeature.types.cjs";
+import { Row } from "../../types/Row.cjs";
+import { Table_Internal } from "../../types/Table.cjs";
+import { TableFeatures } from "../../types/TableFeatures.cjs";
+
+//#region src/features/row-pinning/rowPinningFeature.utils.d.ts
+/**
+ * Creates the default row pinning state.
+ *
+ * Both pinning regions start empty. Reset APIs use this value when
+ * `defaultState` is `true`.
+ *
+ * @example
+ * ```ts
+ * const pinning = getDefaultRowPinningState()
+ * ```
+ */
+declare function getDefaultRowPinningState(): RowPinningState;
+/**
+ * Routes a row pinning updater through the table's row-pinning change handler.
+ *
+ * The updater may be a next `{ top, bottom }` state or a function of the
+ * previous state, matching the instance `table.setRowPinning` behavior.
+ *
+ * @example
+ * ```ts
+ * table_setRowPinning(table, (old) => ({ ...old, top: [rowId] }))
+ * ```
+ */
+declare function table_setRowPinning<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<RowPinningState>): void;
+/**
+ * Resets `rowPinning` to the configured initial state or feature default.
+ *
+ * With no argument, the reset clones `table.initialState.rowPinning` when it
+ * exists. Passing `true` ignores initial state and resets to empty top/bottom
+ * arrays.
+ *
+ * @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;
+/**
+ * Checks whether any rows are pinned.
+ *
+ * Omit `position` to check both regions, or pass `'top'`/`'bottom'` to inspect
+ * one region.
+ *
+ * @example
+ * ```ts
+ * const hasPinnedRows = table_getIsSomeRowsPinned(table)
+ * ```
+ */
+declare function table_getIsSomeRowsPinned<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, position?: RowPinningPosition): boolean;
+/**
+ * Resolves the visible rows pinned to the top region.
+ *
+ * The result follows `state.rowPinning.top` order and marks each row with
+ * `position = 'top'`.
+ *
+ * @example
+ * ```ts
+ * const rows = table_getTopRows(table)
+ * ```
+ */
+declare function table_getTopRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Resolves the visible rows pinned to the bottom region.
+ *
+ * The result follows `state.rowPinning.bottom` order and marks each row with
+ * `position = 'bottom'`.
+ *
+ * @example
+ * ```ts
+ * const rows = table_getBottomRows(table)
+ * ```
+ */
+declare function table_getBottomRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Resolves rows that are not pinned to top or bottom.
+ *
+ * The current row model is filtered by `state.rowPinning.top` and
+ * `state.rowPinning.bottom`.
+ *
+ * @example
+ * ```ts
+ * const rows = table_getCenterRows(table)
+ * ```
+ */
+declare function table_getCenterRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Checks whether this row can be pinned.
+ *
+ * `options.enableRowPinning` may be a boolean or a row predicate; it defaults
+ * to `true`.
+ *
+ * @example
+ * ```ts
+ * const canPin = row_getCanPin(row)
+ * ```
+ */
+declare function row_getCanPin<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * Reads this row's current pinning region.
+ *
+ * Rows listed in `state.rowPinning.top` return `'top'`, rows listed in
+ * `bottom` return `'bottom'`, and unpinned rows return `false`.
+ *
+ * @example
+ * ```ts
+ * const position = row_getIsPinned(row)
+ * ```
+ */
+declare function row_getIsPinned<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): RowPinningPosition;
+/**
+ * Finds this row's visible index within its pinned region.
+ *
+ * Unpinned rows return `-1`.
+ *
+ * @example
+ * ```ts
+ * const index = 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 };
+//# sourceMappingURL=rowPinningFeature.utils.d.cts.map

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

@@ -0,0 +1,143 @@
+import { RowData, Updater } from "../../types/type-utils.js";
+import { RowPinningPosition, RowPinningState } from "./rowPinningFeature.types.js";
+import { Row } from "../../types/Row.js";
+import { Table_Internal } from "../../types/Table.js";
+import { TableFeatures } from "../../types/TableFeatures.js";
+
+//#region src/features/row-pinning/rowPinningFeature.utils.d.ts
+/**
+ * Creates the default row pinning state.
+ *
+ * Both pinning regions start empty. Reset APIs use this value when
+ * `defaultState` is `true`.
+ *
+ * @example
+ * ```ts
+ * const pinning = getDefaultRowPinningState()
+ * ```
+ */
+declare function getDefaultRowPinningState(): RowPinningState;
+/**
+ * Routes a row pinning updater through the table's row-pinning change handler.
+ *
+ * The updater may be a next `{ top, bottom }` state or a function of the
+ * previous state, matching the instance `table.setRowPinning` behavior.
+ *
+ * @example
+ * ```ts
+ * table_setRowPinning(table, (old) => ({ ...old, top: [rowId] }))
+ * ```
+ */
+declare function table_setRowPinning<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<RowPinningState>): void;
+/**
+ * Resets `rowPinning` to the configured initial state or feature default.
+ *
+ * With no argument, the reset clones `table.initialState.rowPinning` when it
+ * exists. Passing `true` ignores initial state and resets to empty top/bottom
+ * arrays.
+ *
+ * @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;
+/**
+ * Checks whether any rows are pinned.
+ *
+ * Omit `position` to check both regions, or pass `'top'`/`'bottom'` to inspect
+ * one region.
+ *
+ * @example
+ * ```ts
+ * const hasPinnedRows = table_getIsSomeRowsPinned(table)
+ * ```
+ */
+declare function table_getIsSomeRowsPinned<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, position?: RowPinningPosition): boolean;
+/**
+ * Resolves the visible rows pinned to the top region.
+ *
+ * The result follows `state.rowPinning.top` order and marks each row with
+ * `position = 'top'`.
+ *
+ * @example
+ * ```ts
+ * const rows = table_getTopRows(table)
+ * ```
+ */
+declare function table_getTopRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Resolves the visible rows pinned to the bottom region.
+ *
+ * The result follows `state.rowPinning.bottom` order and marks each row with
+ * `position = 'bottom'`.
+ *
+ * @example
+ * ```ts
+ * const rows = table_getBottomRows(table)
+ * ```
+ */
+declare function table_getBottomRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Resolves rows that are not pinned to top or bottom.
+ *
+ * The current row model is filtered by `state.rowPinning.top` and
+ * `state.rowPinning.bottom`.
+ *
+ * @example
+ * ```ts
+ * const rows = table_getCenterRows(table)
+ * ```
+ */
+declare function table_getCenterRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+/**
+ * Checks whether this row can be pinned.
+ *
+ * `options.enableRowPinning` may be a boolean or a row predicate; it defaults
+ * to `true`.
+ *
+ * @example
+ * ```ts
+ * const canPin = row_getCanPin(row)
+ * ```
+ */
+declare function row_getCanPin<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * Reads this row's current pinning region.
+ *
+ * Rows listed in `state.rowPinning.top` return `'top'`, rows listed in
+ * `bottom` return `'bottom'`, and unpinned rows return `false`.
+ *
+ * @example
+ * ```ts
+ * const position = row_getIsPinned(row)
+ * ```
+ */
+declare function row_getIsPinned<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): RowPinningPosition;
+/**
+ * Finds this row's visible index within its pinned region.
+ *
+ * Unpinned rows return `-1`.
+ *
+ * @example
+ * ```ts
+ * const index = 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 };
+//# sourceMappingURL=rowPinningFeature.utils.d.ts.map