codeceptjs 3.6.4 → 3.6.5-beta.1

package/typings/promiseBasedTypes.d.ts

@@ -1180,6 +1180,9 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1291,6 +1294,9 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1962,6 +1968,9 @@ declare namespace CodeceptJS {
      * @property [host = "0.0.0.0"] - Mock server host
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2086,6 +2095,9 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3115,6 +3127,91 @@ declare namespace CodeceptJS {
          */
         askGptGeneralPrompt(prompt: string): Promise<string>;
     }
+    /**
+     * ## Configuration
+     *
+     * This helper should be configured in codecept.conf.(js|ts)
+     * @property [url] - base url of website to be tested
+     * @property [browser = 'chromium'] - a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
+     * @property [show = true] - show browser window.
+     * @property [restart = false] - restart strategy between tests. Possible values:
+     *   * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated.
+     *   * 'browser' or **true** - closes browser and opens it again between tests.
+     *   * 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default before CodeceptJS 3.1
+     * @property [timeout = 1000] - -  [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) in ms of all Playwright actions .
+     * @property [disableScreenshots = false] - don't save screenshot on failure.
+     * @property [emulate] - browser in device emulation mode.
+     * @property [video = false] - enables video recording for failed tests; videos are saved into `output/videos` folder
+     * @property [keepVideoForPassedTests = false] - save videos for passed tests; videos are saved into `output/videos` folder
+     * @property [trace = false] - record [tracing information](https://playwright.dev/docs/trace-viewer) with screenshots and snapshots.
+     * @property [keepTraceForPassedTests = false] - save trace for passed tests.
+     * @property [fullPageScreenshots = false] - make full page screenshots on failure.
+     * @property [uniqueScreenshotNames = false] - option to prevent screenshot override if you have scenarios with the same name in different suites.
+     * @property [keepBrowserState = false] - keep browser state between tests when `restart` is set to 'session'.
+     * @property [keepCookies = false] - keep cookies between tests when `restart` is set to 'session'.
+     * @property [waitForAction] - how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
+     * @property [waitForNavigation] - When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `commit`. Choose one of those options is possible. See [Playwright API](https://playwright.dev/docs/api/class-page#page-wait-for-url).
+     * @property [pressKeyDelay = 10] - Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
+     * @property [getPageTimeout] - config option to set maximum navigation time in milliseconds.
+     * @property [waitForTimeout] - default wait* timeout in ms. Default: 1000.
+     * @property [basicAuth] - the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
+     * @property [windowSize] - default window size. Set a dimension like `640x480`.
+     * @property [colorScheme] - default color scheme. Possible values: `dark` | `light` | `no-preference`.
+     * @property [userAgent] - user-agent string.
+     * @property [locale] - locale string. Example: 'en-GB', 'de-DE', 'fr-FR', ...
+     * @property [manualStart] - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
+     * @property [chromium] - pass additional chromium options
+     * @property [firefox] - pass additional firefox options
+     * @property [electron] - (pass additional electron options
+     * @property [channel] - (While Playwright can operate against the stock Google Chrome and Microsoft Edge browsers available on the machine. In particular, current Playwright version will support Stable and Beta channels of these browsers. See [Google Chrome & Microsoft Edge](https://playwright.dev/docs/browsers/#google-chrome--microsoft-edge).
+     * @property [ignoreLog] - An array with console message types that are not logged to debug log. Default value is `['warning', 'log']`. E.g. you can set `[]` to log all messages. See all possible [values](https://playwright.dev/docs/api/class-consolemessage#console-message-type).
+     * @property [ignoreHTTPSErrors] - Allows access to untrustworthy pages, e.g. to a page with an expired certificate. Default value is `false`
+     * @property [bypassCSP] - bypass Content Security Policy or CSP
+     * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
+     * @property [recordHar] - record HAR and will be saved to `output/har`. See more of [HAR options](https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har).
+     * @property [testIdAttribute = data-testid] - locate elements based on the testIdAttribute. See more of [locate by test id](https://playwright.dev/docs/locators#locate-by-test-id).
+     */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    type PlaywrightConfig = {
+        url?: string;
+        browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
+        show?: boolean;
+        restart?: string | boolean;
+        timeout?: number;
+        disableScreenshots?: boolean;
+        emulate?: any;
+        video?: boolean;
+        keepVideoForPassedTests?: boolean;
+        trace?: boolean;
+        keepTraceForPassedTests?: boolean;
+        fullPageScreenshots?: boolean;
+        uniqueScreenshotNames?: boolean;
+        keepBrowserState?: boolean;
+        keepCookies?: boolean;
+        waitForAction?: number;
+        waitForNavigation?: 'load' | 'domcontentloaded' | 'commit';
+        pressKeyDelay?: number;
+        getPageTimeout?: number;
+        waitForTimeout?: number;
+        basicAuth?: any;
+        windowSize?: string;
+        colorScheme?: 'dark' | 'light' | 'no-preference';
+        userAgent?: string;
+        locale?: string;
+        manualStart?: boolean;
+        chromium?: any;
+        firefox?: any;
+        electron?: any;
+        channel?: any;
+        ignoreLog?: string[];
+        ignoreHTTPSErrors?: boolean;
+        bypassCSP?: boolean;
+        highlightElement?: boolean;
+        recordHar?: any;
+        testIdAttribute?: string;
+    };
     /**
      * Uses [Playwright](https://github.com/microsoft/playwright) library to run tests inside:
      *
@@ -4670,6 +4767,13 @@ declare namespace CodeceptJS {
          * @param [sec = 1] - (optional) time in seconds to wait, 1 by default.
          */
         waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
+        /**
+         * Waits for element to become disabled (by default waits for 1sec).
+         * Element can be located by CSS or XPath.
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param [sec = 1] - (optional) time in seconds to wait, 1 by default.
+         */
+        waitForDisabled(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
         /**
          * Waits for the specified value to be in value attribute.
          *
@@ -6419,6 +6523,60 @@ declare namespace CodeceptJS {
          */
         setCookie(cookie: Cookie | Cookie[]): Promise<any>;
     }
+    /**
+     * ## Configuration
+     *
+     * This helper should be configured in codecept.conf.js
+     * @property url - base url of website to be tested
+     * @property [basicAuth] - (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
+     * @property [show] - show Google Chrome window for debug.
+     * @property [restart = true] - restart browser between tests.
+     * @property [disableScreenshots = false] - don't save screenshot on failure.
+     * @property [fullPageScreenshots = false] - make full page screenshots on failure.
+     * @property [uniqueScreenshotNames = false] - option to prevent screenshot override if you have scenarios with the same name in different suites.
+     * @property [trace = false] - record [tracing information](https://pptr.dev/api/puppeteer.tracing) with screenshots.
+     * @property [keepTraceForPassedTests = false] - save trace for passed tests.
+     * @property [keepBrowserState = false] - keep browser state between tests when `restart` is set to false.
+     * @property [keepCookies = false] - keep cookies between tests when `restart` is set to false.
+     * @property [waitForAction = 100] - how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
+     * @property [waitForNavigation = load] - when to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions). Array values are accepted as well.
+     * @property [pressKeyDelay = 10] - delay between key presses in ms. Used when calling Puppeteers page.type(...) in fillField/appendField
+     * @property [getPageTimeout = 30000] - config option to set maximum navigation time in milliseconds. If the timeout is set to 0, then timeout will be disabled.
+     * @property [waitForTimeout = 1000] - default wait* timeout in ms.
+     * @property [windowSize] - default window size. Set a dimension in format WIDTHxHEIGHT like `640x480`.
+     * @property [userAgent] - user-agent string.
+     * @property [manualStart = false] - do not start browser before a test, start it manually inside a helper with `this.helpers["Puppeteer"]._startBrowser()`.
+     * @property [browser = chrome] - can be changed to `firefox` when using [puppeteer-firefox](https://codecept.io/helpers/Puppeteer-firefox).
+     * @property [chrome] - pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
+     * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
+     */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    type PuppeteerConfig = {
+        url: string;
+        basicAuth?: any;
+        show?: boolean;
+        restart?: boolean;
+        disableScreenshots?: boolean;
+        fullPageScreenshots?: boolean;
+        uniqueScreenshotNames?: boolean;
+        trace?: boolean;
+        keepTraceForPassedTests?: boolean;
+        keepBrowserState?: boolean;
+        keepCookies?: boolean;
+        waitForAction?: number;
+        waitForNavigation?: string;
+        pressKeyDelay?: number;
+        getPageTimeout?: number;
+        waitForTimeout?: number;
+        windowSize?: string;
+        userAgent?: string;
+        manualStart?: boolean;
+        browser?: string;
+        chrome?: any;
+        highlightElement?: boolean;
+    };
     /**
      * Uses [Google Chrome's Puppeteer](https://github.com/GoogleChrome/puppeteer) library to run tests inside headless Chrome.
      * Browser control is executed via DevTools Protocol (instead of Selenium).
@@ -8189,6 +8347,32 @@ declare namespace CodeceptJS {
          */
         flushWebSocketMessages(): Promise<any>;
     }
+    /**
+     * ## Configuration
+     * @property [endpoint] - API base URL
+     * @property [prettyPrintJson = false] - pretty print json for response/request on console logs.
+     * @property [printCurl = false] - print cURL request on console logs. False by default.
+     * @property [timeout = 1000] - timeout for requests in milliseconds. 10000ms by default.
+     * @property [defaultHeaders] - a list of default headers.
+     * @property [httpAgent] - create an agent with SSL certificate
+     * @property [onRequest] - an async function which can update request object.
+     * @property [onResponse] - an async function which can update response object.
+     * @property [maxUploadFileSize] - set the max content file size in MB when performing api calls.
+     */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    type RESTConfig = {
+        endpoint?: string;
+        prettyPrintJson?: boolean;
+        printCurl?: boolean;
+        timeout?: number;
+        defaultHeaders?: any;
+        httpAgent?: any;
+        onRequest?: (...params: any[]) => any;
+        onResponse?: (...params: any[]) => any;
+        maxUploadFileSize?: number;
+    };
     /**
      * REST helper allows to send additional requests to the REST API during acceptance tests.
      * [Axios](https://github.com/axios/axios) library is used to perform requests.
@@ -9269,6 +9453,60 @@ declare namespace CodeceptJS {
          */
         waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<any>;
     }
+    /**
+     * ## Configuration
+     *
+     * This helper should be configured in codecept.conf.js
+     * @property url - base url of website to be tested.
+     * @property browser - Browser in which to perform testing.
+     * @property [basicAuth] - (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
+     * @property [host = localhost] - WebDriver host to connect.
+     * @property [port = 4444] - WebDriver port to connect.
+     * @property [protocol = http] - protocol for WebDriver server.
+     * @property [path = /wd/hub] - path to WebDriver server.
+     * @property [restart = true] - restart browser between tests.
+     * @property [smartWait = false] - **enables [SmartWait](http://codecept.io/acceptance/#smartwait)**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
+     * @property [disableScreenshots = false] - don't save screenshots on failure.
+     * @property [fullPageScreenshots = false] - (optional - make full page screenshots on failure.
+     * @property [uniqueScreenshotNames = false] - option to prevent screenshot override if you have scenarios with the same name in different suites.
+     * @property [keepBrowserState = false] - keep browser state between tests when `restart` is set to false.
+     * @property [keepCookies = false] - keep cookies between tests when `restart` set to false.
+     * @property [windowSize = window] - default window size. Set to `maximize` or a dimension in the format `640x480`.
+     * @property [waitForTimeout = 1000] - sets default wait time in *ms* for all `wait*` functions.
+     * @property [desiredCapabilities] - Selenium's [desired capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities).
+     * @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.
+     */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    type WebDriverConfig = {
+        url: string;
+        browser: string;
+        basicAuth?: string;
+        host?: string;
+        port?: number;
+        protocol?: string;
+        path?: string;
+        restart?: boolean;
+        smartWait?: boolean | number;
+        disableScreenshots?: boolean;
+        fullPageScreenshots?: boolean;
+        uniqueScreenshotNames?: boolean;
+        keepBrowserState?: boolean;
+        keepCookies?: boolean;
+        windowSize?: string;
+        waitForTimeout?: number;
+        desiredCapabilities?: any;
+        manualStart?: boolean;
+        timeouts?: any;
+        highlightElement?: boolean;
+        logLevel?: string;
+        devtoolsProtocol?: boolean;
+    };
     /**
      * WebDriver helper which wraps [webdriverio](http://webdriver.io/) library to
      * manipulate browser using Selenium WebDriver or PhantomJS.

package/typings/types.d.ts

@@ -1204,6 +1204,9 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1315,6 +1318,9 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1989,6 +1995,9 @@ declare namespace CodeceptJS {
      * @property [host = "0.0.0.0"] - Mock server host
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2113,6 +2122,9 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3252,6 +3264,9 @@ declare namespace CodeceptJS {
      * @property [recordHar] - record HAR and will be saved to `output/har`. See more of [HAR options](https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har).
      * @property [testIdAttribute = data-testid] - locate elements based on the testIdAttribute. See more of [locate by test id](https://playwright.dev/docs/locators#locate-by-test-id).
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -4904,6 +4919,14 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          */
         waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): void;
+        /**
+         * Waits for element to become disabled (by default waits for 1sec).
+         * Element can be located by CSS or XPath.
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param [sec = 1] - (optional) time in seconds to wait, 1 by default.
+         * @returns automatically synchronized promise through #recorder
+         */
+        waitForDisabled(locator: CodeceptJS.LocatorOrString, sec?: number): void;
         /**
          * Waits for the specified value to be in value attribute.
          *
@@ -6771,6 +6794,9 @@ declare namespace CodeceptJS {
      * @property [chrome] - pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8713,6 +8739,9 @@ declare namespace CodeceptJS {
      * @property [onResponse] - an async function which can update response object.
      * @property [maxUploadFileSize] - set the max content file size in MB when performing api calls.
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9891,6 +9920,9 @@ declare namespace CodeceptJS {
      * @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.
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;