@rickcedwhat/playwright-smart-table 1.0.7 → 2.0.0

package/dist/index.d.ts

@@ -1,4 +1,3 @@
 export * from './useTable';
 export * from './types';
 export * from './strategies';
-export * from './presets';

package/dist/index.js

@@ -17,4 +17,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./useTable"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./strategies"), exports);
-__exportStar(require("./presets"), exports);

package/dist/presets.d.ts

@@ -7,19 +7,7 @@ import { TableConfig } from './types';
  * - Cell: Direct children (> *)
  * - Columns: ['Label', 'Input']
  */
-export declare const useForm: (rootLocator: Locator, options?: TableConfig) => {
-    getHeaders: () => Promise<string[]>;
-    getByRow: (filters: Record<string, string | RegExp | number>, options?: {
-        exact?: boolean;
-        maxPages?: number;
-    }) => Promise<Locator>;
-    getByCell: (rowFilters: Record<string, string | RegExp | number>, targetColumn: string) => Promise<Locator>;
-    getRows: () => Promise<Record<string, string>[]>;
-    getRowAsJSON: (filters: Record<string, string | RegExp | number>) => Promise<Record<string, string>>;
-    setColumnName: (colIndex: number, newNameOrFn: string | ((current: string) => string)) => Promise<void>;
-    generateConfigPrompt: () => Promise<void>;
-    generateStrategyPrompt: () => Promise<void>;
-};
+export declare const useForm: (rootLocator: Locator, options?: TableConfig) => import("./types").TableResult;
 /**
  * Preset for Navigation Menus.
  * * Default Structure:
@@ -27,16 +15,4 @@ export declare const useForm: (rootLocator: Locator, options?: TableConfig) => {
  * - Cell: null (The row IS the cell)
  * - Columns: ['Item']
  */
-export declare const useMenu: (menuLocator: Locator, options?: TableConfig) => {
-    getHeaders: () => Promise<string[]>;
-    getByRow: (filters: Record<string, string | RegExp | number>, options?: {
-        exact?: boolean;
-        maxPages?: number;
-    }) => Promise<Locator>;
-    getByCell: (rowFilters: Record<string, string | RegExp | number>, targetColumn: string) => Promise<Locator>;
-    getRows: () => Promise<Record<string, string>[]>;
-    getRowAsJSON: (filters: Record<string, string | RegExp | number>) => Promise<Record<string, string>>;
-    setColumnName: (colIndex: number, newNameOrFn: string | ((current: string) => string)) => Promise<void>;
-    generateConfigPrompt: () => Promise<void>;
-    generateStrategyPrompt: () => Promise<void>;
-};
+export declare const useMenu: (menuLocator: Locator, options?: TableConfig) => import("./types").TableResult;

package/dist/types.d.ts

@@ -1,26 +1,56 @@
 import { Locator, Page } from '@playwright/test';
+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 selector can be a CSS string, a function, or null (to disable/skip).
+ * A function that handles pagination logic.
+ * Returns true if more data was loaded (navigation occurred), false if end of data.
  */
-export type Selector = string | ((parent: Locator | Page) => Locator) | null;
+export type PaginationStrategy = (context: TableContext) => Promise<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;
     /**
-     * Statically override specific column names.
-     * Use 'undefined' to keep the detected name for that index.
-     * Use this to name columns for Menus or Forms that have no headers.
-     * Example: ['MenuItem'] or [undefined, "Actions"]
+     * Optional hook to rename columns dynamically.
+     * Useful for naming empty columns (like '__col_0') to something semantic like 'Actions'.
      */
-    columnNames?: (string | undefined)[];
+    headerTransformer?: (text: string, index: number) => string;
 }
-export interface TableContext {
-    root: Locator;
-    config: Required<TableConfig>;
-    page: Page;
-    resolve: (item: Selector, parent: Locator | Page) => Locator;
+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.
+     * Default: Returns SmartRow[] (Locators).
+     * Option { asJSON: true }: Returns Record<string, string>[] (Data).
+     */
+    getAllRows: <T extends {
+        asJSON?: boolean;
+    }>(options?: T) => Promise<T['asJSON'] extends true ? Record<string, string>[] : SmartRow[]>;
+    generateConfigPrompt: () => Promise<void>;
+    generateStrategyPrompt: () => Promise<void>;
 }
-export type PaginationStrategy = (context: TableContext) => Promise<boolean>;

package/dist/useTable.d.ts

@@ -1,15 +1,3 @@
 import { Locator } from '@playwright/test';
-import { TableConfig } from './types';
-export declare const useTable: (rootLocator: Locator, configOptions?: TableConfig) => {
-    getHeaders: () => Promise<string[]>;
-    getByRow: (filters: Record<string, string | RegExp | number>, options?: {
-        exact?: boolean;
-        maxPages?: number;
-    }) => Promise<Locator>;
-    getByCell: (rowFilters: Record<string, string | RegExp | number>, targetColumn: string) => Promise<Locator>;
-    getRows: () => Promise<Record<string, string>[]>;
-    getRowAsJSON: (filters: Record<string, string | RegExp | number>) => Promise<Record<string, string>>;
-    setColumnName: (colIndex: number, newNameOrFn: string | ((current: string) => string)) => Promise<void>;
-    generateConfigPrompt: () => Promise<void>;
-    generateStrategyPrompt: () => Promise<void>;
-};
+import { TableConfig, TableResult } from './types';
+export declare const useTable: (rootLocator: Locator, configOptions?: TableConfig) => TableResult;

package/dist/useTable.js

@@ -11,40 +11,58 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useTable = void 0;
 const useTable = (rootLocator, configOptions = {}) => {
-    const config = Object.assign({ rowSelector: "tbody tr", headerSelector: "th", cellSelector: "td", pagination: undefined, maxPages: 1, columnNames: [] }, configOptions);
+    const config = Object.assign({ rowSelector: "tbody tr", headerSelector: "th", cellSelector: "td", pagination: undefined, maxPages: 1, headerTransformer: undefined }, configOptions);
     const resolve = (item, parent) => {
         if (typeof item === 'string')
             return parent.locator(item);
         if (typeof item === 'function')
             return item(parent);
-        throw new Error("Cannot resolve a null selector. Ensure your config defines selectors correctly.");
+        return item;
     };
     let _headerMap = null;
     const _getMap = () => __awaiter(void 0, void 0, void 0, function* () {
         if (_headerMap)
             return _headerMap;
-        // 1. Scrape DOM (Only if headerSelector is NOT null)
-        let texts = [];
-        if (config.headerSelector) {
-            const headerLoc = resolve(config.headerSelector, rootLocator);
-            try {
-                yield headerLoc.first().waitFor({ state: 'visible', timeout: 3000 });
-                texts = yield headerLoc.allInnerTexts();
-            }
-            catch (e) { /* Ignore hydration/empty/timeout */ }
-        }
-        // 2. Merge Scraped Data with Config Overrides
-        _headerMap = new Map();
-        const overrides = config.columnNames || [];
-        const colCount = Math.max(texts.length, overrides.length);
-        for (let i = 0; i < colCount; i++) {
-            const scrapedText = (texts[i] || "").trim() || `__col_${i}`;
-            const overrideText = overrides[i];
-            const finalName = (overrideText !== undefined) ? overrideText : scrapedText;
-            _headerMap.set(finalName, i);
+        const headerLoc = resolve(config.headerSelector, rootLocator);
+        try {
+            yield headerLoc.first().waitFor({ state: 'visible', timeout: 3000 });
         }
+        catch (e) { /* Ignore hydration */ }
+        const texts = yield headerLoc.allInnerTexts();
+        _headerMap = new Map(texts.map((t, i) => {
+            let text = t.trim() || `__col_${i}`;
+            if (config.headerTransformer)
+                text = config.headerTransformer(text, i);
+            return [text, i];
+        }));
         return _headerMap;
     });
+    const _makeSmart = (rowLocator, map) => {
+        const smart = rowLocator;
+        smart.getCell = (colName) => {
+            const idx = map.get(colName);
+            if (idx === undefined)
+                throw new Error(`Column '${colName}' not found.`);
+            if (typeof config.cellSelector === 'string') {
+                return rowLocator.locator(config.cellSelector).nth(idx);
+            }
+            else {
+                return resolve(config.cellSelector, rowLocator).nth(idx);
+            }
+        };
+        smart.toJSON = () => __awaiter(void 0, void 0, void 0, function* () {
+            const result = {};
+            const cells = typeof config.cellSelector === 'string'
+                ? rowLocator.locator(config.cellSelector)
+                : resolve(config.cellSelector, rowLocator);
+            const texts = yield cells.allInnerTexts();
+            for (const [col, idx] of map.entries()) {
+                result[col] = (texts[idx] || '').trim();
+            }
+            return result;
+        });
+        return smart;
+    };
     const _findRowLocator = (filters_1, ...args_1) => __awaiter(void 0, [filters_1, ...args_1], void 0, function* (filters, options = {}) {
         var _a;
         const map = yield _getMap();
@@ -52,67 +70,32 @@ const useTable = (rootLocator, configOptions = {}) => {
         const effectiveMaxPages = (_a = options.maxPages) !== null && _a !== void 0 ? _a : config.maxPages;
         let currentPage = 1;
         while (true) {
-            if (!config.rowSelector)
-                throw new Error("rowSelector cannot be null");
             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: ${Array.from(map.keys())}`);
+                    throw new Error(`Column '${colName}' not found. Available: ${[...map.keys()].join(', ')}`);
                 const exact = options.exact || false;
                 const filterVal = typeof value === 'number' ? String(value) : value;
-                // Case 1: No Cell Selector (Menu) - Filter the Row Itself
-                if (!config.cellSelector) {
-                    if (exact) {
-                        rowLocator = rowLocator.filter({ hasText: new RegExp(`^${escapeRegExp(String(filterVal))}$`) });
-                    }
-                    else {
-                        rowLocator = rowLocator.filter({ hasText: filterVal });
-                    }
-                }
-                // Case 2: String Cell Selector - Standard Table Logic (Restored)
-                else if (typeof config.cellSelector === 'string') {
-                    // RESTORED: This logic worked for standard tables. 
-                    // We resolve against the PAGE to create a generic locator template.
-                    // Playwright handles the relative filtering correctly for standard tables.
-                    const cellTemplate = resolve(config.cellSelector, page);
-                    rowLocator = rowLocator.filter({
-                        has: cellTemplate.nth(colIndex).getByText(filterVal, { exact }),
-                    });
-                }
-                // Case 3: Function Cell Selector - Forms (Iterative Fallback)
-                else {
-                    const count = yield rowLocator.count();
-                    let matchFound = false;
-                    for (let i = 0; i < count; i++) {
-                        const specificRow = rowLocator.nth(i);
-                        // Resolve cell relative to this specific row
-                        const specificCell = config.cellSelector(specificRow).nth(colIndex);
-                        if ((yield specificCell.getByText(filterVal, { exact }).count()) > 0) {
-                            if (matchFound) {
-                                throw new Error(`Strict Mode Violation: Found multiple rows matching ${JSON.stringify(filters)}.`);
-                            }
-                            rowLocator = specificRow;
-                            matchFound = true;
-                            // Break inner loop to proceed to next filter or return
-                            break;
-                        }
-                    }
-                    if (!matchFound) {
-                        // Return empty locator to fail gracefully
-                        return resolve(config.rowSelector, rootLocator).filter({ hasText: "NON_EXISTENT_ROW_" + Date.now() });
-                    }
-                }
+                const cellTemplate = resolve(config.cellSelector, page);
+                rowLocator = rowLocator.filter({
+                    has: cellTemplate.nth(colIndex).getByText(filterVal, { exact }),
+                });
             }
             const count = yield rowLocator.count();
             if (count > 1)
                 throw new Error(`Strict Mode Violation: Found ${count} rows matching ${JSON.stringify(filters)}.`);
             if (count === 1)
                 return rowLocator.first();
-            // --- PAGINATION ---
             if (config.pagination && currentPage < effectiveMaxPages) {
-                const context = { root: rootLocator, config: config, page: page, resolve: resolve };
-                if (yield config.pagination(context)) {
+                const context = {
+                    root: rootLocator,
+                    config: config,
+                    page: page,
+                    resolve: resolve
+                };
+                const didLoadMore = yield config.pagination(context);
+                if (didLoadMore) {
                     currentPage++;
                     continue;
                 }
@@ -122,107 +105,48 @@ const useTable = (rootLocator, configOptions = {}) => {
     });
     return {
         getHeaders: () => __awaiter(void 0, void 0, void 0, function* () { return Array.from((yield _getMap()).keys()); }),
-        getByRow: (filters_1, ...args_1) => __awaiter(void 0, [filters_1, ...args_1], void 0, function* (filters, options = {}) {
-            const row = yield _findRowLocator(filters, options);
-            if (!row)
-                return resolve(config.rowSelector, rootLocator).filter({ hasText: "NON_EXISTENT_ROW_SENTINEL_" + Date.now() });
-            return row;
-        }),
-        getByCell: (rowFilters, targetColumn) => __awaiter(void 0, void 0, void 0, function* () {
-            const row = yield _findRowLocator(rowFilters);
-            if (!row)
-                throw new Error(`Row not found: ${JSON.stringify(rowFilters)}`);
-            // Guard: getByCell makes no sense for Menus (no cells)
-            if (!config.cellSelector) {
-                throw new Error("getByCell is not supported when 'cellSelector' is null (e.g. Menus). Use getByRow instead.");
-            }
+        getHeaderCell: (columnName) => __awaiter(void 0, void 0, void 0, function* () {
             const map = yield _getMap();
-            const colIndex = map.get(targetColumn);
-            if (colIndex === undefined)
-                throw new Error(`Column '${targetColumn}' not found.`);
-            if (typeof config.cellSelector === 'string') {
-                return row.locator(config.cellSelector).nth(colIndex);
-            }
-            else {
-                return resolve(config.cellSelector, row).nth(colIndex);
-            }
-        }),
-        getRows: () => __awaiter(void 0, void 0, void 0, function* () {
-            const map = yield _getMap();
-            const rowLocator = resolve(config.rowSelector, rootLocator);
-            const rowCount = yield rowLocator.count();
-            const results = [];
-            for (let i = 0; i < rowCount; i++) {
-                const row = rowLocator.nth(i);
-                let cellTexts = [];
-                if (!config.cellSelector) {
-                    cellTexts = [yield row.innerText()];
-                }
-                else if (typeof config.cellSelector === 'string') {
-                    // For string selectors, we query all matching cells in the row
-                    cellTexts = yield row.locator(config.cellSelector).allInnerTexts();
-                }
-                else {
-                    // For function selectors, we resolve against the row
-                    cellTexts = yield resolve(config.cellSelector, row).allInnerTexts();
-                }
-                const rowData = {};
-                for (const [colName, colIdx] of map.entries()) {
-                    rowData[colName] = (cellTexts[colIdx] || "").trim();
-                }
-                results.push(rowData);
-            }
-            return results;
+            const idx = map.get(columnName);
+            if (idx === undefined)
+                throw new Error(`Column '${columnName}' not found.`);
+            return resolve(config.headerSelector, rootLocator).nth(idx);
         }),
-        getRowAsJSON: (filters) => __awaiter(void 0, void 0, void 0, function* () {
-            const row = yield _findRowLocator(filters);
-            if (!row)
-                throw new Error(`Row not found: ${JSON.stringify(filters)}`);
-            let cellTexts = [];
-            if (!config.cellSelector) {
-                cellTexts = [yield row.innerText()];
-            }
-            else if (typeof config.cellSelector === 'string') {
-                cellTexts = yield row.locator(config.cellSelector).allInnerTexts();
-            }
-            else {
-                cellTexts = yield resolve(config.cellSelector, row).allInnerTexts();
+        getByRow: (filters, options) => __awaiter(void 0, void 0, void 0, function* () {
+            let row = yield _findRowLocator(filters, options);
+            // ✅ FIX: Sentinel Logic for negative assertions (expect(row).not.toBeVisible())
+            if (!row) {
+                row = resolve(config.rowSelector, rootLocator).filter({ hasText: "___SENTINEL_ROW_NOT_FOUND___" + Date.now() });
             }
-            const map = yield _getMap();
-            const result = {};
-            for (const [colName, colIndex] of map.entries()) {
-                result[colName] = (cellTexts[colIndex] || "").trim();
+            const smartRow = _makeSmart(row, yield _getMap());
+            if (options === null || options === void 0 ? void 0 : options.asJSON) {
+                // If row doesn't exist, toJSON() returns empty object or throws? 
+                // For safety, let's let it run naturally (it will likely return empty strings)
+                return smartRow.toJSON();
             }
-            return result;
+            return smartRow;
         }),
-        setColumnName: (colIndex, newNameOrFn) => __awaiter(void 0, void 0, void 0, function* () {
+        getAllRows: (options) => __awaiter(void 0, void 0, void 0, function* () {
             const map = yield _getMap();
-            let oldName = "";
-            for (const [name, idx] of map.entries()) {
-                if (idx === colIndex) {
-                    oldName = name;
-                    break;
-                }
+            const rowLocators = yield resolve(config.rowSelector, rootLocator).all();
+            const smartRows = rowLocators.map(loc => _makeSmart(loc, map));
+            if (options === null || options === void 0 ? void 0 : options.asJSON) {
+                return Promise.all(smartRows.map(r => r.toJSON()));
             }
-            if (!oldName)
-                oldName = `__col_${colIndex}`;
-            const newName = typeof newNameOrFn === 'function' ? newNameOrFn(oldName) : newNameOrFn;
-            if (map.has(oldName))
-                map.delete(oldName);
-            map.set(newName, colIndex);
+            return smartRows;
         }),
         generateConfigPrompt: () => __awaiter(void 0, void 0, void 0, function* () {
             const html = yield rootLocator.evaluate((el) => el.outerHTML);
-            console.log(`\n=== CONFIG PROMPT ===\nI have this HTML:\n\`\`\`html\n${html}\n\`\`\`\nGenerate a 'useTable' config for it.`);
+            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);
         }),
         generateStrategyPrompt: () => __awaiter(void 0, void 0, void 0, function* () {
             const container = rootLocator.locator('xpath=..');
             const html = yield container.evaluate((el) => el.outerHTML);
-            console.log(`\n=== STRATEGY PROMPT ===\nI have this Container HTML:\n\`\`\`html\n${html.substring(0, 2000)}\n\`\`\`\nWrite a pagination strategy.`);
+            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);
         })
     };
 };
 exports.useTable = useTable;
-function escapeRegExp(string) {
-    return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rickcedwhat/playwright-smart-table",
-  "version": "1.0.7", 
+  "version": "2.0.0",
   "description": "A smart table utility for Playwright with built-in pagination strategies.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,14 +10,19 @@
   "scripts": {
     "build": "tsc",
     "prepublishOnly": "npm run build",
-    "publish": "npm publish --access public",
+    "publish-public": "npm publish --access public",
     "test": "npx playwright test"
   },
-  "keywords": ["playwright", "testing", "table", "automation"],
+  "keywords": [
+    "playwright",
+    "testing",
+    "table",
+    "automation"
+  ],
   "author": "",
   "license": "ISC",
   "peerDependencies": {
-    "@playwright/test": "*" 
+    "@playwright/test": "*"
   },
   "peerDependenciesMeta": {
     "@playwright/test": {