codeceptjs 3.2.1 → 3.3.0-beta.2

package/typings/types.d.ts

@@ -186,11 +186,14 @@ declare namespace CodeceptJS {
          * // create user with defined email
          * // and receive it when inside async function
          * const user = await I.have('user', { email: 'user@user.com'});
+         * // create a user with options that will not be included in the final request
+         * I.have('user', { }, { age: 33, height: 55 })
          * ```
          * @param factory - factory to use
          * @param params - predefined parameters
+         * @param options - options for programmatically generate the attributes
          */
-        have(factory: any, params: any): void;
+        have(factory: any, params: any, options: any): void;
         /**
          * Generates bunch of records and saves multiple API requests to store them.
          *
@@ -200,9 +203,12 @@ declare namespace CodeceptJS {
          *
          * // create 3 posts by one author
          * I.haveMultiple('post', 3, { author: 'davert' });
+         *
+         * // create 3 posts by one author with options
+         * I.haveMultiple('post', 3, { author: 'davert' }, { publish_date: '01.01.1997' });
          * ```
          */
-        haveMultiple(factory: any, times: any, params: any): void;
+        haveMultiple(factory: any, times: any, params: any, options: any): void;
         /**
          * Executes request to create a record in API.
          * Can be replaced from a in custom helper.
@@ -249,7 +255,7 @@ declare namespace CodeceptJS {
          * });
          * ```
          */
-        runOnIOS(caps: any, fn: any): void;
+        runOnIOS(caps: any, fn: any): Promise<any>;
         /**
          * Execute code only on Android
          *
@@ -281,7 +287,7 @@ declare namespace CodeceptJS {
          * });
          * ```
          */
-        runOnAndroid(caps: any, fn: any): void;
+        runOnAndroid(caps: any, fn: any): Promise<any>;
         /**
          * Check if an app is installed.
          *
@@ -289,10 +295,9 @@ declare namespace CodeceptJS {
          * I.seeAppIsInstalled("com.example.android.apis");
          * ```
          * @param bundleId - String  ID of bundled app
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        seeAppIsInstalled(bundleId: string): void;
+        seeAppIsInstalled(bundleId: string): Promise<void>;
         /**
          * Check if an app is not installed.
          *
@@ -300,10 +305,9 @@ declare namespace CodeceptJS {
          * I.seeAppIsNotInstalled("com.example.android.apis");
          * ```
          * @param bundleId - String  ID of bundled app
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        seeAppIsNotInstalled(bundleId: string): void;
+        seeAppIsNotInstalled(bundleId: string): Promise<void>;
         /**
          * Install an app on device.
          *
@@ -311,10 +315,9 @@ declare namespace CodeceptJS {
          * I.installApp('/path/to/file.apk');
          * ```
          * @param path - path to apk file
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        installApp(path: string): void;
+        installApp(path: string): Promise<void>;
         /**
          * Remove an app from the device.
          *
@@ -332,29 +335,27 @@ declare namespace CodeceptJS {
          * ```js
          * I.seeCurrentActivityIs(".HomeScreenActivity")
          * ```
-         * @param currentActivity - Appium: support only Android
+         * @returns Appium: support only Android
          */
-        seeCurrentActivityIs(currentActivity: string): void;
+        seeCurrentActivityIs(currentActivity: string): Promise<void>;
         /**
          * Check whether the device is locked.
          *
          * ```js
          * I.seeDeviceIsLocked();
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        seeDeviceIsLocked(): void;
+        seeDeviceIsLocked(): Promise<void>;
         /**
          * Check whether the device is not locked.
          *
          * ```js
          * I.seeDeviceIsUnlocked();
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        seeDeviceIsUnlocked(): void;
+        seeDeviceIsUnlocked(): Promise<void>;
         /**
          * Check the device orientation
          *
@@ -366,7 +367,7 @@ declare namespace CodeceptJS {
          *
          * Appium: support Android and iOS
          */
-        seeOrientationIs(orientation: 'LANDSCAPE' | 'PORTRAIT'): void;
+        seeOrientationIs(orientation: 'LANDSCAPE' | 'PORTRAIT'): Promise<void>;
         /**
          * Set a device orientation. Will fail, if app will not set orientation
          *
@@ -375,40 +376,36 @@ declare namespace CodeceptJS {
          * I.setOrientation('LANDSCAPE')
          * ```
          * @param orientation - LANDSCAPE or PORTRAIT
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        setOrientation(orientation: 'LANDSCAPE' | 'PORTRAIT'): void;
+        setOrientation(orientation: 'LANDSCAPE' | 'PORTRAIT'): Promise<any>;
         /**
          * Get list of all available contexts
          *
          * ```
          * let contexts = await I.grabAllContexts();
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        grabAllContexts(): void;
+        grabAllContexts(): Promise<string[]>;
         /**
          * Retrieve current context
          *
          * ```js
          * let context = await I.grabContext();
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        grabContext(): void;
+        grabContext(): Promise<string | null>;
         /**
          * Get current device activity.
          *
          * ```js
          * let activity = await I.grabCurrentActivity();
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        grabCurrentActivity(): void;
+        grabCurrentActivity(): Promise<string>;
         /**
          * Get information about the current network connection (Data/WIFI/Airplane).
          * The actual server value will be a number. However WebdriverIO additional
@@ -417,30 +414,27 @@ declare namespace CodeceptJS {
          * ```js
          * let con = await I.grabNetworkConnection();
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        grabNetworkConnection(): void;
+        grabNetworkConnection(): Promise<{}>;
         /**
          * Get current orientation.
          *
          * ```js
          * let orientation = await I.grabOrientation();
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        grabOrientation(): void;
+        grabOrientation(): Promise<string>;
         /**
          * Get all the currently specified settings.
          *
          * ```js
          * let settings = await I.grabSettings();
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        grabSettings(): void;
+        grabSettings(): Promise<string>;
         /**
          * Switch to the specified context.
          * @param context - the context to switch to
@@ -458,7 +452,7 @@ declare namespace CodeceptJS {
          * I.switchToWeb('WEBVIEW_io.selendroid.testapp');
          * ```
          */
-        switchToWeb(context?: string): void;
+        switchToWeb(context?: string): Promise<void>;
         /**
          * Switches to native context.
          * By default switches to NATIVE_APP context unless other specified.
@@ -470,17 +464,16 @@ declare namespace CodeceptJS {
          * I.switchToNative('SOME_OTHER_CONTEXT');
          * ```
          */
-        switchToNative(context: any): void;
+        switchToNative(context: any): Promise<void>;
         /**
          * Start an arbitrary Android activity during a session.
          *
          * ```js
          * I.startActivity('io.selendroid.testapp', '.RegisterUserActivity');
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        startActivity(): void;
+        startActivity(): Promise<void>;
         /**
          * Set network connection mode.
          *
@@ -496,10 +489,9 @@ declare namespace CodeceptJS {
          * I.setNetworkConnection(6) // airplane mode off, wifi on, data on
          * ```
          * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setNetworkConnection.html).
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        setNetworkConnection(): void;
+        setNetworkConnection(): Promise<{}>;
         /**
          * Update the current setting on the device
          *
@@ -507,10 +499,9 @@ declare namespace CodeceptJS {
          * I.setSettings({cyberdelia: 'open'});
          * ```
          * @param settings - object
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        setSettings(settings: any): void;
+        setSettings(settings: any): Promise<any>;
         /**
          * Hide the keyboard.
          *
@@ -536,20 +527,18 @@ declare namespace CodeceptJS {
          * I.sendDeviceKeyEvent(3);
          * ```
          * @param keyValue - Device specific key value
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        sendDeviceKeyEvent(keyValue: number): void;
+        sendDeviceKeyEvent(keyValue: number): Promise<void>;
         /**
          * Open the notifications panel on the device.
          *
          * ```js
          * I.openNotifications();
          * ```
-         *
-         * Appium: support only Android
+         * @returns Appium: support only Android
          */
-        openNotifications(): void;
+        openNotifications(): Promise<void>;
         /**
          * The Touch Action API provides the basis of all gestures that can be
          * automated in Appium. At its core is the ability to chain together ad hoc
@@ -560,10 +549,9 @@ declare namespace CodeceptJS {
          * ```js
          * I.makeTouchAction("~buttonStartWebviewCD", 'tap');
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        makeTouchAction(): void;
+        makeTouchAction(): Promise<void>;
         /**
          * Taps on element.
          *
@@ -573,16 +561,16 @@ declare namespace CodeceptJS {
          *
          * Shortcut for `makeTouchAction`
          */
-        tap(locator: any): void;
+        tap(locator: any): Promise<void>;
         /**
          * Perform a swipe on the screen.
          *
          * ```js
-         * I.performswipe(100,200);
+         * I.performSwipe({ x: 300, y: 100 }, { x: 200, y: 100 });
          * ```
          * @param to - Appium: support Android and iOS
          */
-        performSwipe(from: number, to: number): void;
+        performSwipe(from: any, to: any): void;
         /**
          * Perform a swipe down on an element.
          *
@@ -594,10 +582,9 @@ declare namespace CodeceptJS {
          * ```
          * @param [yoffset = 1000] - (optional)
          * @param [speed = 1000] - (optional), 1000 by default
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        swipeDown(locator: CodeceptJS.LocatorOrString, yoffset?: number, speed?: number): void;
+        swipeDown(locator: CodeceptJS.LocatorOrString, yoffset?: number, speed?: number): Promise<void>;
         /**
          * Perform a swipe left on an element.
          *
@@ -609,10 +596,9 @@ declare namespace CodeceptJS {
          * ```
          * @param [xoffset = 1000] - (optional)
          * @param [speed = 1000] - (optional), 1000 by default
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        swipeLeft(locator: CodeceptJS.LocatorOrString, xoffset?: number, speed?: number): void;
+        swipeLeft(locator: CodeceptJS.LocatorOrString, xoffset?: number, speed?: number): Promise<void>;
         /**
          * Perform a swipe right on an element.
          *
@@ -624,10 +610,9 @@ declare namespace CodeceptJS {
          * ```
          * @param [xoffset = 1000] - (optional)
          * @param [speed = 1000] - (optional), 1000 by default
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        swipeRight(locator: CodeceptJS.LocatorOrString, xoffset?: number, speed?: number): void;
+        swipeRight(locator: CodeceptJS.LocatorOrString, xoffset?: number, speed?: number): Promise<void>;
         /**
          * Perform a swipe up on an element.
          *
@@ -639,10 +624,9 @@ declare namespace CodeceptJS {
          * ```
          * @param [yoffset = 1000] - (optional)
          * @param [speed = 1000] - (optional), 1000 by default
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        swipeUp(locator: CodeceptJS.LocatorOrString, yoffset?: number, speed?: number): void;
+        swipeUp(locator: CodeceptJS.LocatorOrString, yoffset?: number, speed?: number): Promise<void>;
         /**
          * Perform a swipe in selected direction on an element to searchable element.
          *
@@ -655,9 +639,9 @@ declare namespace CodeceptJS {
          *    100,
          *    500);
          * ```
-         * @param speed - Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        swipeTo(searchableLocator: string, scrollLocator: string, direction: string, timeout: number, offset: number, speed: number): void;
+        swipeTo(searchableLocator: string, scrollLocator: string, direction: string, timeout: number, offset: number, speed: number): Promise<void>;
         /**
          * Performs a specific touch action.
          * The action object need to contain the action name, x/y coordinates
@@ -694,20 +678,18 @@ declare namespace CodeceptJS {
          * // save file to output dir
          * I.pullFile('/storage/emulated/0/DCIM/logo.png', output_dir);
          * ```
-         *
-         * Appium: support Android and iOS
+         * @returns Appium: support Android and iOS
          */
-        pullFile(): void;
+        pullFile(path: string, dest: string): Promise<string>;
         /**
          * Perform a shake action on the device.
          *
          * ```js
          * I.shakeDevice();
          * ```
-         *
-         * Appium: support only iOS
+         * @returns Appium: support only iOS
          */
-        shakeDevice(): void;
+        shakeDevice(): Promise<void>;
         /**
          * Perform a rotation gesture centered on the specified element.
          *
@@ -716,18 +698,16 @@ declare namespace CodeceptJS {
          * ```
          *
          * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/rotate.html).
-         *
-         * Appium: support only iOS
+         * @returns Appium: support only iOS
          */
-        rotate(): void;
+        rotate(): Promise<void>;
         /**
          * Set immediate value in app.
          *
          * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setImmediateValue.html).
-         *
-         * Appium: support only iOS
+         * @returns Appium: support only iOS
          */
-        setImmediateValue(): void;
+        setImmediateValue(): Promise<void>;
         /**
          * Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint.
          *
@@ -736,21 +716,19 @@ declare namespace CodeceptJS {
          * I.touchId(true); // simulates valid fingerprint
          * I.touchId(false); // simulates invalid fingerprint
          * ```
-         *
-         * Appium: support only iOS
+         * @returns Appium: support only iOS
          * TODO: not tested
          */
-        simulateTouchId(): void;
+        simulateTouchId(): Promise<void>;
         /**
          * Close the given application.
          *
          * ```js
          * I.closeApp();
          * ```
-         *
-         * Appium: support only iOS
+         * @returns Appium: support only iOS
          */
-        closeApp(): void;
+        closeApp(): Promise<void>;
         /**
          * Appends text to a input field or textarea.
          * Field is located by name, label, CSS or XPath
@@ -959,7 +937,7 @@ declare namespace CodeceptJS {
          * ```
          * @param fileName - file name to save.
          */
-        saveScreenshot(fileName: string): void;
+        saveScreenshot(fileName: string): Promise<void>;
         /**
          * Scroll element into viewport.
          *
@@ -1106,7 +1084,17 @@ declare namespace CodeceptJS {
      * I.amInPath('test');
      * I.seeFile('codecept.json');
      * I.seeInThisFile('FileSystem');
-     * I.dontSeeInThisFile("WebDriverIO");
+     * I.dontSeeInThisFile("WebDriver");
+     * ```
+     *
+     * ## Configuration
+     *
+     * Enable helper in config file:
+     *
+     * ```js
+     * helpers: {
+     *     FileSystem: {},
+     * }
      * ```
      *
      * ## Methods
@@ -1451,6 +1439,179 @@ declare namespace CodeceptJS {
          */
         _requestDelete(operation: string, data: any): void;
     }
+    /**
+     * This helper allows performing assertions on JSON responses paired with following helpers:
+     *
+     * * REST
+     * * GraphQL
+     * * Playwright
+     *
+     * It can check status codes, response data, response structure.
+     *
+     *
+     * ## Configuration
+     *
+     * * `requestHelper` - a helper which will perform requests. `REST` by default, also `Playwright` or `GraphQL` can be used. Custom helpers must have `onResponse` hook in their config, which will be executed when request is performed.
+     *
+     * ### Examples
+     *
+     * Zero-configuration when paired with REST:
+     *
+     * ```js
+     * // inside codecept.conf.js
+     * {
+     *   helpers: {
+     *     REST: {
+     *       endpoint: 'http://site.com/api',
+     *     },
+     *     JSONResponse: {}
+     *   }
+     * }
+     * ```
+     * Explicitly setting request helper if you use `makeApiRequest` of Playwright to perform requests and not paired REST:
+     *
+     * ```js
+     * // inside codecept.conf.js
+     * // ...
+     *   helpers: {
+     *     Playwright: {
+     *       url: 'https://localhost',
+     *       browser: 'chromium',
+     *     },
+     *     JSONResponse: {
+     *       requestHelper: 'Playwright',
+     *     }
+     *   }
+     * ```
+     * ## Access From Helpers
+     *
+     * If you plan to add custom assertions it is recommended to create a helper that will retrieve response object from JSONResponse:
+     *
+     *
+     * ```js
+     * // inside custom helper
+     * const response = this.helpers.JSONResponse.response;
+     * ```
+     *
+     * ## Methods
+     */
+    class JSONResponse {
+        /**
+         * Checks that response code is equal to the provided one
+         *
+         * ```js
+         * I.seeResponseCodeIs(200);
+         * ```
+         */
+        seeResponseCodeIs(code: number): void;
+        /**
+         * Checks that response code is not equal to the provided one
+         *
+         * ```js
+         * I.dontSeeResponseCodeIs(500);
+         * ```
+         */
+        dontSeeResponseCodeIs(code: number): void;
+        /**
+         * Checks that the response code is 4xx
+         */
+        seeResponseCodeIsClientError(): void;
+        /**
+         * Checks that the response code is 3xx
+         */
+        seeResponseCodeIsRedirection(): void;
+        /**
+         * Checks that the response code is 5xx
+         */
+        seeResponseCodeIsServerError(): void;
+        /**
+         * Checks that the response code is 2xx
+         * Use it instead of seeResponseCodeIs(200) if server can return 204 instead.
+         *
+         * ```js
+         * I.seeResponseCodeIsSuccessful();
+         * ```
+         */
+        seeResponseCodeIsSuccessful(): void;
+        /**
+         * Checks for deep inclusion of a provided json in a response data.
+         *
+         * ```js
+         * // response.data == { user: { name: 'jon', email: 'jon@doe.com' } }
+         *
+         * I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } });
+         * ```
+         */
+        seeResponseContainsJson(json: any): void;
+        /**
+         * Checks for deep inclusion of a provided json in a response data.
+         *
+         * ```js
+         * // response.data == { data: { user: 1 } }
+         *
+         * I.dontSeeResponseContainsJson({ user: 2 });
+         * ```
+         */
+        dontSeeResponseContainsJson(json: any): void;
+        /**
+         * Checks for deep inclusion of a provided json in a response data.
+         *
+         * ```js
+         * // response.data == { user: { name: 'jon', email: 'jon@doe.com' } }
+         *
+         * I.seeResponseContainsKeys(['user']);
+         * ```
+         */
+        seeResponseContainsKeys(keys: any[]): void;
+        /**
+         * Executes a callback function passing in `response` object and chai assertions with `expect`
+         * Use it to perform custom checks of response data
+         *
+         * ```js
+         * I.seeResponseValidByCallback({ data, status, expect } => {
+         *   expect(status).to.eql(200);
+         *   expect(data).keys.to.include(['user', 'company']);
+         * });
+         * ```
+         */
+        seeResponseValidByCallback(fn: (...params: any[]) => any): void;
+        /**
+         * Checks that response data equals to expected:
+         *
+         * ```js
+         * // response.data is { error: 'Not allowed' }
+         *
+         * I.seeResponseEquals({ error: 'Not allowed' })
+         * ```
+         */
+        seeResponseEquals(resp: any): void;
+        /**
+         * Validates JSON structure of response using [joi library](https://joi.dev).
+         * See [joi API](https://joi.dev/api/) for complete reference on usage.
+         *
+         * Use pre-initialized joi instance by passing function callback:
+         *
+         * ```js
+         * // response.data is { name: 'jon', id: 1 }
+         *
+         * I.seeResponseMatchesJsonSchema(joi => {
+         *   return joi.object({
+         *     name: joi.string();
+         *     id: joi.number();
+         *   })
+         * });
+         *
+         * // or pass a valid schema
+         * const joi = require('joi);
+         *
+         * I.seeResponseMatchesJsonSchema(joi.object({
+         *   name: joi.string();
+         *   id: joi.number();
+         * });
+         * ```
+         */
+        seeResponseMatchesJsonSchema(fnOrSchema: any): void;
+    }
     /**
      * Nightmare helper wraps [Nightmare](https://github.com/segmentio/nightmare) library to provide
      * fastest headless testing using Electron engine. Unlike Selenium-based drivers this uses
@@ -2403,12 +2564,18 @@ declare namespace CodeceptJS {
      *
      * This helper works with a browser out of the box with no additional tools required to install.
      *
-     * Requires `playwright` package version ^1 to be installed:
+     * Requires `playwright` or `playwright-core` package version ^1 to be installed:
      *
      * ```
-     * npm i playwright@^1 --save
+     * npm i playwright@^1.18 --save
+     * ```
+     * or
+     * ```
+     * npm i playwright-core@^1.18 --save
      * ```
      *
+     * Using playwright-core package, will prevent the download of browser binaries and allow connecting to an existing browser installation or for connecting to a remote one.
+     *
      * ## Configuration
      *
      * This helper should be configured in codecept.json or codecept.conf.js
@@ -2426,7 +2593,7 @@ declare namespace CodeceptJS {
      * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to false.
      * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to false.
      * * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
-     * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitfornavigationoptions).
+     * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/main/docs/api.md#pagewaitfornavigationoptions).
      * * `pressKeyDelay`: (optional, default: '10'). Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
      * * `getPageTimeout` (optional, default: '0') config option to set maximum navigation time in milliseconds.
      * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
@@ -2437,6 +2604,7 @@ declare namespace CodeceptJS {
      * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
      * * `chromium`: (optional) pass additional chromium options
      * * `electron`: (optional) pass additional electron options
+     * * `channel`: (optional) 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).
      *
      * #### Video Recording Customization
      *
@@ -2591,15 +2759,15 @@ declare namespace CodeceptJS {
          * First argument is a description of an action.
          * Second argument is async function that gets this helper as parameter.
          *
-         * { [`page`](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-page), [`context`](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-context) [`browser`](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-browser) } objects from Playwright API are available.
+         * { [`page`](https://github.com/microsoft/playwright/blob/main/docs/src/api/class-page.md), [`browserContext`](https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browsercontext.md) [`browser`](https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browser.md) } objects from Playwright API are available.
          *
          * ```js
-         * I.usePlaywrightTo('emulate offline mode', async ({ context }) {
-         *   await context.setOffline(true);
+         * I.usePlaywrightTo('emulate offline mode', async ({ browserContext }) => {
+         *   await browserContext.setOffline(true);
          * });
          * ```
          * @param description - used to show in logs.
-         * @param fn - async functuion that executed with Playwright helper as argument
+         * @param fn - async function that executed with Playwright helper as argument
          */
         usePlaywrightTo(description: string, fn: (...params: any[]) => any): void;
         /**
@@ -2889,7 +3057,7 @@ declare namespace CodeceptJS {
          * I.openNewTab();
          * ```
          *
-         * You can pass in [page options](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsernewpageoptions) to emulate device on this page
+         * You can pass in [page options](https://github.com/microsoft/playwright/blob/main/docs/api.md#browsernewpageoptions) to emulate device on this page
          *
          * ```js
          * // enable mobile
@@ -3730,6 +3898,23 @@ declare namespace CodeceptJS {
          * @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
          */
         saveScreenshot(fileName: string, fullPage?: boolean): void;
+        /**
+         * Performs [api request](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get) using
+         * the cookies from the current browser session.
+         *
+         * ```js
+         * const users = await I.makeApiRequest('GET', '/api/users', { params: { page: 1 }});
+         * users[0]
+         * I.makeApiRequest('PATCH', )
+         * ```
+         *
+         * > This is Playwright's built-in alternative to using REST helper's sendGet, sendPost, etc methods.
+         * @param method - HTTP method
+         * @param url - endpoint
+         * @param options - request options depending on method used
+         * @returns response
+         */
+        makeApiRequest(method: string, url: string, options: any): Promise<object>;
         /**
          * Pauses execution for a number of seconds.
          *
@@ -5291,7 +5476,15 @@ declare namespace CodeceptJS {
      * Browser control is executed via DevTools Protocol (instead of Selenium).
      * This helper works with a browser out of the box with no additional tools required to install.
      *
-     * Requires `puppeteer` package to be installed.
+     * Requires `puppeteer` or `puppeteer-core` package to be installed.
+     * ```
+     * npm i puppeteer --save
+     * ```
+     * or
+     * ```
+     * npm i puppeteer-core --save
+     * ```
+     * Using `puppeteer-core` package, will prevent the download of browser binaries and allow connecting to an existing browser installation or for connecting to a remote one.
      *
      * > Experimental Firefox support [can be activated](https://codecept.io/helpers/Puppeteer-firefox).
      *
@@ -6936,6 +7129,21 @@ declare namespace CodeceptJS {
      * ## Methods
      */
     class REST {
+        /**
+         * Sets request headers for all requests of this test
+         * @param headers - headers list
+         */
+        haveRequestHeaders(headers: any): void;
+        /**
+         * 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): void;
         /**
          * Executes axios request
          * @returns response
@@ -9836,6 +10044,7 @@ declare namespace CodeceptJS {
          * If js file provided: require it and get .config key
          * If json file provided: load and parse JSON
          * If directory provided:
+         * * try to load `codecept.config.js` from it
          * * try to load `codecept.conf.js` from it
          * * try to load `codecept.json` from it
          * If none of above: fail.
@@ -10311,7 +10520,13 @@ declare namespace CodeceptJS {
         args: any[];
         metaStep: MetaStep;
         stack: string;
-        totalTimeout: number;
+        getTimeout(): number | undefined;
+        /**
+         * @param timeout - timeout in milliseconds or 0 if no timeout
+         * @param order - order defines the priority of timeout, timeouts set with lower order override those set with higher order.
+         *                         When order below 0 value of timeout only override if new value is lower
+         */
+        setTimeout(timeout: number, order: number): void;
         setTrace(): void;
         setArguments(args: any[]): void;
         run(...args: any[]): any;
@@ -10889,3 +11104,23 @@ declare namespace CodeceptJS {
     }
 }
 
+/**
+ * timeouts set with order below zero only override timeouts of higher order if their value is smaller
+ */
+declare var testOrSuite: any;
+
+/**
+ * 0-9 - designated for override of timeouts set from code, 5 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=true
+ */
+declare var stepTimeoutHard: any;
+
+/**
+ * 10-19 - designated for timeouts set from code, 15 is order of I.setTimeout(t) operation
+ */
+declare var codeLimitTime: any;
+
+/**
+ * 20-29 - designated for timeout settings which could be overriden in tests code, 25 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=false
+ */
+declare var stepTimeoutSoft: any;
+