@rickcedwhat/playwright-smart-table 2.0.0 → 2.0.1

package/dist/strategies/index.js

@@ -84,16 +84,18 @@ exports.TableStrategies = {
             const oldCount = yield rows.count();
             if (oldCount === 0)
                 return false;
-            // 1. Scroll the very last row into view to trigger the fetch
-            yield rows.last().scrollIntoViewIfNeeded();
-            // Optional: Press "End" to force scroll on stubborn grids (like AG Grid)
-            yield page.keyboard.press('End');
-            // 2. Smart Wait: Wait for row count to increase
+            // 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.
             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 });
+                yield test_1.expect.poll(() => __awaiter(void 0, void 0, void 0, function* () {
+                    // 1. Trigger: Scroll the last row into view
+                    yield rows.last().scrollIntoViewIfNeeded();
+                    // 2. Force: Press "End" to help with stubborn window-scrollers
+                    yield page.keyboard.press('End');
+                    // 3. Return count for assertion
+                    return rows.count();
+                }), { timeout }).toBeGreaterThan(oldCount);
                 return true;
             }
             catch (e) {

package/dist/typeContext.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 🤖 AUTO-GENERATED FILE. DO NOT EDIT.
+ * 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 = "\n// src/types.ts\n\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\n/**\n * A function that handles pagination logic.\n * Returns true if more data was loaded (navigation occurred), false if end of data.\n */\nexport type PaginationStrategy = (context: TableContext) => Promise<boolean>;\n\nexport interface PromptOptions {\n  /** * Where to output the prompt.\n   * - 'console': Logs to stdout (default).\n   * - 'report': Attaches to the Playwright HTML report (best for CI/VMs).\n   * - 'file': Writes to a local file (e.g. 'smart-table-prompt.md').\n   */\n  output?: 'console' | 'report' | 'file';\n  \n  /**\n   * Include TypeScript interfaces in the prompt?\n   * Helps LLMs generate correct code structure.\n   * Default: true\n   */\n  includeTypes?: boolean;\n}\n\nexport interface TableConfig {\n  rowSelector?: Selector;\n  headerSelector?: Selector;\n  cellSelector?: Selector;\n  /**\n   * Strategy for handling pagination.\n   * Use presets from TableStrategies or write your own.\n   */\n  pagination?: PaginationStrategy;\n  maxPages?: number;\n  /**\n   * Optional hook to rename columns dynamically.\n   * Useful for naming empty columns (like '__col_0') to something semantic like 'Actions'.\n   */\n  headerTransformer?: (text: string, index: number) => string;\n  /**\n   * Automatically scroll the table into view on first interaction.\n   * Helps ensure the table is visible in traces/videos.\n   * Default: true\n   */\n  autoScroll?: boolean;\n}\n\nexport interface TableResult {\n  getHeaders: () => Promise<string[]>;\n  getHeaderCell: (columnName: string) => Promise<Locator>;\n\n  /** * Find a specific row by its content.\n   * Default: Returns SmartRow (Locator).\n   * Option { asJSON: true }: Returns Record<string, string> (Data).\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  /** * Get all rows on the current page.\n   * Can be filtered by column values.\n   * * @param options.asJSON - Returns data objects instead of SmartRows\n   * @param options.filter - Key-Value pairs to filter rows (e.g. { Status: 'Active' })\n   * @param options.exact - Exact match for filters (default: false)\n   */\n  getAllRows: <T extends { asJSON?: boolean }>(\n    options?: { \n      filter?: Record<string, string | RegExp | number>; \n      exact?: boolean \n    } & 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

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TYPE_CONTEXT = void 0;
+/**
+ * 🤖 AUTO-GENERATED FILE. DO NOT EDIT.
+ * This file is generated by scripts/embed-types.js
+ * It contains the raw text of types.ts to provide context for LLM prompts.
+ */
+exports.TYPE_CONTEXT = `
+// src/types.ts
+
+export type Selector = string | ((root: Locator | Page) => Locator);
+
+export type SmartRow = Locator & {
+  getCell(column: string): Locator;
+  toJSON(): Promise<Record<string, string>>;
+};
+
+export interface TableContext {
+  root: Locator;
+  config: Required<TableConfig>;
+  page: Page;
+  resolve: (selector: Selector, parent: Locator | Page) => Locator;
+}
+
+/**
+ * A function that handles pagination logic.
+ * Returns true if more data was loaded (navigation occurred), false if end of data.
+ */
+export type PaginationStrategy = (context: TableContext) => Promise<boolean>;
+
+export interface PromptOptions {
+  /** * Where to output the prompt.
+   * - 'console': Logs to stdout (default).
+   * - 'report': Attaches to the Playwright HTML report (best for CI/VMs).
+   * - 'file': Writes to a local file (e.g. 'smart-table-prompt.md').
+   */
+  output?: 'console' | 'report' | 'file';
+  
+  /**
+   * Include TypeScript interfaces in the prompt?
+   * Helps LLMs generate correct code structure.
+   * Default: true
+   */
+  includeTypes?: boolean;
+}
+
+export interface TableConfig {
+  rowSelector?: Selector;
+  headerSelector?: Selector;
+  cellSelector?: Selector;
+  /**
+   * Strategy for handling pagination.
+   * Use presets from TableStrategies or write your own.
+   */
+  pagination?: PaginationStrategy;
+  maxPages?: number;
+  /**
+   * Optional hook to rename columns dynamically.
+   * Useful for naming empty columns (like '__col_0') to something semantic like 'Actions'.
+   */
+  headerTransformer?: (text: string, index: number) => string;
+  /**
+   * Automatically scroll the table into view on first interaction.
+   * Helps ensure the table is visible in traces/videos.
+   * Default: true
+   */
+  autoScroll?: boolean;
+}
+
+export interface TableResult {
+  getHeaders: () => Promise<string[]>;
+  getHeaderCell: (columnName: string) => Promise<Locator>;
+
+  /** * Find a specific row by its content.
+   * Default: Returns SmartRow (Locator).
+   * Option { asJSON: true }: Returns Record<string, string> (Data).
+   */
+  getByRow: <T extends { asJSON?: boolean }>(
+    filters: Record<string, string | RegExp | number>, 
+    options?: { exact?: boolean, maxPages?: number } & T
+  ) => Promise<T['asJSON'] extends true ? Record<string, string> : SmartRow>;
+
+  /** * Get all rows on the current page.
+   * Can be filtered by column values.
+   * * @param options.asJSON - Returns data objects instead of SmartRows
+   * @param options.filter - Key-Value pairs to filter rows (e.g. { Status: 'Active' })
+   * @param options.exact - Exact match for filters (default: false)
+   */
+  getAllRows: <T extends { asJSON?: boolean }>(
+    options?: { 
+      filter?: Record<string, string | RegExp | number>; 
+      exact?: boolean 
+    } & T
+  ) => Promise<T['asJSON'] extends true ? Record<string, string>[] : SmartRow[]>;
+
+  generateConfigPrompt: (options?: PromptOptions) => Promise<void>;
+  generateStrategyPrompt: (options?: PromptOptions) => Promise<void>;
+}
+`;

package/dist/types.d.ts

@@ -15,6 +15,20 @@ export interface TableContext {
  * Returns true if more data was loaded (navigation occurred), false if end of data.
  */
 export type PaginationStrategy = (context: TableContext) => Promise<boolean>;
+export interface PromptOptions {
+    /** * Where to output the prompt.
+     * - 'console': Logs to stdout (default).
+     * - 'report': Attaches to the Playwright HTML report (best for CI/VMs).
+     * - 'file': Writes to a local file (e.g. 'smart-table-prompt.md').
+     */
+    output?: 'console' | 'report' | 'file';
+    /**
+     * Include TypeScript interfaces in the prompt?
+     * Helps LLMs generate correct code structure.
+     * Default: true
+     */
+    includeTypes?: boolean;
+}
 export interface TableConfig {
     rowSelector?: Selector;
     headerSelector?: Selector;
@@ -30,6 +44,12 @@ export interface TableConfig {
      * Useful for naming empty columns (like '__col_0') to something semantic like 'Actions'.
      */
     headerTransformer?: (text: string, index: number) => string;
+    /**
+     * Automatically scroll the table into view on first interaction.
+     * Helps ensure the table is visible in traces/videos.
+     * Default: true
+     */
+    autoScroll?: boolean;
 }
 export interface TableResult {
     getHeaders: () => Promise<string[]>;
@@ -45,12 +65,17 @@ export interface TableResult {
         maxPages?: number;
     } & T) => Promise<T['asJSON'] extends true ? Record<string, string> : SmartRow>;
     /** * Get all rows on the current page.
-     * Default: Returns SmartRow[] (Locators).
-     * Option { asJSON: true }: Returns Record<string, string>[] (Data).
+     * Can be filtered by column values.
+     * * @param options.asJSON - Returns data objects instead of SmartRows
+     * @param options.filter - Key-Value pairs to filter rows (e.g. { Status: 'Active' })
+     * @param options.exact - Exact match for filters (default: false)
      */
     getAllRows: <T extends {
         asJSON?: boolean;
-    }>(options?: T) => Promise<T['asJSON'] extends true ? Record<string, string>[] : SmartRow[]>;
-    generateConfigPrompt: () => Promise<void>;
-    generateStrategyPrompt: () => Promise<void>;
+    }>(options?: {
+        filter?: Record<string, string | RegExp | number>;
+        exact?: boolean;
+    } & T) => Promise<T['asJSON'] extends true ? Record<string, string>[] : SmartRow[]>;
+    generateConfigPrompt: (options?: PromptOptions) => Promise<void>;
+    generateStrategyPrompt: (options?: PromptOptions) => Promise<void>;
 }

package/dist/useTable.js

@@ -10,8 +10,10 @@ 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: undefined, maxPages: 1, headerTransformer: undefined }, configOptions);
+    const config = Object.assign({ rowSelector: "tbody tr", headerSelector: "th", cellSelector: "td", pagination: undefined, maxPages: 1, headerTransformer: undefined, autoScroll: true }, configOptions);
     const resolve = (item, parent) => {
         if (typeof item === 'string')
             return parent.locator(item);
@@ -23,6 +25,10 @@ const useTable = (rootLocator, configOptions = {}) => {
     const _getMap = () => __awaiter(void 0, void 0, void 0, function* () {
         if (_headerMap)
             return _headerMap;
+        // ✅ New Feature: Auto-Scroll on first interaction
+        if (config.autoScroll) {
+            yield rootLocator.scrollIntoViewIfNeeded();
+        }
         const headerLoc = resolve(config.headerSelector, rootLocator);
         try {
             yield headerLoc.first().waitFor({ state: 'visible', timeout: 3000 });
@@ -63,39 +69,69 @@ const useTable = (rootLocator, configOptions = {}) => {
         });
         return smart;
     };
+    // ♻️ HELPER: Centralized logic to filter a row locator
+    const _applyFilters = (baseRows, filters, map, exact) => {
+        let filtered = baseRows;
+        const page = rootLocator.page();
+        for (const [colName, value] of Object.entries(filters)) {
+            const colIndex = map.get(colName);
+            if (colIndex === undefined)
+                throw new Error(`Column '${colName}' not found.`);
+            const filterVal = typeof value === 'number' ? String(value) : value;
+            const cellTemplate = resolve(config.cellSelector, page);
+            // Filter the TRs that contain the matching cell at the specific index
+            filtered = filtered.filter({
+                has: cellTemplate.nth(colIndex).getByText(filterVal, { exact }),
+            });
+        }
+        return filtered;
+    };
+    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 } = options; // Default includeTypes to true
+        let finalPrompt = content;
+        if (includeTypes) {
+            // ✅ Inject the dynamic TYPE_CONTEXT
+            finalPrompt += `\n\n👇 Useful TypeScript Definitions 👇\n\`\`\`typescript\n${typeContext_1.TYPE_CONTEXT}\n\`\`\`\n`;
+        }
+        if (output === 'console') {
+            console.log(finalPrompt);
+        }
+        else if (output === 'report') {
+            if (test_1.test.info()) {
+                yield test_1.test.info().attach(promptName, {
+                    body: finalPrompt,
+                    contentType: 'text/markdown'
+                });
+                console.log(`✅ Attached '${promptName}' to Playwright Report.`);
+            }
+            else {
+                console.warn('⚠️ Cannot attach to report: No active test info found.');
+                console.log(finalPrompt);
+            }
+        }
+        // ... (file output logic) ...
+    });
     const _findRowLocator = (filters_1, ...args_1) => __awaiter(void 0, [filters_1, ...args_1], void 0, function* (filters, options = {}) {
         var _a;
         const map = yield _getMap();
-        const page = rootLocator.page();
         const effectiveMaxPages = (_a = options.maxPages) !== null && _a !== void 0 ? _a : config.maxPages;
         let currentPage = 1;
         while (true) {
-            let rowLocator = resolve(config.rowSelector, rootLocator);
-            for (const [colName, value] of Object.entries(filters)) {
-                const colIndex = map.get(colName);
-                if (colIndex === undefined)
-                    throw new Error(`Column '${colName}' not found. Available: ${[...map.keys()].join(', ')}`);
-                const exact = options.exact || false;
-                const filterVal = typeof value === 'number' ? String(value) : value;
-                const cellTemplate = resolve(config.cellSelector, page);
-                rowLocator = rowLocator.filter({
-                    has: cellTemplate.nth(colIndex).getByText(filterVal, { exact }),
-                });
-            }
-            const count = yield rowLocator.count();
+            // 1. Get all rows
+            const allRows = resolve(config.rowSelector, rootLocator);
+            // 2. Apply filters using helper
+            const matchedRows = _applyFilters(allRows, filters, map, options.exact || false);
+            // 3. Check Count
+            const count = yield matchedRows.count();
             if (count > 1)
                 throw new Error(`Strict Mode Violation: Found ${count} rows matching ${JSON.stringify(filters)}.`);
             if (count === 1)
-                return rowLocator.first();
+                return matchedRows.first();
+            // 4. Pagination Logic (unchanged)
             if (config.pagination && currentPage < effectiveMaxPages) {
-                const context = {
-                    root: rootLocator,
-                    config: config,
-                    page: page,
-                    resolve: resolve
-                };
-                const didLoadMore = yield config.pagination(context);
-                if (didLoadMore) {
+                // ... (pagination code same as before)
+                const context = { root: rootLocator, config, page: rootLocator.page(), resolve };
+                if (yield config.pagination(context)) {
                     currentPage++;
                     continue;
                 }
@@ -128,24 +164,30 @@ const useTable = (rootLocator, configOptions = {}) => {
         }),
         getAllRows: (options) => __awaiter(void 0, void 0, void 0, function* () {
             const map = yield _getMap();
-            const rowLocators = yield resolve(config.rowSelector, rootLocator).all();
-            const smartRows = rowLocators.map(loc => _makeSmart(loc, map));
+            let rowLocators = resolve(config.rowSelector, rootLocator);
+            // ✅ NEW: Apply filters if they exist
+            if (options === null || options === void 0 ? void 0 : options.filter) {
+                rowLocators = _applyFilters(rowLocators, options.filter, map, options.exact || false);
+            }
+            // Convert Locator to array of Locators
+            const rows = yield rowLocators.all();
+            const smartRows = rows.map(loc => _makeSmart(loc, map));
             if (options === null || options === void 0 ? void 0 : options.asJSON) {
                 return Promise.all(smartRows.map(r => r.toJSON()));
             }
             return smartRows;
         }),
-        generateConfigPrompt: () => __awaiter(void 0, void 0, void 0, function* () {
+        generateConfigPrompt: (options) => __awaiter(void 0, void 0, void 0, function* () {
             const html = yield rootLocator.evaluate((el) => el.outerHTML);
             const separator = "=".repeat(50);
-            const prompt = `\n${separator}\n🤖 COPY INTO GEMINI/ChatGPT 🤖\n${separator}\nI am using 'playwright-smart-table'. Generate config for:\n\`\`\`html\n${html.substring(0, 5000)} ...\n\`\`\`\n${separator}\n`;
-            console.log(prompt);
+            const content = `\n${separator}\n🤖 COPY INTO GEMINI/ChatGPT 🤖\n${separator}\nI am using 'playwright-smart-table'. Generate config for:\n\`\`\`html\n${html.substring(0, 5000)} ...\n\`\`\`\n${separator}\n`;
+            yield _handlePrompt('Smart Table Config', content, options);
         }),
-        generateStrategyPrompt: () => __awaiter(void 0, void 0, void 0, function* () {
+        generateStrategyPrompt: (options) => __awaiter(void 0, void 0, void 0, function* () {
             const container = rootLocator.locator('xpath=..');
             const html = yield container.evaluate((el) => el.outerHTML);
-            const prompt = `\n==================================================\n🤖 COPY INTO GEMINI/ChatGPT TO WRITE A STRATEGY 🤖\n==================================================\nI need a custom Pagination Strategy for 'playwright-smart-table'.\nContainer HTML:\n\`\`\`html\n${html.substring(0, 5000)} ...\n\`\`\`\n`;
-            console.log(prompt);
+            const content = `\n==================================================\n🤖 COPY INTO GEMINI/ChatGPT TO WRITE A STRATEGY 🤖\n==================================================\nI need a custom Pagination Strategy for 'playwright-smart-table'.\nContainer HTML:\n\`\`\`html\n${html.substring(0, 5000)} ...\n\`\`\`\n`;
+            yield _handlePrompt('Smart Table Strategy', content, options);
         })
     };
 };

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@rickcedwhat/playwright-smart-table",
-  "version": "2.0.0",
-  "description": "A smart table utility for Playwright with built-in pagination strategies.",
+  "version": "2.0.1",
+  "description": "A smart table utility for Playwright with built-in pagination strategies that are fully extensible.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsc",
+    "generate-types": "node scripts/embed-types.mjs",
+    "build": "npm run generate-types && tsc",
     "prepublishOnly": "npm run build",
-    "publish-public": "npm publish --access public",
+    "release": "npm run build && npm publish --access public",
     "test": "npx playwright test"
   },
   "keywords": [