@rickcedwhat/playwright-smart-table 6.9.0 → 6.10.1

package/README.md

@@ -43,8 +43,11 @@ const email = await row.locator('td').nth(emailIndex).textContent();
 const row = table.getRow({ Name: 'John Doe' });
 const email = await row.getCell('Email').textContent();
 
-// ✅ Auto-pagination across all pages
-const allEngineers = await table.findRows({ Department: 'Engineering' });
+// ✅ Pagination-aware when you raise maxPages
+const allEngineers = await table.findRows(
+  { Department: 'Engineering' },
+  { maxPages: 5 }
+);
 
 // ✅ Type-safe
 type Employee = { Name: string; Email: string; Department: string };
@@ -72,8 +75,8 @@ const row = table.getRow({ Name: 'John Doe' });
 // Access cells by column name
 const email = await row.getCell('Email').innerText();
 
-// Search across paginated tables
-const allActive = await table.findRows({ Status: 'Active' });
+// Search more than the current page by raising maxPages
+const allActive = await table.findRows({ Status: 'Active' }, { maxPages: 5 });
 ```
 
 ### Iterating Across Pages
@@ -163,9 +166,9 @@ const table = useTable(page.locator('#table'), {
 - 🎯 **Smart Locators** - Find rows by content, not position
 - 🧠 **Fuzzy Matching** - Smart suggestions for typos in column names
 - ⚡ **Smart Initialization** - Handles loading states and dynamic headers automatically
-- 📄 **Auto-Pagination** - Search across all pages automatically
+- 📄 **Pagination-aware search** - Scan beyond the current page when `maxPages` is increased
 - 🔍 **Column-Aware Access** - Access cells by column name
-- 🔁 **Iteration Methods** - `forEach`, `map`, `filter`, and `for await...of` across all pages
+- 🔁 **Iteration Methods** - `forEach`, `map`, `filter`, and `for await...of` across the configured page range
 - 🛠️ **Debug Mode** - Visual debugging with slow motion and logging
 - 🔌 **[Extensible Strategies](docs/concepts/strategies.md)** - Support any table implementation
 - 💪 **Type-Safe** - Full TypeScript support

package/dist/engine/rowFinder.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RowFinder = void 0;
 const debugUtils_1 = require("../utils/debugUtils");
@@ -28,175 +19,169 @@ class RowFinder {
     log(msg) {
         (0, debugUtils_1.logDebug)(this.config, 'verbose', msg);
     }
-    findRow(filters_1) {
-        return __awaiter(this, arguments, void 0, function* (filters, options = {}) {
-            (0, debugUtils_1.logDebug)(this.config, 'info', 'Searching for row', filters);
-            yield this.tableMapper.getMap();
-            const rowLocator = yield this.findRowLocator(filters, options);
-            if (rowLocator) {
-                (0, debugUtils_1.logDebug)(this.config, 'info', 'Row found');
-                yield (0, debugUtils_1.debugDelay)(this.config, 'findRow');
-                return this.makeSmartRow(rowLocator, yield this.tableMapper.getMap(), 0);
-            }
-            (0, debugUtils_1.logDebug)(this.config, 'error', 'Row not found', filters);
-            yield (0, debugUtils_1.debugDelay)(this.config, 'findRow');
-            const sentinel = this.resolve(this.config.rowSelector, this.rootLocator)
-                .filter({ hasText: "___SENTINEL_ROW_NOT_FOUND___" + Date.now() });
-            const smartRow = this.makeSmartRow(sentinel, yield this.tableMapper.getMap(), 0);
-            smartRow[sentinel_1.SENTINEL_ROW] = true;
-            return smartRow;
-        });
+    async findRow(filters, options = {}) {
+        (0, debugUtils_1.logDebug)(this.config, 'info', 'Searching for row', filters);
+        await this.tableMapper.getMap();
+        const rowLocator = await this.findRowLocator(filters, options);
+        if (rowLocator) {
+            (0, debugUtils_1.logDebug)(this.config, 'info', 'Row found');
+            await (0, debugUtils_1.debugDelay)(this.config, 'findRow');
+            return this.makeSmartRow(rowLocator, await this.tableMapper.getMap(), 0);
+        }
+        (0, debugUtils_1.logDebug)(this.config, 'error', 'Row not found', filters);
+        await (0, debugUtils_1.debugDelay)(this.config, 'findRow');
+        const sentinel = this.resolve(this.config.rowSelector, this.rootLocator)
+            .filter({ hasText: "___SENTINEL_ROW_NOT_FOUND___" + Date.now() });
+        const smartRow = this.makeSmartRow(sentinel, await this.tableMapper.getMap(), 0);
+        smartRow[sentinel_1.SENTINEL_ROW] = true;
+        return smartRow;
     }
-    findRows() {
-        return __awaiter(this, arguments, void 0, function* (filters = {}, options) {
-            var _a, _b, _c, _d;
-            const filtersRecord = filters;
-            const map = yield this.tableMapper.getMap();
-            const allRows = [];
-            const effectiveMaxPages = (_b = (_a = options === null || options === void 0 ? void 0 : options.maxPages) !== null && _a !== void 0 ? _a : this.config.maxPages) !== null && _b !== void 0 ? _b : Infinity;
-            let pagesScanned = 1;
-            this.log(`findRows: starting (maxPages=${effectiveMaxPages}, filters=${JSON.stringify(filtersRecord)})`);
-            const tracker = new elementTracker_1.ElementTracker('findRows');
-            try {
-                const collectMatches = () => __awaiter(this, void 0, void 0, function* () {
-                    var _a, _b;
-                    let rowLocators = this.resolve(this.config.rowSelector, this.rootLocator);
-                    // Only apply filters if we have them
-                    if (Object.keys(filtersRecord).length > 0) {
-                        rowLocators = this.filterEngine.applyFilters(rowLocators, filtersRecord, map, (_a = options === null || options === void 0 ? void 0 : options.exact) !== null && _a !== void 0 ? _a : false, this.rootLocator.page(), this.rootLocator);
-                    }
-                    // Get only newly seen matched rows
-                    const newIndices = yield tracker.getUnseenIndices(rowLocators);
-                    const currentRows = yield rowLocators.all();
-                    const isRowLoading = (_b = this.config.strategies.loading) === null || _b === void 0 ? void 0 : _b.isRowLoading;
-                    let added = 0;
-                    for (const idx of newIndices) {
-                        const smartRow = this.makeSmartRow(currentRows[idx], map, allRows.length, this.tableState.currentPageIndex);
-                        if (isRowLoading && (yield isRowLoading(smartRow))) {
-                            this.log(`findRows: page ${this.tableState.currentPageIndex} — row skipped (isRowLoading=true)`);
-                            continue;
-                        }
-                        allRows.push(smartRow);
-                        added++;
-                    }
-                    this.log(`findRows: page ${this.tableState.currentPageIndex} — ${added} new match(es) (total: ${allRows.length})`);
-                });
-                // Scan first page
-                yield collectMatches();
-                // Pagination Loop
-                while (pagesScanned < effectiveMaxPages && this.config.strategies.pagination) {
-                    const context = {
-                        root: this.rootLocator,
-                        config: this.config,
-                        resolve: this.resolve,
-                        page: this.rootLocator.page()
-                    };
-                    let paginationResult;
-                    if ((_c = this.config.strategies.pagination) === null || _c === void 0 ? void 0 : _c.goNextBulk) {
-                        paginationResult = yield this.config.strategies.pagination.goNextBulk(context);
-                    }
-                    else if ((_d = this.config.strategies.pagination) === null || _d === void 0 ? void 0 : _d.goNext) {
-                        paginationResult = yield this.config.strategies.pagination.goNext(context);
-                    }
-                    else {
-                        this.log(`findRows: no pagination primitive — stopping`);
-                        break;
-                    }
-                    const didPaginate = (0, validation_1.validatePaginationResult)(paginationResult, 'Pagination Strategy');
-                    if (!didPaginate) {
-                        this.log(`findRows: pagination returned false — end of data`);
-                        break;
+    async findRows(filters = {}, options) {
+        var _a, _b, _c, _d;
+        const filtersRecord = filters;
+        const map = await this.tableMapper.getMap();
+        const allRows = [];
+        const effectiveMaxPages = (_b = (_a = options === null || options === void 0 ? void 0 : options.maxPages) !== null && _a !== void 0 ? _a : this.config.maxPages) !== null && _b !== void 0 ? _b : Infinity;
+        let pagesScanned = 1;
+        this.log(`findRows: starting (maxPages=${effectiveMaxPages}, filters=${JSON.stringify(filtersRecord)})`);
+        const tracker = new elementTracker_1.ElementTracker('findRows');
+        try {
+            const collectMatches = async () => {
+                var _a, _b;
+                let rowLocators = this.resolve(this.config.rowSelector, this.rootLocator);
+                // Only apply filters if we have them
+                if (Object.keys(filtersRecord).length > 0) {
+                    rowLocators = this.filterEngine.applyFilters(rowLocators, filtersRecord, map, (_a = options === null || options === void 0 ? void 0 : options.exact) !== null && _a !== void 0 ? _a : false, this.rootLocator.page(), this.rootLocator);
+                }
+                // Get only newly seen matched rows
+                const newIndices = await tracker.getUnseenIndices(rowLocators);
+                const currentRows = await rowLocators.all();
+                const isRowLoading = (_b = this.config.strategies.loading) === null || _b === void 0 ? void 0 : _b.isRowLoading;
+                let added = 0;
+                for (const idx of newIndices) {
+                    const smartRow = this.makeSmartRow(currentRows[idx], map, allRows.length, this.tableState.currentPageIndex);
+                    if (isRowLoading && await isRowLoading(smartRow)) {
+                        this.log(`findRows: page ${this.tableState.currentPageIndex} — row skipped (isRowLoading=true)`);
+                        continue;
                     }
-                    const pagesJumped = typeof paginationResult === 'number' ? paginationResult : 1;
-                    this.tableState.currentPageIndex += pagesJumped;
-                    pagesScanned += pagesJumped;
-                    this.log(`findRows: advanced ${pagesJumped} page(s), now at page ${this.tableState.currentPageIndex}`);
-                    yield collectMatches();
+                    allRows.push(smartRow);
+                    added++;
                 }
+                this.log(`findRows: page ${this.tableState.currentPageIndex} — ${added} new match(es) (total: ${allRows.length})`);
+            };
+            // Scan first page
+            await collectMatches();
+            // Pagination Loop
+            while (pagesScanned < effectiveMaxPages && this.config.strategies.pagination) {
+                const context = {
+                    root: this.rootLocator,
+                    config: this.config,
+                    resolve: this.resolve,
+                    page: this.rootLocator.page()
+                };
+                let paginationResult;
+                if ((_c = this.config.strategies.pagination) === null || _c === void 0 ? void 0 : _c.goNextBulk) {
+                    paginationResult = await this.config.strategies.pagination.goNextBulk(context);
+                }
+                else if ((_d = this.config.strategies.pagination) === null || _d === void 0 ? void 0 : _d.goNext) {
+                    paginationResult = await this.config.strategies.pagination.goNext(context);
+                }
+                else {
+                    this.log(`findRows: no pagination primitive — stopping`);
+                    break;
+                }
+                const didPaginate = (0, validation_1.validatePaginationResult)(paginationResult, 'Pagination Strategy');
+                if (!didPaginate) {
+                    this.log(`findRows: pagination returned false — end of data`);
+                    break;
+                }
+                const pagesJumped = typeof paginationResult === 'number' ? paginationResult : 1;
+                this.tableState.currentPageIndex += pagesJumped;
+                pagesScanned += pagesJumped;
+                this.log(`findRows: advanced ${pagesJumped} page(s), now at page ${this.tableState.currentPageIndex}`);
+                await collectMatches();
             }
-            finally {
-                yield tracker.cleanup(this.rootLocator.page());
-            }
-            this.log(`findRows: done — ${allRows.length} row(s) collected across ${pagesScanned} page(s)`);
-            return (0, smartRowArray_1.createSmartRowArray)(allRows);
-        });
+        }
+        finally {
+            await tracker.cleanup(this.rootLocator.page());
+        }
+        this.log(`findRows: done — ${allRows.length} row(s) collected across ${pagesScanned} page(s)`);
+        return (0, smartRowArray_1.createSmartRowArray)(allRows);
     }
-    findRowLocator(filters_1) {
-        return __awaiter(this, arguments, void 0, function* (filters, options = {}) {
-            var _a, _b, _c, _d;
-            const map = yield this.tableMapper.getMap();
-            const effectiveMaxPages = (_a = options.maxPages) !== null && _a !== void 0 ? _a : this.config.maxPages;
-            let pagesScanned = 1;
-            this.log(`Looking for row: ${JSON.stringify(filters)} (MaxPages: ${effectiveMaxPages})`);
-            while (true) {
-                // Check Loading
-                if ((_b = this.config.strategies.loading) === null || _b === void 0 ? void 0 : _b.isTableLoading) {
-                    const isLoading = yield this.config.strategies.loading.isTableLoading({
-                        root: this.rootLocator,
-                        config: this.config,
-                        page: this.rootLocator.page(),
-                        resolve: this.resolve
-                    });
-                    if (isLoading) {
-                        this.log('Table is loading... waiting');
-                        yield this.rootLocator.page().waitForTimeout(200);
-                        continue;
-                    }
+    async findRowLocator(filters, options = {}) {
+        var _a, _b, _c, _d;
+        const map = await this.tableMapper.getMap();
+        const effectiveMaxPages = (_a = options.maxPages) !== null && _a !== void 0 ? _a : this.config.maxPages;
+        let pagesScanned = 1;
+        this.log(`Looking for row: ${JSON.stringify(filters)} (MaxPages: ${effectiveMaxPages})`);
+        while (true) {
+            // Check Loading
+            if ((_b = this.config.strategies.loading) === null || _b === void 0 ? void 0 : _b.isTableLoading) {
+                const isLoading = await this.config.strategies.loading.isTableLoading({
+                    root: this.rootLocator,
+                    config: this.config,
+                    page: this.rootLocator.page(),
+                    resolve: this.resolve
+                });
+                if (isLoading) {
+                    this.log('Table is loading... waiting');
+                    await this.rootLocator.page().waitForTimeout(200);
+                    continue;
                 }
-                const allRows = this.resolve(this.config.rowSelector, this.rootLocator);
-                const matchedRows = this.filterEngine.applyFilters(allRows, filters, map, options.exact || false, this.rootLocator.page(), this.rootLocator);
-                const count = yield matchedRows.count();
-                this.log(`Page ${this.tableState.currentPageIndex}: Found ${count} matches.`);
-                if (count > 1) {
-                    const sampleData = [];
-                    try {
-                        const firstFewRows = yield matchedRows.all();
-                        const sampleCount = Math.min(firstFewRows.length, 3);
-                        for (let i = 0; i < sampleCount; i++) {
-                            const rowData = yield this.makeSmartRow(firstFewRows[i], map, 0, this.tableState.currentPageIndex).toJSON();
-                            sampleData.push(JSON.stringify(rowData));
-                        }
+            }
+            const allRows = this.resolve(this.config.rowSelector, this.rootLocator);
+            const matchedRows = this.filterEngine.applyFilters(allRows, filters, map, options.exact || false, this.rootLocator.page(), this.rootLocator);
+            const count = await matchedRows.count();
+            this.log(`Page ${this.tableState.currentPageIndex}: Found ${count} matches.`);
+            if (count > 1) {
+                const sampleData = [];
+                try {
+                    const firstFewRows = await matchedRows.all();
+                    const sampleCount = Math.min(firstFewRows.length, 3);
+                    for (let i = 0; i < sampleCount; i++) {
+                        const rowData = await this.makeSmartRow(firstFewRows[i], map, 0, this.tableState.currentPageIndex).toJSON();
+                        sampleData.push(JSON.stringify(rowData));
                     }
-                    catch (e) { }
-                    const sampleMsg = sampleData.length > 0 ? `\nSample matching rows:\n${sampleData.map((d, i) => `  ${i + 1}. ${d}`).join('\n')}` : '';
-                    throw new Error(`Ambiguous Row: Found ${count} rows matching ${JSON.stringify(filters)} on page ${this.tableState.currentPageIndex}. ` +
-                        `Expected exactly one match. Try adding more filters to make your query unique.${sampleMsg}`);
                 }
-                if (count === 1)
-                    return matchedRows.first();
-                if (pagesScanned < effectiveMaxPages) {
-                    this.log(`Page ${this.tableState.currentPageIndex}: Not found. Attempting pagination...`);
-                    const context = {
-                        root: this.rootLocator,
-                        config: this.config,
-                        resolve: this.resolve,
-                        page: this.rootLocator.page()
-                    };
-                    let paginationResult;
-                    if ((_c = this.config.strategies.pagination) === null || _c === void 0 ? void 0 : _c.goNextBulk) {
-                        paginationResult = yield this.config.strategies.pagination.goNextBulk(context);
-                    }
-                    else if ((_d = this.config.strategies.pagination) === null || _d === void 0 ? void 0 : _d.goNext) {
-                        paginationResult = yield this.config.strategies.pagination.goNext(context);
-                    }
-                    else {
-                        this.log(`Page ${this.tableState.currentPageIndex}: Pagination failed (no goNext or goNextBulk primitive).`);
-                        return null;
-                    }
-                    const didLoadMore = (0, validation_1.validatePaginationResult)(paginationResult, 'Pagination Strategy');
-                    if (didLoadMore) {
-                        const pagesJumped = typeof paginationResult === 'number' ? paginationResult : 1;
-                        this.tableState.currentPageIndex += pagesJumped;
-                        pagesScanned += pagesJumped;
-                        continue;
-                    }
-                    else {
-                        this.log(`Page ${this.tableState.currentPageIndex}: Pagination failed (end of data).`);
-                    }
+                catch (e) { }
+                const sampleMsg = sampleData.length > 0 ? `\nSample matching rows:\n${sampleData.map((d, i) => `  ${i + 1}. ${d}`).join('\n')}` : '';
+                throw new Error(`Ambiguous Row: Found ${count} rows matching ${JSON.stringify(filters)} on page ${this.tableState.currentPageIndex}. ` +
+                    `Expected exactly one match. Try adding more filters to make your query unique.${sampleMsg}`);
+            }
+            if (count === 1)
+                return matchedRows.first();
+            if (pagesScanned < effectiveMaxPages) {
+                this.log(`Page ${this.tableState.currentPageIndex}: Not found. Attempting pagination...`);
+                const context = {
+                    root: this.rootLocator,
+                    config: this.config,
+                    resolve: this.resolve,
+                    page: this.rootLocator.page()
+                };
+                let paginationResult;
+                if ((_c = this.config.strategies.pagination) === null || _c === void 0 ? void 0 : _c.goNextBulk) {
+                    paginationResult = await this.config.strategies.pagination.goNextBulk(context);
+                }
+                else if ((_d = this.config.strategies.pagination) === null || _d === void 0 ? void 0 : _d.goNext) {
+                    paginationResult = await this.config.strategies.pagination.goNext(context);
+                }
+                else {
+                    this.log(`Page ${this.tableState.currentPageIndex}: Pagination failed (no goNext or goNextBulk primitive).`);
+                    return null;
+                }
+                const didLoadMore = (0, validation_1.validatePaginationResult)(paginationResult, 'Pagination Strategy');
+                if (didLoadMore) {
+                    const pagesJumped = typeof paginationResult === 'number' ? paginationResult : 1;
+                    this.tableState.currentPageIndex += pagesJumped;
+                    pagesScanned += pagesJumped;
+                    continue;
+                }
+                else {
+                    this.log(`Page ${this.tableState.currentPageIndex}: Pagination failed (end of data).`);
                 }
-                return null;
             }
-        });
+            return null;
+        }
     }
 }
 exports.RowFinder = RowFinder;