@progress/kendo-e2e 4.11.3 → 4.12.0

package/dist/selenium/browser.js

@@ -28,10 +28,46 @@ function isDriver(obj) {
     return obj && typeof obj.getSession === 'function';
 }
 /**
- * Extends the {@link WebApp} with browser based capabilities.
- * Essentially, we test browsers (that have nice things like {@link navigateTo}, {@link refresh} etc.),
- * and electron apps, that render within a webview (but have no shell with address bar, refresh button, tabs, etc),
- * and VSCode extensions... which is an electron app.
+ * Browser automation class with automatic waiting and modern web testing features.
+ *
+ * Extends {@link WebApp} with browser-specific capabilities like navigation, window management,
+ * accessibility testing, and console log monitoring. Perfect for testing web applications in
+ * real browsers (Chrome, Firefox, Safari, Edge).
+ *
+ * **Key features:**
+ * - Browser navigation and URL management
+ * - Window resizing and iframe handling
+ * - Mobile device emulation
+ * - Accessibility (a11y) testing with axe-core
+ * - Console error detection
+ * - BiDi protocol support
+ *
+ * @example
+ * ```typescript
+ * // Basic browser test
+ * const browser = new Browser();
+ * await browser.navigateTo('https://example.com');
+ * await browser.click('#login-button');
+ * await browser.expect('.welcome-message').toBeVisible();
+ * await browser.close();
+ *
+ * // Mobile emulation
+ * const mobile = new Browser({ mobileEmulation: { deviceName: 'iPhone 14 Pro Max' } });
+ * await mobile.navigateTo('https://example.com');
+ *
+ * // With BiDi for advanced features
+ * const browser = new Browser({ enableBidi: true });
+ *
+ * // Check for console errors
+ * await browser.clearLogs();
+ * await browser.click('#trigger-error');
+ * const errors = await browser.getErrorLogs();
+ * expect(errors).toHaveLength(0);
+ *
+ * // Accessibility testing
+ * const violations = await browser.getAccessibilityViolations();
+ * expect(violations).toHaveLength(0);
+ * ```
  */
 class Browser extends web_app_1.WebApp {
     /**
@@ -99,11 +135,51 @@ class Browser extends web_app_1.WebApp {
         }
         super(driver);
     }
+    /**
+     * Closes the browser and ends the WebDriver session.
+     *
+     * Should be called at the end of each test to clean up resources.
+     * Closes all browser windows and terminates the driver.
+     *
+     * @returns Promise that resolves when browser is closed
+     *
+     * @example
+     * ```typescript
+     * const browser = new Browser();
+     * try {
+     *   await browser.navigateTo('https://example.com');
+     *   // ... test code ...
+     * } finally {
+     *   await browser.close(); // Always close to free resources
+     * }
+     * ```
+     */
     close() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.driver.quit();
         });
     }
+    /**
+     * Navigates the browser to a specified URL.
+     *
+     * Opens the URL in the current browser window. Waits for the page to load before
+     * the promise resolves.
+     *
+     * @param url - The URL to navigate to (must include protocol: http:// or https://)
+     * @returns Promise that resolves when navigation completes
+     *
+     * @example
+     * ```typescript
+     * // Navigate to a website
+     * await browser.navigateTo('https://example.com');
+     *
+     * // Navigate to local development server
+     * await browser.navigateTo('http://localhost:3000');
+     *
+     * // Navigate to specific page
+     * await browser.navigateTo('https://example.com/products/123');
+     * ```
+     */
     navigateTo(url) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.driver.navigate().to(url);
@@ -160,22 +236,115 @@ class Browser extends web_app_1.WebApp {
             }
         });
     }
+    /**
+     * Refreshes the current page (like pressing F5 or clicking browser refresh).
+     *
+     * Reloads the page from the server, resetting all JavaScript state.
+     *
+     * @returns Promise that resolves when page reload completes
+     *
+     * @example
+     * ```typescript
+     * // Refresh after making changes
+     * await browser.click('#update-settings');
+     * await browser.refresh();
+     *
+     * // Verify data persists after refresh
+     * await browser.type('#input', 'test');
+     * await browser.click('#save');
+     * await browser.refresh();
+     * const value = await browser.getAttribute('#input', 'value');
+     * expect(value).toBe('test');
+     * ```
+     */
     refresh() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.driver.navigate().refresh();
         });
     }
+    /**
+     * Switches the WebDriver context to an iframe.
+     *
+     * After calling this, all subsequent commands will target elements within the iframe.
+     * To switch back to the main page, use `driver.switchTo().defaultContent()`.
+     *
+     * @param elementLocator - By locator for the iframe element
+     * @returns Promise that resolves when context is switched
+     *
+     * @example
+     * ```typescript
+     * // Switch to iframe and interact with its content
+     * await browser.switchToIFrame(By.css('#my-iframe'));
+     * await browser.click('#button-inside-iframe');
+     *
+     * // Switch back to main page
+     * await browser.driver.switchTo().defaultContent();
+     * await browser.click('#button-on-main-page');
+     *
+     * // Work with nested iframes
+     * await browser.switchToIFrame(By.css('#outer-frame'));
+     * await browser.switchToIFrame(By.css('#inner-frame'));
+     * ```
+     */
     switchToIFrame(elementLocator) {
         return __awaiter(this, void 0, void 0, function* () {
             const iframe = yield this.find(elementLocator);
             yield this.driver.switchTo().frame(iframe);
         });
     }
+    /**
+     * Gets the current URL of the browser.
+     *
+     * Returns the complete URL including protocol, domain, path, and query parameters.
+     *
+     * @returns Promise resolving to the current URL string
+     *
+     * @example
+     * ```typescript
+     * // Verify navigation occurred
+     * await browser.click('#products-link');
+     * const url = await browser.getCurrentUrl();
+     * expect(url).toContain('/products');
+     *
+     * // Check URL parameters
+     * const currentUrl = await browser.getCurrentUrl();
+     * expect(currentUrl).toContain('?filter=active');
+     *
+     * // Verify redirect
+     * await browser.navigateTo('http://example.com/old-page');
+     * const redirectedUrl = await browser.getCurrentUrl();
+     * expect(redirectedUrl).toBe('http://example.com/new-page');
+     * ```
+     */
     getCurrentUrl() {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.driver.getCurrentUrl();
         });
     }
+    /**
+     * Gets the name of the current browser.
+     *
+     * Returns lowercase browser name: 'chrome', 'firefox', 'safari', 'edge', etc.
+     * Useful for browser-specific test logic.
+     *
+     * @returns Promise resolving to lowercase browser name
+     *
+     * @example
+     * ```typescript
+     * const browserName = await browser.getBrowserName();
+     *
+     * if (browserName === 'safari') {
+     *   // Skip Safari-incompatible test
+     *   console.log('Skipping on Safari');
+     *   return;
+     * }
+     *
+     * // Browser-specific assertions
+     * if (browserName === 'firefox') {
+     *   // Firefox-specific validation
+     * }
+     * ```
+     */
     getBrowserName() {
         return __awaiter(this, void 0, void 0, function* () {
             const capabilities = (yield (yield this.driver).getCapabilities());
@@ -183,6 +352,35 @@ class Browser extends web_app_1.WebApp {
             return browserName;
         });
     }
+    /**
+     * Runs accessibility (a11y) tests using axe-core and returns violations.
+     *
+     * Scans the page for accessibility issues like missing alt text, insufficient color contrast,
+     * missing ARIA labels, etc. Returns an array of violations that should be addressed.
+     *
+     * @param cssSelector - CSS selector to limit scanning scope (default: 'html' for full page)
+     * @param disableRules - Array of axe rule IDs to disable (default: ['color-contrast'])
+     * @returns Promise resolving to array of accessibility violations
+     *
+     * @example
+     * ```typescript
+     * // Scan entire page
+     * const violations = await browser.getAccessibilityViolations();
+     * expect(violations).toHaveLength(0);
+     *
+     * // Scan specific component
+     * const formViolations = await browser.getAccessibilityViolations('#login-form');
+     *
+     * // Enable all rules including color contrast
+     * const allViolations = await browser.getAccessibilityViolations('html', []);
+     *
+     * // Disable specific rules
+     * const violations = await browser.getAccessibilityViolations('html', [
+     *   'color-contrast',
+     *   'landmark-one-main'
+     * ]);
+     * ```
+     */
     getAccessibilityViolations() {
         return __awaiter(this, arguments, void 0, function* (cssSelector = "html", disableRules = ["color-contrast"]) {
             yield this.find(selenium_webdriver_1.By.css(cssSelector));
@@ -193,11 +391,54 @@ class Browser extends web_app_1.WebApp {
             return result.violations;
         });
     }
+    /**
+     * Clears the browser console logs.
+     *
+     * Call this before performing actions to get a clean slate for error detection.
+     * Useful when you want to check if a specific action causes console errors.
+     *
+     * @returns Promise that resolves when logs are cleared
+     *
+     * @example
+     * ```typescript
+     * // Clear logs before action
+     * await browser.clearLogs();
+     * await browser.click('#potential-error-button');
+     * const errors = await browser.getErrorLogs();
+     * ```
+     */
     clearLogs() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.driver.manage().logs().get(logging_1.Type.BROWSER);
         });
     }
+    /**
+     * Gets console errors from the browser (Chrome only).
+     *
+     * Retrieves console errors logged by the browser. Only works in Chrome on desktop platforms.
+     * Firefox and mobile platforms don't support log retrieval.
+     *
+     * @param excludeList - Array of strings to filter out from errors (default: ['favicon.ico'])
+     * @param logLevel - Minimum log level to collect (default: Level.SEVERE for errors)
+     * @returns Promise resolving to array of error message strings
+     *
+     * @example
+     * ```typescript
+     * // Check for any console errors
+     * const errors = await browser.getErrorLogs();
+     * expect(errors.length).toBe(0);
+     *
+     * // Exclude known non-critical errors
+     * const errors = await browser.getErrorLogs(['favicon', 'analytics']);
+     *
+     * // Get all warnings and errors
+     * const logs = await browser.getErrorLogs([], Level.WARNING);
+     *
+     * // Check for specific error
+     * const errors = await browser.getErrorLogs();
+     * expect(errors.some(e => e.includes('TypeError'))).toBe(false);
+     * ```
+     */
     getErrorLogs() {
         return __awaiter(this, arguments, void 0, function* (excludeList = ["favicon.ico"], logLevel = logging_1.Level.SEVERE) {
             const errors = [];

package/dist/selenium/browser.js.map

@@ -1 +1 @@
-{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../src/selenium/browser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,wEAA+C;AAC/C,2DAAuE;AACvE,4DAA6D;AAC7D,qDAAiD;AACjD,uCAAmC;AAEnC,yDAAwG;AAA/F,wGAAA,EAAE,OAAA;AAAE,yGAAA,GAAG,OAAA;AAAqB,2GAAA,KAAK,OAAA;AAAE,gHAAA,UAAU,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AAQ3E,SAAS,QAAQ,CAAC,GAAQ;IACtB,OAAO,GAAG,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAa,OAAQ,SAAQ,gBAAM;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,YACI,eAAoD,EACpD,eAAsG,EACtG,UAAoB;;QAEpB,IAAI,MAAyB,CAAC;QAE9B,gEAAgE;QAChE,IAAI,eAAe,IAAI,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YAC/C,MAAM,GAAG,eAAe,CAAC;QAC7B,CAAC;aAAM,CAAC;YACJ,MAAM,OAAO,GAAoB,eAAkC,IAAI,EAAE,CAAC;YAE1E,IAAI,eAAe,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;gBAC9C,OAAO,CAAC,eAAe,GAAG,eAAe,CAAC;YAC9C,CAAC;YACD,IAAI,UAAU,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBACjD,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;YACpC,CAAC;YAED,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,IAAI,8BAAa,EAAE,CAAC,SAAS,CAAC;gBACrD,eAAe,EAAE,OAAO,CAAC,eAAe;gBACxC,UAAU,EAAE,OAAO,CAAC,UAAU;aACjC,CAAC,CAAC;QACP,CAAC;QAED,KAAK,CAAC,MAAM,CAAC,CAAC;IAClB,CAAC;IAEY,KAAK;;YACd,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC7B,CAAC;KAAA;IAEY,UAAU,CAAC,GAAW;;YAC/B,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;QACzC,CAAC;KAAA;IAEY,OAAO;;YAChB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;QACzD,CAAC;KAAA;IAEY,OAAO,CAAC,IAAiE;;;YAClF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;YAClE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;gBAClC,KAAK,EAAE,MAAA,IAAI,CAAC,KAAK,mCAAI,WAAW,CAAC,KAAK;gBACtC,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,mCAAI,WAAW,CAAC,MAAM;gBACzC,CAAC,EAAE,MAAA,IAAI,CAAC,CAAC,mCAAI,WAAW,CAAC,CAAC;gBAC1B,CAAC,EAAE,MAAA,IAAI,CAAC,CAAC,mCAAI,WAAW,CAAC,CAAC;aAC7B,CAAC,CAAC;QACP,CAAC;KAAA;IAEY,4BAA4B;;YACrC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YAC1C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,2BAA2B,CAAW,CAAC;YAC9F,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,mCAAmC,CAAW,CAAC;YACtG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,cAAc,GAAG,YAAY,CAAC,MAAM,GAAG,cAAc,EAAE,CAAC,CAAC;QAC1F,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACU,YAAY,CAAC,KAAa,EAAE,MAAc;;YACnD,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,IAAI,MAAM,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAChI,CAAC;QACL,CAAC;KAAA;IAEY,OAAO;;YAChB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QAC3C,CAAC;KAAA;IAEY,cAAc,CAAC,cAAkB;;YAC1C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC/C,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC/C,CAAC;KAAA;IAEY,aAAa;;YACtB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QAC7C,CAAC;KAAA;IAEY,cAAc;;YACvB,MAAM,YAAY,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC;YACnE,MAAM,WAAW,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC,WAAW,EAAE,CAAC;YAChE,OAAO,WAAW,CAAC;QACvB,CAAC;KAAA;IAEY,0BAA0B;6DAAC,WAAW,GAAG,MAAM,EAAE,YAAY,GAAG,CAAC,gBAAgB,CAAC;YAC3F,MAAM,IAAI,CAAC,IAAI,CAAC,uBAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;YACrC,MAAM,GAAG,GAAG,IAAI,qBAAU,CAAC,IAAI,CAAC,MAAM,CAAC;iBAClC,OAAO,CAAC,WAAW,CAAC;iBACpB,YAAY,CAAC,YAAY,CAAC,CAAC;YAChC,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;YACnC,OAAO,MAAM,CAAC,UAAgB,CAAC;QACnC,CAAC;KAAA;IAEY,SAAS;;YAClB,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,cAAI,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;KAAA;IAEY,YAAY;6DAAC,WAAW,GAAG,CAAC,aAAa,CAAC,EAAE,QAAQ,GAAG,eAAK,CAAC,MAAM;YAC5E,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,MAAM,YAAY,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC;YACnE,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,CAAC;YAC1D,MAAM,WAAW,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC,WAAW,EAAE,CAAC;YAEhE,oCAAoC;YACpC,cAAc;YACd,2EAA2E;YAC3E,EAAE;YACF,wDAAwD;YACxD,IAAI,WAAW,KAAK,QAAQ,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC9E,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,cAAI,CAAC,OAAO,CAAC,CAAC;gBACjE,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;oBACvB,6GAA6G;oBAC7G,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;wBACtC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC/B,CAAC;gBACL,CAAC;YACL,CAAC;YAED,gBAAgB;YAChB,IAAI,cAAc,GAAG,MAAM,CAAC;YAC5B,KAAK,MAAM,WAAW,IAAI,WAAW,EAAE,CAAC;gBACpC,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,KAAa,EAAE,EAAE;oBACrD,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,CAAC;gBACtE,CAAC,CAAC,CAAC;YACP,CAAC;YAED,OAAO,cAAc,CAAC;QAC1B,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,aAAa;6DAAC,MAAc,EAAE,YAAY,GAAG,CAAC,EAAE,WAAW,GAAG,CAAC;YACxE,IAAI,CAAC;gBACD,qCAAqC;gBACrC,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;oBACnB,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;gBACpE,CAAC;gBAED,qBAAqB;gBACrB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBAEvD,oCAAoC;gBACpC,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;oBAClB,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;gBACnE,CAAC;gBAED,OAAO,MAAM,CAAC;YAClB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,wCAAwC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACtH,CAAC;QACL,CAAC;KAAA;CACJ;AAvOD,0BAuOC"}
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../src/selenium/browser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,wEAA+C;AAC/C,2DAAuE;AACvE,4DAA6D;AAC7D,qDAAiD;AACjD,uCAAmC;AAEnC,yDAAwG;AAA/F,wGAAA,EAAE,OAAA;AAAE,yGAAA,GAAG,OAAA;AAAqB,2GAAA,KAAK,OAAA;AAAE,gHAAA,UAAU,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AAQ3E,SAAS,QAAQ,CAAC,GAAQ;IACtB,OAAO,GAAG,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAa,OAAQ,SAAQ,gBAAM;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,YACI,eAAoD,EACpD,eAAsG,EACtG,UAAoB;;QAEpB,IAAI,MAAyB,CAAC;QAE9B,gEAAgE;QAChE,IAAI,eAAe,IAAI,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YAC/C,MAAM,GAAG,eAAe,CAAC;QAC7B,CAAC;aAAM,CAAC;YACJ,MAAM,OAAO,GAAoB,eAAkC,IAAI,EAAE,CAAC;YAE1E,IAAI,eAAe,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;gBAC9C,OAAO,CAAC,eAAe,GAAG,eAAe,CAAC;YAC9C,CAAC;YACD,IAAI,UAAU,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBACjD,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;YACpC,CAAC;YAED,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,IAAI,8BAAa,EAAE,CAAC,SAAS,CAAC;gBACrD,eAAe,EAAE,OAAO,CAAC,eAAe;gBACxC,UAAU,EAAE,OAAO,CAAC,UAAU;aACjC,CAAC,CAAC;QACP,CAAC;QAED,KAAK,CAAC,MAAM,CAAC,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACU,KAAK;;YACd,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC7B,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,UAAU,CAAC,GAAW;;YAC/B,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;QACzC,CAAC;KAAA;IAEY,OAAO;;YAChB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;QACzD,CAAC;KAAA;IAEY,OAAO,CAAC,IAAiE;;;YAClF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;YAClE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;gBAClC,KAAK,EAAE,MAAA,IAAI,CAAC,KAAK,mCAAI,WAAW,CAAC,KAAK;gBACtC,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,mCAAI,WAAW,CAAC,MAAM;gBACzC,CAAC,EAAE,MAAA,IAAI,CAAC,CAAC,mCAAI,WAAW,CAAC,CAAC;gBAC1B,CAAC,EAAE,MAAA,IAAI,CAAC,CAAC,mCAAI,WAAW,CAAC,CAAC;aAC7B,CAAC,CAAC;QACP,CAAC;KAAA;IAEY,4BAA4B;;YACrC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YAC1C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,2BAA2B,CAAW,CAAC;YAC9F,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,mCAAmC,CAAW,CAAC;YACtG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,cAAc,GAAG,YAAY,CAAC,MAAM,GAAG,cAAc,EAAE,CAAC,CAAC;QAC1F,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACU,YAAY,CAAC,KAAa,EAAE,MAAc;;YACnD,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,IAAI,MAAM,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAChI,CAAC;QACL,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,OAAO;;YAChB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QAC3C,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,cAAc,CAAC,cAAkB;;YAC1C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC/C,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,aAAa;;YACtB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QAC7C,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,cAAc;;YACvB,MAAM,YAAY,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC;YACnE,MAAM,WAAW,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC,WAAW,EAAE,CAAC;YAChE,OAAO,WAAW,CAAC;QACvB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACU,0BAA0B;6DAAC,WAAW,GAAG,MAAM,EAAE,YAAY,GAAG,CAAC,gBAAgB,CAAC;YAC3F,MAAM,IAAI,CAAC,IAAI,CAAC,uBAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;YACrC,MAAM,GAAG,GAAG,IAAI,qBAAU,CAAC,IAAI,CAAC,MAAM,CAAC;iBAClC,OAAO,CAAC,WAAW,CAAC;iBACpB,YAAY,CAAC,YAAY,CAAC,CAAC;YAChC,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;YACnC,OAAO,MAAM,CAAC,UAAgB,CAAC;QACnC,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACU,SAAS;;YAClB,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,cAAI,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,YAAY;6DAAC,WAAW,GAAG,CAAC,aAAa,CAAC,EAAE,QAAQ,GAAG,eAAK,CAAC,MAAM;YAC5E,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,MAAM,YAAY,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC;YACnE,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,CAAC;YAC1D,MAAM,WAAW,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC,WAAW,EAAE,CAAC;YAEhE,oCAAoC;YACpC,cAAc;YACd,2EAA2E;YAC3E,EAAE;YACF,wDAAwD;YACxD,IAAI,WAAW,KAAK,QAAQ,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC9E,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,cAAI,CAAC,OAAO,CAAC,CAAC;gBACjE,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;oBACvB,6GAA6G;oBAC7G,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;wBACtC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC/B,CAAC;gBACL,CAAC;YACL,CAAC;YAED,gBAAgB;YAChB,IAAI,cAAc,GAAG,MAAM,CAAC;YAC5B,KAAK,MAAM,WAAW,IAAI,WAAW,EAAE,CAAC;gBACpC,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,KAAa,EAAE,EAAE;oBACrD,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,CAAC;gBACtE,CAAC,CAAC,CAAC;YACP,CAAC;YAED,OAAO,cAAc,CAAC;QAC1B,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,aAAa;6DAAC,MAAc,EAAE,YAAY,GAAG,CAAC,EAAE,WAAW,GAAG,CAAC;YACxE,IAAI,CAAC;gBACD,qCAAqC;gBACrC,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;oBACnB,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;gBACpE,CAAC;gBAED,qBAAqB;gBACrB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBAEvD,oCAAoC;gBACpC,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;oBAClB,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;gBACnE,CAAC;gBAED,OAAO,MAAM,CAAC;YAClB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,wCAAwC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACtH,CAAC;QACL,CAAC;KAAA;CACJ;AApbD,0BAobC"}

package/dist/selenium/conditions.d.ts

@@ -1,15 +1,270 @@
 import { By, WebDriver, WebElement } from "selenium-webdriver";
+/**
+ * A function that checks a condition and returns whether it's met.
+ * Used with WebApp.wait() and WebApp.waitSafely() methods.
+ */
 export type WaitCondition = (driver: WebDriver) => Promise<boolean>;
+/**
+ * Expected Conditions (EC) - factory methods for creating wait conditions.
+ *
+ * Provides a collection of commonly used wait conditions for element states.
+ * These conditions are designed to work with {@link WebApp.wait} and {@link WebApp.waitSafely}.
+ *
+ * **All conditions automatically handle:**
+ * - Elements that don't exist yet
+ * - Stale element references
+ * - Timing issues
+ *
+ * @example
+ * ```typescript
+ * // Wait for element to be visible
+ * await app.wait(EC.isVisible('#modal'));
+ *
+ * // Wait for element to have specific text
+ * await app.wait(EC.hasText(element, 'Success'));
+ *
+ * // Wait for element to have focus
+ * await app.wait(EC.hasFocus(inputElement));
+ *
+ * // Check condition without throwing error
+ * const isVisible = await app.waitSafely(EC.isVisible('.optional-banner'));
+ * if (isVisible) {
+ *   await app.click('.banner-close');
+ * }
+ * ```
+ */
 export declare class EC {
+    /**
+     * Creates a condition that waits for an element to have specific text.
+     *
+     * Compares the element's visible text content (via getText()) with the expected text.
+     * Match must be exact.
+     *
+     * @param element - WebElement to check text of
+     * @param text - Exact text to wait for
+     * @returns Condition function for use with wait()
+     *
+     * @example
+     * ```typescript
+     * const message = await app.find('#message');
+     * await app.wait(EC.hasText(message, 'Operation completed'));
+     *
+     * // Or check without waiting
+     * const hasCorrectText = await app.hasText('#status', 'Active');
+     * ```
+     */
     static hasText(element: WebElement, text: string): (driver: WebDriver) => Promise<boolean>;
+    /**
+     * Creates a condition that waits for an input element to have a specific value.
+     *
+     * Checks the 'value' attribute of form inputs. Perfect for validating input fields
+     * after auto-fill, dynamic updates, or user interaction.
+     *
+     * @param element - Input WebElement to check
+     * @param value - Expected value
+     * @returns Condition function for use with wait()
+     *
+     * @example
+     * ```typescript
+     * const input = await app.find('#username');
+     * await app.type(input, 'testuser');
+     * await app.wait(EC.hasValue(input, 'testuser'));
+     *
+     * // Wait for auto-filled value
+     * await app.wait(EC.hasValue(await app.find('#email'), 'user@example.com'));
+     * ```
+     */
     static hasValue(element: WebElement, value: string): (driver: WebDriver) => Promise<boolean>;
+    /**
+     * Creates a condition that waits for an element to have keyboard focus.
+     *
+     * Checks if the element is the currently active (focused) element in the document.
+     * Useful for testing keyboard navigation and focus management.
+     *
+     * @param element - WebElement to check for focus
+     * @returns Condition function for use with wait()
+     *
+     * @example
+     * ```typescript
+     * const input = await app.find('#search');
+     * await app.click(input);
+     * await app.wait(EC.hasFocus(input));
+     *
+     * // Verify focus moved after Tab key
+     * await app.sendKey(Key.TAB);
+     * const nextInput = await app.find('#next-field');
+     * await app.wait(EC.hasFocus(nextInput));
+     * ```
+     */
     static hasFocus(element: WebElement): (driver: WebDriver) => Promise<boolean>;
+    /**
+     * Creates a condition that waits for an element to lose keyboard focus.
+     *
+     * Opposite of {@link hasFocus}. Useful for testing blur events and focus movement.
+     *
+     * @param element - WebElement to check for lack of focus
+     * @returns Condition function for use with wait()
+     *
+     * @example
+     * ```typescript
+     * const input = await app.find('#field');
+     * await app.focus(input);
+     * await app.sendKey(Key.TAB); // Move focus away
+     * await app.wait(EC.hasNoFocus(input));
+     * ```
+     */
     static hasNoFocus(element: WebElement): (driver: WebDriver) => Promise<boolean>;
+    /**
+     * Creates a condition that waits for an element to have at least one child matching a locator.
+     *
+     * Checks if the parent element contains any child elements matching the selector.
+     * Useful for waiting for dynamic content to load within a container.
+     *
+     * @param element - Parent WebElement to search within
+     * @param locator - Child element selector (By locator or CSS selector string)
+     * @returns Condition function for use with wait()
+     *
+     * @example
+     * ```typescript
+     * const list = await app.find('ul#results');
+     * await app.wait(EC.hasChild(list, 'li'));
+     *
+     * // Wait for specific child
+     * const table = await app.find('#data-table');
+     * await app.wait(EC.hasChild(table, '.loaded-row'));
+     * ```
+     */
     static hasChild(element: WebElement, locator: By | string): () => Promise<boolean>;
+    /**
+     * Creates a condition that waits for an element to have a specific attribute value.
+     *
+     * Can check for exact match or partial match (contains). Useful for validating
+     * data attributes, ARIA attributes, disabled state, etc.
+     *
+     * @param element - WebElement to check
+     * @param attribute - Attribute name (e.g., 'disabled', 'data-id', 'aria-label')
+     * @param value - Expected value
+     * @param exactMatch - If true, value must match exactly; if false, attribute must contain value (default: true)
+     * @returns Condition function for use with wait()
+     *
+     * @example
+     * ```typescript
+     * const button = await app.find('#submit');
+     *
+     * // Wait for button to become disabled
+     * await app.wait(EC.hasAttribute(button, 'disabled', 'true'));
+     *
+     * // Wait for data attribute (partial match)
+     * await app.wait(EC.hasAttribute(button, 'data-state', 'loading', false));
+     *
+     * // Check ARIA label
+     * await app.wait(EC.hasAttribute(button, 'aria-label', 'Submit form'));
+     * ```
+     */
     static hasAttribute(element: WebElement, attribute: string, value: string, exactMatch?: boolean): (driver: WebDriver) => Promise<boolean>;
+    /**
+     * Creates a condition that waits for an element to have a specific CSS class.
+     *
+     * Convenience method that checks the 'class' attribute. Can do exact or partial match.
+     * Perfect for waiting for state changes reflected in CSS classes.
+     *
+     * @param element - WebElement to check
+     * @param value - Class name to wait for
+     * @param exactMatch - If true, class attribute must match exactly; if false, must contain the class (default: false)
+     * @returns Condition function for use with wait()
+     *
+     * @example
+     * ```typescript
+     * const button = await app.find('#submit');
+     *
+     * // Wait for class to be added (partial match)
+     * await app.wait(EC.hasClass(button, 'active'));
+     *
+     * // Wait for exact class attribute
+     * await app.wait(EC.hasClass(button, 'btn btn-primary', true));
+     *
+     * // Wait for loading class
+     * await app.wait(EC.hasClass(await app.find('.spinner'), 'loading'));
+     * ```
+     */
     static hasClass(element: WebElement, value: string, exactMatch?: boolean): (driver: WebDriver) => Promise<boolean>;
+    /**
+     * Creates a condition that waits for an element to be visible.
+     *
+     * Element must be present in DOM and have display style that makes it visible.
+     * Accepts WebElement, By locator, or CSS selector string.
+     *
+     * @param element - Element to check visibility of (WebElement, By locator, or CSS selector)
+     * @returns Condition function for use with wait()
+     *
+     * @example
+     * ```typescript
+     * // Wait for modal to appear
+     * await app.wait(EC.isVisible('#modal'));
+     *
+     * // Wait for element after click
+     * await app.click('#show-details');
+     * await app.wait(EC.isVisible('.details-panel'));
+     *
+     * // With By locator
+     * await app.wait(EC.isVisible(By.css('[data-test="banner"]')));
+     * ```
+     */
     static isVisible(element: WebElement | By | string): (driver: WebDriver) => Promise<boolean>;
+    /**
+     * Creates a condition that waits for an element to become hidden or not present.
+     *
+     * Element is considered not visible if it's either not in DOM or has display:none or similar.
+     * Opposite of {@link isVisible}.
+     *
+     * @param element - Element to check (WebElement, By locator, or CSS selector)
+     * @returns Condition function for use with wait()
+     *
+     * @example
+     * ```typescript
+     * // Wait for loading spinner to disappear
+     * await app.wait(EC.notVisible('.spinner'));
+     *
+     * // Wait for modal to close
+     * await app.click('.modal .close');
+     * await app.wait(EC.notVisible('.modal'));
+     * ```
+     */
     static notVisible(element: WebElement | By | string): (driver: WebDriver) => Promise<boolean>;
+    /**
+     * Creates a condition that waits for an element to be in the visible viewport.
+     *
+     * Checks if the center point of the element is actually visible in the viewport and not
+     * covered by other elements. Stricter than {@link isVisible} - element must be scrolled into view.
+     *
+     * @param element - Element to check (WebElement, By locator, or CSS selector)
+     * @returns Condition function for use with wait()
+     *
+     * @example
+     * ```typescript
+     * // Wait for element to scroll into view
+     * await app.wait(EC.isInViewport('.footer-content'));
+     *
+     * // Verify element is actually visible to user
+     * await app.scrollIntoView('#target');
+     * await app.wait(EC.isInViewport('#target'));
+     * ```
+     */
     static isInViewport(element: WebElement | By | string): (driver: WebDriver) => Promise<boolean>;
+    /**
+     * Creates a condition that waits for an element to be outside the visible viewport.
+     *
+     * Checks if the element is scrolled out of view or covered. Opposite of {@link isInViewport}.
+     *
+     * @param element - Element to check (WebElement, By locator, or CSS selector)
+     * @returns Condition function for use with wait()
+     *
+     * @example
+     * ```typescript
+     * // Wait for element to scroll out of view
+     * await app.scrollIntoView('#bottom-element');
+     * await app.wait(EC.notInViewport('#top-element'));
+     * ```
+     */
     static notInViewport(element: WebElement | By | string): (driver: WebDriver) => Promise<boolean>;
 }