@flash-ai-team/flash-test-framework 0.0.16 → 0.0.18

package/README.md

@@ -134,6 +134,12 @@ test.describe('AI Scenario', () => {
 
 ## Keywords
 
+### Core Helpers
+
+*   `el(selector, description?)`: Creates a Test Object.
+    *   `selector` (string): The CSS selector, XPath, or Playwright selector (e.g. `text=Submit`, `role=button[name="Login"]`).
+    *   `description` (string): Optional description for reporting logs.
+
 ### Web
 
 #### Navigation
@@ -168,12 +174,15 @@ test.describe('AI Scenario', () => {
 *   `verifyElementText(testObject, expectedText)`: Assert element text matches.
 *   `verifyElementAttributeValue(testObject, attribute, value)`: Assert element attribute matches.
 *   `verifyElementChecked(testObject, checked?)`: Assert element checked state.
+*   `verifyElementClickable(testObject, timeout?)`: Assert element is visible and enabled.
 *   `verifyTextPresent(text)`: Assert text exists on the page.
 
 #### Synchonization
 *   `waitForElementVisible(testObject, timeout?)`: Wait for element to be visible.
 *   `waitForElementNotVisible(testObject, timeout?)`: Wait for element to disappear.
 *   `waitForElementClickable(testObject, timeout?)`: Wait for element to be clickable.
+*   `waitForPageLoad(timeout?, state?)`: Wait for page load state ('load', 'domcontentloaded', 'networkidle').
+*   `waitForNextPageLoaded(timeout?, waitUntil?)`: Wait for next navigation to complete.
 *   `waitForAngularLoad()`: Wait for Angular stability (if applicable).
 *   `delay(seconds)`: Hard wait (use sparingly).
 

package/dist/core/ObjectRepository.d.ts

@@ -1,12 +1,13 @@
+import { Locator } from '@playwright/test';
 /**
  * Represents a Test Object wrapper around Playwright Locators
  */
 export declare class TestObject {
-    selector: string;
+    selector: string | Locator;
     description: string;
-    constructor(selector: string, description?: string);
+    constructor(selector: string | Locator, description?: string);
 }
 /**
  * Helper to create Test Objects easily
  */
-export declare function el(selector: string, description?: string): TestObject;
+export declare function el(selector: string | Locator, description?: string): TestObject;

package/dist/keywords/WebUI.d.ts

@@ -24,6 +24,10 @@ export declare class Web {
      */
     static click(to: TestObject, options?: {
         description?: string;
+        position?: {
+            x: number;
+            y: number;
+        };
     }): Promise<void>;
     /**
      * Sets the text of an input element.
@@ -33,6 +37,14 @@ export declare class Web {
     static setText(to: TestObject, text: string, options?: {
         description?: string;
     }): Promise<void>;
+    /**
+     * Sets the text of a password input element.
+     * @param to - The TestObject representing the input element.
+     * @param text - The text to set.
+     */
+    static setPassword(to: TestObject, text: string, options?: {
+        description?: string;
+    }): Promise<void>;
     /**
      * Searches for the specified text using heuristic selectors.
      * @param text - The text to search for.
@@ -68,6 +80,10 @@ export declare class Web {
      */
     static doubleClick(to: TestObject, options?: {
         description?: string;
+        position?: {
+            x: number;
+            y: number;
+        };
     }): Promise<void>;
     /**
      * Right clicks (context click) on the specified element.
@@ -166,6 +182,12 @@ export declare class Web {
      * @param checked - True to verify checked, false to verify unchecked (default: true).
      */
     static verifyElementChecked(to: TestObject, checked?: boolean): Promise<void>;
+    /**
+     * Verifies that the element is clickable (visible and enabled).
+     * @param to - The TestObject representing the element.
+     * @param timeout - The maximum time to wait in milliseconds (default: 5000).
+     */
+    static verifyElementClickable(to: TestObject, timeout?: number): Promise<void>;
     /**
      * Waits for the specified element to be visible.
      * @param to - The TestObject representing the element.
@@ -184,6 +206,18 @@ export declare class Web {
      * @param timeout - The maximum time to wait in milliseconds (default: 5000).
      */
     static waitForElementNotVisible(to: TestObject, timeout?: number): Promise<void>;
+    /**
+     * Waits for the page to load.
+     * @param timeout - The maximum time to wait in milliseconds (default: 30000).
+     * @param state - The load state to wait for ('load' | 'domcontentloaded' | 'networkidle'). Default is 'load'.
+     */
+    static waitForPageLoad(timeout?: number, state?: 'load' | 'domcontentloaded' | 'networkidle'): Promise<void>;
+    /**
+     * Waits for the next navigation to complete.
+     * @param timeout - The maximum time to wait in milliseconds (default: 30000).
+     * @param waitUntil - The event to wait for ('load' | 'domcontentloaded' | 'networkidle' | 'commit'). Default is 'load'.
+     */
+    static waitForNextPageLoaded(timeout?: number, waitUntil?: 'load' | 'domcontentloaded' | 'networkidle' | 'commit'): Promise<void>;
     /**
      * Delays execution for a specified number of seconds.
      * @param seconds - The number of seconds to wait.
@@ -224,4 +258,9 @@ export declare class Web {
      * Waits for Angular to finish rendering.
      */
     static waitForAngularLoad(): Promise<void>;
+    /**
+     * Switches to the window/tab with the specified title.
+     * @param title - The title of the window to switch to.
+     */
+    static switchToTabTitle(title: string): Promise<void>;
 }

package/dist/keywords/WebUI.js

@@ -22,7 +22,10 @@ class Web {
         return Keyword_1.KeywordContext.page;
     }
     static getLocator(to) {
-        return this.page.locator(to.selector);
+        if (typeof to.selector === 'string') {
+            return this.page.locator(to.selector);
+        }
+        return to.selector;
     }
     /**
      * Navigates to the specified URL.
@@ -45,7 +48,7 @@ class Web {
      * @param options - Optional parameters (description).
      */
     static async click(to, options) {
-        await this.getLocator(to).click();
+        await this.getLocator(to).click({ position: options?.position });
     }
     /**
      * Sets the text of an input element.
@@ -55,6 +58,14 @@ class Web {
     static async setText(to, text, options) {
         await this.getLocator(to).fill(text);
     }
+    /**
+     * Sets the text of a password input element.
+     * @param to - The TestObject representing the input element.
+     * @param text - The text to set.
+     */
+    static async setPassword(to, text, options) {
+        await this.getLocator(to).fill(text);
+    }
     /**
      * Searches for the specified text using heuristic selectors.
      * @param text - The text to search for.
@@ -102,7 +113,7 @@ class Web {
      * @param to - The TestObject representing the element.
      */
     static async doubleClick(to, options) {
-        await this.getLocator(to).dblclick();
+        await this.getLocator(to).dblclick({ position: options?.position });
     }
     /**
      * Right clicks (context click) on the specified element.
@@ -292,6 +303,16 @@ class Web {
             await (0, test_1.expect)(this.getLocator(to)).not.toBeChecked();
         }
     }
+    /**
+     * Verifies that the element is clickable (visible and enabled).
+     * @param to - The TestObject representing the element.
+     * @param timeout - The maximum time to wait in milliseconds (default: 5000).
+     */
+    static async verifyElementClickable(to, timeout = 5000) {
+        const locator = this.getLocator(to);
+        await (0, test_1.expect)(locator).toBeVisible({ timeout });
+        await (0, test_1.expect)(locator).toBeEnabled({ timeout });
+    }
     // --- Wait Keywords ---
     /**
      * Waits for the specified element to be visible.
@@ -321,6 +342,22 @@ class Web {
     static async waitForElementNotVisible(to, timeout = 5000) {
         await this.getLocator(to).waitFor({ state: 'hidden', timeout });
     }
+    /**
+     * Waits for the page to load.
+     * @param timeout - The maximum time to wait in milliseconds (default: 30000).
+     * @param state - The load state to wait for ('load' | 'domcontentloaded' | 'networkidle'). Default is 'load'.
+     */
+    static async waitForPageLoad(timeout = 30000, state = 'load') {
+        await this.page.waitForLoadState(state, { timeout });
+    }
+    /**
+     * Waits for the next navigation to complete.
+     * @param timeout - The maximum time to wait in milliseconds (default: 30000).
+     * @param waitUntil - The event to wait for ('load' | 'domcontentloaded' | 'networkidle' | 'commit'). Default is 'load'.
+     */
+    static async waitForNextPageLoaded(timeout = 30000, waitUntil = 'load') {
+        await this.page.waitForNavigation({ timeout, waitUntil });
+    }
     /**
      * Delays execution for a specified number of seconds.
      * @param seconds - The number of seconds to wait.
@@ -387,6 +424,22 @@ class Web {
             }
         });
     }
+    /**
+     * Switches to the window/tab with the specified title.
+     * @param title - The title of the window to switch to.
+     */
+    static async switchToTabTitle(title) {
+        const pages = this.page.context().pages();
+        for (const p of pages) {
+            const pageTitle = await p.title();
+            if (pageTitle === title || pageTitle.includes(title)) {
+                await p.bringToFront();
+                Keyword_1.KeywordContext.page = p;
+                return;
+            }
+        }
+        throw new Error(`Tab with title '${title}' not found`);
+    }
 }
 exports.Web = Web;
 __decorate([
@@ -413,6 +466,12 @@ __decorate([
     __metadata("design:paramtypes", [ObjectRepository_1.TestObject, String, Object]),
     __metadata("design:returntype", Promise)
 ], Web, "setText", null);
+__decorate([
+    (0, Keyword_1.Keyword)("Set Password"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [ObjectRepository_1.TestObject, String, Object]),
+    __metadata("design:returntype", Promise)
+], Web, "setPassword", null);
 __decorate([
     (0, Keyword_1.Keyword)("Search"),
     __metadata("design:type", Function),
@@ -539,6 +598,12 @@ __decorate([
     __metadata("design:paramtypes", [ObjectRepository_1.TestObject, Boolean]),
     __metadata("design:returntype", Promise)
 ], Web, "verifyElementChecked", null);
+__decorate([
+    (0, Keyword_1.Keyword)("Verify Element Clickable"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [ObjectRepository_1.TestObject, Number]),
+    __metadata("design:returntype", Promise)
+], Web, "verifyElementClickable", null);
 __decorate([
     (0, Keyword_1.Keyword)("Wait For Element Visible"),
     __metadata("design:type", Function),
@@ -557,6 +622,18 @@ __decorate([
     __metadata("design:paramtypes", [ObjectRepository_1.TestObject, Number]),
     __metadata("design:returntype", Promise)
 ], Web, "waitForElementNotVisible", null);
+__decorate([
+    (0, Keyword_1.Keyword)("Wait For Page Load"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number, String]),
+    __metadata("design:returntype", Promise)
+], Web, "waitForPageLoad", null);
+__decorate([
+    (0, Keyword_1.Keyword)("Wait For Next Page Loaded"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number, String]),
+    __metadata("design:returntype", Promise)
+], Web, "waitForNextPageLoaded", null);
 __decorate([
     (0, Keyword_1.Keyword)("Delay"),
     __metadata("design:type", Function),
@@ -605,3 +682,9 @@ __decorate([
     __metadata("design:paramtypes", []),
     __metadata("design:returntype", Promise)
 ], Web, "waitForAngularLoad", null);
+__decorate([
+    (0, Keyword_1.Keyword)("Switch To Tab Title"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], Web, "switchToTabTitle", null);

package/dist/reporting/HtmlReporter.js

@@ -86,6 +86,31 @@ class HtmlReporter {
         }
         fs.writeFileSync(this.reportPath, html);
         console.log(`HTML Report generated at: ${this.reportPath}`);
+        // Check if we should open the report
+        let openReport = true; // Default to true
+        try {
+            const configPath = path.join(process.cwd(), 'report.config.json');
+            if (fs.existsSync(configPath)) {
+                const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
+                if (config.openReport === false) {
+                    openReport = false;
+                }
+            }
+        }
+        catch (e) { /* ignore */ }
+        if (openReport) {
+            try {
+                // Write a marker file for VS Code extension to detect and open Latest Run view
+                const markerPath = path.join(process.cwd(), '.flash-report-ready');
+                fs.writeFileSync(markerPath, JSON.stringify({
+                    reportPath: this.reportPath,
+                    timestamp: Date.now()
+                }));
+            }
+            catch (e) {
+                console.log('Could not write report marker file.');
+            }
+        }
     }
     onTestEnd(test, result) {
         let suite = test.parent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flash-ai-team/flash-test-framework",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "description": "A powerful keyword-driven automation framework built on top of Playwright and TypeScript.",
   "keywords": [
     "playwright",