@rickcedwhat/playwright-smart-table 2.0.7 → 2.0.9

package/dist/strategies/index.d.ts

@@ -2,29 +2,14 @@ import { PaginationStrategy, Selector } from '../types';
 export declare const TableStrategies: {
     /**
      * Strategy: Clicks a "Next" button and waits for the first row of data to change.
-     * Best for: Standard pagination (Page 1 > Page 2 > Page 3)
-     * * @param nextButtonSelector - Selector for the next button (e.g. 'button.next' or getByRole('button', {name: 'Next'}))
-     * @param timeout - How long to wait for the table to refresh (default: 5000ms)
      */
     clickNext: (nextButtonSelector: Selector, timeout?: number) => PaginationStrategy;
     /**
      * Strategy: Clicks a "Load More" button and waits for the row count to increase.
-     * Best for: Lists where "Load More" appends data to the bottom.
-     * * @param buttonSelector - Selector for the load more button
-     * @param timeout - Wait timeout (default: 5000ms)
      */
     clickLoadMore: (buttonSelector: Selector, timeout?: number) => PaginationStrategy;
     /**
-     * Strategy: Scrolls a specific container (or the window) to the bottom.
-     * Best for: Infinite Scroll grids (Ag-Grid, Virtual Lists)
-     * * @param options.timeout - Wait timeout (default: 5000ms)
-     * @param options.scrollerSelector - (Optional) Selector for the scrollable container.
-     * If omitted, tries to scroll the table root.
-     * @param options.interval - (Optional) Polling interval in ms (default: 1000ms)
+     * Strategy: Scrolls to the bottom and waits for more rows to appear.
      */
-    infiniteScroll: (options?: {
-        timeout?: number;
-        scrollerSelector?: Selector;
-        interval?: number;
-    }) => PaginationStrategy;
+    infiniteScroll: (timeout?: number) => PaginationStrategy;
 };

package/dist/strategies/index.js

@@ -10,118 +10,88 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TableStrategies = void 0;
-// src/strategies/index.ts
-const test_1 = require("@playwright/test");
+/**
+ * Internal helper to wait for a condition to be met.
+ * Replaces the dependency on 'expect(...).toPass()' to ensure compatibility
+ * with environments like QA Wolf where 'expect' is not globally available.
+ */
+const waitForCondition = (predicate, timeout, page // Context page for pauses
+) => __awaiter(void 0, void 0, void 0, function* () {
+    const startTime = Date.now();
+    while (Date.now() - startTime < timeout) {
+        if (yield predicate()) {
+            return true;
+        }
+        // Wait 100ms before next check (Standard Polling)
+        yield page.waitForTimeout(100).catch(() => new Promise(r => setTimeout(r, 100)));
+    }
+    return false;
+});
 exports.TableStrategies = {
     /**
      * Strategy: Clicks a "Next" button and waits for the first row of data to change.
-     * Best for: Standard pagination (Page 1 > Page 2 > Page 3)
-     * * @param nextButtonSelector - Selector for the next button (e.g. 'button.next' or getByRole('button', {name: 'Next'}))
-     * @param timeout - How long to wait for the table to refresh (default: 5000ms)
      */
     clickNext: (nextButtonSelector, timeout = 5000) => {
-        return (_a) => __awaiter(void 0, [_a], void 0, function* ({ root, config, resolve }) {
-            // 1. Find the button using the table's helper
+        return (_a) => __awaiter(void 0, [_a], void 0, function* ({ root, config, resolve, page }) {
             const nextBtn = resolve(nextButtonSelector, root).first();
-            // If button isn't there or disabled, we are at the end
+            // Check if button exists/enabled before clicking
             if (!(yield nextBtn.isVisible()) || !(yield nextBtn.isEnabled())) {
                 return false;
             }
-            // 2. Snapshot the current state (text of the first row)
-            // We use the table's OWN row selector to ensure we are looking at real data
+            // 1. Snapshot current state
             const firstRow = resolve(config.rowSelector, root).first();
-            const oldText = yield firstRow.innerText().catch(() => ""); // Handle empty tables gracefully
-            // 3. Click the button
+            const oldText = yield firstRow.innerText().catch(() => "");
+            // 2. Click
             yield nextBtn.click();
-            // 4. Smart Wait: Wait for the first row to have DIFFERENT text
-            try {
-                yield (0, test_1.expect)(firstRow).not.toHaveText(oldText, { timeout });
-                return true; // Success: Data changed
-            }
-            catch (e) {
-                return false; // Failed: Timed out (probably end of data or broken button)
-            }
+            // 3. Smart Wait (Polling) - No 'expect' needed
+            return yield waitForCondition(() => __awaiter(void 0, void 0, void 0, function* () {
+                const newText = yield firstRow.innerText().catch(() => "");
+                return newText !== oldText;
+            }), timeout, page);
         });
     },
     /**
      * Strategy: Clicks a "Load More" button and waits for the row count to increase.
-     * Best for: Lists where "Load More" appends data to the bottom.
-     * * @param buttonSelector - Selector for the load more button
-     * @param timeout - Wait timeout (default: 5000ms)
      */
     clickLoadMore: (buttonSelector, timeout = 5000) => {
-        return (_a) => __awaiter(void 0, [_a], void 0, function* ({ root, config, resolve }) {
+        return (_a) => __awaiter(void 0, [_a], void 0, function* ({ root, config, resolve, page }) {
             const loadMoreBtn = resolve(buttonSelector, root).first();
             if (!(yield loadMoreBtn.isVisible()) || !(yield loadMoreBtn.isEnabled())) {
                 return false;
             }
-            // 1. Snapshot: Count current rows
+            // 1. Snapshot count
             const rows = resolve(config.rowSelector, root);
             const oldCount = yield rows.count();
             // 2. Click
             yield loadMoreBtn.click();
-            // 3. Smart Wait: Wait for row count to be greater than before
-            try {
-                yield (0, test_1.expect)(() => __awaiter(void 0, void 0, void 0, function* () {
-                    const newCount = yield rows.count();
-                    (0, test_1.expect)(newCount).toBeGreaterThan(oldCount);
-                })).toPass({ timeout });
-                return true;
-            }
-            catch (e) {
-                return false;
-            }
+            // 3. Smart Wait (Polling)
+            return yield waitForCondition(() => __awaiter(void 0, void 0, void 0, function* () {
+                const newCount = yield rows.count();
+                return newCount > oldCount;
+            }), timeout, page);
         });
     },
     /**
-     * Strategy: Scrolls a specific container (or the window) to the bottom.
-     * Best for: Infinite Scroll grids (Ag-Grid, Virtual Lists)
-     * * @param options.timeout - Wait timeout (default: 5000ms)
-     * @param options.scrollerSelector - (Optional) Selector for the scrollable container.
-     * If omitted, tries to scroll the table root.
-     * @param options.interval - (Optional) Polling interval in ms (default: 1000ms)
+     * Strategy: Scrolls to the bottom and waits for more rows to appear.
      */
-    infiniteScroll: (options) => {
-        const { timeout = 5000, scrollerSelector, interval = 1000 } = options || {};
+    infiniteScroll: (timeout = 5000) => {
         return (_a) => __awaiter(void 0, [_a], void 0, function* ({ root, config, resolve, page }) {
             const rows = resolve(config.rowSelector, root);
             const oldCount = yield rows.count();
             if (oldCount === 0)
                 return false;
-            // Aggressive Scroll Logic:
-            // We use expect.poll to RETRY the scroll action if the count hasn't increased.
-            // This fixes flakiness where the first scroll might be missed by the intersection observer.
+            // 1. Trigger Scroll
+            yield rows.last().scrollIntoViewIfNeeded();
+            // Optional: Keyboard press for robust grid handling
             try {
-                yield test_1.expect.poll(() => __awaiter(void 0, void 0, void 0, function* () {
-                    // 1. Determine target container
-                    // If user provided a specific scroller (e.g. the div WRAPPING the table), use it.
-                    // Otherwise, default to the root locator.
-                    const scroller = scrollerSelector
-                        ? resolve(scrollerSelector, root)
-                        : root;
-                    // 2. Perform the Scroll
-                    // Method A: DOM Manipulation (Fastest/Most Reliable for containers)
-                    // We set scrollTop to a huge number to force it to the bottom
-                    yield scroller.evaluate((el) => {
-                        el.scrollTop = el.scrollHeight;
-                    }).catch(() => { }); // Ignore if element doesn't support scrollTop (e.g. it's a window wrapper)
-                    // Method B: Playwright Native (Fallback)
-                    // Scroll the last row into view (good for Window scroll)
-                    yield rows.last().scrollIntoViewIfNeeded().catch(() => { });
-                    // Method C: Keyboard (Desperation)
-                    yield page.keyboard.press('End');
-                    // 3. Return count for assertion
-                    return rows.count();
-                }), {
-                    timeout,
-                    // ✅ FIX: Use user-provided interval (default 1000ms)
-                    intervals: [interval]
-                }).toBeGreaterThan(oldCount);
-                return true;
-            }
-            catch (e) {
-                return false;
+                yield page.keyboard.press('End');
             }
+            catch (e) { }
+            // 2. Smart Wait (Polling)
+            return yield waitForCondition(() => __awaiter(void 0, void 0, void 0, function* () {
+                const newCount = yield rows.count();
+                return newCount > oldCount;
+            }), timeout, page);
         });
     }
 };

package/dist/typeContext.d.ts

@@ -3,4 +3,4 @@
  * This file is generated by scripts/embed-types.js
  * It contains the raw text of types.ts to provide context for LLM prompts.
  */
-export declare const TYPE_CONTEXT = "\nexport type Selector = string | ((root: Locator | Page) => Locator);\n\nexport type SmartRow = Locator & {\n  getCell(column: string): Locator;\n  toJSON(): Promise<Record<string, string>>;\n};\n\nexport interface TableContext {\n  root: Locator;\n  config: Required<TableConfig>;\n  page: Page;\n  resolve: (selector: Selector, parent: Locator | Page) => Locator;\n}\n\nexport type PaginationStrategy = (context: TableContext) => Promise<boolean>;\n\nexport interface PromptOptions {\n  /**\n   * Output Strategy:\n   * - 'error': Throws an error with the prompt (Best for Cloud/QA Wolf to get clean text).\n   * - 'console': Standard console logs (Default).\n   * - 'report': Attaches to Playwright Report (Requires testInfo).\n   */\n  output?: 'console' | 'report' | 'error';\n  includeTypes?: boolean;\n  testInfo?: TestInfo;\n}\n\nexport interface TableConfig {\n  rowSelector?: Selector;\n  headerSelector?: Selector;\n  cellSelector?: Selector;\n  pagination?: PaginationStrategy;\n  maxPages?: number;\n  headerTransformer?: (text: string, index: number) => string;\n  autoScroll?: boolean;\n}\n\nexport interface TableResult {\n  getHeaders: () => Promise<string[]>;\n  getHeaderCell: (columnName: string) => Promise<Locator>;\n\n  getByRow: <T extends { asJSON?: boolean }>(\n    filters: Record<string, string | RegExp | number>, \n    options?: { exact?: boolean, maxPages?: number } & T\n  ) => Promise<T['asJSON'] extends true ? Record<string, string> : SmartRow>;\n\n  getAllRows: <T extends { asJSON?: boolean }>(\n    options?: { filter?: Record<string, any>, exact?: boolean } & T\n  ) => Promise<T['asJSON'] extends true ? Record<string, string>[] : SmartRow[]>;\n\n  generateConfigPrompt: (options?: PromptOptions) => Promise<void>;\n  generateStrategyPrompt: (options?: PromptOptions) => Promise<void>;\n}\n";
+export declare const TYPE_CONTEXT = "\nexport type Selector = string | ((root: Locator | Page) => Locator);\n\nexport type SmartRow = Locator & {\n  getCell(column: string): Locator;\n  toJSON(): Promise<Record<string, string>>;\n};\n\nexport interface TableContext {\n  root: Locator;\n  config: Required<TableConfig>;\n  page: Page;\n  resolve: (selector: Selector, parent: Locator | Page) => Locator;\n}\n\nexport type PaginationStrategy = (context: TableContext) => Promise<boolean>;\n\nexport interface PromptOptions {\n  /**\n   * Output Strategy:\n   * - 'error': Throws an error with the prompt (Best for Cloud/QA Wolf to get clean text).\n   * - 'console': Standard console logs (Default).\n   */\n  output?: 'console' | 'error';\n  includeTypes?: boolean;\n}\n\nexport interface TableConfig {\n  rowSelector?: Selector;\n  headerSelector?: Selector;\n  cellSelector?: Selector;\n  pagination?: PaginationStrategy;\n  maxPages?: number;\n  headerTransformer?: (text: string, index: number) => string;\n  autoScroll?: boolean;\n}\n\nexport interface TableResult {\n  getHeaders: () => Promise<string[]>;\n  getHeaderCell: (columnName: string) => Promise<Locator>;\n\n  getByRow: <T extends { asJSON?: boolean }>(\n    filters: Record<string, string | RegExp | number>, \n    options?: { exact?: boolean, maxPages?: number } & T\n  ) => Promise<T['asJSON'] extends true ? Record<string, string> : SmartRow>;\n\n  getAllRows: <T extends { asJSON?: boolean }>(\n    options?: { filter?: Record<string, any>, exact?: boolean } & T\n  ) => Promise<T['asJSON'] extends true ? Record<string, string>[] : SmartRow[]>;\n\n  generateConfigPrompt: (options?: PromptOptions) => Promise<void>;\n  generateStrategyPrompt: (options?: PromptOptions) => Promise<void>;\n}\n";

package/dist/typeContext.js

@@ -28,11 +28,9 @@ export interface PromptOptions {
    * Output Strategy:
    * - 'error': Throws an error with the prompt (Best for Cloud/QA Wolf to get clean text).
    * - 'console': Standard console logs (Default).
-   * - 'report': Attaches to Playwright Report (Requires testInfo).
    */
-  output?: 'console' | 'report' | 'error';
+  output?: 'console' | 'error';
   includeTypes?: boolean;
-  testInfo?: TestInfo;
 }
 
 export interface TableConfig {

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { Locator, Page, TestInfo } from '@playwright/test';
+import type { Locator, Page } from '@playwright/test';
 export type Selector = string | ((root: Locator | Page) => Locator);
 export type SmartRow = Locator & {
     getCell(column: string): Locator;
@@ -16,11 +16,9 @@ export interface PromptOptions {
      * Output Strategy:
      * - 'error': Throws an error with the prompt (Best for Cloud/QA Wolf to get clean text).
      * - 'console': Standard console logs (Default).
-     * - 'report': Attaches to Playwright Report (Requires testInfo).
      */
-    output?: 'console' | 'report' | 'error';
+    output?: 'console' | 'error';
     includeTypes?: boolean;
-    testInfo?: TestInfo;
 }
 export interface TableConfig {
     rowSelector?: Selector;

package/dist/useTable.d.ts

@@ -1,3 +1,3 @@
-import { Locator } from '@playwright/test';
+import type { Locator } from '@playwright/test';
 import { TableConfig, TableResult } from './types';
 export declare const useTable: (rootLocator: Locator, configOptions?: TableConfig) => TableResult;

package/dist/useTable.js

@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useTable = void 0;
-const test_1 = require("@playwright/test");
 const typeContext_1 = require("./typeContext");
 const useTable = (rootLocator, configOptions = {}) => {
     const config = Object.assign({ rowSelector: "tbody tr", headerSelector: "th", cellSelector: "td", pagination: () => __awaiter(void 0, void 0, void 0, function* () { return false; }), maxPages: 1, headerTransformer: (text) => text, autoScroll: true }, configOptions);
@@ -116,7 +115,7 @@ const useTable = (rootLocator, configOptions = {}) => {
         }
     });
     const _handlePrompt = (promptName_1, content_1, ...args_1) => __awaiter(void 0, [promptName_1, content_1, ...args_1], void 0, function* (promptName, content, options = {}) {
-        const { output = 'console', includeTypes = true, testInfo } = options;
+        const { output = 'console', includeTypes = true } = options;
         let finalPrompt = content;
         if (includeTypes) {
             finalPrompt += `\n\n👇 Useful TypeScript Definitions 👇\n\`\`\`typescript\n${typeContext_1.TYPE_CONTEXT}\n\`\`\`\n`;
@@ -125,23 +124,6 @@ const useTable = (rootLocator, configOptions = {}) => {
             console.log(`⚠️ Throwing error to display [${promptName}] cleanly...`);
             throw new Error(finalPrompt);
         }
-        if (output === 'report') {
-            let activeInfo = testInfo;
-            if (!activeInfo) {
-                try {
-                    activeInfo = test_1.test.info();
-                }
-                catch (e) { }
-            }
-            if (activeInfo) {
-                yield activeInfo.attach(promptName, { body: finalPrompt, contentType: 'text/markdown' });
-                console.log(`✅ [${promptName}] Attached to Playwright Report.`);
-                return;
-            }
-            else {
-                console.warn(`⚠️ [${promptName}] Cannot attach to report (Context unavailable). Logging to console instead.`);
-            }
-        }
         console.log(finalPrompt);
     });
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rickcedwhat/playwright-smart-table",
-  "version": "2.0.7",
+  "version": "2.0.9",
   "description": "A smart table utility for Playwright with built-in pagination strategies that are fully extensible.",
   "repository": {
     "type": "git",

package/dist/presets.d.ts

@@ -1,18 +0,0 @@
-import { Locator } from '@playwright/test';
-import { TableConfig } from './types';
-/**
- * Preset for Key-Value Forms.
- * * Default Structure:
- * - Row: div.form-group
- * - Cell: Direct children (> *)
- * - Columns: ['Label', 'Input']
- */
-export declare const useForm: (rootLocator: Locator, options?: TableConfig) => import("./types").TableResult;
-/**
- * Preset for Navigation Menus.
- * * Default Structure:
- * - Row: li
- * - Cell: null (The row IS the cell)
- * - Columns: ['Item']
- */
-export declare const useMenu: (menuLocator: Locator, options?: TableConfig) => import("./types").TableResult;

package/dist/presets.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useMenu = exports.useForm = void 0;
-const useTable_1 = require("./useTable");
-/**
- * Preset for Key-Value Forms.
- * * Default Structure:
- * - Row: div.form-group
- * - Cell: Direct children (> *)
- * - Columns: ['Label', 'Input']
- */
-const useForm = (rootLocator, options = {}) => {
-    return (0, useTable_1.useTable)(rootLocator, Object.assign({ 
-        // Defaults:
-        rowSelector: 'div.form-group', cellSelector: (row) => row.locator('> *'), headerSelector: null, columnNames: ['Label', 'Input'] }, options));
-};
-exports.useForm = useForm;
-/**
- * Preset for Navigation Menus.
- * * Default Structure:
- * - Row: li
- * - Cell: null (The row IS the cell)
- * - Columns: ['Item']
- */
-const useMenu = (menuLocator, options = {}) => {
-    return (0, useTable_1.useTable)(menuLocator, Object.assign({ 
-        // Defaults:
-        rowSelector: 'li', cellSelector: null, headerSelector: null, columnNames: ['Item'] }, options));
-};
-exports.useMenu = useMenu;