@rickcedwhat/playwright-smart-table 6.21.0 → 6.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/engine/rowFinder.js +2 -4
- package/dist/engine/tableIteration.js +2 -2
- package/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/presets/mui.js +15 -29
- package/dist/smartRow.js +3 -2
- package/dist/typeContext.d.ts +1 -1
- package/dist/typeContext.js +32 -16
- package/dist/types.d.ts +31 -16
- package/dist/useTable.js +28 -21
- package/dist/utils/loadingWait.d.ts +15 -0
- package/dist/utils/loadingWait.js +43 -0
- package/dist/utils/pageIndex.d.ts +12 -0
- package/dist/utils/pageIndex.js +19 -0
- package/package.json +1 -1
package/dist/engine/rowFinder.js
CHANGED
|
@@ -9,6 +9,7 @@ const navigationBarrier_1 = require("../utils/navigationBarrier");
|
|
|
9
9
|
const rowResolution_1 = require("./rowResolution");
|
|
10
10
|
const resolveCellLocator_1 = require("../utils/resolveCellLocator");
|
|
11
11
|
const scanPages_1 = require("./scanPages");
|
|
12
|
+
const loadingWait_1 = require("../utils/loadingWait");
|
|
12
13
|
class RowFinder {
|
|
13
14
|
constructor(rootLocator, config, resolve, filterEngine, tableMapper, makeSmartRow, tableState = { currentPageIndex: 0 }, advancePage = async () => false) {
|
|
14
15
|
this.rootLocator = rootLocator;
|
|
@@ -131,10 +132,7 @@ class RowFinder {
|
|
|
131
132
|
page: this.rootLocator.page(),
|
|
132
133
|
resolve: this.resolve
|
|
133
134
|
};
|
|
134
|
-
|
|
135
|
-
(0, debugUtils_1.logDebug)(this.config, 'verbose', 'Table is loading... waiting');
|
|
136
|
-
await this.rootLocator.page().waitForTimeout(200);
|
|
137
|
-
}
|
|
135
|
+
await (0, loadingWait_1.waitWhileTableLoading)(this.config, context, this.rootLocator.page(), 'waitForTableReady');
|
|
138
136
|
}
|
|
139
137
|
async findRows(filters = {}, options) {
|
|
140
138
|
var _a, _b, _c;
|
|
@@ -28,8 +28,8 @@ async function runMap(env, callback, options = {}, label = 'map') {
|
|
|
28
28
|
const effectiveMaxPages = (_a = options.maxPages) !== null && _a !== void 0 ? _a : env.config.maxPages;
|
|
29
29
|
const dedupeStrategy = (_b = options.dedupe) !== null && _b !== void 0 ? _b : env.config.strategies.dedupe;
|
|
30
30
|
const dedupeKeys = dedupeStrategy ? new Set() : null;
|
|
31
|
-
|
|
32
|
-
const concurrency = (_d = (_c = options.concurrency) !== null && _c !== void 0 ? _c : env.config.concurrency) !== null && _d !== void 0 ? _d :
|
|
31
|
+
// Sequential by default for all iteration labels (#434) — parallel is opt-in for read-only maps.
|
|
32
|
+
const concurrency = (_d = (_c = options.concurrency) !== null && _c !== void 0 ? _c : env.config.concurrency) !== null && _d !== void 0 ? _d : 'sequential';
|
|
33
33
|
const useBarrier = concurrency === 'synchronized';
|
|
34
34
|
// Mutex must not pair with the navigation barrier: synchronized mode needs every row
|
|
35
35
|
// to enter barrier.sync concurrently; serializing callbacks here deadlocks (first row waits
|
package/dist/packageVersion.d.ts
CHANGED
|
@@ -3,4 +3,4 @@
|
|
|
3
3
|
* Generated by scripts/embed-version.mjs from package.json
|
|
4
4
|
*/
|
|
5
5
|
/** Semver of this package. Use in logs or diagnostics to confirm the installed build. */
|
|
6
|
-
export declare const PLAYWRIGHT_SMART_TABLE_VERSION: "6.
|
|
6
|
+
export declare const PLAYWRIGHT_SMART_TABLE_VERSION: "6.22.0";
|
package/dist/packageVersion.js
CHANGED
|
@@ -6,4 +6,4 @@ exports.PLAYWRIGHT_SMART_TABLE_VERSION = void 0;
|
|
|
6
6
|
* Generated by scripts/embed-version.mjs from package.json
|
|
7
7
|
*/
|
|
8
8
|
/** Semver of this package. Use in logs or diagnostics to confirm the installed build. */
|
|
9
|
-
exports.PLAYWRIGHT_SMART_TABLE_VERSION = "6.
|
|
9
|
+
exports.PLAYWRIGHT_SMART_TABLE_VERSION = "6.22.0";
|
package/dist/presets/mui.js
CHANGED
|
@@ -146,22 +146,14 @@ function createMuiTable(opts) {
|
|
|
146
146
|
return 'asc';
|
|
147
147
|
return 'none';
|
|
148
148
|
},
|
|
149
|
-
doSort: async ({ columnName,
|
|
150
|
-
|
|
149
|
+
doSort: async ({ columnName, context }) => {
|
|
150
|
+
// Trigger-only: core `sorting.apply` owns retries + state checks (#434).
|
|
151
151
|
if (!context.getHeaderCell)
|
|
152
152
|
return;
|
|
153
153
|
const header = await context.getHeaderCell(columnName);
|
|
154
154
|
const sortLabel = header.locator('.MuiTableSortLabel-root').first();
|
|
155
155
|
const target = await sortLabel.isVisible().catch(() => false) ? sortLabel : header;
|
|
156
|
-
|
|
157
|
-
let attempts = 0;
|
|
158
|
-
// Click until the state matches the target direction, max 3 times (none -> asc -> desc)
|
|
159
|
-
while (current !== direction && attempts < 3) {
|
|
160
|
-
await target.click();
|
|
161
|
-
await context.page.waitForTimeout(100);
|
|
162
|
-
current = await ((_b = context.config.strategies.sorting) === null || _b === void 0 ? void 0 : _b.getSortState({ columnName, context })) || 'none';
|
|
163
|
-
attempts++;
|
|
164
|
-
}
|
|
156
|
+
await target.click();
|
|
165
157
|
}
|
|
166
158
|
},
|
|
167
159
|
dedupe: async (row) => {
|
|
@@ -303,28 +295,22 @@ function createMuiDataGrid(opts) {
|
|
|
303
295
|
return 'desc';
|
|
304
296
|
return 'none';
|
|
305
297
|
},
|
|
306
|
-
doSort: async ({ columnName,
|
|
307
|
-
|
|
298
|
+
doSort: async ({ columnName, context }) => {
|
|
299
|
+
// Trigger-only: core `sorting.apply` owns retries + state checks (#434).
|
|
308
300
|
if (!context.getHeaderCell)
|
|
309
301
|
return;
|
|
310
302
|
const header = await context.getHeaderCell(columnName);
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
}
|
|
318
|
-
else {
|
|
319
|
-
await header.click({ force: true });
|
|
320
|
-
}
|
|
321
|
-
// Wait for stabilization (using DataGrid specific overlay check inside helper)
|
|
322
|
-
const displayedRows = context.root.locator('.MuiTablePagination-displayedRows');
|
|
323
|
-
const text = await displayedRows.innerText().catch(() => '');
|
|
324
|
-
await waitForMuiPaginationStabilization(context, displayedRows, text);
|
|
325
|
-
current = await ((_b = context.config.strategies.sorting) === null || _b === void 0 ? void 0 : _b.getSortState({ columnName, context })) || 'none';
|
|
326
|
-
attempts++;
|
|
303
|
+
const clickTarget = header.locator('.MuiDataGrid-columnHeaderTitleContainer').first();
|
|
304
|
+
if (await clickTarget.isVisible()) {
|
|
305
|
+
await clickTarget.click({ force: true });
|
|
306
|
+
}
|
|
307
|
+
else {
|
|
308
|
+
await header.click({ force: true });
|
|
327
309
|
}
|
|
310
|
+
// One stabilization wait after the click; core also polls isTableLoading.
|
|
311
|
+
const displayedRows = context.root.locator('.MuiTablePagination-displayedRows');
|
|
312
|
+
const text = await displayedRows.innerText().catch(() => '');
|
|
313
|
+
await waitForMuiPaginationStabilization(context, displayedRows, text);
|
|
328
314
|
}
|
|
329
315
|
},
|
|
330
316
|
dedupe: async (row) => {
|
package/dist/smartRow.js
CHANGED
|
@@ -7,6 +7,7 @@ const stringUtils_1 = require("./utils/stringUtils");
|
|
|
7
7
|
const debugUtils_1 = require("./utils/debugUtils");
|
|
8
8
|
const paginationPath_1 = require("./utils/paginationPath");
|
|
9
9
|
const sentinel_1 = require("./utils/sentinel");
|
|
10
|
+
const pageIndex_1 = require("./utils/pageIndex");
|
|
10
11
|
/**
|
|
11
12
|
* Internal helper to navigate to a cell with active cell optimization.
|
|
12
13
|
* Uses `strategies.navigation` primitives (goUp/goDown/goLeft/goRight, optional snap/seek/goHome).
|
|
@@ -885,7 +886,7 @@ const createSmartRow = (rowLocator, map, rowIndex, config, rootLocator, resolve,
|
|
|
885
886
|
const primitives = config.strategies.pagination;
|
|
886
887
|
const context = { root: rootLocator, config, page: rootLocator.page(), resolve };
|
|
887
888
|
const getCurrent = () => parentTable.currentPageIndex;
|
|
888
|
-
const setCurrent = (n) => { parentTable
|
|
889
|
+
const setCurrent = (n) => { (0, pageIndex_1.setCurrentPageIndex)(parentTable, n); };
|
|
889
890
|
if (primitives.goToPage) {
|
|
890
891
|
(0, debugUtils_1.logDebug)(config, 'info', `bringIntoView: Navigating to page ${tablePageIndex} (goToPage retry loop)`);
|
|
891
892
|
await (0, paginationPath_1.executeNavigationWithGoToPageRetry)(tablePageIndex, primitives, context, getCurrent, setCurrent);
|
|
@@ -910,7 +911,7 @@ const createSmartRow = (rowLocator, map, rowIndex, config, rootLocator, resolve,
|
|
|
910
911
|
if (!ok)
|
|
911
912
|
throw new Error(`bringIntoView: goNext failed before reaching page ${tablePageIndex}.`);
|
|
912
913
|
}
|
|
913
|
-
parentTable
|
|
914
|
+
(0, pageIndex_1.setCurrentPageIndex)(parentTable, tablePageIndex);
|
|
914
915
|
}
|
|
915
916
|
else {
|
|
916
917
|
(0, debugUtils_1.logDebug)(config, 'error', `Cannot bring row on page ${tablePageIndex} into view. No backwards pagination strategies (goToPage, goPrevious, goPreviousBulk, or goToFirst+goNext) provided.`);
|
package/dist/typeContext.d.ts
CHANGED
|
@@ -3,4 +3,4 @@
|
|
|
3
3
|
* This file is generated by scripts/embed-types.mjs
|
|
4
4
|
* It contains the raw text of types.ts to provide context for LLM prompts.
|
|
5
5
|
*/
|
|
6
|
-
export declare const TYPE_CONTEXT = "\n/**\n * Flexible selector type - can be a CSS string, function returning a Locator, or Locator itself.\n * @example\n * // String selector\n * rowSelector: 'tbody tr'\n * \n * // Function selector\n * headerSelector: (root) => root.locator('[role=\"columnheader\"]')\n */\nexport type Selector = string | ((root: Locator | Page) => Locator) | ((root: Locator) => Locator);\n\n/**\n * Return type for `resolveRowIndex`. A plain number gives the logical index only;\n * `{ index, selector }` additionally provides a CSS selector the library uses to\n * build a self-healing row locator that survives virtual-scroll DOM recycling.\n */\nexport type RowIndexResult = number | { index: number; selector: string };\n\n/**\n * Value used to filter rows.\n * - string/number/RegExp: filter by text content of the cell.\n * - function: filter by custom locator logic within the cell.\n * @example\n * // Text filter\n * { Name: 'John' }\n * \n * // Custom locator filter (e.g. checkbox is checked)\n * { Status: (cell) => cell.locator('input:checked') }\n */\nexport type FilterValue = string | RegExp | number | ((cell: Locator) => Locator);\n\n/**\n * Function to get a cell locator given row, column info.\n * Replaces the old cellResolver.\n */\nexport type GetCellLocatorFn = (args: {\n row: Locator;\n /** The root locator passed to useTable(). Useful for re-querying stale row locators. */\n root: Locator;\n columnName: string;\n columnIndex: number;\n rowIndex?: number;\n page: Page;\n config: FinalTableConfig<any>;\n}) => Locator;\n\n/**\n * Hook called before each cell value is read in `toJSON` (and `columnOverrides.read`).\n *\n * Use this to scroll off-screen columns into view in **horizontally** virtualized tables,\n * wait for lazy-rendered content (popovers, tooltips, async cell renderers), or perform\n * any other pre-read setup that doesn't involve Y-axis scrolling.\n *\n * ---\n *\n * **\u26A0\uFE0F Y-scroll footgun \u2014 do NOT call `scrollIntoViewIfNeeded()` on row-virtualized grids.**\n *\n * `scrollIntoViewIfNeeded` adjusts *both* scroll axes. On grids that recycle DOM nodes\n * based on the Y position (MUI DataGrid, AG Grid, react-window, etc.) calling it will\n * shift the viewport vertically, unmounting the row you are currently reading and\n * silently returning stale or empty cell values for the remainder of the row.\n *\n * Safe uses:\n * - Column-only (X-axis) virtualization where rows are always in the DOM.\n * - Calling `scrollIntoViewIfNeeded` on the **header cell** only, when that header is\n * guaranteed not to trigger a Y-scroll (e.g. sticky header grids).\n *\n * For grids with **both** row and column virtualization, use the `viewport` strategy\n * instead \u2014 it drives explicit `scrollToRow` / `scrollToColumn` calls and is aware of\n * the virtualization lifecycle.\n *\n * @example\n * // Safe: column-only horizontal virtualization (rows always in DOM)\n * strategies: {\n * beforeCellRead: async ({ columnName, getHeaderCell }) => {\n * const header = await getHeaderCell(columnName);\n * await header.scrollIntoViewIfNeeded(); // only scrolls X \u2014 rows stay mounted\n * }\n * }\n *\n * @example\n * // Safe: wait for a lazy-rendered popover/tooltip before reading its text\n * strategies: {\n * beforeCellRead: async ({ cell }) => {\n * await cell.hover();\n * await cell.page().waitForSelector('.cell-tooltip', { state: 'visible' });\n * }\n * }\n */\nexport type BeforeCellReadFn = (args: {\n /** The resolved cell locator */\n cell: Locator;\n columnName: string;\n columnIndex: number;\n row: Locator;\n page: Page;\n root: Locator;\n /** Resolves a column name to its header cell locator */\n getHeaderCell: (columnName: string) => Promise<Locator>;\n}) => Promise<void>;\n\n/**\n * Function to get the currently active/focused cell.\n * Returns null if no cell is active.\n */\nexport type GetActiveCellFn = (args: TableContext) => Promise<{\n rowIndex: number;\n columnIndex: number;\n columnName?: string;\n locator: Locator;\n} | null>;\n\n/**\n * Viewport oracle strategies for virtualized tables.\n *\n * These tell the library *what is currently in the DOM* rather than *how to move*.\n * When present, the cell-reading engine uses them to jump directly to a target\n * row/column instead of stepping blindly with navigation primitives.\n *\n * This is the primary fix for the 2D scroll hazard: scrolling right to bring a\n * column into view can knock rows out of the vertical viewport (and vice versa).\n * With `getVisibleRowRange` the engine detects this and calls `scrollToRow` to\n * restore the row before reading \u2014 eliminating the hazard without polling loops.\n *\n * All members are optional. Supply whichever the underlying grid exposes:\n * - Range oracles alone enable hazard detection with graceful fallback to navigation primitives.\n * - Scroll primitives alone enable direct jumps without range awareness.\n * - Both together give the most reliable, fastest path.\n *\n * @example\n * // MUI DataGrid via apiRef\n * strategies: {\n * viewport: {\n * getVisibleRowRange: async ({ root }) =>\n * root.evaluate(el => {\n * const api = (el as any).__muiDataGrid__;\n * return { first: api.getFirstVisibleRow(), last: api.getLastVisibleRow() };\n * }),\n * scrollToRow: async ({ root }, rowIndex) =>\n * root.evaluate((el, idx) =>\n * (el as any).__muiDataGrid__.scrollToIndexes({ rowIndex: idx }), rowIndex),\n * scrollToColumn: async ({ root }, colIndex) =>\n * root.evaluate((el, idx) =>\n * (el as any).__muiDataGrid__.scrollToIndexes({ colIndex: idx }), colIndex),\n * }\n * }\n *\n * @example\n * // aria-rowindex / aria-colindex DOM fallback (works without internal API access)\n * strategies: {\n * viewport: {\n * getVisibleRowRange: async ({ root }) =>\n * root.evaluate(el => {\n * const rows = [...el.querySelectorAll('[role=\"row\"][aria-rowindex]')];\n * const idxs = rows.map(r => Number(r.getAttribute('aria-rowindex')) - 1);\n * return { first: Math.min(...idxs), last: Math.max(...idxs) };\n * }),\n * }\n * }\n */\nexport interface ViewportStrategy {\n /**\n * Returns the 0-based index range of rows currently rendered in the DOM.\n * Used to detect when a target row has been scrolled out of view and needs recovery.\n */\n getVisibleRowRange?: (context: TableContext) => Promise<{ first: number; last: number }>;\n\n /**\n * Returns the DOM positions (0-based, document order \u2014 indices into the resolved\n * `rowSelector` set) of rows currently within the scroll container's visible bounds.\n * Unlike `getVisibleRowRange` (a logical min/max), this identifies the exact rows, so\n * `map`/`forEach`/`filter` can skip overscan rows during collection (see #353 / #357).\n * Geometry-based and inclusive (any overlap counts as visible). When the container can't\n * be measured, return all positions so no rows are filtered.\n */\n getVisibleRowIndices?: (context: TableContext) => Promise<number[]>;\n\n /**\n * Returns the 0-based index range of columns currently rendered in the DOM.\n * Used to detect when a target column is not yet mounted before reading.\n */\n getVisibleColumnRange?: (context: TableContext) => Promise<{ first: number; last: number }>;\n\n /**\n * Scrolls or jumps directly to make a row visible by 0-based index.\n * Replaces blind goDown()/goUp() step loops for grids that expose a scroll API.\n */\n scrollToRow?: (context: TableContext, rowIndex: number) => Promise<void>;\n\n /**\n * Scrolls or jumps directly to make a column visible by 0-based index.\n * Replaces blind goRight()/goLeft() step loops for grids that expose a scroll API.\n */\n scrollToColumn?: (context: TableContext, colIndex: number) => Promise<void>;\n\n /**\n * When true, disables the automatic memoization of getVisibleColumnRange and\n * getVisibleRowRange results. By default the library caches each range value and\n * invalidates it after the corresponding scroll call, eliminating redundant DOM\n * evaluate() round-trips between scrolls.\n */\n disableCache?: boolean;\n}\n\n\n/**\n * SmartCell - A Playwright Locator with table-aware methods for single-cell operations.\n * \n * Extends all standard Locator methods (click, isVisible, etc.).\n */\nexport type SmartCell = Locator & {\n /**\n * Scrolls/paginates to bring this specific cell into view using the configured strategies.\n * Useful when the grid is horizontally virtualized and the column must be scrolled\n * into view before it can be interacted with or read.\n */\n bringIntoView(): Promise<void>;\n};\n\n\n/**\n * SmartRow - A Playwright Locator with table-aware methods.\n * \n * Extends all standard Locator methods (click, isVisible, etc.) with table-specific functionality.\n * \n * @example\n * const row = table.getRow({ Name: 'John Doe' });\n * await row.click(); // Standard Locator method\n * const email = row.getCell('Email'); // Table-aware method\n * const data = await row.toJSON(); // Extract all row data\n * await row.smartFill({ Name: 'Jane', Status: 'Active' }); // Fill form fields\n */\nexport type SmartRow<T = any> = Locator & {\n /** Optional row index (0-based) if known */\n rowIndex?: number;\n\n /** Optional page index this row was found on (0-based) */\n tablePageIndex?: number;\n\n /** Reference to the parent TableResult */\n table: TableResult<T>;\n\n /**\n * Get a cell locator by column name.\n * @param column - Column name (case-sensitive)\n * @returns SmartCell (Locator + bringIntoView)\n * @example\n * const emailCell = row.getCell('Email');\n * await emailCell.bringIntoView();\n * await expect(emailCell).toHaveText('john@example.com');\n */\n getCell(column: string): SmartCell;\n\n /**\n * Extract all cell data as a key-value object.\n * @param options - Optional configuration\n * @param options.columns - Specific columns to extract (extracts all if not specified)\n * @returns Promise resolving to row data\n * @example\n * const data = await row.toJSON();\n * // { Name: 'John', Email: 'john@example.com', ... }\n * \n * const partial = await row.toJSON({ columns: ['Name', 'Email'] });\n * // { Name: 'John', Email: 'john@example.com' }\n *\n * // Atomic: snapshot all cell values in a single evaluate \u2014 zero inter-column stagger.\n * // Requires cellSelector to be a CSS string (not a function).\n * // Column overrides ARE supported (run against a frozen off-screen reconstruction).\n * // Uses textContent (not layout-dependent innerText) for non-override columns.\n * const coherent = await row.toJSON({ atomic: true });\n */\n toJSON(options?: { columns?: string[]; atomic?: boolean }): Promise<T>;\n\n /**\n * Scrolls/paginates to bring this row into view.\n * Works when row position metadata is known (e.g., from getRowByIndex, findRow,\n * findRows, filter, or async iteration).\n *\n * Prefers `strategies.viewport.scrollToRow` when configured; otherwise falls back to\n * Playwright `scrollIntoViewIfNeeded()`.\n * @throws Error if row position metadata is unknown\n */\n bringIntoView(): Promise<void>;\n\n /**\n * Intelligently fills form fields in the row.\n * Automatically detects input types (text, select, checkbox, contenteditable).\n * \n * @param data - Column-value pairs to fill\n * @param options - Optional configuration\n * @param options.inputMappers - Custom input selectors per column\n * @example\n * // Auto-detection\n * await row.smartFill({ Name: 'John', Status: 'Active', Subscribe: true });\n * \n * // Custom input mappers\n * await row.smartFill(\n * { Name: 'John' },\n * { inputMappers: { Name: (cell) => cell.locator('.custom-input') } }\n * );\n */\n smartFill: (data: Partial<T> | Record<string, any>, options?: FillOptions) => Promise<void>;\n\n /**\n * Get the resolved value of any column \u2014 real, override, or synthetic.\n *\n * When `strategies.viewport` or `strategies.navigation` is configured, runs the same\n * cell-navigation pipeline as `toJSON` / `getCell().bringIntoView()` so off-screen\n * virtualized cells are mounted before reading. Without those strategies, reads the\n * current DOM cell (Playwright auto-wait).\n *\n * @param column - Column name (case-sensitive)\n * @returns The column value as a string\n */\n getValue(column: string): Promise<string>;\n\n /**\n * Returns whether the row exists in the DOM (i.e. is not a sentinel row).\n */\n wasFound(): boolean;\n};\n\nexport type StrategyContext = TableContext & {\n rowLocator?: Locator;\n rowIndex?: number;\n};\n\n/**\n * Defines the contract for a sorting strategy.\n */\nexport interface SortingStrategy {\n /**\n * Performs the sort action on a column.\n */\n doSort(options: {\n columnName: string;\n direction: 'asc' | 'desc';\n context: StrategyContext;\n }): Promise<void>;\n\n /**\n * Retrieves the current sort state of a column.\n */\n getSortState(options: {\n columnName: string;\n context: StrategyContext;\n }): Promise<'asc' | 'desc' | 'none'>;\n}\n\n/**\n * Debug configuration for development and troubleshooting\n */\nexport type DebugConfig = {\n /**\n * Slow down operations for debugging\n * - number: Apply same delay to all operations (ms)\n * - object: Granular delays per operation type\n */\n slow?: number | {\n pagination?: number;\n getCell?: number;\n findRow?: number;\n default?: number;\n };\n /**\n * Log level for debug output\n * - 'verbose': All logs (verbose, info, error)\n * - 'info': Info and error logs only\n * - 'error': Error logs only\n * - 'none': No logs\n */\n logLevel?: 'verbose' | 'info' | 'error' | 'none';\n};\n\nexport interface TableContext<T = any> {\n root: Locator;\n config: FinalTableConfig<T>;\n page: Page;\n resolve: (selector: Selector, parent: Locator | Page) => Locator;\n /** Resolves a column name to its header cell locator. Available after table is initialized. */\n getHeaderCell?: (columnName: string) => Promise<Locator>;\n /** Returns all column names in order. Available after table is initialized. */\n getHeaders?: () => Promise<string[]>;\n /** Scrolls the table horizontally to bring the given column's header into view. */\n scrollToColumn?: (columnName: string) => Promise<void>;\n}\n\nexport interface PaginationPrimitives {\n /** Classic \"Next Page\" or \"Scroll Down\" */\n goNext?: (context: TableContext) => Promise<boolean>;\n\n /** Classic \"Previous Page\" or \"Scroll Up\" */\n goPrevious?: (context: TableContext) => Promise<boolean>;\n\n /** Bulk skip forward multiple pages at once. Returns number of pages skipped. */\n goNextBulk?: (context: TableContext) => Promise<boolean | number>;\n\n /** Bulk skip backward multiple pages at once. Returns number of pages skipped. */\n goPreviousBulk?: (context: TableContext) => Promise<boolean | number>;\n\n /** Jump to first page / scroll to top */\n goToFirst?: (context: TableContext) => Promise<boolean>;\n\n /** Jump to last page / scroll to bottom */\n goToLast?: (context: TableContext) => Promise<boolean>;\n\n /**\n * Fetch the total number of pages currently available.\n * Can be used to optimize pagination paths (e.g. jumping to last page and going backwards).\n */\n getTotalPages?: (context: TableContext) => Promise<number | null>;\n\n /**\n * Jump to specific page index (0-indexed).\n * Can be full-range (e.g. page number input: any page works) or windowed (e.g. only visible links 6\u201314).\n * Return false when the page is not reachable in the current UI; the library will step toward the target (goNextBulk/goNext or goPreviousBulk/goPrevious) and retry goToPage until it succeeds.\n */\n goToPage?: (pageIndex: number, context: TableContext) => Promise<boolean>;\n\n /** How many pages one goNextBulk() advances. Used by navigation path planner for optimal bringIntoView. */\n nextBulkPages?: number;\n\n /** How many pages one goPreviousBulk() goes back. Used by navigation path planner for optimal bringIntoView. */\n previousBulkPages?: number;\n\n /**\n * Called once during init() to sync the library's page counter with the actual DOM state.\n * Use when a table may open on a page other than the first (e.g. a deep-linked URL that\n * lands on page 5). Returns a 0-indexed page number.\n * @example\n * detectCurrentPage: async (root) => {\n * const text = await root.locator('[aria-current=\"page\"]').textContent();\n * return parseInt(text ?? '1') - 1;\n * }\n */\n detectCurrentPage?: (root: import('@playwright/test').Locator) => number | Promise<number>;\n}\n\nexport type PaginationStrategy = PaginationPrimitives;\n\nexport type DedupeStrategy = (row: SmartRow) => string | number | Promise<string | number>;\n\nexport type ContentReadyStrategy = (row: Locator, page: Page) => Promise<void>;\n\n\n\nexport type FillStrategy = (options: {\n row: SmartRow;\n columnName: string;\n value: any;\n index: number;\n page: Page;\n rootLocator: Locator;\n config: FinalTableConfig<any>;\n table: TableResult; // The parent table instance\n fillOptions?: FillOptions;\n}) => Promise<void>;\n\n/** Context passed as the second argument to {@link ColumnOverride.read}. */\nexport interface ColumnOverrideReadContext {\n /**\n * The parent row. Use for multi-cell or row-derived values \u2014 e.g. a synthetic column\n * that reads an `a[href]` or a `data-*` attribute from the row rather than a cell:\n * `read: (_cell, { row }) => row.evaluate(el => el.querySelector('a')?.href)`.\n */\n row: SmartRow;\n /** The column being read. */\n columnName: string;\n /** The column's 0-based index in the resolved header map. */\n columnIndex: number;\n /**\n * Get a Locator for another cell in the same row by column name.\n * Returns raw cell Locators, not override-processed values.\n *\n * In atomic mode, the Locator points at the frozen reconstructed cell \u2014 coherent with\n * every other cell from the same snapshot. In non-atomic mode, it points at the live cell.\n *\n * @example\n * read: async (_cell, { getCell }) => {\n * const name = (await getCell('Name').innerText()).trim();\n * const href = await getCell('Name').locator('a').getAttribute('href') || '';\n * return `${name} | ${href}`;\n * }\n */\n getCell: (columnName: string) => Locator;\n}\n\nexport interface SyntheticColumnDef<T = any> {\n compute: (row: SmartRow<T>) => Promise<string | number> | string | number;\n}\n\nexport interface ColumnOverride<TValue = any> {\n /**\n * How to extract the value from the cell.\n * The second `context` argument provides the parent `row` (for multi-cell or row-derived\n * values), plus `columnName` and `columnIndex`. Backwards-compatible: existing\n * single-argument `read(cell)` implementations keep working.\n */\n read?: (cell: Locator, context: ColumnOverrideReadContext) => Promise<TValue> | TValue;\n\n /** \n * How to fill the cell with a new value. (Replaces smartFill default logic)\n * Provides the current value (via `read`) if a `write` wants to check state first.\n */\n write?: (params: {\n cell: Locator;\n targetValue: TValue;\n currentValue?: TValue;\n row: SmartRow<any>;\n }) => Promise<void>;\n}\n\nexport type { HeaderStrategy } from './strategies/headers';\nexport type { NavigationPrimitives, CellNavigationStrategy } from './strategies/columns';\n\n/**\n * Strategy to resolve column names (string or regex) to their index.\n */\n// fallow-ignore-next-line unused-type\nexport type { ColumnResolutionStrategy } from './strategies/resolution';\n\n/**\n * Strategy to filter rows based on criteria. Applied when using getRow/findRow/findRows with filters.\n * The default engine handles string, RegExp, number, and function (cell) => Locator filters.\n */\nexport interface FilterStrategy {\n apply(options: {\n rows: Locator;\n filter: { column: string, value: FilterValue };\n colIndex: number;\n tableContext: TableContext;\n }): Locator;\n}\n\n/**\n * Strategy to check if the table or rows are loading. Used after pagination/sort to wait for content.\n * E.g. isHeaderLoading for init stability; isTableLoading after sort/pagination.\n */\nexport interface LoadingStrategy {\n isTableLoading?: (context: TableContext) => Promise<boolean>;\n isRowLoading?: (row: SmartRow) => Promise<boolean>;\n isHeaderLoading?: (context: TableContext) => Promise<boolean>;\n\n /**\n * How long (ms) to wait for a loading row to resolve before applying onRowLoadingTimeout.\n * Honored by findRows AND by map/forEach/filter, where the wait runs before the dedupe\n * strategy so content-based dedupe keys see the row's final loaded state.\n * When not set (backward-compatible behavior): findRows skips loading rows immediately;\n * map/forEach/filter process them as-is.\n */\n rowLoadingTimeout?: number;\n\n /**\n * What to do when a row is still loading after rowLoadingTimeout ms.\n * - 'skip': drop the row from results (matches legacy skip behavior)\n * - 'read-as-is': include the row even though it's still loading (default)\n * - 'throw': throw an error with row index and timeout info\n * Defaults to 'read-as-is' when rowLoadingTimeout is set.\n */\n onRowLoadingTimeout?: 'skip' | 'read-as-is' | 'throw';\n\n /**\n * Predicate called before reading each cell. Return true if the cell is still loading.\n * When cellLoadingTimeout is also set, the engine waits up to that many ms for the\n * cell to resolve before applying onCellLoadingTimeout.\n */\n isCellLoading?: (cell: import('@playwright/test').Locator, columnName: string, row: SmartRow) => Promise<boolean>;\n\n /**\n * How long (ms) to wait for a loading cell to resolve before applying onCellLoadingTimeout.\n * When not set and isCellLoading returns true, the cell is read as-is immediately.\n */\n cellLoadingTimeout?: number;\n\n /**\n * What to do when a cell is still loading after cellLoadingTimeout ms.\n * - 'skip': use empty string for this cell value\n * - 'read-as-is': read the cell content even though it's still loading (default)\n * - 'throw': throw an error with column name, row index and timeout info\n * - callback: called with (cell, columnName, row); its return value becomes the cell's string value\n * Defaults to 'read-as-is' when cellLoadingTimeout is set.\n */\n onCellLoadingTimeout?:\n | 'skip'\n | 'read-as-is'\n | 'throw'\n | ((cell: import('@playwright/test').Locator, columnName: string, row: SmartRow) => Promise<string>);\n\n /** Max ms to wait for sort stabilization when isTableLoading is set. @default 10000 */\n sortStabilizationTimeout?: number;\n /** Polling interval (ms) while waiting for sort stabilization. @default 100 */\n sortStabilizationPollInterval?: number;\n /** Fallback delay (ms) after sort when no isTableLoading is configured. @default 200 */\n sortStabilizationFallbackDelay?: number;\n}\n\n/**\n * Organized container for all table interaction strategies.\n */\nexport interface TableStrategies {\n /** Strategy for discovering/scanning headers */\n header?: HeaderStrategy;\n /** Primitive navigation functions (goUp, goDown, goLeft, goRight, goHome) */\n navigation?: NavigationPrimitives;\n\n /** Strategy for filling form inputs */\n fill?: FillStrategy;\n /** Strategy for paginating through data */\n pagination?: PaginationStrategy;\n /** Strategy for sorting columns */\n sorting?: SortingStrategy;\n /** Strategy for deduplicating rows during iteration/scrolling */\n dedupe?: DedupeStrategy;\n /** Function to get a cell locator */\n getCellLocator?: GetCellLocatorFn;\n /** Function to get the currently active/focused cell */\n getActiveCell?: GetActiveCellFn;\n /**\n * Strategy for filtering rows. If present, FilterEngine will delegate filter application\n * to this pluggable strategy.\n */\n filter?: FilterStrategy;\n /**\n * Hook called before each cell value is read in toJSON and columnOverrides.read.\n * Fires for both the default innerText extraction and custom read mappers.\n * Useful for scrolling off-screen columns into view in horizontally virtualized tables.\n */\n beforeCellRead?: BeforeCellReadFn;\n /**\n * Strategy for detecting loading states. Use this for table-, row-, and header-level readiness.\n * E.g. after sort/pagination, the engine uses loading.isTableLoading when present.\n */\n loading?: LoadingStrategy;\n\n /**\n * Resolve the stable data-model index for a row locator.\n *\n * Called by `findRow` / `findRows` to convert a DOM row into the index used for\n * virtual-scroll positioning. Useful for grids where DOM position resets to 0 on\n * each page while the grid itself maintains a monotone counter (e.g. MUI DataGrid's\n * `data-rowindex` attribute).\n *\n * Return `undefined` to fall back to DOM position.\n *\n * When the index maps to a DOM attribute, return `{ index, selector }` instead of\n * a plain number. The library uses the CSS selector to build a **self-healing row\n * locator** that re-queries the DOM on every action \u2014 surviving virtual-scroll\n * recycling for `getCell`, `smartFill`, and `toJSON` without manual re-pinning.\n *\n * @example\n * // MUI DataGrid: self-healing via data-rowindex attribute\n * resolveRowIndex: async (row) => {\n * const v = await row.getAttribute('data-rowindex').catch(() => null);\n * if (v === null || isNaN(Number(v))) return undefined;\n * return { index: Number(v), selector: `[data-rowindex=\"${v}\"]` };\n * }\n */\n resolveRowIndex?: (row: Locator) => Promise<RowIndexResult | undefined>;\n\n /**\n * Waits until a row's content has stabilized before cloning in\n * `toJSON({ atomic: true })`. Needed for recycling virtualizers where the\n * framework updates element positions synchronously but renders cell content\n * asynchronously (e.g. react-window, react-virtuoso with React concurrent mode).\n *\n * Without this, the clone captures stale content from the previous occupant of the\n * DOM slot \u2014 the element is at the correct position but React hasn't re-rendered yet.\n *\n * Use `Strategies.ContentReady.textStable()` for the built-in text-polling strategy.\n *\n * @example\n * strategies: {\n * contentReady: Strategies.ContentReady.textStable({ timeout: 500 }),\n * }\n */\n contentReady?: ContentReadyStrategy;\n\n /**\n * Viewport oracle strategies for 2D virtualized tables (e.g. MUI DataGrid, AG Grid,\n * Braintrust-style grids where both rows and columns are virtualized simultaneously).\n *\n * When present, the cell-reading engine uses these to jump directly to the target\n * row/column and to detect the 2D scroll hazard (scrolling to reveal a column can\n * knock rows out of the vertical viewport, and vice versa).\n *\n * Completely optional and additive \u2014 existing `navigation` primitives remain the fallback.\n */\n viewport?: ViewportStrategy;\n}\n\n\nexport interface TableConfig<T = any> {\n /** Selector for the table headers */\n headerSelector?: string | ((root: Locator) => Locator);\n /** Selector for the table rows */\n rowSelector?: string;\n /** Selector for the cells within a row */\n cellSelector?: string | ((row: Locator) => Locator);\n /** Number of pages to scan for verification */\n maxPages?: number;\n /**\n * Default concurrency strategy for iteration methods.\n * Can be overridden by the options passed to forEach, map, or filter.\n */\n concurrency?: RowIterationMode;\n /** Hook to rename columns dynamically */\n headerTransformer?: (args: { text: string, index: number, locator: Locator, seenHeaders: Set<string> }) => string | Promise<string>;\n /** Automatically scroll to table on init */\n autoScroll?: boolean;\n /** Debug options for development and troubleshooting */\n debug?: DebugConfig;\n /** Hook called after reset completes (after goToFirst, cache clear, and autoInit). */\n onReset?: (context: TableContext) => Promise<void>;\n /** All interaction strategies */\n strategies?: TableStrategies;\n\n /**\n * Unified interface for reading and writing data to specific columns.\n * Overrides both default extraction (toJSON) and filling (smartFill) logic.\n */\n columnOverrides?: Partial<Record<keyof T, ColumnOverride<T[keyof T]>>>;\n\n /**\n * Computed columns with no DOM presence. Each key becomes a virtual column name\n * available in `toJSON()`, `getValue()`, and `findRow()`/`findRows()` filters.\n * The `compute` function receives the full SmartRow and must only read real or\n * override columns (no chaining between synthetics).\n */\n syntheticColumns?: Record<string, SyntheticColumnDef<T>>;\n\n /**\n * Locator for an empty-state element that replaces the table when there are no results.\n * If header resolution fails during init() and this locator is visible, init() succeeds\n * and isEmpty() returns true. All row operations still throw normally.\n */\n emptyState?: Locator;\n}\n\n/**\n * @internal Resolved config after defaults are applied. Prefer {@link TableConfig} in public code.\n */\nexport interface FinalTableConfig<T = any> extends TableConfig<T> {\n headerSelector: string | ((root: Locator) => Locator);\n rowSelector: string;\n cellSelector: string | ((row: Locator) => Locator);\n maxPages: number;\n autoScroll: boolean;\n concurrency?: RowIterationMode;\n debug?: TableConfig['debug'];\n headerTransformer: (args: { text: string, index: number, locator: Locator, seenHeaders: Set<string> }) => string | Promise<string>;\n onReset: (context: TableContext) => Promise<void>;\n strategies: TableStrategies;\n}\n\n\nexport interface FillOptions {\n /**\n * Custom input mappers for specific columns.\n * Maps column names to functions that return the input locator for that cell.\n */\n inputMappers?: Record<string, (cell: Locator) => Locator>;\n}\n\n\n\n/** Callback context passed to forEach, map, and filter. */\nexport type RowIterationContext<T = any> = {\n row: SmartRow<T>;\n /**\n * The row's logical/data-model index. When a `resolveRowIndex` strategy is configured\n * (e.g. MUI DataGrid's `data-rowindex`) this is the grid's true row index; otherwise it\n * equals `index`. Use this for `row.bringIntoView()` and position math on virtualized\n * tables \u2014 it is stable across scrolling/dedupe, unlike the visit-order `index`.\n */\n rowIndex: number;\n /**\n * 0-based enumeration counter \u2014 the order this row was visited (contiguous within the run).\n * Not a DOM position or grid identity. Use `rowIndex` for the row's data-model index.\n */\n index: number;\n /** 0-based page index \u2014 which page this row was collected from. */\n pageIndex: number;\n stop: () => void;\n};\n\n/** Concurrency modes for row iteration. */\nexport type RowIterationMode = 'parallel' | 'sequential' | 'synchronized';\n\n/** Shared options for forEach, map, and filter. */\nexport type RowIterationOptions = {\n /** Maximum number of pages to iterate. Defaults to config.maxPages. */\n maxPages?: number;\n /**\n * Concurrency strategy for iteration.\n * - 'parallel': Full parallel execution of both navigation and actions.\n * - 'synchronized': Parallel navigation (lock-step) with serial actions.\n * - 'sequential': Strictly serial one-at-a-time execution. No parallel navigation.\n * @default 'parallel' (for map), 'sequential' (for forEach/filter)\n */\n concurrency?: RowIterationMode;\n /**\n * Deduplication strategy. Use when rows may repeat across iterations\n * (e.g. infinite scroll tables). Returns a unique key per row.\n */\n dedupe?: DedupeStrategy;\n /**\n * When true, use goNextBulk (if present) to advance pages during iteration.\n * @default false \u2014 uses goNext for one-page-at-a-time advancement\n */\n useBulkPagination?: boolean;\n};\n\n/**\n * Result of {@link useTable}. Implements `AsyncIterable` \u2014 `for await (const { row } of table)`\n * uses the same page-walk as `map` / `forEach` (`scanPages` + runMap): overscan, loading,\n * dedupe, and EOF final scan (#427).\n */\nexport interface TableResult<T = any> extends AsyncIterable<{ row: SmartRow<T>; rowIndex: number; index: number; pageIndex: number }> {\n /**\n * Represents the current page index of the table's DOM.\n * Starts at 0. Automatically maintained by the library during pagination and bringIntoView.\n */\n currentPageIndex: number;\n\n /**\n * Initializes the table by resolving headers. Must be called before using sync methods.\n * @param options Optional timeout for header resolution (default: 3000ms)\n */\n init(options?: { timeout?: number }): Promise<TableResult<T>>;\n\n /**\n * SYNC: Checks if the table has been initialized.\n * @returns true if init() has been called and completed, false otherwise\n */\n isInitialized(): boolean;\n\n /**\n * SYNC: Returns true if init() resolved via the emptyState path \u2014 the table's\n * empty-state locator was visible when header resolution failed.\n * Row operations still throw normally; use this to branch before calling them.\n */\n isEmpty(): boolean;\n\n getHeaders: () => Promise<string[]>;\n getHeaderCell: (columnName: string) => Promise<Locator>;\n\n /**\n * Finds a row by filters on the current page only. Returns immediately (sync).\n * Throws error if table is not initialized.\n * @note The sync path cannot compute a real `rowIndex`, so the returned SmartRow's\n * `rowIndex` is `undefined` (virtual-scroll positioning via `bringIntoView()` is limited).\n * Use `findRow()` (async) when you need a row with an accurate `rowIndex`.\n * @note Cannot filter by `syntheticColumns` or `columnOverrides.read` keys \u2014 those need\n * async evaluation via `findRow()` / `findRows()`. DOM filters use `strategies.getCellLocator`\n * when configured (column-virtualized grids), otherwise `cellSelector` + column index.\n */\n getRow: (\n filters: Record<string, FilterValue>,\n options?: { exact?: boolean }\n ) => SmartRow<T>;\n\n /**\n * Gets a row by its 0-based position in the currently-rendered DOM (sync, no scroll).\n * Throws if the table is not initialized.\n *\n * For button-paginated tables this is the i-th row on the current page. For virtualized\n * tables the render window shifts as you scroll, so `getRowByIndex(i)` returns whatever\n * row currently sits at DOM position `i` \u2014 NOT the logical/absolute row `i` in the dataset\n * once the list has scrolled. For the row with a specific logical/data-model index on a\n * virtualized table, use the async `findRowByIndex(i)` instead (it scrolls to the row);\n * to iterate by logical identity, use `map` / `findRows` (with a `dedupe` strategy).\n *\n * Resolution is lazy: an out-of-range index yields a SmartRow whose operations fail when\n * it is used, rather than throwing here.\n *\n * @param index 0-based position within the current render window\n */\n getRowByIndex: (\n index: number\n ) => SmartRow<T>;\n\n /**\n * ASYNC: Returns the row with a specific logical/data-model index, scrolling/paginating to\n * reach it. Unlike the sync `getRowByIndex` (render-window position), this resolves the true\n * data-model row `index` on virtualized tables.\n *\n * Reaches the row via, in order: a currently-mounted match, the viewport's random-access\n * `scrollToRow` fast path, then advancing pages (on infinite-scroll tables a \"page\" is a\n * scroll step) up to `maxPages`.\n *\n * Requires a `strategies.resolveRowIndex` to identify rows by logical index \u2014 throws if one\n * is not configured. Also throws if the row cannot be reached (no silent wrong-row fallback).\n *\n * @param index 0-based logical/data-model row index\n * @param options - `maxPages` bounds how far to scroll/paginate (defaults to config.maxPages)\n */\n findRowByIndex: (\n index: number,\n options?: { maxPages?: number }\n ) => Promise<SmartRow<T>>;\n\n /**\n * ASYNC: Searches for a single row across pages using pagination.\n * Auto-initializes the table if not already initialized.\n * @param filters - The filter criteria to match\n * @param options - Search options including exact match and max pages\n */\n findRow: (\n filters: Record<string, FilterValue>,\n options?: { exact?: boolean, maxPages?: number }\n ) => Promise<SmartRow<T>>;\n\n /**\n * ASYNC: Searches for all matching rows across pages using pagination.\n * Auto-initializes the table if not already initialized.\n * @param filters - The filter criteria to match (omit or pass {} for all rows)\n * @param options - Search options (exact, maxPages). `useBulkPagination` defaults to `false`: pages advance one at a time via `goNext` so no intermediate page is skipped. Set it to `true` to opt into `goNextBulk` (faster, but skips the rows on jumped-over pages).\n */\n findRows: (\n filters?: Record<string, FilterValue>,\n options?: { exact?: boolean, maxPages?: number, useBulkPagination?: boolean }\n ) => Promise<SmartRowArray<T>>;\n\n /**\n * Resolves the named column and scrolls it into view.\n * Prefers `strategies.viewport.scrollToColumn` when configured; otherwise scrolls the\n * header cell via Playwright `scrollIntoViewIfNeeded()`.\n */\n scrollToColumn: (columnName: string) => Promise<void>;\n\n /**\n * Counts the number of rows, optionally filtered.\n * Without arguments, counts all rows. With filters, counts only matching rows.\n * Paginates when pagination is configured.\n */\n countRows: (filters?: Record<string, FilterValue>, options?: { exact?: boolean; maxPages?: number }) => Promise<number>;\n\n /**\n * Iterates over rows and extracts the value of a single column.\n * More efficient than map + toJSON for single-column extraction.\n * @param columnName - The name of the column to extract\n * @param options - Iteration options\n */\n mapColumn<R = string>(columnName: string, options?: RowIterationOptions): Promise<R[]>;\n\n /**\n * @deprecated Use `mapColumn` (or `map`) instead. Will be removed in v7.0.0.\n * Iterates over rows and extracts the value of a single column as strings.\n * @param columnName - The name of the column to extract\n * @param options - Iteration options\n */\n getColumnValues(columnName: string, options?: RowIterationOptions): Promise<string[]>;\n\n\n /**\n * Resets the table: calls goToFirst (if configured), clears cache, re-inits headers, then calls onReset.\n */\n reset: () => Promise<void>;\n\n /**\n * Revalidates the table's structure (headers, columns) without resetting pagination or state.\n * Useful when columns change visibility or order dynamically.\n */\n revalidate: () => Promise<void>;\n\n /**\n * Iterates every row across all pages, calling the callback for side effects.\n * Execution is sequential by default (safe for interactions like clicking/filling).\n * Call `stop()` in the callback to end iteration early.\n *\n * @param callback - Function receiving { row, rowIndex, stop }\n * @param options - maxPages, concurrency, dedupe, useBulkPagination\n *\n * @example\n * await table.forEach(async ({ row, stop }) => {\n * if (await row.getCell('Status').innerText() === 'Done') stop();\n * await row.getCell('Checkbox').click();\n * });\n */\n forEach(\n callback: (ctx: RowIterationContext<T>) => void | Promise<void>,\n options?: RowIterationOptions\n ): Promise<void>;\n\n /**\n * Transforms every row across all pages into a value. Returns a flat array.\n * Execution is parallel within each page by default (safe for reads).\n * Call `stop()` to halt after the current page finishes.\n *\n * > **\u26A0\uFE0F UI Interactions:** `map` defaults to `concurrency: 'parallel'`. If your callback opens popovers,\n * > fills inputs, or otherwise mutates UI state, pass `concurrency: 'sequential'` (or `'synchronized'`\n * > when navigation must stay lock-step) to avoid overlapping interactions.\n *\n * @param callback - Function receiving { row, rowIndex, stop }\n * @param options - maxPages, concurrency, dedupe, useBulkPagination\n *\n * @example\n * // Data extraction \u2014 parallel is safe\n * const emails = await table.map(({ row }) => row.getCell('Email').innerText());\n *\n * @example\n * // UI interactions \u2014 use sequential (or synchronized) concurrency\n * const assignees = await table.map(async ({ row }) => {\n * await row.getCell('Assignee').locator('button').click();\n * const name = await page.locator('.popover .name').innerText();\n * await page.keyboard.press('Escape');\n * return name;\n * }, { concurrency: 'sequential' });\n */\n map<R>(\n callback: (ctx: RowIterationContext<T>) => R | Promise<R>,\n options?: RowIterationOptions\n ): Promise<R[]>;\n\n /**\n * Shorthand for `map()` + `reset()`. Iterates every row across all pages, applies the\n * callback (defaults to `row.toJSON()`), then resets the table back to page 1 \u2014 even if\n * the callback throws.\n *\n * @param callback - Optional map function. Defaults to `({ row }) => row.toJSON()`.\n * @param options - Same options as `map()`.\n *\n * @example\n * // Zero-arg: returns toJSON() for every row\n * const rows = await table.toArray();\n *\n * @example\n * // Custom callback\n * const names = await table.toArray(({ row }) => row.getCell('Name').innerText());\n *\n * @example\n * // With options\n * const rows = await table.toArray(({ row }) => row.toJSON(), { concurrency: 'parallel' });\n */\n toArray<R = Record<string, unknown>>(\n callback?: (ctx: RowIterationContext<T>) => R | Promise<R>,\n options?: RowIterationOptions\n ): Promise<R[]>;\n\n /**\n * Filters rows across all pages by an async predicate. Returns a SmartRowArray.\n * Rows are returned as-is \u2014 call `bringIntoView()` on each if needed.\n * Execution is sequential by default.\n *\n * @param predicate - Function receiving { row, rowIndex, stop }\n * @param options - maxPages, concurrency, dedupe, useBulkPagination\n *\n * @example\n * const active = await table.filter(async ({ row }) =>\n * await row.getCell('Status').innerText() === 'Active'\n * );\n */\n filter(\n predicate: (ctx: RowIterationContext<T>) => boolean | Promise<boolean>,\n options?: RowIterationOptions\n ): Promise<SmartRowArray<T>>;\n\n /**\n * Provides access to sorting actions and assertions.\n */\n sorting: {\n /**\n * Applies the configured sorting strategy to the specified column.\n * @param columnName The name of the column to sort.\n * @param direction The direction to sort ('asc' or 'desc').\n */\n apply(columnName: string, direction: 'asc' | 'desc'): Promise<void>;\n /**\n * Gets the current sort state of a column using the configured sorting strategy.\n * @param columnName The name of the column to check.\n * @returns A promise that resolves to 'asc', 'desc', or 'none'.\n */\n getState(columnName: string): Promise<'asc' | 'desc' | 'none'>;\n };\n\n /**\n * Generate an AI-friendly configuration prompt for debugging.\n * Outputs table HTML and TypeScript definitions to help AI assistants generate config.\n * Automatically throws an Error containing the prompt.\n */\n generateConfig: () => Promise<void>;\n\n /**\n * @deprecated Use `generateConfig()` instead. Will be removed in v7.0.0.\n */\n generateConfigPrompt: () => Promise<void>;\n}\n";
|
|
6
|
+
export declare const TYPE_CONTEXT = "\n/**\n * Flexible selector type - can be a CSS string, function returning a Locator, or Locator itself.\n * @example\n * // String selector\n * rowSelector: 'tbody tr'\n * \n * // Function selector\n * headerSelector: (root) => root.locator('[role=\"columnheader\"]')\n */\nexport type Selector = string | ((root: Locator | Page) => Locator) | ((root: Locator) => Locator);\n\n/**\n * Return type for `resolveRowIndex`. A plain number gives the logical index only;\n * `{ index, selector }` additionally provides a CSS selector the library uses to\n * build a self-healing row locator that survives virtual-scroll DOM recycling.\n */\nexport type RowIndexResult = number | { index: number; selector: string };\n\n/**\n * Value used to filter rows.\n * - string/number/RegExp: filter by text content of the cell.\n * - function: filter by custom locator logic within the cell.\n * @example\n * // Text filter\n * { Name: 'John' }\n * \n * // Custom locator filter (e.g. checkbox is checked)\n * { Status: (cell) => cell.locator('input:checked') }\n */\nexport type FilterValue = string | RegExp | number | ((cell: Locator) => Locator);\n\n/**\n * Function to get a cell locator given row, column info.\n * Replaces the old cellResolver.\n */\nexport type GetCellLocatorFn = (args: {\n row: Locator;\n /** The root locator passed to useTable(). Useful for re-querying stale row locators. */\n root: Locator;\n columnName: string;\n columnIndex: number;\n rowIndex?: number;\n page: Page;\n config: FinalTableConfig<any>;\n}) => Locator;\n\n/**\n * Hook called before each cell value is read in `toJSON` (and `columnOverrides.read`).\n *\n * Use this to scroll off-screen columns into view in **horizontally** virtualized tables,\n * wait for lazy-rendered content (popovers, tooltips, async cell renderers), or perform\n * any other pre-read setup that doesn't involve Y-axis scrolling.\n *\n * ---\n *\n * **\u26A0\uFE0F Y-scroll footgun \u2014 do NOT call `scrollIntoViewIfNeeded()` on row-virtualized grids.**\n *\n * `scrollIntoViewIfNeeded` adjusts *both* scroll axes. On grids that recycle DOM nodes\n * based on the Y position (MUI DataGrid, AG Grid, react-window, etc.) calling it will\n * shift the viewport vertically, unmounting the row you are currently reading and\n * silently returning stale or empty cell values for the remainder of the row.\n *\n * Safe uses:\n * - Column-only (X-axis) virtualization where rows are always in the DOM.\n * - Calling `scrollIntoViewIfNeeded` on the **header cell** only, when that header is\n * guaranteed not to trigger a Y-scroll (e.g. sticky header grids).\n *\n * For grids with **both** row and column virtualization, use the `viewport` strategy\n * instead \u2014 it drives explicit `scrollToRow` / `scrollToColumn` calls and is aware of\n * the virtualization lifecycle.\n *\n * @example\n * // Safe: column-only horizontal virtualization (rows always in DOM)\n * strategies: {\n * beforeCellRead: async ({ columnName, getHeaderCell }) => {\n * const header = await getHeaderCell(columnName);\n * await header.scrollIntoViewIfNeeded(); // only scrolls X \u2014 rows stay mounted\n * }\n * }\n *\n * @example\n * // Safe: wait for a lazy-rendered popover/tooltip before reading its text\n * strategies: {\n * beforeCellRead: async ({ cell }) => {\n * await cell.hover();\n * await cell.page().waitForSelector('.cell-tooltip', { state: 'visible' });\n * }\n * }\n */\nexport type BeforeCellReadFn = (args: {\n /** The resolved cell locator */\n cell: Locator;\n columnName: string;\n columnIndex: number;\n row: Locator;\n page: Page;\n root: Locator;\n /** Resolves a column name to its header cell locator */\n getHeaderCell: (columnName: string) => Promise<Locator>;\n}) => Promise<void>;\n\n/**\n * Function to get the currently active/focused cell.\n * Returns null if no cell is active.\n */\nexport type GetActiveCellFn = (args: TableContext) => Promise<{\n rowIndex: number;\n columnIndex: number;\n columnName?: string;\n locator: Locator;\n} | null>;\n\n/**\n * Viewport oracle strategies for virtualized tables.\n *\n * These tell the library *what is currently in the DOM* rather than *how to move*.\n * When present, the cell-reading engine uses them to jump directly to a target\n * row/column instead of stepping blindly with navigation primitives.\n *\n * This is the primary fix for the 2D scroll hazard: scrolling right to bring a\n * column into view can knock rows out of the vertical viewport (and vice versa).\n * With `getVisibleRowRange` the engine detects this and calls `scrollToRow` to\n * restore the row before reading \u2014 eliminating the hazard without polling loops.\n *\n * All members are optional. Supply whichever the underlying grid exposes:\n * - Range oracles alone enable hazard detection with graceful fallback to navigation primitives.\n * - Scroll primitives alone enable direct jumps without range awareness.\n * - Both together give the most reliable, fastest path.\n *\n * @example\n * // MUI DataGrid via apiRef\n * strategies: {\n * viewport: {\n * getVisibleRowRange: async ({ root }) =>\n * root.evaluate(el => {\n * const api = (el as any).__muiDataGrid__;\n * return { first: api.getFirstVisibleRow(), last: api.getLastVisibleRow() };\n * }),\n * scrollToRow: async ({ root }, rowIndex) =>\n * root.evaluate((el, idx) =>\n * (el as any).__muiDataGrid__.scrollToIndexes({ rowIndex: idx }), rowIndex),\n * scrollToColumn: async ({ root }, colIndex) =>\n * root.evaluate((el, idx) =>\n * (el as any).__muiDataGrid__.scrollToIndexes({ colIndex: idx }), colIndex),\n * }\n * }\n *\n * @example\n * // aria-rowindex / aria-colindex DOM fallback (works without internal API access)\n * strategies: {\n * viewport: {\n * getVisibleRowRange: async ({ root }) =>\n * root.evaluate(el => {\n * const rows = [...el.querySelectorAll('[role=\"row\"][aria-rowindex]')];\n * const idxs = rows.map(r => Number(r.getAttribute('aria-rowindex')) - 1);\n * return { first: Math.min(...idxs), last: Math.max(...idxs) };\n * }),\n * }\n * }\n */\nexport interface ViewportStrategy {\n /**\n * Returns the 0-based index range of rows currently rendered in the DOM.\n * Used to detect when a target row has been scrolled out of view and needs recovery.\n */\n getVisibleRowRange?: (context: TableContext) => Promise<{ first: number; last: number }>;\n\n /**\n * Returns the DOM positions (0-based, document order \u2014 indices into the resolved\n * `rowSelector` set) of rows currently within the scroll container's visible bounds.\n * Unlike `getVisibleRowRange` (a logical min/max), this identifies the exact rows, so\n * `map`/`forEach`/`filter` can skip overscan rows during collection (see #353 / #357).\n * Geometry-based and inclusive (any overlap counts as visible). When the container can't\n * be measured, return all positions so no rows are filtered.\n */\n getVisibleRowIndices?: (context: TableContext) => Promise<number[]>;\n\n /**\n * Returns the 0-based index range of columns currently rendered in the DOM.\n * Used to detect when a target column is not yet mounted before reading.\n */\n getVisibleColumnRange?: (context: TableContext) => Promise<{ first: number; last: number }>;\n\n /**\n * Scrolls or jumps directly to make a row visible by 0-based index.\n * Replaces blind goDown()/goUp() step loops for grids that expose a scroll API.\n */\n scrollToRow?: (context: TableContext, rowIndex: number) => Promise<void>;\n\n /**\n * Scrolls or jumps directly to make a column visible by 0-based index.\n * Replaces blind goRight()/goLeft() step loops for grids that expose a scroll API.\n */\n scrollToColumn?: (context: TableContext, colIndex: number) => Promise<void>;\n\n /**\n * When true, disables the automatic memoization of getVisibleColumnRange and\n * getVisibleRowRange results. By default the library caches each range value and\n * invalidates it after the corresponding scroll call, eliminating redundant DOM\n * evaluate() round-trips between scrolls.\n */\n disableCache?: boolean;\n}\n\n\n/**\n * SmartCell - A Playwright Locator with table-aware methods for single-cell operations.\n * \n * Extends all standard Locator methods (click, isVisible, etc.).\n */\nexport type SmartCell = Locator & {\n /**\n * Scrolls/paginates to bring this specific cell into view using the configured strategies.\n * Useful when the grid is horizontally virtualized and the column must be scrolled\n * into view before it can be interacted with or read.\n */\n bringIntoView(): Promise<void>;\n};\n\n\n/**\n * SmartRow - A Playwright Locator with table-aware methods.\n * \n * Extends all standard Locator methods (click, isVisible, etc.) with table-specific functionality.\n * \n * @example\n * const row = table.getRow({ Name: 'John Doe' });\n * await row.click(); // Standard Locator method\n * const email = row.getCell('Email'); // Table-aware method\n * const data = await row.toJSON(); // Extract all row data\n * await row.smartFill({ Name: 'Jane', Status: 'Active' }); // Fill form fields\n */\nexport type SmartRow<T = any> = Locator & {\n /** Optional row index (0-based) if known */\n rowIndex?: number;\n\n /** Optional page index this row was found on (0-based) */\n tablePageIndex?: number;\n\n /** Reference to the parent TableResult */\n table: TableResult<T>;\n\n /**\n * Get a cell locator by column name.\n * @param column - Column name (case-sensitive)\n * @returns SmartCell (Locator + bringIntoView)\n * @example\n * const emailCell = row.getCell('Email');\n * await emailCell.bringIntoView();\n * await expect(emailCell).toHaveText('john@example.com');\n */\n getCell(column: string): SmartCell;\n\n /**\n * Extract all cell data as a key-value object.\n * @param options - Optional configuration\n * @param options.columns - Specific columns to extract (extracts all if not specified)\n * @returns Promise resolving to row data\n * @example\n * const data = await row.toJSON();\n * // { Name: 'John', Email: 'john@example.com', ... }\n * \n * const partial = await row.toJSON({ columns: ['Name', 'Email'] });\n * // { Name: 'John', Email: 'john@example.com' }\n *\n * // Atomic: snapshot all cell values in a single evaluate \u2014 zero inter-column stagger.\n * // Requires cellSelector to be a CSS string (not a function).\n * // Column overrides ARE supported (run against a frozen off-screen reconstruction).\n * // Uses textContent (not layout-dependent innerText) for non-override columns.\n * const coherent = await row.toJSON({ atomic: true });\n */\n toJSON(options?: { columns?: string[]; atomic?: boolean }): Promise<T>;\n\n /**\n * Scrolls/paginates to bring this row into view.\n * Works when row position metadata is known (e.g., from getRowByIndex, findRow,\n * findRows, filter, or async iteration).\n *\n * Prefers `strategies.viewport.scrollToRow` when configured; otherwise falls back to\n * Playwright `scrollIntoViewIfNeeded()`.\n * @throws Error if row position metadata is unknown\n */\n bringIntoView(): Promise<void>;\n\n /**\n * Intelligently fills form fields in the row.\n * Automatically detects input types (text, select, checkbox, contenteditable).\n * \n * @param data - Column-value pairs to fill\n * @param options - Optional configuration\n * @param options.inputMappers - Custom input selectors per column\n * @example\n * // Auto-detection\n * await row.smartFill({ Name: 'John', Status: 'Active', Subscribe: true });\n * \n * // Custom input mappers\n * await row.smartFill(\n * { Name: 'John' },\n * { inputMappers: { Name: (cell) => cell.locator('.custom-input') } }\n * );\n */\n smartFill: (data: Partial<T> | Record<string, any>, options?: FillOptions) => Promise<void>;\n\n /**\n * Get the resolved value of any column \u2014 real, override, or synthetic.\n *\n * When `strategies.viewport` or `strategies.navigation` is configured, runs the same\n * cell-navigation pipeline as `toJSON` / `getCell().bringIntoView()` so off-screen\n * virtualized cells are mounted before reading. Without those strategies, reads the\n * current DOM cell (Playwright auto-wait).\n *\n * @param column - Column name (case-sensitive)\n * @returns The column value as a string\n */\n getValue(column: string): Promise<string>;\n\n /**\n * Returns whether the row exists in the DOM (i.e. is not a sentinel row).\n */\n wasFound(): boolean;\n};\n\nexport type StrategyContext = TableContext & {\n rowLocator?: Locator;\n rowIndex?: number;\n};\n\n/**\n * Defines the contract for a sorting strategy.\n */\nexport interface SortingStrategy {\n /**\n * Performs the sort action on a column.\n */\n doSort(options: {\n columnName: string;\n direction: 'asc' | 'desc';\n context: StrategyContext;\n }): Promise<void>;\n\n /**\n * Retrieves the current sort state of a column.\n */\n getSortState(options: {\n columnName: string;\n context: StrategyContext;\n }): Promise<'asc' | 'desc' | 'none'>;\n}\n\n/**\n * Debug configuration for development and troubleshooting\n */\nexport type DebugConfig = {\n /**\n * Slow down operations for debugging\n * - number: Apply same delay to all operations (ms)\n * - object: Granular delays per operation type\n */\n slow?: number | {\n pagination?: number;\n getCell?: number;\n findRow?: number;\n default?: number;\n };\n /**\n * Log level for debug output\n * - 'verbose': All logs (verbose, info, error)\n * - 'info': Info and error logs only\n * - 'error': Error logs only\n * - 'none': No logs\n */\n logLevel?: 'verbose' | 'info' | 'error' | 'none';\n};\n\nexport interface TableContext<T = any> {\n root: Locator;\n config: FinalTableConfig<T>;\n page: Page;\n resolve: (selector: Selector, parent: Locator | Page) => Locator;\n /** Resolves a column name to its header cell locator. Available after table is initialized. */\n getHeaderCell?: (columnName: string) => Promise<Locator>;\n /** Returns all column names in order. Available after table is initialized. */\n getHeaders?: () => Promise<string[]>;\n /** Scrolls the table horizontally to bring the given column's header into view. */\n scrollToColumn?: (columnName: string) => Promise<void>;\n}\n\nexport interface PaginationPrimitives {\n /** Classic \"Next Page\" or \"Scroll Down\" */\n goNext?: (context: TableContext) => Promise<boolean>;\n\n /** Classic \"Previous Page\" or \"Scroll Up\" */\n goPrevious?: (context: TableContext) => Promise<boolean>;\n\n /** Bulk skip forward multiple pages at once. Returns number of pages skipped. */\n goNextBulk?: (context: TableContext) => Promise<boolean | number>;\n\n /** Bulk skip backward multiple pages at once. Returns number of pages skipped. */\n goPreviousBulk?: (context: TableContext) => Promise<boolean | number>;\n\n /** Jump to first page / scroll to top */\n goToFirst?: (context: TableContext) => Promise<boolean>;\n\n /** Jump to last page / scroll to bottom */\n goToLast?: (context: TableContext) => Promise<boolean>;\n\n /**\n * Fetch the total number of pages currently available.\n * Can be used to optimize pagination paths (e.g. jumping to last page and going backwards).\n */\n getTotalPages?: (context: TableContext) => Promise<number | null>;\n\n /**\n * Jump to specific page index (0-indexed).\n * Can be full-range (e.g. page number input: any page works) or windowed (e.g. only visible links 6\u201314).\n * Return false when the page is not reachable in the current UI; the library will step toward the target (goNextBulk/goNext or goPreviousBulk/goPrevious) and retry goToPage until it succeeds.\n */\n goToPage?: (pageIndex: number, context: TableContext) => Promise<boolean>;\n\n /** How many pages one goNextBulk() advances. Used by navigation path planner for optimal bringIntoView. */\n nextBulkPages?: number;\n\n /** How many pages one goPreviousBulk() goes back. Used by navigation path planner for optimal bringIntoView. */\n previousBulkPages?: number;\n\n /**\n * Called once during init() to sync the library's page counter with the actual DOM state.\n * Use when a table may open on a page other than the first (e.g. a deep-linked URL that\n * lands on page 5). Returns a 0-indexed page number.\n * @example\n * detectCurrentPage: async (root) => {\n * const text = await root.locator('[aria-current=\"page\"]').textContent();\n * return parseInt(text ?? '1') - 1;\n * }\n */\n detectCurrentPage?: (root: import('@playwright/test').Locator) => number | Promise<number>;\n}\n\nexport type PaginationStrategy = PaginationPrimitives;\n\nexport type DedupeStrategy = (row: SmartRow) => string | number | Promise<string | number>;\n\nexport type ContentReadyStrategy = (row: Locator, page: Page) => Promise<void>;\n\n\n\nexport type FillStrategy = (options: {\n row: SmartRow;\n columnName: string;\n value: any;\n index: number;\n page: Page;\n rootLocator: Locator;\n config: FinalTableConfig<any>;\n table: TableResult; // The parent table instance\n fillOptions?: FillOptions;\n}) => Promise<void>;\n\n/** Context passed as the second argument to {@link ColumnOverride.read}. */\nexport interface ColumnOverrideReadContext {\n /**\n * The parent row. Use for multi-cell or row-derived values \u2014 e.g. a synthetic column\n * that reads an `a[href]` or a `data-*` attribute from the row rather than a cell:\n * `read: (_cell, { row }) => row.evaluate(el => el.querySelector('a')?.href)`.\n */\n row: SmartRow;\n /** The column being read. */\n columnName: string;\n /** The column's 0-based index in the resolved header map. */\n columnIndex: number;\n /**\n * Get a Locator for another cell in the same row by column name.\n * Returns raw cell Locators, not override-processed values.\n *\n * In atomic mode, the Locator points at the frozen reconstructed cell \u2014 coherent with\n * every other cell from the same snapshot. In non-atomic mode, it points at the live cell.\n *\n * @example\n * read: async (_cell, { getCell }) => {\n * const name = (await getCell('Name').innerText()).trim();\n * const href = await getCell('Name').locator('a').getAttribute('href') || '';\n * return `${name} | ${href}`;\n * }\n */\n getCell: (columnName: string) => Locator;\n}\n\nexport interface SyntheticColumnDef<T = any> {\n compute: (row: SmartRow<T>) => Promise<string | number> | string | number;\n}\n\nexport interface ColumnOverride<TValue = any> {\n /**\n * How to extract the value from the cell.\n * The second `context` argument provides the parent `row` (for multi-cell or row-derived\n * values), plus `columnName` and `columnIndex`. Backwards-compatible: existing\n * single-argument `read(cell)` implementations keep working.\n */\n read?: (cell: Locator, context: ColumnOverrideReadContext) => Promise<TValue> | TValue;\n\n /** \n * How to fill the cell with a new value. (Replaces smartFill default logic)\n * Provides the current value (via `read`) if a `write` wants to check state first.\n */\n write?: (params: {\n cell: Locator;\n targetValue: TValue;\n currentValue?: TValue;\n row: SmartRow<any>;\n }) => Promise<void>;\n}\n\nexport type { HeaderStrategy } from './strategies/headers';\nexport type { NavigationPrimitives, CellNavigationStrategy } from './strategies/columns';\n\n/**\n * Strategy to resolve column names (string or regex) to their index.\n */\n// fallow-ignore-next-line unused-type\nexport type { ColumnResolutionStrategy } from './strategies/resolution';\n\n/**\n * Strategy to filter rows based on criteria. Applied when using getRow/findRow/findRows with filters.\n * The default engine handles string, RegExp, number, and function (cell) => Locator filters.\n */\nexport interface FilterStrategy {\n apply(options: {\n rows: Locator;\n filter: { column: string, value: FilterValue };\n colIndex: number;\n tableContext: TableContext;\n }): Locator;\n}\n\n/**\n * Strategy to check if the table or rows are loading. Used after pagination/sort to wait for content.\n * E.g. isHeaderLoading for init stability; isTableLoading after sort/pagination.\n */\nexport interface LoadingStrategy {\n isTableLoading?: (context: TableContext) => Promise<boolean>;\n isRowLoading?: (row: SmartRow) => Promise<boolean>;\n isHeaderLoading?: (context: TableContext) => Promise<boolean>;\n\n /**\n * How long (ms) to wait for a loading row to resolve before applying onRowLoadingTimeout.\n * Honored by findRows AND by map/forEach/filter, where the wait runs before the dedupe\n * strategy so content-based dedupe keys see the row's final loaded state.\n * When not set (backward-compatible behavior): findRows skips loading rows immediately;\n * map/forEach/filter process them as-is.\n */\n rowLoadingTimeout?: number;\n\n /**\n * What to do when a row is still loading after rowLoadingTimeout ms.\n * - 'skip': drop the row from results (matches legacy skip behavior)\n * - 'read-as-is': include the row even though it's still loading (default)\n * - 'throw': throw an error with row index and timeout info\n * Defaults to 'read-as-is' when rowLoadingTimeout is set.\n */\n onRowLoadingTimeout?: 'skip' | 'read-as-is' | 'throw';\n\n /**\n * Predicate called before reading each cell. Return true if the cell is still loading.\n * When cellLoadingTimeout is also set, the engine waits up to that many ms for the\n * cell to resolve before applying onCellLoadingTimeout.\n */\n isCellLoading?: (cell: import('@playwright/test').Locator, columnName: string, row: SmartRow) => Promise<boolean>;\n\n /**\n * How long (ms) to wait for a loading cell to resolve before applying onCellLoadingTimeout.\n * When not set and isCellLoading returns true, the cell is read as-is immediately.\n */\n cellLoadingTimeout?: number;\n\n /**\n * What to do when a cell is still loading after cellLoadingTimeout ms.\n * - 'skip': use empty string for this cell value\n * - 'read-as-is': read the cell content even though it's still loading (default)\n * - 'throw': throw an error with column name, row index and timeout info\n * - callback: called with (cell, columnName, row); its return value becomes the cell's string value\n * Defaults to 'read-as-is' when cellLoadingTimeout is set.\n */\n onCellLoadingTimeout?:\n | 'skip'\n | 'read-as-is'\n | 'throw'\n | ((cell: import('@playwright/test').Locator, columnName: string, row: SmartRow) => Promise<string>);\n\n /**\n * Max ms to wait while `isTableLoading` returns true (countRows, findRow(s),\n * page-ready gates, and sort when `sortStabilizationTimeout` is unset).\n * @default 10000\n */\n loadingTimeout?: number;\n\n /** Max ms to wait for sort stabilization when isTableLoading is set. Overrides `loadingTimeout` for sort only. @default 10000 */\n sortStabilizationTimeout?: number;\n /** Polling interval (ms) while waiting for sort / table-ready stabilization. @default 100 (sort) / 200 (table-ready) */\n sortStabilizationPollInterval?: number;\n /** Fallback delay (ms) after sort when no isTableLoading is configured. @default 200 */\n sortStabilizationFallbackDelay?: number;\n}\n\n/**\n * Organized container for all table interaction strategies.\n */\nexport interface TableStrategies {\n /** Strategy for discovering/scanning headers */\n header?: HeaderStrategy;\n /** Primitive navigation functions (goUp, goDown, goLeft, goRight, goHome) */\n navigation?: NavigationPrimitives;\n\n /** Strategy for filling form inputs */\n fill?: FillStrategy;\n /** Strategy for paginating through data */\n pagination?: PaginationStrategy;\n /** Strategy for sorting columns */\n sorting?: SortingStrategy;\n /** Strategy for deduplicating rows during iteration/scrolling */\n dedupe?: DedupeStrategy;\n /** Function to get a cell locator */\n getCellLocator?: GetCellLocatorFn;\n /** Function to get the currently active/focused cell */\n getActiveCell?: GetActiveCellFn;\n /**\n * Strategy for filtering rows. If present, FilterEngine will delegate filter application\n * to this pluggable strategy.\n */\n filter?: FilterStrategy;\n /**\n * Hook called before each cell value is read in toJSON and columnOverrides.read.\n * Fires for both the default innerText extraction and custom read mappers.\n * Useful for scrolling off-screen columns into view in horizontally virtualized tables.\n */\n beforeCellRead?: BeforeCellReadFn;\n /**\n * Strategy for detecting loading states. Use this for table-, row-, and header-level readiness.\n * E.g. after sort/pagination, the engine uses loading.isTableLoading when present.\n */\n loading?: LoadingStrategy;\n\n /**\n * Resolve the stable data-model index for a row locator.\n *\n * Called by `findRow` / `findRows` to convert a DOM row into the index used for\n * virtual-scroll positioning. Useful for grids where DOM position resets to 0 on\n * each page while the grid itself maintains a monotone counter (e.g. MUI DataGrid's\n * `data-rowindex` attribute).\n *\n * Return `undefined` to fall back to DOM position.\n *\n * When the index maps to a DOM attribute, return `{ index, selector }` instead of\n * a plain number. The library uses the CSS selector to build a **self-healing row\n * locator** that re-queries the DOM on every action \u2014 surviving virtual-scroll\n * recycling for `getCell`, `smartFill`, and `toJSON` without manual re-pinning.\n *\n * @example\n * // MUI DataGrid: self-healing via data-rowindex attribute\n * resolveRowIndex: async (row) => {\n * const v = await row.getAttribute('data-rowindex').catch(() => null);\n * if (v === null || isNaN(Number(v))) return undefined;\n * return { index: Number(v), selector: `[data-rowindex=\"${v}\"]` };\n * }\n */\n resolveRowIndex?: (row: Locator) => Promise<RowIndexResult | undefined>;\n\n /**\n * Waits until a row's content has stabilized before cloning in\n * `toJSON({ atomic: true })`. Needed for recycling virtualizers where the\n * framework updates element positions synchronously but renders cell content\n * asynchronously (e.g. react-window, react-virtuoso with React concurrent mode).\n *\n * Without this, the clone captures stale content from the previous occupant of the\n * DOM slot \u2014 the element is at the correct position but React hasn't re-rendered yet.\n *\n * Use `Strategies.ContentReady.textStable()` for the built-in text-polling strategy.\n *\n * @example\n * strategies: {\n * contentReady: Strategies.ContentReady.textStable({ timeout: 500 }),\n * }\n */\n contentReady?: ContentReadyStrategy;\n\n /**\n * Viewport oracle strategies for 2D virtualized tables (e.g. MUI DataGrid, AG Grid,\n * Braintrust-style grids where both rows and columns are virtualized simultaneously).\n *\n * When present, the cell-reading engine uses these to jump directly to the target\n * row/column and to detect the 2D scroll hazard (scrolling to reveal a column can\n * knock rows out of the vertical viewport, and vice versa).\n *\n * Completely optional and additive \u2014 existing `navigation` primitives remain the fallback.\n */\n viewport?: ViewportStrategy;\n}\n\n\nexport interface TableConfig<T = any> {\n /** Selector for the table headers */\n headerSelector?: string | ((root: Locator) => Locator);\n /** Selector for the table rows */\n rowSelector?: string;\n /** Selector for the cells within a row */\n cellSelector?: string | ((row: Locator) => Locator);\n /**\n * Number of pages to scan for verification / iteration.\n * Defaults to `1` \u2014 set explicitly (e.g. `maxPages: 5`) when using a pagination\n * strategy, or you will never leave page 1. Init logs a warning when pagination\n * is configured and this is still `1`.\n */\n maxPages?: number;\n /**\n * Default concurrency strategy for iteration methods.\n * Can be overridden by the options passed to forEach, map, or filter.\n * Defaults to sequential when unset (safer for UI interactions).\n */\n concurrency?: RowIterationMode;\n /** Hook to rename columns dynamically */\n headerTransformer?: (args: { text: string, index: number, locator: Locator, seenHeaders: Set<string> }) => string | Promise<string>;\n /** Automatically scroll to table on init */\n autoScroll?: boolean;\n /** Debug options for development and troubleshooting */\n debug?: DebugConfig;\n /** Hook called after reset completes (after goToFirst, cache clear, and autoInit). */\n onReset?: (context: TableContext) => Promise<void>;\n /** All interaction strategies */\n strategies?: TableStrategies;\n\n /**\n * Unified interface for reading and writing data to specific columns.\n * Overrides both default extraction (toJSON) and filling (smartFill) logic.\n */\n columnOverrides?: Partial<Record<keyof T, ColumnOverride<T[keyof T]>>>;\n\n /**\n * Computed columns with no DOM presence. Each key becomes a virtual column name\n * available in `toJSON()`, `getValue()`, and `findRow()`/`findRows()` filters.\n * The `compute` function receives the full SmartRow and must only read real or\n * override columns (no chaining between synthetics).\n */\n syntheticColumns?: Record<string, SyntheticColumnDef<T>>;\n\n /**\n * Locator for an empty-state element that replaces the table when there are no results.\n * If header resolution fails during init() and this locator is visible, init() succeeds\n * and isEmpty() returns true. All row operations still throw normally.\n */\n emptyState?: Locator;\n}\n\n/**\n * @internal Resolved config after defaults are applied. Prefer {@link TableConfig} in public code.\n */\nexport interface FinalTableConfig<T = any> extends TableConfig<T> {\n headerSelector: string | ((root: Locator) => Locator);\n rowSelector: string;\n cellSelector: string | ((row: Locator) => Locator);\n maxPages: number;\n autoScroll: boolean;\n concurrency?: RowIterationMode;\n debug?: TableConfig['debug'];\n headerTransformer: (args: { text: string, index: number, locator: Locator, seenHeaders: Set<string> }) => string | Promise<string>;\n onReset: (context: TableContext) => Promise<void>;\n strategies: TableStrategies;\n}\n\n\nexport interface FillOptions {\n /**\n * Custom input mappers for specific columns.\n * Maps column names to functions that return the input locator for that cell.\n */\n inputMappers?: Record<string, (cell: Locator) => Locator>;\n}\n\n\n\n/** Callback context passed to forEach, map, and filter. */\nexport type RowIterationContext<T = any> = {\n row: SmartRow<T>;\n /**\n * The row's logical/data-model index. When a `resolveRowIndex` strategy is configured\n * (e.g. MUI DataGrid's `data-rowindex`) this is the grid's true row index; otherwise it\n * equals `index`. Use this for `row.bringIntoView()` and position math on virtualized\n * tables \u2014 it is stable across scrolling/dedupe, unlike the visit-order `index`.\n */\n rowIndex: number;\n /**\n * 0-based enumeration counter \u2014 the order this row was visited (contiguous within the run).\n * Not a DOM position or grid identity. Use `rowIndex` for the row's data-model index.\n */\n index: number;\n /** 0-based page index \u2014 which page this row was collected from. */\n pageIndex: number;\n stop: () => void;\n};\n\n/** Concurrency modes for row iteration. */\nexport type RowIterationMode = 'parallel' | 'sequential' | 'synchronized';\n\n/** Shared options for forEach, map, and filter. */\nexport type RowIterationOptions = {\n /** Maximum number of pages to iterate. Defaults to config.maxPages. */\n maxPages?: number;\n /**\n * Concurrency strategy for iteration.\n * - 'parallel': Full parallel execution of both navigation and actions.\n * - 'synchronized': Parallel navigation (lock-step) with serial actions.\n * - 'sequential': Strictly serial one-at-a-time execution. No parallel navigation.\n * @default 'parallel' (for map), 'sequential' (for forEach/filter)\n */\n concurrency?: RowIterationMode;\n /**\n * Deduplication strategy. Use when rows may repeat across iterations\n * (e.g. infinite scroll tables). Returns a unique key per row.\n */\n dedupe?: DedupeStrategy;\n /**\n * When true, use goNextBulk (if present) to advance pages during iteration.\n * @default false \u2014 uses goNext for one-page-at-a-time advancement\n */\n useBulkPagination?: boolean;\n};\n\n/**\n * Result of {@link useTable}. Implements `AsyncIterable` \u2014 `for await (const { row } of table)`\n * uses the same page-walk as `map` / `forEach` (`scanPages` + runMap): overscan, loading,\n * dedupe, and EOF final scan (#427).\n */\nexport interface TableResult<T = any> extends AsyncIterable<{ row: SmartRow<T>; rowIndex: number; index: number; pageIndex: number }> {\n /**\n * Current DOM page index (0-based). Automatically maintained during pagination\n * and `bringIntoView`. Treat as **read-only** \u2014 assigning manually can desync\n * the path planner. Manual writes log a warning; prefer `reset()` / library\n * navigation. Writable access may become read-only in v7.\n */\n currentPageIndex: number;\n\n /**\n * Initializes the table by resolving headers. Must be called before using sync methods.\n * @param options Optional timeout for header resolution (default: 3000ms)\n */\n init(options?: { timeout?: number }): Promise<TableResult<T>>;\n\n /**\n * SYNC: Checks if the table has been initialized.\n * @returns true if init() has been called and completed, false otherwise\n */\n isInitialized(): boolean;\n\n /**\n * SYNC: Returns true if init() resolved via the emptyState path \u2014 the table's\n * empty-state locator was visible when header resolution failed.\n * Row operations still throw normally; use this to branch before calling them.\n */\n isEmpty(): boolean;\n\n getHeaders: () => Promise<string[]>;\n getHeaderCell: (columnName: string) => Promise<Locator>;\n\n /**\n * Finds a row by filters on the current page only. Returns immediately (sync).\n * Throws error if table is not initialized.\n * @note The sync path cannot compute a real `rowIndex`, so the returned SmartRow's\n * `rowIndex` is `undefined` (virtual-scroll positioning via `bringIntoView()` is limited).\n * Use `findRow()` (async) when you need a row with an accurate `rowIndex`.\n * @note Cannot filter by `syntheticColumns` or `columnOverrides.read` keys \u2014 those need\n * async evaluation via `findRow()` / `findRows()`. DOM filters use `strategies.getCellLocator`\n * when configured (column-virtualized grids), otherwise `cellSelector` + column index.\n */\n getRow: (\n filters: Record<string, FilterValue>,\n options?: { exact?: boolean }\n ) => SmartRow<T>;\n\n /**\n * Gets a row by its 0-based position in the currently-rendered DOM (sync, no scroll).\n * Throws if the table is not initialized.\n *\n * For button-paginated tables this is the i-th row on the current page. For virtualized\n * tables the render window shifts as you scroll, so `getRowByIndex(i)` returns whatever\n * row currently sits at DOM position `i` \u2014 NOT the logical/absolute row `i` in the dataset\n * once the list has scrolled. For the row with a specific logical/data-model index on a\n * virtualized table, use the async `findRowByIndex(i)` instead (it scrolls to the row);\n * to iterate by logical identity, use `map` / `findRows` (with a `dedupe` strategy).\n *\n * Resolution is lazy: an out-of-range index yields a SmartRow whose operations fail when\n * it is used, rather than throwing here.\n *\n * @param index 0-based position within the current render window\n */\n getRowByIndex: (\n index: number\n ) => SmartRow<T>;\n\n /**\n * ASYNC: Returns the row with a specific logical/data-model index, scrolling/paginating to\n * reach it. Unlike the sync `getRowByIndex` (render-window position), this resolves the true\n * data-model row `index` on virtualized tables.\n *\n * Reaches the row via, in order: a currently-mounted match, the viewport's random-access\n * `scrollToRow` fast path, then advancing pages (on infinite-scroll tables a \"page\" is a\n * scroll step) up to `maxPages`.\n *\n * Requires a `strategies.resolveRowIndex` to identify rows by logical index \u2014 throws if one\n * is not configured. Also throws if the row cannot be reached (no silent wrong-row fallback).\n *\n * @param index 0-based logical/data-model row index\n * @param options - `maxPages` bounds how far to scroll/paginate (defaults to config.maxPages)\n */\n findRowByIndex: (\n index: number,\n options?: { maxPages?: number }\n ) => Promise<SmartRow<T>>;\n\n /**\n * ASYNC: Searches for a single row across pages using pagination.\n * Auto-initializes the table if not already initialized.\n * @param filters - The filter criteria to match\n * @param options - Search options including exact match and max pages\n */\n findRow: (\n filters: Record<string, FilterValue>,\n options?: { exact?: boolean, maxPages?: number }\n ) => Promise<SmartRow<T>>;\n\n /**\n * ASYNC: Searches for all matching rows across pages using pagination.\n * Auto-initializes the table if not already initialized.\n * @param filters - The filter criteria to match (omit or pass {} for all rows)\n * @param options - Search options (exact, maxPages). `useBulkPagination` defaults to `false`: pages advance one at a time via `goNext` so no intermediate page is skipped. Set it to `true` to opt into `goNextBulk` (faster, but skips the rows on jumped-over pages).\n */\n findRows: (\n filters?: Record<string, FilterValue>,\n options?: { exact?: boolean, maxPages?: number, useBulkPagination?: boolean }\n ) => Promise<SmartRowArray<T>>;\n\n /**\n * Resolves the named column and scrolls it into view.\n * Prefers `strategies.viewport.scrollToColumn` when configured; otherwise scrolls the\n * header cell via Playwright `scrollIntoViewIfNeeded()`.\n */\n scrollToColumn: (columnName: string) => Promise<void>;\n\n /**\n * Counts the number of rows, optionally filtered.\n * Without arguments, counts all rows. With filters, counts only matching rows.\n * Paginates when pagination is configured.\n */\n countRows: (filters?: Record<string, FilterValue>, options?: { exact?: boolean; maxPages?: number }) => Promise<number>;\n\n /**\n * Iterates over rows and extracts the value of a single column.\n * More efficient than map + toJSON for single-column extraction.\n * @param columnName - The name of the column to extract\n * @param options - Iteration options\n */\n mapColumn<R = string>(columnName: string, options?: RowIterationOptions): Promise<R[]>;\n\n /**\n * @deprecated Use `mapColumn` (or `map`) instead. Will be removed in v7.0.0.\n * Iterates over rows and extracts the value of a single column as strings.\n * @param columnName - The name of the column to extract\n * @param options - Iteration options\n */\n getColumnValues(columnName: string, options?: RowIterationOptions): Promise<string[]>;\n\n\n /**\n * Resets the table: calls goToFirst (if configured), clears cache, re-inits headers, then calls onReset.\n */\n reset: () => Promise<void>;\n\n /**\n * Revalidates the table's structure (headers, columns) without resetting pagination or state.\n * Useful when columns change visibility or order dynamically.\n */\n revalidate: () => Promise<void>;\n\n /**\n * Iterates every row across all pages, calling the callback for side effects.\n * Execution is sequential by default (safe for interactions like clicking/filling).\n * Call `stop()` in the callback to end iteration early.\n *\n * @param callback - Function receiving { row, rowIndex, stop }\n * @param options - maxPages, concurrency, dedupe, useBulkPagination\n *\n * @example\n * await table.forEach(async ({ row, stop }) => {\n * if (await row.getCell('Status').innerText() === 'Done') stop();\n * await row.getCell('Checkbox').click();\n * });\n */\n forEach(\n callback: (ctx: RowIterationContext<T>) => void | Promise<void>,\n options?: RowIterationOptions\n ): Promise<void>;\n\n /**\n * Transforms every row across all pages into a value. Returns a flat array.\n * Defaults to `concurrency: 'sequential'` (safe for clicks/fills). Pass\n * `concurrency: 'parallel'` for read-only extraction, or `'synchronized'` when\n * navigation must stay lock-step on virtualized grids.\n * Call `stop()` to halt after the current page finishes.\n *\n * @param callback - Function receiving { row, rowIndex, stop }\n * @param options - maxPages, concurrency, dedupe, useBulkPagination\n *\n * @example\n * // Default sequential \u2014 safe for UI interactions\n * const assignees = await table.map(async ({ row }) => {\n * await row.getCell('Assignee').locator('button').click();\n * const name = await page.locator('.popover .name').innerText();\n * await page.keyboard.press('Escape');\n * return name;\n * });\n *\n * @example\n * // Read-only extraction \u2014 opt into parallel\n * const emails = await table.map(\n * ({ row }) => row.getCell('Email').innerText(),\n * { concurrency: 'parallel' }\n * );\n */\n map<R>(\n callback: (ctx: RowIterationContext<T>) => R | Promise<R>,\n options?: RowIterationOptions\n ): Promise<R[]>;\n\n /**\n * Shorthand for `map()` + `reset()`. Iterates every row across all pages, applies the\n * callback (defaults to `row.toJSON()`), then resets the table back to page 1 \u2014 even if\n * the callback throws.\n *\n * @param callback - Optional map function. Defaults to `({ row }) => row.toJSON()`.\n * @param options - Same options as `map()`.\n *\n * @example\n * // Zero-arg: returns toJSON() for every row\n * const rows = await table.toArray();\n *\n * @example\n * // Custom callback\n * const names = await table.toArray(({ row }) => row.getCell('Name').innerText());\n *\n * @example\n * // With options\n * const rows = await table.toArray(({ row }) => row.toJSON(), { concurrency: 'parallel' });\n */\n toArray<R = Record<string, unknown>>(\n callback?: (ctx: RowIterationContext<T>) => R | Promise<R>,\n options?: RowIterationOptions\n ): Promise<R[]>;\n\n /**\n * Filters rows across all pages by an async predicate. Returns a SmartRowArray.\n * Rows are returned as-is \u2014 call `bringIntoView()` on each if needed.\n * Execution is sequential by default.\n *\n * @param predicate - Function receiving { row, rowIndex, stop }\n * @param options - maxPages, concurrency, dedupe, useBulkPagination\n *\n * @example\n * const active = await table.filter(async ({ row }) =>\n * await row.getCell('Status').innerText() === 'Active'\n * );\n */\n filter(\n predicate: (ctx: RowIterationContext<T>) => boolean | Promise<boolean>,\n options?: RowIterationOptions\n ): Promise<SmartRowArray<T>>;\n\n /**\n * Provides access to sorting actions and assertions.\n */\n sorting: {\n /**\n * Applies the configured sorting strategy to the specified column.\n * @param columnName The name of the column to sort.\n * @param direction The direction to sort ('asc' or 'desc').\n */\n apply(columnName: string, direction: 'asc' | 'desc'): Promise<void>;\n /**\n * Gets the current sort state of a column using the configured sorting strategy.\n * @param columnName The name of the column to check.\n * @returns A promise that resolves to 'asc', 'desc', or 'none'.\n */\n getState(columnName: string): Promise<'asc' | 'desc' | 'none'>;\n };\n\n /**\n * Generate an AI-friendly configuration prompt for debugging.\n * Outputs table HTML and TypeScript definitions to help AI assistants generate config.\n * Automatically throws an Error containing the prompt.\n */\n generateConfig: () => Promise<void>;\n\n /**\n * @deprecated Use `generateConfig()` instead. Will be removed in v7.0.0.\n */\n generateConfigPrompt: () => Promise<void>;\n}\n";
|
package/dist/typeContext.js
CHANGED
|
@@ -595,9 +595,16 @@ export interface LoadingStrategy {
|
|
|
595
595
|
| 'throw'
|
|
596
596
|
| ((cell: import('@playwright/test').Locator, columnName: string, row: SmartRow) => Promise<string>);
|
|
597
597
|
|
|
598
|
-
/**
|
|
598
|
+
/**
|
|
599
|
+
* Max ms to wait while \`isTableLoading\` returns true (countRows, findRow(s),
|
|
600
|
+
* page-ready gates, and sort when \`sortStabilizationTimeout\` is unset).
|
|
601
|
+
* @default 10000
|
|
602
|
+
*/
|
|
603
|
+
loadingTimeout?: number;
|
|
604
|
+
|
|
605
|
+
/** Max ms to wait for sort stabilization when isTableLoading is set. Overrides \`loadingTimeout\` for sort only. @default 10000 */
|
|
599
606
|
sortStabilizationTimeout?: number;
|
|
600
|
-
/** Polling interval (ms) while waiting for sort stabilization. @default 100 */
|
|
607
|
+
/** Polling interval (ms) while waiting for sort / table-ready stabilization. @default 100 (sort) / 200 (table-ready) */
|
|
601
608
|
sortStabilizationPollInterval?: number;
|
|
602
609
|
/** Fallback delay (ms) after sort when no isTableLoading is configured. @default 200 */
|
|
603
610
|
sortStabilizationFallbackDelay?: number;
|
|
@@ -705,11 +712,17 @@ export interface TableConfig<T = any> {
|
|
|
705
712
|
rowSelector?: string;
|
|
706
713
|
/** Selector for the cells within a row */
|
|
707
714
|
cellSelector?: string | ((row: Locator) => Locator);
|
|
708
|
-
/**
|
|
715
|
+
/**
|
|
716
|
+
* Number of pages to scan for verification / iteration.
|
|
717
|
+
* Defaults to \`1\` — set explicitly (e.g. \`maxPages: 5\`) when using a pagination
|
|
718
|
+
* strategy, or you will never leave page 1. Init logs a warning when pagination
|
|
719
|
+
* is configured and this is still \`1\`.
|
|
720
|
+
*/
|
|
709
721
|
maxPages?: number;
|
|
710
722
|
/**
|
|
711
723
|
* Default concurrency strategy for iteration methods.
|
|
712
724
|
* Can be overridden by the options passed to forEach, map, or filter.
|
|
725
|
+
* Defaults to sequential when unset (safer for UI interactions).
|
|
713
726
|
*/
|
|
714
727
|
concurrency?: RowIterationMode;
|
|
715
728
|
/** Hook to rename columns dynamically */
|
|
@@ -826,8 +839,10 @@ export type RowIterationOptions = {
|
|
|
826
839
|
*/
|
|
827
840
|
export interface TableResult<T = any> extends AsyncIterable<{ row: SmartRow<T>; rowIndex: number; index: number; pageIndex: number }> {
|
|
828
841
|
/**
|
|
829
|
-
*
|
|
830
|
-
*
|
|
842
|
+
* Current DOM page index (0-based). Automatically maintained during pagination
|
|
843
|
+
* and \`bringIntoView\`. Treat as **read-only** — assigning manually can desync
|
|
844
|
+
* the path planner. Manual writes log a warning; prefer \`reset()\` / library
|
|
845
|
+
* navigation. Writable access may become read-only in v7.
|
|
831
846
|
*/
|
|
832
847
|
currentPageIndex: number;
|
|
833
848
|
|
|
@@ -993,28 +1008,29 @@ export interface TableResult<T = any> extends AsyncIterable<{ row: SmartRow<T>;
|
|
|
993
1008
|
|
|
994
1009
|
/**
|
|
995
1010
|
* Transforms every row across all pages into a value. Returns a flat array.
|
|
996
|
-
*
|
|
1011
|
+
* Defaults to \`concurrency: 'sequential'\` (safe for clicks/fills). Pass
|
|
1012
|
+
* \`concurrency: 'parallel'\` for read-only extraction, or \`'synchronized'\` when
|
|
1013
|
+
* navigation must stay lock-step on virtualized grids.
|
|
997
1014
|
* Call \`stop()\` to halt after the current page finishes.
|
|
998
1015
|
*
|
|
999
|
-
* > **⚠️ UI Interactions:** \`map\` defaults to \`concurrency: 'parallel'\`. If your callback opens popovers,
|
|
1000
|
-
* > fills inputs, or otherwise mutates UI state, pass \`concurrency: 'sequential'\` (or \`'synchronized'\`
|
|
1001
|
-
* > when navigation must stay lock-step) to avoid overlapping interactions.
|
|
1002
|
-
*
|
|
1003
1016
|
* @param callback - Function receiving { row, rowIndex, stop }
|
|
1004
1017
|
* @param options - maxPages, concurrency, dedupe, useBulkPagination
|
|
1005
1018
|
*
|
|
1006
1019
|
* @example
|
|
1007
|
-
* //
|
|
1008
|
-
* const emails = await table.map(({ row }) => row.getCell('Email').innerText());
|
|
1009
|
-
*
|
|
1010
|
-
* @example
|
|
1011
|
-
* // UI interactions — use sequential (or synchronized) concurrency
|
|
1020
|
+
* // Default sequential — safe for UI interactions
|
|
1012
1021
|
* const assignees = await table.map(async ({ row }) => {
|
|
1013
1022
|
* await row.getCell('Assignee').locator('button').click();
|
|
1014
1023
|
* const name = await page.locator('.popover .name').innerText();
|
|
1015
1024
|
* await page.keyboard.press('Escape');
|
|
1016
1025
|
* return name;
|
|
1017
|
-
* }
|
|
1026
|
+
* });
|
|
1027
|
+
*
|
|
1028
|
+
* @example
|
|
1029
|
+
* // Read-only extraction — opt into parallel
|
|
1030
|
+
* const emails = await table.map(
|
|
1031
|
+
* ({ row }) => row.getCell('Email').innerText(),
|
|
1032
|
+
* { concurrency: 'parallel' }
|
|
1033
|
+
* );
|
|
1018
1034
|
*/
|
|
1019
1035
|
map<R>(
|
|
1020
1036
|
callback: (ctx: RowIterationContext<T>) => R | Promise<R>,
|
package/dist/types.d.ts
CHANGED
|
@@ -541,9 +541,15 @@ export interface LoadingStrategy {
|
|
|
541
541
|
* Defaults to 'read-as-is' when cellLoadingTimeout is set.
|
|
542
542
|
*/
|
|
543
543
|
onCellLoadingTimeout?: 'skip' | 'read-as-is' | 'throw' | ((cell: import('@playwright/test').Locator, columnName: string, row: SmartRow) => Promise<string>);
|
|
544
|
-
/**
|
|
544
|
+
/**
|
|
545
|
+
* Max ms to wait while `isTableLoading` returns true (countRows, findRow(s),
|
|
546
|
+
* page-ready gates, and sort when `sortStabilizationTimeout` is unset).
|
|
547
|
+
* @default 10000
|
|
548
|
+
*/
|
|
549
|
+
loadingTimeout?: number;
|
|
550
|
+
/** Max ms to wait for sort stabilization when isTableLoading is set. Overrides `loadingTimeout` for sort only. @default 10000 */
|
|
545
551
|
sortStabilizationTimeout?: number;
|
|
546
|
-
/** Polling interval (ms) while waiting for sort stabilization. @default 100 */
|
|
552
|
+
/** Polling interval (ms) while waiting for sort / table-ready stabilization. @default 100 (sort) / 200 (table-ready) */
|
|
547
553
|
sortStabilizationPollInterval?: number;
|
|
548
554
|
/** Fallback delay (ms) after sort when no isTableLoading is configured. @default 200 */
|
|
549
555
|
sortStabilizationFallbackDelay?: number;
|
|
@@ -644,11 +650,17 @@ export interface TableConfig<T = any> {
|
|
|
644
650
|
rowSelector?: string;
|
|
645
651
|
/** Selector for the cells within a row */
|
|
646
652
|
cellSelector?: string | ((row: Locator) => Locator);
|
|
647
|
-
/**
|
|
653
|
+
/**
|
|
654
|
+
* Number of pages to scan for verification / iteration.
|
|
655
|
+
* Defaults to `1` — set explicitly (e.g. `maxPages: 5`) when using a pagination
|
|
656
|
+
* strategy, or you will never leave page 1. Init logs a warning when pagination
|
|
657
|
+
* is configured and this is still `1`.
|
|
658
|
+
*/
|
|
648
659
|
maxPages?: number;
|
|
649
660
|
/**
|
|
650
661
|
* Default concurrency strategy for iteration methods.
|
|
651
662
|
* Can be overridden by the options passed to forEach, map, or filter.
|
|
663
|
+
* Defaults to sequential when unset (safer for UI interactions).
|
|
652
664
|
*/
|
|
653
665
|
concurrency?: RowIterationMode;
|
|
654
666
|
/** Hook to rename columns dynamically */
|
|
@@ -768,8 +780,10 @@ export interface TableResult<T = any> extends AsyncIterable<{
|
|
|
768
780
|
pageIndex: number;
|
|
769
781
|
}> {
|
|
770
782
|
/**
|
|
771
|
-
*
|
|
772
|
-
*
|
|
783
|
+
* Current DOM page index (0-based). Automatically maintained during pagination
|
|
784
|
+
* and `bringIntoView`. Treat as **read-only** — assigning manually can desync
|
|
785
|
+
* the path planner. Manual writes log a warning; prefer `reset()` / library
|
|
786
|
+
* navigation. Writable access may become read-only in v7.
|
|
773
787
|
*/
|
|
774
788
|
currentPageIndex: number;
|
|
775
789
|
/**
|
|
@@ -916,28 +930,29 @@ export interface TableResult<T = any> extends AsyncIterable<{
|
|
|
916
930
|
forEach(callback: (ctx: RowIterationContext<T>) => void | Promise<void>, options?: RowIterationOptions): Promise<void>;
|
|
917
931
|
/**
|
|
918
932
|
* Transforms every row across all pages into a value. Returns a flat array.
|
|
919
|
-
*
|
|
933
|
+
* Defaults to `concurrency: 'sequential'` (safe for clicks/fills). Pass
|
|
934
|
+
* `concurrency: 'parallel'` for read-only extraction, or `'synchronized'` when
|
|
935
|
+
* navigation must stay lock-step on virtualized grids.
|
|
920
936
|
* Call `stop()` to halt after the current page finishes.
|
|
921
937
|
*
|
|
922
|
-
* > **⚠️ UI Interactions:** `map` defaults to `concurrency: 'parallel'`. If your callback opens popovers,
|
|
923
|
-
* > fills inputs, or otherwise mutates UI state, pass `concurrency: 'sequential'` (or `'synchronized'`
|
|
924
|
-
* > when navigation must stay lock-step) to avoid overlapping interactions.
|
|
925
|
-
*
|
|
926
938
|
* @param callback - Function receiving { row, rowIndex, stop }
|
|
927
939
|
* @param options - maxPages, concurrency, dedupe, useBulkPagination
|
|
928
940
|
*
|
|
929
941
|
* @example
|
|
930
|
-
* //
|
|
931
|
-
* const emails = await table.map(({ row }) => row.getCell('Email').innerText());
|
|
932
|
-
*
|
|
933
|
-
* @example
|
|
934
|
-
* // UI interactions — use sequential (or synchronized) concurrency
|
|
942
|
+
* // Default sequential — safe for UI interactions
|
|
935
943
|
* const assignees = await table.map(async ({ row }) => {
|
|
936
944
|
* await row.getCell('Assignee').locator('button').click();
|
|
937
945
|
* const name = await page.locator('.popover .name').innerText();
|
|
938
946
|
* await page.keyboard.press('Escape');
|
|
939
947
|
* return name;
|
|
940
|
-
* }
|
|
948
|
+
* });
|
|
949
|
+
*
|
|
950
|
+
* @example
|
|
951
|
+
* // Read-only extraction — opt into parallel
|
|
952
|
+
* const emails = await table.map(
|
|
953
|
+
* ({ row }) => row.getCell('Email').innerText(),
|
|
954
|
+
* { concurrency: 'parallel' }
|
|
955
|
+
* );
|
|
941
956
|
*/
|
|
942
957
|
map<R>(callback: (ctx: RowIterationContext<T>) => R | Promise<R>, options?: RowIterationOptions): Promise<R[]>;
|
|
943
958
|
/**
|
package/dist/useTable.js
CHANGED
|
@@ -32,6 +32,8 @@ const scanPages_1 = require("./engine/scanPages");
|
|
|
32
32
|
const debugUtils_1 = require("./utils/debugUtils");
|
|
33
33
|
const smartRowArray_1 = require("./utils/smartRowArray");
|
|
34
34
|
const elementTracker_1 = require("./utils/elementTracker");
|
|
35
|
+
const loadingWait_1 = require("./utils/loadingWait");
|
|
36
|
+
const pageIndex_1 = require("./utils/pageIndex");
|
|
35
37
|
// Helper to safely serialize objects containing functions for logging
|
|
36
38
|
const safeStringify = (obj) => {
|
|
37
39
|
try {
|
|
@@ -183,7 +185,7 @@ const useTable = (rootLocator, configOptions = {}) => {
|
|
|
183
185
|
const _handlePrompt = async (promptName, content) => {
|
|
184
186
|
let finalPrompt = content;
|
|
185
187
|
finalPrompt += `\n\n👇 Useful TypeScript Definitions 👇\n\`\`\`typescript\n${minimalConfigContext_1.MINIMAL_CONFIG_CONTEXT}\n\`\`\`\n`;
|
|
186
|
-
|
|
188
|
+
(0, debugUtils_1.logDebug)(config, 'info', `Throwing error to display [${promptName}] cleanly...`);
|
|
187
189
|
throw new Error(finalPrompt);
|
|
188
190
|
};
|
|
189
191
|
const _autoInit = async () => {
|
|
@@ -229,9 +231,12 @@ const useTable = (rootLocator, configOptions = {}) => {
|
|
|
229
231
|
};
|
|
230
232
|
const result = {
|
|
231
233
|
get currentPageIndex() { return tableState.currentPageIndex; },
|
|
232
|
-
set currentPageIndex(v) {
|
|
234
|
+
set currentPageIndex(v) {
|
|
235
|
+
console.warn('[SmartTable] Manually assigning table.currentPageIndex can desync pagination path planning. Prefer reset() / library navigation; writable access may become read-only in v7.');
|
|
236
|
+
tableState.currentPageIndex = v;
|
|
237
|
+
},
|
|
233
238
|
init: async (options) => {
|
|
234
|
-
var _a;
|
|
239
|
+
var _a, _b, _c;
|
|
235
240
|
if (tableMapper.isInitialized() || tableState.empty)
|
|
236
241
|
return result;
|
|
237
242
|
if (config.strategies.sorting)
|
|
@@ -240,6 +245,10 @@ const useTable = (rootLocator, configOptions = {}) => {
|
|
|
240
245
|
(0, validation_1.validateFillStrategy)(config.strategies.fill);
|
|
241
246
|
(0, debugUtils_1.warnIfDebugInCI)(config);
|
|
242
247
|
(0, debugUtils_1.logDebug)(config, 'info', 'Initializing table');
|
|
248
|
+
if (config.maxPages === 1 &&
|
|
249
|
+
(((_a = config.strategies.pagination) === null || _a === void 0 ? void 0 : _a.goNext) || ((_b = config.strategies.pagination) === null || _b === void 0 ? void 0 : _b.goNextBulk))) {
|
|
250
|
+
console.warn('[SmartTable] maxPages is 1 but a pagination strategy is configured — iteration/find will never leave page 1. Pass maxPages: N (or Infinity) to scan further pages.');
|
|
251
|
+
}
|
|
243
252
|
let map;
|
|
244
253
|
try {
|
|
245
254
|
map = await tableMapper.getMap(options === null || options === void 0 ? void 0 : options.timeout);
|
|
@@ -256,7 +265,7 @@ const useTable = (rootLocator, configOptions = {}) => {
|
|
|
256
265
|
throw headerError;
|
|
257
266
|
}
|
|
258
267
|
(0, debugUtils_1.logDebug)(config, 'info', `Table initialized with ${map.size} columns`, Array.from(map.keys()));
|
|
259
|
-
if ((
|
|
268
|
+
if ((_c = config.strategies.pagination) === null || _c === void 0 ? void 0 : _c.detectCurrentPage) {
|
|
260
269
|
try {
|
|
261
270
|
const detected = await config.strategies.pagination.detectCurrentPage(rootLocator);
|
|
262
271
|
if (Number.isInteger(detected) && detected >= 0) {
|
|
@@ -370,10 +379,7 @@ const useTable = (rootLocator, configOptions = {}) => {
|
|
|
370
379
|
const isTableLoading = (_e = config.strategies.loading) === null || _e === void 0 ? void 0 : _e.isTableLoading;
|
|
371
380
|
if (isTableLoading) {
|
|
372
381
|
const ctx = createStrategyContext();
|
|
373
|
-
|
|
374
|
-
log('countRows: table is loading... waiting');
|
|
375
|
-
await rootLocator.page().waitForTimeout(200);
|
|
376
|
-
}
|
|
382
|
+
await (0, loadingWait_1.waitWhileTableLoading)(config, ctx, rootLocator.page(), 'countRows');
|
|
377
383
|
}
|
|
378
384
|
if (!hasPagination) {
|
|
379
385
|
log(`countRows: counting rows in current viewport (no pagination)${hasFilters ? ` filters=${safeStringify(filtersRecord)}` : ''}`);
|
|
@@ -396,10 +402,7 @@ const useTable = (rootLocator, configOptions = {}) => {
|
|
|
396
402
|
if (!isTableLoading)
|
|
397
403
|
return;
|
|
398
404
|
const ctx = createStrategyContext();
|
|
399
|
-
|
|
400
|
-
log('countRows: table is loading... waiting');
|
|
401
|
-
await rootLocator.page().waitForTimeout(200);
|
|
402
|
-
}
|
|
405
|
+
await (0, loadingWait_1.waitWhileTableLoading)(config, ctx, rootLocator.page(), 'countRows');
|
|
403
406
|
},
|
|
404
407
|
}, async ({ pagesScanned: pageNum }) => {
|
|
405
408
|
const rowLocators = resolveRows();
|
|
@@ -592,7 +595,7 @@ const useTable = (rootLocator, configOptions = {}) => {
|
|
|
592
595
|
},
|
|
593
596
|
sorting: {
|
|
594
597
|
apply: async (columnName, direction) => {
|
|
595
|
-
var _a, _b, _c, _d, _e;
|
|
598
|
+
var _a, _b, _c, _d, _e, _f;
|
|
596
599
|
await _autoInit();
|
|
597
600
|
if (!config.strategies.sorting)
|
|
598
601
|
throw new Error('No sorting strategy has been configured.');
|
|
@@ -607,15 +610,15 @@ const useTable = (rootLocator, configOptions = {}) => {
|
|
|
607
610
|
}
|
|
608
611
|
await config.strategies.sorting.doSort({ columnName, direction, context });
|
|
609
612
|
if ((_a = config.strategies.loading) === null || _a === void 0 ? void 0 : _a.isTableLoading) {
|
|
610
|
-
const timeout = (_b = config.strategies.loading.sortStabilizationTimeout) !== null && _b !== void 0 ? _b : 10000;
|
|
611
|
-
const poll = (
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
}
|
|
613
|
+
const timeout = (_c = (_b = config.strategies.loading.sortStabilizationTimeout) !== null && _b !== void 0 ? _b : config.strategies.loading.loadingTimeout) !== null && _c !== void 0 ? _c : 10000;
|
|
614
|
+
const poll = (_d = config.strategies.loading.sortStabilizationPollInterval) !== null && _d !== void 0 ? _d : 100;
|
|
615
|
+
await (0, loadingWait_1.waitWhileTableLoading)(config, context, rootLocator.page(), 'sorting.apply', {
|
|
616
|
+
timeout,
|
|
617
|
+
pollInterval: poll,
|
|
618
|
+
});
|
|
616
619
|
}
|
|
617
620
|
else {
|
|
618
|
-
const fallback = (
|
|
621
|
+
const fallback = (_f = (_e = config.strategies.loading) === null || _e === void 0 ? void 0 : _e.sortStabilizationFallbackDelay) !== null && _f !== void 0 ? _f : 200;
|
|
619
622
|
await rootLocator.page().waitForTimeout(fallback);
|
|
620
623
|
}
|
|
621
624
|
await (0, debugUtils_1.debugDelay)(config, 'default');
|
|
@@ -767,10 +770,14 @@ const useTable = (rootLocator, configOptions = {}) => {
|
|
|
767
770
|
await _handlePrompt('Smart Table Config', content);
|
|
768
771
|
},
|
|
769
772
|
generateConfigPrompt: async () => {
|
|
770
|
-
|
|
773
|
+
(0, debugUtils_1.logDebug)(config, 'error', 'generateConfigPrompt() is deprecated and will be removed in v7.0.0. Please use generateConfig() instead.');
|
|
771
774
|
return result.generateConfig();
|
|
772
775
|
},
|
|
773
776
|
};
|
|
777
|
+
Object.defineProperty(result, pageIndex_1.SET_CURRENT_PAGE_INDEX, {
|
|
778
|
+
value: (v) => { tableState.currentPageIndex = v; },
|
|
779
|
+
enumerable: false,
|
|
780
|
+
});
|
|
774
781
|
createStrategyContext = () => ({
|
|
775
782
|
root: rootLocator,
|
|
776
783
|
config,
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { Page } from '@playwright/test';
|
|
2
|
+
import type { FinalTableConfig, TableContext } from '../types';
|
|
3
|
+
/**
|
|
4
|
+
* Poll `loading.isTableLoading` until false or timeout.
|
|
5
|
+
* Shared by countRows, findRow(s), and sort stabilization (#434).
|
|
6
|
+
*
|
|
7
|
+
* Timeout resolution (first defined wins):
|
|
8
|
+
* 1. Explicit `options.timeout` — e.g. the sort caller's stabilization timeout
|
|
9
|
+
* 2. `loadingTimeout` — general gate for any isTableLoading poll
|
|
10
|
+
* 3. 10_000 ms default
|
|
11
|
+
*/
|
|
12
|
+
export declare function waitWhileTableLoading(config: FinalTableConfig, context: TableContext, page: Page, label: string, options?: {
|
|
13
|
+
timeout?: number;
|
|
14
|
+
pollInterval?: number;
|
|
15
|
+
}): Promise<void>;
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.waitWhileTableLoading = waitWhileTableLoading;
|
|
4
|
+
const debugUtils_1 = require("./debugUtils");
|
|
5
|
+
/**
|
|
6
|
+
* Poll `loading.isTableLoading` until false or timeout.
|
|
7
|
+
* Shared by countRows, findRow(s), and sort stabilization (#434).
|
|
8
|
+
*
|
|
9
|
+
* Timeout resolution (first defined wins):
|
|
10
|
+
* 1. Explicit `options.timeout` — e.g. the sort caller's stabilization timeout
|
|
11
|
+
* 2. `loadingTimeout` — general gate for any isTableLoading poll
|
|
12
|
+
* 3. 10_000 ms default
|
|
13
|
+
*/
|
|
14
|
+
async function waitWhileTableLoading(config, context, page, label, options) {
|
|
15
|
+
var _a, _b, _c, _d, _e;
|
|
16
|
+
const isTableLoading = (_a = config.strategies.loading) === null || _a === void 0 ? void 0 : _a.isTableLoading;
|
|
17
|
+
if (!isTableLoading)
|
|
18
|
+
return;
|
|
19
|
+
const loading = config.strategies.loading;
|
|
20
|
+
const timeout = (_c = (_b = options === null || options === void 0 ? void 0 : options.timeout) !== null && _b !== void 0 ? _b : loading.loadingTimeout) !== null && _c !== void 0 ? _c : 10000;
|
|
21
|
+
const poll = (_e = (_d = options === null || options === void 0 ? void 0 : options.pollInterval) !== null && _d !== void 0 ? _d : loading.sortStabilizationPollInterval) !== null && _e !== void 0 ? _e : 200;
|
|
22
|
+
const deadline = Date.now() + timeout;
|
|
23
|
+
while (Date.now() < deadline) {
|
|
24
|
+
let timer;
|
|
25
|
+
try {
|
|
26
|
+
// A custom predicate may never settle. Stop waiting when the budget expires;
|
|
27
|
+
// Promise.race also handles any later rejection from that predicate.
|
|
28
|
+
const expired = new Promise(resolve => {
|
|
29
|
+
timer = setTimeout(() => resolve(false), Math.max(0, deadline - Date.now()));
|
|
30
|
+
});
|
|
31
|
+
if (!(await Promise.race([isTableLoading(context), expired])))
|
|
32
|
+
return;
|
|
33
|
+
}
|
|
34
|
+
finally {
|
|
35
|
+
clearTimeout(timer);
|
|
36
|
+
}
|
|
37
|
+
const remaining = deadline - Date.now();
|
|
38
|
+
if (remaining <= 0)
|
|
39
|
+
return;
|
|
40
|
+
(0, debugUtils_1.logDebug)(config, 'verbose', `${label}: table is loading... waiting`);
|
|
41
|
+
await page.waitForTimeout(Math.min(poll, remaining));
|
|
42
|
+
}
|
|
43
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Internal setter for `table.currentPageIndex` used by library navigation
|
|
3
|
+
* (bringIntoView path planner, etc.) so the public setter can warn on
|
|
4
|
+
* external writes without spamming on every library update (#434).
|
|
5
|
+
*/
|
|
6
|
+
export declare const SET_CURRENT_PAGE_INDEX: unique symbol;
|
|
7
|
+
export type PageIndexWritable = {
|
|
8
|
+
currentPageIndex: number;
|
|
9
|
+
[SET_CURRENT_PAGE_INDEX]?: (n: number) => void;
|
|
10
|
+
};
|
|
11
|
+
/** Prefer the internal setter when present; fall back to the public property. */
|
|
12
|
+
export declare function setCurrentPageIndex(table: PageIndexWritable, n: number): void;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SET_CURRENT_PAGE_INDEX = void 0;
|
|
4
|
+
exports.setCurrentPageIndex = setCurrentPageIndex;
|
|
5
|
+
/**
|
|
6
|
+
* Internal setter for `table.currentPageIndex` used by library navigation
|
|
7
|
+
* (bringIntoView path planner, etc.) so the public setter can warn on
|
|
8
|
+
* external writes without spamming on every library update (#434).
|
|
9
|
+
*/
|
|
10
|
+
exports.SET_CURRENT_PAGE_INDEX = Symbol.for('playwright-smart-table.setCurrentPageIndex');
|
|
11
|
+
/** Prefer the internal setter when present; fall back to the public property. */
|
|
12
|
+
function setCurrentPageIndex(table, n) {
|
|
13
|
+
const internal = table[exports.SET_CURRENT_PAGE_INDEX];
|
|
14
|
+
if (typeof internal === 'function') {
|
|
15
|
+
internal(n);
|
|
16
|
+
return;
|
|
17
|
+
}
|
|
18
|
+
table.currentPageIndex = n;
|
|
19
|
+
}
|