codeceptjs 3.5.11 → 3.5.12-beta.2

package/typings/promiseBasedTypes.d.ts

@@ -4347,6 +4347,16 @@ declare namespace CodeceptJS {
          * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
          */
         waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): Promise<any>;
         /**
          * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
          *
@@ -7454,6 +7464,16 @@ declare namespace CodeceptJS {
          * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
          */
         waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): Promise<any>;
         /**
          * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
          *
@@ -8667,6 +8687,13 @@ declare namespace CodeceptJS {
      *
      * WebDriver requires Selenium Server and ChromeDriver/GeckoDriver to be installed. Those tools can be easily installed via NPM. Please check [Testing with WebDriver](https://codecept.io/webdriver/#testing-with-webdriver) for more details.
      *
+     * With the release of WebdriverIO version v8.14.0, and onwards, all driver management hassles are now a thing of the past 🙌. Read more [here](https://webdriver.io/blog/2023/07/31/driver-management/).
+     * One of the significant advantages of this update is that you can now get rid of any driver services you previously had to manage, such as
+     * `wdio-chromedriver-service`, `wdio-geckodriver-service`, `wdio-edgedriver-service`, `wdio-safaridriver-service`, and even `@wdio/selenium-standalone-service`.
+     *
+     * For those who require custom driver options, fear not; WebDriver Helper allows you to pass in driver options through custom WebDriver configuration.
+     * If you have a custom grid, use a cloud service, or prefer to run your own driver, there's no need to worry since WebDriver Helper will only start a driver when there are no other connection information settings like hostname or port specified.
+     *
      * <!-- configuration -->
      *
      * Example:
@@ -8688,6 +8715,28 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
+     * Testing Chrome locally is now more convenient than ever. You can define a browser channel, and WebDriver Helper will take care of downloading the specified browser version for you.
+     * For example:
+     *
+     * ```js
+     * {
+     *    helpers: {
+     *      WebDriver : {
+     *        smartWait: 5000,
+     *        browser: "chrome",
+     *        browserVersion: '116.0.5793.0', // or 'stable', 'beta', 'dev' or 'canary'
+     *        restart: false,
+     *        windowSize: "maximize",
+     *        timeouts: {
+     *          "script": 60000,
+     *          "page load": 10000
+     *        }
+     *      }
+     *    }
+     * }
+     * ```
+     *
+     *
      * Example with basic authentication
      * ```js
      * {
@@ -8728,6 +8777,25 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
+     * ### Running with devtools protocol
+     *
+     * ```js
+     * {
+     *    helpers: {
+     *      WebDriver : {
+     *        url: "http://localhost",
+     *        browser: "chrome",
+     *        devtoolsProtocol: true,
+     *        desiredCapabilities: {
+     *          chromeOptions: {
+     *            args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
+     *          }
+     *        }
+     *      }
+     *    }
+     * }
+     * ```
+     *
      * ### Internet Explorer
      *
      * Additional configuration params can be used from [IE options](https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/IE/Options.html)
@@ -10295,6 +10363,16 @@ declare namespace CodeceptJS {
          * @param [sec = null] - (optional, `1` by default) time in seconds to wait
          */
         waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<any>;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): Promise<any>;
         /**
          * Switches frame or in case of null locator reverts to parent.
          *
@@ -10388,6 +10466,9 @@ declare namespace CodeceptJS {
          */
         grabPageScrollPosition(): Promise<PageScrollPosition>;
         /**
+         * This method is **deprecated**.
+         *
+         *
          * Set the current geo location
          *
          *
@@ -10397,10 +10478,12 @@ declare namespace CodeceptJS {
          * ```
          * @param latitude - to set.
          * @param longitude - to set
-         * @param [altitude = null] - (optional, null by default) to set
+         * @param [altitude] - (optional, null by default) to set
          */
         setGeoLocation(latitude: number, longitude: number, altitude?: number): Promise<any>;
         /**
+         * This method is **deprecated**.
+         *
          * Return the current geo location
          * Resumes test execution, so **should be used inside async function with `await`** operator.
          *

package/typings/types.d.ts

@@ -4583,6 +4583,17 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          */
         waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         * @returns automatically synchronized promise through #recorder
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): void;
         /**
          * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
          *
@@ -7938,6 +7949,17 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          */
         waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         * @returns automatically synchronized promise through #recorder
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): void;
         /**
          * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
          *
@@ -9255,6 +9277,8 @@ declare namespace CodeceptJS {
      * @property [manualStart = false] - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriver"]._startBrowser()`.
      * @property [timeouts] - [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
+     * @property [logLevel = silent] - level of logging verbosity. Default: silent. Options: trace | debug | info | warn | error | silent. More info: https://webdriver.io/docs/configuration/#loglevel
+     * @property [devtoolsProtocol = false] - enable devtools protocol. Default: false. More info: https://webdriver.io/docs/automationProtocols/#devtools-protocol.
      */
     type WebDriverConfig = {
         url: string;
@@ -9277,6 +9301,8 @@ declare namespace CodeceptJS {
         manualStart?: boolean;
         timeouts?: any;
         highlightElement?: boolean;
+        logLevel?: string;
+        devtoolsProtocol?: boolean;
     };
     /**
      * WebDriver helper which wraps [webdriverio](http://webdriver.io/) library to
@@ -9284,6 +9310,13 @@ declare namespace CodeceptJS {
      *
      * WebDriver requires Selenium Server and ChromeDriver/GeckoDriver to be installed. Those tools can be easily installed via NPM. Please check [Testing with WebDriver](https://codecept.io/webdriver/#testing-with-webdriver) for more details.
      *
+     * With the release of WebdriverIO version v8.14.0, and onwards, all driver management hassles are now a thing of the past 🙌. Read more [here](https://webdriver.io/blog/2023/07/31/driver-management/).
+     * One of the significant advantages of this update is that you can now get rid of any driver services you previously had to manage, such as
+     * `wdio-chromedriver-service`, `wdio-geckodriver-service`, `wdio-edgedriver-service`, `wdio-safaridriver-service`, and even `@wdio/selenium-standalone-service`.
+     *
+     * For those who require custom driver options, fear not; WebDriver Helper allows you to pass in driver options through custom WebDriver configuration.
+     * If you have a custom grid, use a cloud service, or prefer to run your own driver, there's no need to worry since WebDriver Helper will only start a driver when there are no other connection information settings like hostname or port specified.
+     *
      * <!-- configuration -->
      *
      * Example:
@@ -9305,6 +9338,28 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
+     * Testing Chrome locally is now more convenient than ever. You can define a browser channel, and WebDriver Helper will take care of downloading the specified browser version for you.
+     * For example:
+     *
+     * ```js
+     * {
+     *    helpers: {
+     *      WebDriver : {
+     *        smartWait: 5000,
+     *        browser: "chrome",
+     *        browserVersion: '116.0.5793.0', // or 'stable', 'beta', 'dev' or 'canary'
+     *        restart: false,
+     *        windowSize: "maximize",
+     *        timeouts: {
+     *          "script": 60000,
+     *          "page load": 10000
+     *        }
+     *      }
+     *    }
+     * }
+     * ```
+     *
+     *
      * Example with basic authentication
      * ```js
      * {
@@ -9345,6 +9400,25 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
+     * ### Running with devtools protocol
+     *
+     * ```js
+     * {
+     *    helpers: {
+     *      WebDriver : {
+     *        url: "http://localhost",
+     *        browser: "chrome",
+     *        devtoolsProtocol: true,
+     *        desiredCapabilities: {
+     *          chromeOptions: {
+     *            args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
+     *          }
+     *        }
+     *      }
+     *    }
+     * }
+     * ```
+     *
      * ### Internet Explorer
      *
      * Additional configuration params can be used from [IE options](https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/IE/Options.html)
@@ -11016,6 +11090,17 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          */
         waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): void;
+        /**
+         * Waits for number of tabs.
+         *
+         * ```js
+         * I.waitForNumberOfTabs(2);
+         * ```
+         * @param expectedTabs - expecting the number of tabs.
+         * @param sec - number of secs to wait.
+         * @returns automatically synchronized promise through #recorder
+         */
+        waitForNumberOfTabs(expectedTabs: number, sec: number): void;
         /**
          * Switches frame or in case of null locator reverts to parent.
          *
@@ -11117,6 +11202,9 @@ declare namespace CodeceptJS {
          */
         grabPageScrollPosition(): Promise<PageScrollPosition>;
         /**
+         * This method is **deprecated**.
+         *
+         *
          * Set the current geo location
          *
          *
@@ -11126,11 +11214,13 @@ declare namespace CodeceptJS {
          * ```
          * @param latitude - to set.
          * @param longitude - to set
-         * @param [altitude = null] - (optional, null by default) to set
+         * @param [altitude] - (optional, null by default) to set
          * @returns automatically synchronized promise through #recorder
          */
         setGeoLocation(latitude: number, longitude: number, altitude?: number): void;
         /**
+         * This method is **deprecated**.
+         *
          * Return the current geo location
          * Resumes test execution, so **should be used inside async function with `await`** operator.
          *
@@ -11513,7 +11603,10 @@ declare namespace CodeceptJS {
         isStrict(): boolean;
         isAccessibilityId(): boolean;
         isBasic(): boolean;
-        toXPath(): string;
+        /**
+         * @param [pseudoSelector] - CSS to XPath extension pseudo: https://www.npmjs.com/package/csstoxpath?activeTab=explore#extension-pseudos
+         */
+        toXPath(pseudoSelector?: string): string;
         or(locator: CodeceptJS.LocatorOrString): Locator;
         find(locator: CodeceptJS.LocatorOrString): Locator;
         withChild(locator: CodeceptJS.LocatorOrString): Locator;
@@ -11521,7 +11614,14 @@ declare namespace CodeceptJS {
         at(position: number): Locator;
         first(): Locator;
         last(): Locator;
+        /**
+         * Find an element containing a text
+         */
         withText(text: string): Locator;
+        /**
+         * Find an element with exact text
+         */
+        withTextEquals(text: string): Locator;
         withAttr(attributes: {
             [key: string]: string;
         }): Locator;