@rickcedwhat/playwright-smart-table 6.3.2 → 6.5.0

package/dist/useTable.d.ts

@@ -1,48 +1,6 @@
 import type { Locator } from '@playwright/test';
-import { TableConfig, TableContext, Selector, TableResult, SmartRow as SmartRowType, DedupeStrategy, PaginationStrategy } from './types';
-import { FillStrategies } from './strategies/fill';
-import { HeaderStrategies } from './strategies/headers';
-import { CellNavigationStrategies } from './strategies/columns';
-import { ResolutionStrategies } from './strategies/resolution';
-import { Strategies } from './strategies';
+import { TableConfig, TableResult } from './types';
 /**
  * Main hook to interact with a table.
  */
 export declare const useTable: <T = any>(rootLocator: Locator, configOptions?: TableConfig<T>) => TableResult<T>;
-export declare const PaginationStrategies: {
-    clickNext: (nextButtonSelector: Selector, options?: {
-        stabilization?: import("./strategies/stabilization").StabilizationStrategy;
-        timeout?: number;
-    }) => PaginationStrategy;
-    infiniteScroll: (options?: {
-        action?: "scroll" | "js-scroll";
-        scrollTarget?: Selector;
-        scrollAmount?: number;
-        stabilization?: import("./strategies/stabilization").StabilizationStrategy;
-        timeout?: number;
-    }) => PaginationStrategy;
-};
-export declare const LoadingStrategies: {
-    Table: {
-        hasSpinner: (selector?: string) => ({ root }: TableContext) => Promise<boolean>;
-        custom: (fn: (context: TableContext) => Promise<boolean>) => (context: TableContext) => Promise<boolean>;
-        never: () => Promise<boolean>;
-    };
-    Row: {
-        hasClass: (className?: string) => (row: SmartRowType) => Promise<boolean>;
-        hasText: (text?: string | RegExp) => (row: SmartRowType) => Promise<boolean>;
-        hasEmptyCells: () => (row: SmartRowType) => Promise<boolean>;
-        never: () => Promise<boolean>;
-    };
-    Headers: {
-        stable: (duration?: number) => (context: TableContext) => Promise<boolean>;
-        never: () => Promise<boolean>;
-    };
-};
-export declare const SortingStrategies: {
-    AriaSort: () => import("./types").SortingStrategy;
-};
-export declare const DedupeStrategies: {
-    byTopPosition: (tolerance?: number) => DedupeStrategy;
-};
-export { FillStrategies, HeaderStrategies, CellNavigationStrategies, ResolutionStrategies, Strategies };

package/dist/useTable.js

@@ -9,26 +9,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Strategies = exports.ResolutionStrategies = exports.CellNavigationStrategies = exports.HeaderStrategies = exports.FillStrategies = exports.DedupeStrategies = exports.SortingStrategies = exports.LoadingStrategies = exports.PaginationStrategies = exports.useTable = void 0;
-const typeContext_1 = require("./typeContext");
-const sorting_1 = require("./strategies/sorting");
-const pagination_1 = require("./strategies/pagination");
-const dedupe_1 = require("./strategies/dedupe");
+exports.useTable = void 0;
+const minimalConfigContext_1 = require("./minimalConfigContext");
+const validation_1 = require("./strategies/validation");
 const loading_1 = require("./strategies/loading");
 const fill_1 = require("./strategies/fill");
-Object.defineProperty(exports, "FillStrategies", { enumerable: true, get: function () { return fill_1.FillStrategies; } });
 const headers_1 = require("./strategies/headers");
-Object.defineProperty(exports, "HeaderStrategies", { enumerable: true, get: function () { return headers_1.HeaderStrategies; } });
-const columns_1 = require("./strategies/columns");
-Object.defineProperty(exports, "CellNavigationStrategies", { enumerable: true, get: function () { return columns_1.CellNavigationStrategies; } });
 const smartRow_1 = require("./smartRow");
 const filterEngine_1 = require("./filterEngine");
 const tableMapper_1 = require("./engine/tableMapper");
 const rowFinder_1 = require("./engine/rowFinder");
-const resolution_1 = require("./strategies/resolution");
-Object.defineProperty(exports, "ResolutionStrategies", { enumerable: true, get: function () { return resolution_1.ResolutionStrategies; } });
-const strategies_1 = require("./strategies");
-Object.defineProperty(exports, "Strategies", { enumerable: true, get: function () { return strategies_1.Strategies; } });
 const debugUtils_1 = require("./utils/debugUtils");
 const smartRowArray_1 = require("./utils/smartRowArray");
 /**
@@ -42,7 +32,6 @@ const useTable = (rootLocator, configOptions = {}) => {
     const defaultStrategies = {
         fill: fill_1.FillStrategies.default,
         header: headers_1.HeaderStrategies.visible,
-        cellNavigation: columns_1.CellNavigationStrategies.default,
         pagination: () => __awaiter(void 0, void 0, void 0, function* () { return false; }),
         loading: {
             isHeaderLoading: loading_1.LoadingStrategies.Headers.stable(200)
@@ -87,10 +76,11 @@ const useTable = (rootLocator, configOptions = {}) => {
     // Placeholder for the final table object
     let finalTable = null;
     // Helper factory
-    const _makeSmart = (rowLocator, map, rowIndex) => {
-        return (0, smartRow_1.createSmartRow)(rowLocator, map, rowIndex, config, rootLocator, resolve, finalTable);
+    const _makeSmart = (rowLocator, map, rowIndex, tablePageIndex) => {
+        return (0, smartRow_1.createSmartRow)(rowLocator, map, rowIndex, config, rootLocator, resolve, finalTable, tablePageIndex);
     };
-    const rowFinder = new rowFinder_1.RowFinder(rootLocator, config, resolve, filterEngine, tableMapper, _makeSmart);
+    const tableState = { currentPageIndex: 0 };
+    const rowFinder = new rowFinder_1.RowFinder(rootLocator, config, resolve, filterEngine, tableMapper, _makeSmart, tableState);
     const _getCleanHtml = (loc) => __awaiter(void 0, void 0, void 0, function* () {
         return loc.evaluate((el) => {
             const clone = el.cloneNode(true);
@@ -117,7 +107,7 @@ const useTable = (rootLocator, configOptions = {}) => {
         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`;
+            finalPrompt += `\n\n👇 Useful TypeScript Definitions 👇\n\`\`\`typescript\n${minimalConfigContext_1.MINIMAL_CONFIG_CONTEXT}\n\`\`\`\n`;
         }
         if (output === 'error') {
             console.log(`⚠️ Throwing error to display [${promptName}] cleanly...`);
@@ -129,6 +119,8 @@ const useTable = (rootLocator, configOptions = {}) => {
         yield tableMapper.getMap();
     });
     const result = {
+        get currentPageIndex() { return tableState.currentPageIndex; },
+        set currentPageIndex(v) { tableState.currentPageIndex = v; },
         init: (options) => __awaiter(void 0, void 0, void 0, function* () {
             if (tableMapper.isInitialized())
                 return result;
@@ -144,14 +136,9 @@ const useTable = (rootLocator, configOptions = {}) => {
             const idx = map.get(columnName);
             if (idx === undefined)
                 throw _createColumnError(columnName, map);
-            yield config.strategies.cellNavigation({
-                config: config,
-                root: rootLocator,
-                page: rootLocator.page(),
-                resolve,
-                column: columnName,
-                index: idx
-            });
+            // Use header cell for scrolling
+            const headerCell = resolve(config.headerSelector, rootLocator).nth(idx);
+            yield headerCell.scrollIntoViewIfNeeded();
         }),
         getHeaders: () => __awaiter(void 0, void 0, void 0, function* () {
             const map = yield tableMapper.getMap();
@@ -185,7 +172,7 @@ const useTable = (rootLocator, configOptions = {}) => {
                 throw _createColumnError(column, map);
             const mapper = (_a = options === null || options === void 0 ? void 0 : options.mapper) !== null && _a !== void 0 ? _a : ((c) => c.innerText());
             const effectiveMaxPages = (_b = options === null || options === void 0 ? void 0 : options.maxPages) !== null && _b !== void 0 ? _b : config.maxPages;
-            let currentPage = 1;
+            let pagesScanned = 1;
             const results = [];
             log(`Getting column values for '${column}' (Pages: ${effectiveMaxPages})`);
             while (true) {
@@ -196,11 +183,23 @@ const useTable = (rootLocator, configOptions = {}) => {
                         : resolve(config.cellSelector, row).nth(colIdx);
                     results.push(yield mapper(cell));
                 }
-                if (currentPage < effectiveMaxPages) {
+                if (pagesScanned < effectiveMaxPages) {
                     const context = { root: rootLocator, config, page: rootLocator.page(), resolve };
-                    if (yield config.strategies.pagination(context)) {
+                    let pageRes;
+                    if (typeof config.strategies.pagination === 'function') {
+                        pageRes = yield config.strategies.pagination(context);
+                    }
+                    else {
+                        if (!config.strategies.pagination.goNext) {
+                            log('Cannot paginate: no goNext primitive found.');
+                            break;
+                        }
+                        pageRes = yield config.strategies.pagination.goNext(context);
+                    }
+                    if (yield (0, validation_1.validatePaginationResult)(pageRes, 'Pagination Strategy')) {
                         _hasPaginated = true;
-                        currentPage++;
+                        tableState.currentPageIndex++;
+                        pagesScanned++;
                         continue;
                     }
                 }
@@ -228,11 +227,6 @@ const useTable = (rootLocator, configOptions = {}) => {
             // @ts-ignore
             return rowFinder.findRow(filters, options);
         }),
-        getRows: (options) => __awaiter(void 0, void 0, void 0, function* () {
-            console.warn('DEPRECATED: table.getRows() is deprecated and will be removed in a future version. Use table.findRows() instead.');
-            // @ts-ignore
-            return rowFinder.findRows((options === null || options === void 0 ? void 0 : options.filter) || {}, Object.assign(Object.assign({}, options), { maxPages: 1 }));
-        }),
         findRows: (filters, options) => __awaiter(void 0, void 0, void 0, function* () {
             return rowFinder.findRows(filters, options);
         }),
@@ -267,13 +261,13 @@ const useTable = (rootLocator, configOptions = {}) => {
             yield result.init();
             const map = tableMapper.getMapSync();
             const restrictedTable = {
+                get currentPageIndex() { return tableState.currentPageIndex; },
                 init: result.init,
                 getHeaders: result.getHeaders,
                 getHeaderCell: result.getHeaderCell,
                 getRow: result.getRow,
                 getRowByIndex: result.getRowByIndex,
                 findRow: result.findRow,
-                getRows: result.getRows,
                 findRows: result.findRows,
                 getColumnValues: result.getColumnValues,
                 isInitialized: result.isInitialized,
@@ -362,10 +356,20 @@ const useTable = (rootLocator, configOptions = {}) => {
                     let finalIsLast = isLastDueToMax;
                     if (!isLastIteration) {
                         const context = { root: rootLocator, config, page: rootLocator.page(), resolve };
-                        paginationResult = yield paginationStrategy(context);
+                        if (typeof paginationStrategy === 'function') {
+                            paginationResult = yield paginationStrategy(context);
+                        }
+                        else {
+                            const pageObj = paginationStrategy;
+                            if (!pageObj.goNext)
+                                break;
+                            paginationResult = yield pageObj.goNext(context);
+                        }
                         (0, debugUtils_1.logDebug)(config, 'info', `Pagination ${paginationResult ? 'succeeded' : 'failed'}`);
                         yield (0, debugUtils_1.debugDelay)(config, 'pagination');
                         finalIsLast = getIsLast({ index: callbackIndex, paginationResult }) || !paginationResult;
+                        if (paginationResult)
+                            tableState.currentPageIndex++;
                     }
                     if (finalIsLast && (options === null || options === void 0 ? void 0 : options.afterLast)) {
                         yield options.afterLast({ index: callbackIndex, rows: (0, smartRowArray_1.createSmartRowArray)(callbackRows), allData });
@@ -383,9 +387,21 @@ const useTable = (rootLocator, configOptions = {}) => {
                 else {
                     // Continue paginating even when batching
                     const context = { root: rootLocator, config, page: rootLocator.page(), resolve };
-                    paginationResult = yield paginationStrategy(context);
+                    if (typeof paginationStrategy === 'function') {
+                        paginationResult = yield paginationStrategy(context);
+                    }
+                    else {
+                        const pageObj = paginationStrategy;
+                        if (!pageObj.goNext) {
+                            log(`Cannot paginate: no goNext primitive found.`);
+                            break;
+                        }
+                        paginationResult = yield pageObj.goNext(context);
+                    }
                     (0, debugUtils_1.logDebug)(config, 'info', `Pagination ${paginationResult ? 'succeeded' : 'failed'} (batching mode)`);
                     yield (0, debugUtils_1.debugDelay)(config, 'pagination');
+                    if (paginationResult)
+                        tableState.currentPageIndex++;
                     if (!paginationResult) {
                         // Pagination failed, invoke callback with current batch
                         const callbackIndex = batchStartIndex;
@@ -438,7 +454,3 @@ const useTable = (rootLocator, configOptions = {}) => {
     return result;
 };
 exports.useTable = useTable;
-exports.PaginationStrategies = Object.assign({}, pagination_1.PaginationStrategies);
-exports.LoadingStrategies = loading_1.LoadingStrategies;
-exports.SortingStrategies = sorting_1.SortingStrategies;
-exports.DedupeStrategies = dedupe_1.DedupeStrategies;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rickcedwhat/playwright-smart-table",
-  "version": "6.3.2",
+  "version": "6.5.0",
   "description": "Smart, column-aware table interactions for Playwright",
   "author": "Cedrick Catalan",
   "license": "MIT",
@@ -15,12 +15,13 @@
   ],
   "scripts": {
     "generate-types": "node scripts/embed-types.mjs",
+    "generate-config-types": "node scripts/embed-config-types.mjs",
     "generate-docs": "node scripts/generate-readme.mjs",
     "generate-all-api-docs": "node scripts/generate-all-api-docs.mjs",
     "update-all-api-signatures": "node scripts/update-all-api-signatures.mjs",
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
-    "build": "npm run generate-types && npm run generate-docs && npm run generate-all-api-docs && npm run update-all-api-signatures && tsc",
+    "build": "npm run generate-types && npm run generate-config-types && npm run generate-docs && npm run generate-all-api-docs && npm run update-all-api-signatures && tsc",
     "prepublishOnly": "npm run build",
     "test": "npm run test:unit && npx playwright test",
     "test:unit": "vitest run --reporter=verbose --reporter=html",