codeceptjs 3.5.4-beta.1 → 3.5.5

package/typings/promiseBasedTypes.d.ts

@@ -841,7 +841,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        dontSeeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Opposite to `see`. Checks that a text is not present on a page.
          * Use context parameter to narrow down the search.
@@ -1022,7 +1022,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        seeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Checks that a page contains a visible text.
          * Use context parameter to narrow down the search.
@@ -1295,6 +1295,21 @@ declare namespace CodeceptJS {
          * @param [options] - are additional query options
          */
         sendMutation(mutation: string, variables?: any, options?: any, headers?: any): Promise<any>;
+        /**
+         * Sets request headers for all requests of this test
+         * @param headers - headers list
+         */
+        haveRequestHeaders(headers: any): Promise<any>;
+        /**
+         * Adds a header for Bearer authentication
+         *
+         * ```js
+         * // we use secret function to hide token from logs
+         * I.amBearerAuthenticated(secret('heregoestoken'))
+         * ```
+         * @param accessToken - Bearer access token
+         */
+        amBearerAuthenticated(accessToken: string | CodeceptJS.Secret): Promise<any>;
     }
     /**
      * Helper for managing remote data using GraphQL queries.
@@ -2056,6 +2071,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -2085,6 +2102,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -2191,7 +2210,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        seeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Checks that value of input field or textarea doesn't equal to given value
          * Opposite to `seeInField`.
@@ -2204,7 +2223,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        dontSeeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Sends [input event](http://electron.atom.io/docs/api/web-contents/#webcontentssendinputeventevent) on a page.
          * Can submit special keys like 'Enter', 'Backspace', etc
@@ -2825,6 +2844,7 @@ declare namespace CodeceptJS {
      *      url: "http://localhost",
      *      show: true // headless mode not supported for extensions
      *      chromium: {
+     *        // Note: due to this would launch persistent context, so to avoid the error when running tests with run-workers a timestamp would be appended to the defined folder name. For instance: playwright-tmp_1692715649511
      *        userDataDir: '/tmp/playwright-tmp', // necessary to launch the browser in normal mode instead of incognito,
      *        args: [
      *           `--disable-extensions-except=${pathToExtension}`,
@@ -3226,7 +3246,16 @@ declare namespace CodeceptJS {
          */
         _locate(): Promise<any>;
         /**
-         * Find a checkbox by providing human readable text:
+         * Get the first element by different locator types, including strict locator
+         * Should be used in custom helpers:
+         *
+         * ```js
+         * const element = await this.helpers['Playwright']._locateElement({name: 'password'});
+         * ```
+         */
+        _locateElement(): Promise<any>;
+        /**
+         * Find a checkbox by providing human-readable text:
          * NOTE: Assumes the checkable element exists
          *
          * ```js
@@ -3235,7 +3264,7 @@ declare namespace CodeceptJS {
          */
         _locateCheckable(): Promise<any>;
         /**
-         * Find a clickable element by providing human readable text:
+         * Find a clickable element by providing human-readable text:
          *
          * ```js
          * this.helpers['Playwright']._locateClickable('Next page').then // ...
@@ -3243,7 +3272,7 @@ declare namespace CodeceptJS {
          */
         _locateClickable(): Promise<any>;
         /**
-         * Find field elements by providing human readable text:
+         * Find field elements by providing human-readable text:
          *
          * ```js
          * this.helpers['Playwright']._locateFields('Your email').then // ...
@@ -3728,7 +3757,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        seeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Checks that value of input field or textarea doesn't equal to given value
          * Opposite to `seeInField`.
@@ -3741,7 +3770,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        dontSeeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Attaches a file to element located by label, name, CSS or XPath
          * Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
@@ -4433,11 +4462,18 @@ declare namespace CodeceptJS {
          */
         waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<any>;
         /**
-         * Waits for navigation to finish. By default takes configured `waitForNavigation` option.
+         * Waits for navigation to finish. By default, it takes configured `waitForNavigation` option.
          *
          * See [Playwright's reference](https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions)
          */
         waitForNavigation(options: any): Promise<any>;
+        /**
+         * Waits for page navigates to a new URL or reloads. By default, it takes configured `waitForNavigation` option.
+         *
+         * See [Playwright's reference](https://playwright.dev/docs/api/class-page#page-wait-for-url)
+         * @param url - A glob pattern, regex pattern or predicate receiving URL to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.
+         */
+        waitForURL(url: string | RegExp, options: any): Promise<any>;
         /**
          * Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
          * Element can be located by CSS or XPath.
@@ -4520,20 +4556,27 @@ declare namespace CodeceptJS {
          */
         stopMockingRoute(url?: string | RegExp, handler?: (...params: any[]) => any): Promise<any>;
         /**
-         * Starts recording of network traffic.
+         * Starts recording the network traffics.
          * This also resets recorded network requests.
          *
          * ```js
          * I.startRecordingTraffic();
          * ```
          */
-        startRecordingTraffic(): Promise<void>;
+        startRecordingTraffic(): Promise<any>;
         /**
          * Grab the recording network traffics
+         *
+         * ```js
+         * const traffics = await I.grabRecordedNetworkTraffics();
+         * expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
+         * expect(traffics[0].response.status).to.equal(200);
+         * expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
+         * ```
          */
-        grabRecordedNetworkTraffics(): Promise<any>;
+        grabRecordedNetworkTraffics(): Promise<any[]>;
         /**
-         * Blocks traffic for URL.
+         * Blocks traffic of a given URL or a list of URLs.
          *
          * Examples:
          *
@@ -4543,9 +4586,13 @@ declare namespace CodeceptJS {
          * I.blockTraffic('http://example.com/**');
          * I.blockTraffic(/\.css$/);
          * ```
-         * @param url - URL to block . URL can contain * for wildcards. Example: https://www.example.com** to block all traffic for that domain. Regexp are also supported.
+         *
+         * ```js
+         * I.blockTraffic(['http://example.com/css/style.css', 'http://example.com/css/*.css']);
+         * ```
+         * @param urls - URL or a list of URLs to block . URL can contain * for wildcards. Example: https://www.example.com** to block all traffic for that domain. Regexp are also supported.
          */
-        blockTraffic(url: any): Promise<any>;
+        blockTraffic(urls: string | any[] | RegExp): Promise<any>;
         /**
          * Mocks traffic for URL(s).
          * This is a powerful feature to manipulate network traffic. Can be used e.g. to stabilize your tests, speed up your tests or as a last resort to make some test scenarios even possible.
@@ -4646,42 +4693,84 @@ declare namespace CodeceptJS {
             name: string;
             url: string | RegExp;
         }): Promise<any>;
-    }
-    /**
-     * This helper works the same as MockRequest helper. It has been included for backwards compatibility
-     * reasons. So use MockRequest helper instead of this.
-     *
-     * Please refer to MockRequest helper documentation for details.
-     *
-     * ### Installations
-     *
-     * Requires [Polly.js](https://netflix.github.io/pollyjs/#/) library by Netflix installed
-     *
-     * ```
-     * npm i @pollyjs/core @pollyjs/adapter-puppeteer --save-dev
-     * ```
-     *
-     * Requires Puppeteer helper or WebDriver helper enabled
-     *
-     * ### Configuration
-     *
-     * Just enable helper in config file:
-     *
-     * ```js
-     * helpers: {
-     *    Puppeteer: {
-     *      // regular Puppeteer config here
-     *    },
-     *    Polly: {}
-     * }
-     * ```
-     * The same can be done when using WebDriver helper..
-     *
-     * ### Usage
-     *
-     * Use `I.mockRequest` to intercept and mock requests.
-     */
-    class PollyTs {
+        /**
+         * Starts recording of websocket messages.
+         * This also resets recorded websocket messages.
+         *
+         * ```js
+         * await I.startRecordingWebSocketMessages();
+         * ```
+         */
+        startRecordingWebSocketMessages(): Promise<any>;
+        /**
+         * Stops recording WS messages. Recorded WS messages is not flashed.
+         *
+         * ```js
+         * await I.stopRecordingWebSocketMessages();
+         * ```
+         */
+        stopRecordingWebSocketMessages(): Promise<any>;
+        /**
+         * Grab the recording WS messages
+         */
+        grabWebSocketMessages(): Promise<any>;
+        /**
+         * Resets all recorded WS messages.
+         */
+        flushWebSocketMessages(): Promise<any>;
+        /**
+         * Return a performance metric from the chrome cdp session.
+         * Note: Chrome-only
+         *
+         * Examples:
+         *
+         * ```js
+         * const metrics = await I.grabMetrics();
+         *
+         * // returned metrics
+         *
+         * [
+         *   { name: 'Timestamp', value: 1584904.203473 },
+         *   { name: 'AudioHandlers', value: 0 },
+         *   { name: 'AudioWorkletProcessors', value: 0 },
+         *   { name: 'Documents', value: 22 },
+         *   { name: 'Frames', value: 10 },
+         *   { name: 'JSEventListeners', value: 366 },
+         *   { name: 'LayoutObjects', value: 1240 },
+         *   { name: 'MediaKeySessions', value: 0 },
+         *   { name: 'MediaKeys', value: 0 },
+         *   { name: 'Nodes', value: 4505 },
+         *   { name: 'Resources', value: 141 },
+         *   { name: 'ContextLifecycleStateObservers', value: 34 },
+         *   { name: 'V8PerContextDatas', value: 4 },
+         *   { name: 'WorkerGlobalScopes', value: 0 },
+         *   { name: 'UACSSResources', value: 0 },
+         *   { name: 'RTCPeerConnections', value: 0 },
+         *   { name: 'ResourceFetchers', value: 22 },
+         *   { name: 'AdSubframes', value: 0 },
+         *   { name: 'DetachedScriptStates', value: 2 },
+         *   { name: 'ArrayBufferContents', value: 1 },
+         *   { name: 'LayoutCount', value: 0 },
+         *   { name: 'RecalcStyleCount', value: 0 },
+         *   { name: 'LayoutDuration', value: 0 },
+         *   { name: 'RecalcStyleDuration', value: 0 },
+         *   { name: 'DevToolsCommandDuration', value: 0.000013 },
+         *   { name: 'ScriptDuration', value: 0 },
+         *   { name: 'V8CompileDuration', value: 0 },
+         *   { name: 'TaskDuration', value: 0.000014 },
+         *   { name: 'TaskOtherDuration', value: 0.000001 },
+         *   { name: 'ThreadTime', value: 0.000046 },
+         *   { name: 'ProcessTime', value: 0.616852 },
+         *   { name: 'JSHeapUsedSize', value: 19004908 },
+         *   { name: 'JSHeapTotalSize', value: 26820608 },
+         *   { name: 'FirstMeaningfulPaint', value: 0 },
+         *   { name: 'DomContentLoaded', value: 1584903.690491 },
+         *   { name: 'NavigationStart', value: 1584902.841845 }
+         * ]
+         *
+         * ```
+         */
+        grabMetrics(): Promise<object[]>;
     }
     /**
      * Protractor helper is based on [Protractor library](http://www.protractortest.org) and used for testing web applications.
@@ -5069,7 +5158,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        seeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Checks that value of input field or textarea doesn't equal to given value
          * Opposite to `seeInField`.
@@ -5082,7 +5171,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        dontSeeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Appends text to a input field or textarea.
          * Field is located by name, label, CSS or XPath
@@ -5479,6 +5568,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
@@ -5505,6 +5596,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
@@ -6905,7 +6998,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        seeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Checks that value of input field or textarea doesn't equal to given value
          * Opposite to `seeInField`.
@@ -6918,7 +7011,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        dontSeeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Attaches a file to element located by label, name, CSS or XPath
          * Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
@@ -7229,6 +7322,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -7258,6 +7353,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -7861,72 +7958,6 @@ declare namespace CodeceptJS {
          */
         sendDeleteRequest(url: any, headers?: any): Promise<any>;
     }
-    /**
-     * SeleniumWebdriver helper is based on the official [Selenium Webdriver JS](https://www.npmjs.com/package/selenium-webdriver)
-     * library. It implements common web api methods (amOnPage, click, see).
-     *
-     * ## Backends
-     *
-     * ### Selenium Installation
-     *
-     * 1. Download [Selenium Server](http://docs.seleniumhq.org/download/)
-     * 2. For Chrome browser install [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/getting-started), for Firefox browser install [GeckoDriver](https://github.com/mozilla/geckodriver).
-     * 3. Launch the server: `java -jar selenium-server-standalone-3.xx.xxx.jar`. To locate Chromedriver binary use `-Dwebdriver.chrome.driver=./chromedriver` option. For Geckodriver use `-Dwebdriver.gecko.driver=`.
-     *
-     *
-     * ### PhantomJS Installation
-     *
-     * PhantomJS is a headless alternative to Selenium Server that implements [the WebDriver protocol](https://code.google.com/p/selenium/wiki/JsonWireProtocol).
-     * It allows you to run Selenium tests on a server without a GUI installed.
-     *
-     * 1. Download [PhantomJS](http://phantomjs.org/download.html)
-     * 2. Run PhantomJS in WebDriver mode: `phantomjs --webdriver=4444`
-     *
-     * ## Configuration
-     *
-     * This helper should be configured in codecept.json or codecept.conf.js
-     *
-     * * `url` - base url of website to be tested
-     * * `browser` - browser in which perform testing
-     * * `driver` - which protractor driver to use (local, direct, session, hosted, sauce, browserstack). By default set to 'hosted' which requires selenium server to be started.
-     * * `restart` - restart browser between tests (default: true).
-     * * `smartWait`: (optional) **enables SmartWait**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000
-     * * `disableScreenshots` (optional, default: false)  - don't save screenshot on failure
-     * * `uniqueScreenshotNames` (optional, default: false)  - option to prevent screenshot override if you have scenarios with the same name in different suites
-     * * `keepBrowserState` (optional, default: false)  - keep browser state between tests when `restart` set to false.
-     * * `keepCookies` (optional, default: false)  - keep cookies between tests when `restart` set to false.*
-     * * `seleniumAddress` - Selenium address to connect (default: http://localhost:4444/wd/hub)
-     * * `waitForTimeout`: (optional) sets default wait time in _ms_ for all `wait*` functions. 1000 by default;
-     * * `scriptTimeout`: (optional) sets default timeout for scripts in `executeAsync`. 1000 by default.
-     * * `windowSize`: (optional) default window size. Set to `maximize` or a dimension in the format `640x480`.
-     * * `manualStart` (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriverIO"]._startBrowser()`
-     * * `capabilities`: {} - list of [Desired Capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities)
-     *
-     * Example:
-     *
-     * ```json
-     * {
-     *    "helpers": {
-     *      "SeleniumWebdriver" : {
-     *        "url": "http://localhost",
-     *        "browser": "chrome",
-     *        "smartWait": 5000,
-     *        "restart": false
-     *      }
-     *    }
-     * }
-     * ```
-     *
-     * ## Access From Helpers
-     *
-     * Receive a WebDriverIO client from a custom helper by accessing `browser` property:
-     *
-     * ```js
-     * this.helpers['SeleniumWebdriver'].browser
-     * ```
-     */
-    class SeleniumWebdriverTs {
-    }
     /**
      * Client Functions
      */
@@ -8474,7 +8505,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        seeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Checks that value of input field or textarea doesn't equal to given value
          * Opposite to `seeInField`.
@@ -8487,7 +8518,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        dontSeeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Checks that text is equal to provided one.
          *
@@ -8577,6 +8608,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -9789,7 +9822,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        seeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Checks that value of input field or textarea doesn't equal to given value
          * Opposite to `seeInField`.
@@ -9802,7 +9835,7 @@ declare namespace CodeceptJS {
          * @param value - value to check.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        dontSeeInField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
+        dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
          * Verifies that the specified checkbox is checked.
          *
@@ -10057,6 +10090,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -10087,6 +10122,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;