codeceptjs 4.0.0-beta.3 → 4.0.0-beta.5

package/typings/types.d.ts

@@ -113,7 +113,7 @@ declare namespace CodeceptJS {
      *
      * module.exports = new Factory()
      *    // no need to set id, it will be set by REST API
-     *    .attr('author', () => faker.name.findName())
+     *    .attr('author', () => faker.person.findName())
      *    .attr('title', () => faker.lorem.sentence())
      *    .attr('body', () => faker.lorem.paragraph());
      * ```
@@ -354,6 +354,17 @@ declare namespace CodeceptJS {
          * ```
          */
         runOnAndroid(caps: any, fn: any): void;
+        /**
+         * Execute code only in Web mode.
+         *
+         * ```js
+         * I.runInWeb(() => {
+         *    I.waitForElement('#data');
+         *    I.seeInCurrentUrl('/data');
+         * });
+         * ```
+         */
+        runInWeb(): void;
         /**
          * Returns app installation status.
          *
@@ -597,17 +608,11 @@ declare namespace CodeceptJS {
          * ```js
          * // taps outside to hide keyboard per default
          * I.hideDeviceKeyboard();
-         * I.hideDeviceKeyboard('tapOutside');
-         *
-         * // or by pressing key
-         * I.hideDeviceKeyboard('pressKey', 'Done');
          * ```
          *
          * Appium: support Android and iOS
-         * @param [strategy] - Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
-         * @param [key] - Optional key
          */
-        hideDeviceKeyboard(strategy?: 'tapOutside' | 'pressKey', key?: string): void;
+        hideDeviceKeyboard(): void;
         /**
          * Send a key event to the device.
          * List of keys: https://developer.android.com/reference/android/view/KeyEvent.html
@@ -651,6 +656,19 @@ declare namespace CodeceptJS {
          * Shortcut for `makeTouchAction`
          */
         tap(locator: any): Promise<void>;
+        /**
+         * Perform a swipe on the screen or an element.
+         *
+         * ```js
+         * let locator = "#io.selendroid.testapp:id/LinearLayout1";
+         * I.swipe(locator, 800, 1200, 1000);
+         * ```
+         *
+         * [See complete reference](http://webdriver.io/api/mobile/swipe.html)
+         * @param [speed = 1000] - (optional), 1000 by default
+         * @returns Appium: support Android and iOS
+         */
+        swipe(locator: CodeceptJS.LocatorOrString, xoffset: number, yoffset: number, speed?: number): Promise<void>;
         /**
          * Perform a swipe on the screen.
          *
@@ -1185,244 +1203,6 @@ declare namespace CodeceptJS {
          */
         waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): void;
     }
-    /**
-     * This helper allows performing assertions based on Chai.
-     *
-     * ### Examples
-     *
-     * Zero-configuration when paired with other helpers like REST, Playwright:
-     *
-     * ```js
-     * // inside codecept.conf.js
-     * {
-     *   helpers: {
-     *     Playwright: {...},
-     *     ExpectHelper: {},
-     *   }
-     * }
-     * ```
-     *
-     * ## Methods
-     */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    class ExpectHelper {
-        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): void;
-        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): void;
-        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): void;
-        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): void;
-        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): void;
-        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): void;
-        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): void;
-        /**
-         * @param [ajvOptions] - Pass AJV options
-         */
-        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions?: any): void;
-        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
-        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
-        expectToBeA(targetData: any, type: any, customErrorMsg?: any): void;
-        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): void;
-        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): void;
-        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): void;
-        expectEmpty(targetData: any, customErrorMsg?: any): void;
-        expectTrue(targetData: any, customErrorMsg?: any): void;
-        expectFalse(targetData: any, customErrorMsg?: any): void;
-        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): void;
-        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): void;
-        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): void;
-        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): void;
-        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        /**
-         * expects members of two arrays are deeply equal
-         */
-        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        /**
-         * expects an array to be a superset of another array
-         */
-        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): void;
-        /**
-         * expects members of two JSON objects are deeply equal excluding some properties
-         */
-        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): void;
-        /**
-         * expects a JSON object matches a provided pattern
-         */
-        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): void;
-        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): void;
-        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): void;
-        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): void;
-        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): void;
-        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): void;
-        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): void;
-        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): void;
-        /**
-         * @param [ajvOptions] - Pass AJV options
-         */
-        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions?: any): void;
-        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
-        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
-        expectToBeA(targetData: any, type: any, customErrorMsg?: any): void;
-        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): void;
-        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): void;
-        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): void;
-        expectEmpty(targetData: any, customErrorMsg?: any): void;
-        expectTrue(targetData: any, customErrorMsg?: any): void;
-        expectFalse(targetData: any, customErrorMsg?: any): void;
-        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): void;
-        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): void;
-        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): void;
-        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): void;
-        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        /**
-         * expects members of two arrays are deeply equal
-         */
-        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        /**
-         * expects an array to be a superset of another array
-         */
-        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): void;
-        /**
-         * expects members of two JSON objects are deeply equal excluding some properties
-         */
-        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): void;
-        /**
-         * expects a JSON object matches a provided pattern
-         */
-        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): void;
-    }
-    /**
-     * This helper allows performing assertions based on Chai.
-     *
-     * ### Examples
-     *
-     * Zero-configuration when paired with other helpers like REST, Playwright:
-     *
-     * ```js
-     * // inside codecept.conf.js
-     * {
-     *   helpers: {
-     *     Playwright: {...},
-     *     ExpectHelper: {},
-     *   }
-     * }
-     * ```
-     *
-     * ## Methods
-     */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    class ExpectHelper {
-        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): void;
-        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): void;
-        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): void;
-        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): void;
-        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): void;
-        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): void;
-        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): void;
-        /**
-         * @param [ajvOptions] - Pass AJV options
-         */
-        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions?: any): void;
-        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
-        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
-        expectToBeA(targetData: any, type: any, customErrorMsg?: any): void;
-        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): void;
-        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): void;
-        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): void;
-        expectEmpty(targetData: any, customErrorMsg?: any): void;
-        expectTrue(targetData: any, customErrorMsg?: any): void;
-        expectFalse(targetData: any, customErrorMsg?: any): void;
-        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): void;
-        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): void;
-        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): void;
-        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): void;
-        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        /**
-         * expects members of two arrays are deeply equal
-         */
-        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        /**
-         * expects an array to be a superset of another array
-         */
-        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): void;
-        /**
-         * expects members of two JSON objects are deeply equal excluding some properties
-         */
-        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): void;
-        /**
-         * expects a JSON object matches a provided pattern
-         */
-        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): void;
-        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): void;
-        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): void;
-        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): void;
-        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): void;
-        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): void;
-        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): void;
-        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): void;
-        /**
-         * @param [ajvOptions] - Pass AJV options
-         */
-        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions?: any): void;
-        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
-        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
-        expectToBeA(targetData: any, type: any, customErrorMsg?: any): void;
-        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): void;
-        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): void;
-        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): void;
-        expectEmpty(targetData: any, customErrorMsg?: any): void;
-        expectTrue(targetData: any, customErrorMsg?: any): void;
-        expectFalse(targetData: any, customErrorMsg?: any): void;
-        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): void;
-        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): void;
-        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): void;
-        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): void;
-        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        /**
-         * expects members of two arrays are deeply equal
-         */
-        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
-        /**
-         * expects an array to be a superset of another array
-         */
-        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): void;
-        /**
-         * expects members of two JSON objects are deeply equal excluding some properties
-         */
-        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): void;
-        /**
-         * expects a JSON object matches a provided pattern
-         */
-        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): void;
-    }
     /**
      * Helper for testing filesystem.
      * Can be easily used to check file structures:
@@ -1672,7 +1452,7 @@ declare namespace CodeceptJS {
      *    input: { ...buildObj },
      * }))
      *    // 'attr'-id can be left out depending on the GraphQl resolvers
-     *    .attr('name', () => faker.name.findName())
+     *    .attr('name', () => faker.person.findName())
      *    .attr('email', () => faker.interact.email())
      * ```
      * For more options see [rosie documentation](https://github.com/rosiejs/rosie).
@@ -1949,13 +1729,14 @@ declare namespace CodeceptJS {
          */
         seeResponseContainsKeys(keys: any[]): void;
         /**
-         * Executes a callback function passing in `response` object and chai assertions with `expect`
+         * Executes a callback function passing in `response` object and assert
          * 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']);
+         * I.seeResponseValidByCallback(({ data, status }) => {
+         *   assert.strictEqual(status, 200);
+         *   assert('user' in data);
+         *   assert('company' in data);
          * });
          * ```
          */
@@ -1997,207 +1778,6 @@ declare namespace CodeceptJS {
          */
         seeResponseMatchesJsonSchema(fnOrSchema: any): void;
     }
-    /**
-     * ## Configuration
-     *
-     * This helper should be configured in codecept.conf.(js|ts)
-     * @property [port = 9393] - Mock server port
-     * @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
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    type MockServerConfig = {
-        port?: number;
-        host?: string;
-        httpsOpts?: any;
-    };
-    /**
-     * MockServer
-     *
-     * The MockServer Helper in CodeceptJS empowers you to mock any server or service via HTTP or HTTPS, making it an excellent tool for simulating REST endpoints and other HTTP-based APIs.
-     *
-     * <!-- configuration -->
-     *
-     * #### Examples
-     *
-     * You can seamlessly integrate MockServer with other helpers like REST or Playwright. Here's a configuration example inside the `codecept.conf.js` file:
-     *
-     * ```javascript
-     * {
-     *   helpers: {
-     *     REST: {...},
-     *     MockServer: {
-     *       // default mock server config
-     *       port: 9393,
-     *       host: '0.0.0.0',
-     *       httpsOpts: {
-     *         key: '',
-     *         cert: '',
-     *       },
-     *     },
-     *   }
-     * }
-     * ```
-     *
-     * #### Adding Interactions
-     *
-     * Interactions add behavior to the mock server. Use the `I.addInteractionToMockServer()` method to include interactions. It takes an interaction object as an argument, containing request and response details.
-     *
-     * ```javascript
-     * I.addInteractionToMockServer({
-     *    request: {
-     *      method: 'GET',
-     *      path: '/api/hello'
-     *    },
-     *    response: {
-     *      status: 200,
-     *      body: {
-     *        'say': 'hello to mock server'
-     *      }
-     *    }
-     * });
-     * ```
-     *
-     * #### Request Matching
-     *
-     * When a real request is sent to the mock server, it matches the received request with the interactions. If a match is found, it returns the specified response; otherwise, a 404 status code is returned.
-     *
-     * - Strong match on HTTP Method, Path, Query Params & JSON body.
-     * - Loose match on Headers.
-     *
-     * ##### Strong Match on Query Params
-     *
-     * You can send different responses based on query parameters:
-     *
-     * ```javascript
-     * I.addInteractionToMockServer({
-     *   request: {
-     *     method: 'GET',
-     *     path: '/api/users',
-     *     queryParams: {
-     *       id: 1
-     *     }
-     *   },
-     *   response: {
-     *     status: 200,
-     *     body: 'user 1'
-     *   }
-     * });
-     *
-     * I.addInteractionToMockServer({
-     *   request: {
-     *     method: 'GET',
-     *     path: '/api/users',
-     *     queryParams: {
-     *       id: 2
-     *     }
-     *   },
-     *   response: {
-     *     status: 200,
-     *     body: 'user 2'
-     *   }
-     * });
-     * ```
-     *
-     * - GET to `/api/users?id=1` will return 'user 1'.
-     * - GET to `/api/users?id=2` will return 'user 2'.
-     * - For all other requests, it returns a 404 status code.
-     *
-     * ##### Loose Match on Body
-     *
-     * When `strict` is set to false, it performs a loose match on query params and response body:
-     *
-     * ```javascript
-     * I.addInteractionToMockServer({
-     *   strict: false,
-     *   request: {
-     *     method: 'POST',
-     *     path: '/api/users',
-     *     body: {
-     *       name: 'john'
-     *     }
-     *   },
-     *   response: {
-     *     status: 200
-     *   }
-     * });
-     * ```
-     *
-     * - POST to `/api/users` with the body containing `name` as 'john' will return a 200 status code.
-     * - POST to `/api/users` without the `name` property in the body will return a 404 status code.
-     *
-     * Happy testing with MockServer in CodeceptJS! 🚀
-     *
-     * ## Methods
-     */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    class MockServer {
-        /**
-         * Start the mock server
-         * @param [port] - start the mock server with given port
-         * @returns void
-         */
-        startMockServer(port?: number): any;
-        /**
-         * Stop the mock server
-         * @returns void
-         */
-        stopMockServer(): any;
-        /**
-         * An interaction adds behavior to the mock server
-         *
-         *
-         * ```js
-         * I.addInteractionToMockServer({
-         *    request: {
-         *      method: 'GET',
-         *      path: '/api/hello'
-         *    },
-         *    response: {
-         *      status: 200,
-         *      body: {
-         *        'say': 'hello to mock server'
-         *      }
-         *    }
-         * });
-         * ```
-         * ```js
-         * // with query params
-         * I.addInteractionToMockServer({
-         *    request: {
-         *      method: 'GET',
-         *      path: '/api/hello',
-         *      queryParams: {
-         *       id: 2
-         *     }
-         *    },
-         *    response: {
-         *      status: 200,
-         *      body: {
-         *        'say': 'hello to mock server'
-         *      }
-         *    }
-         * });
-         * ```
-         * @param interaction - add behavior to the mock server
-         * @returns void
-         */
-        addInteractionToMockServer(interaction: CodeceptJS.MockInteraction | any): any;
-    }
     /**
      * Nightmare helper wraps [Nightmare](https://github.com/segmentio/nightmare) library to provide
      * fastest headless testing using Electron engine. Unlike Selenium-based drivers this uses
@@ -2985,7 +2565,7 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.clearCookie();
-         * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
+         * I.clearCookie('test');
          * ```
          * @param [cookie = null] - (optional, `null` by default) cookie name
          */
@@ -3200,46 +2780,6 @@ declare namespace CodeceptJS {
          */
         grabPageScrollPosition(): Promise<PageScrollPosition>;
     }
-    /**
-     * OpenAI Helper for CodeceptJS.
-     *
-     * This helper class provides integration with the OpenAI GPT-3.5 or 4 language model for generating responses to questions or prompts within the context of web pages. It allows you to interact with the GPT-3.5 model to obtain intelligent responses based on HTML fragments or general prompts.
-     * This helper should be enabled with any web helpers like Playwright or Puppeteer or WebDrvier to ensure the HTML context is available.
-     *
-     * ## Configuration
-     *
-     * This helper should be configured in codecept.json or codecept.conf.js
-     *
-     * * `chunkSize`: (optional, default: 80000) - The maximum number of characters to send to the OpenAI API at once. We split HTML fragments by 8000 chars to not exceed token limit. Increase this value if you use GPT-4.
-     */
-    class OpenAI {
-        /**
-         * Asks the OpenAI GPT language model a question based on the provided prompt within the context of the current page's HTML.
-         *
-         * ```js
-         * I.askGptOnPage('what does this page do?');
-         * ```
-         * @param prompt - The question or prompt to ask the GPT model.
-         * @returns - A Promise that resolves to the generated responses from the GPT model, joined by newlines.
-         */
-        askGptOnPage(prompt: string): Promise<string>;
-        /**
-         * Asks the OpenAI GPT-3.5 language model a question based on the provided prompt within the context of a specific HTML fragment on the current page.
-         *
-         * ```js
-         * I.askGptOnPageFragment('describe features of this screen', '.screen');
-         * ```
-         * @param prompt - The question or prompt to ask the GPT-3.5 model.
-         * @param locator - The locator or selector used to identify the HTML fragment on the page.
-         * @returns - A Promise that resolves to the generated response from the GPT model.
-         */
-        askGptOnPageFragment(prompt: string, locator: string): Promise<string>;
-        /**
-         * Send a general request to ChatGPT and return response.
-         * @returns - A Promise that resolves to the generated response from the GPT model.
-         */
-        askGptGeneralPrompt(prompt: string): Promise<string>;
-    }
     /**
      * ## Configuration
      *
@@ -3285,13 +2825,6 @@ declare namespace CodeceptJS {
      * @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
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -4697,7 +4230,7 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.clearCookie();
-         * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
+         * I.clearCookie('test');
          * ```
          * @param [cookie = null] - (optional, `null` by default) cookie name
          */
@@ -6370,7 +5903,7 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.clearCookie();
-         * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
+         * I.clearCookie('test');
          * ```
          * @param [cookie = null] - (optional, `null` by default) cookie name
          */
@@ -6820,13 +6353,6 @@ declare namespace CodeceptJS {
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      */
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8075,7 +7601,7 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.clearCookie();
-         * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
+         * I.clearCookie('test');
          * ```
          * @param [cookie = null] - (optional, `null` by default) cookie name
          */
@@ -8770,13 +8296,6 @@ declare namespace CodeceptJS {
      * @property [maxUploadFileSize] - set the max content file size in MB when performing api calls.
      */
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -8957,289 +8476,56 @@ declare namespace CodeceptJS {
          * @returns response
          */
         sendDeleteRequest(url: any, headers?: any): Promise<any>;
+        /**
+         * Sends DELETE request to API with payload.
+         *
+         * ```js
+         * I.sendDeleteRequestWithPayload('/api/users/1', { author: 'john' });
+         * ```
+         * @param [payload = {}] - the payload to be sent. By default it is sent as an empty object
+         * @param [headers = {}] - the headers object to be sent. By default, it is sent as an empty object
+         * @returns response
+         */
+        sendDeleteRequestWithPayload(url: any, payload?: any, headers?: any): Promise<any>;
     }
     /**
-     * SoftAssertHelper is a utility class for performing soft assertions.
-     * Unlike traditional assertions that stop the execution on failure,
-     * soft assertions allow the execution to continue and report all failures at the end.
+     * Client Functions
+     */
+    function getPageUrl(): void;
+    /**
+     * Uses [TestCafe](https://github.com/DevExpress/testcafe) library to run cross-browser tests.
+     * The browser version you want to use in tests must be installed on your system.
      *
-     * ### Examples
+     * Requires `testcafe` package to be installed.
+     *
+     * ```
+     * npm i testcafe --save-dev
+     * ```
+     *
+     * ## Configuration
+     *
+     * This helper should be configured in codecept.conf.ts or codecept.conf.js
+     *
+     * * `url`: base url of website to be tested
+     * * `show`: (optional, default: false) - show browser window.
+     * * `windowSize`: (optional) - set browser window width and height
+     * * `getPageTimeout` (optional, default: '30000') config option to set maximum navigation time in milliseconds.
+     * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 5000.
+     * * `browser`: (optional, default: chrome)  - See https://devexpress.github.io/testcafe/documentation/using-testcafe/common-concepts/browsers/browser-support.html
      *
-     * Zero-configuration when paired with other helpers like REST, Playwright:
+     *
+     * #### Example #1: Show chrome browser window
      *
      * ```js
-     * // inside codecept.conf.js
      * {
-     *   helpers: {
-     *     Playwright: {...},
-     *     SoftExpectHelper: {},
-     *   }
-     * }
-     * ```
-     *
-     * ```js
-     * // in scenario
-     * I.softExpectEqual('a', 'b')
-     * I.flushSoftAssertions() // Throws an error if any soft assertions have failed. The error message contains all the accumulated failures.
-     * ```
-     *
-     * ## Methods
-     */
-    class SoftAssertHelper {
-        /**
-         * Performs a soft assertion by executing the provided assertion function.
-         * If the assertion fails, the error is caught and stored without halting the execution.
-         * @param assertionFn - The assertion function to execute.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softAssert(assertionFn: (...params: any[]) => any, customErrorMsg?: string): void;
-        /**
-         * Throws an error if any soft assertions have failed.
-         * The error message contains all the accumulated failures.
-         */
-        flushSoftAssertions(): void;
-        /**
-         * Softly asserts that two values are equal.
-         * @param actualValue - The actual value.
-         * @param expectedValue - The expected value.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectEqual(actualValue: any, expectedValue: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that two values are not equal.
-         * @param actualValue - The actual value.
-         * @param expectedValue - The expected value.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that two values are deeply equal.
-         * @param actualValue - The actual value.
-         * @param expectedValue - The expected value.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that two values are not deeply equal.
-         * @param actualValue - The actual value.
-         * @param expectedValue - The expected value.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that a value contains the expected value.
-         * @param actualValue - The actual value.
-         * @param expectedValueToContain - The value that should be contained within the actual value.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that a value does not contain the expected value.
-         * @param actualValue - The actual value.
-         * @param expectedValueToNotContain - The value that should not be contained within the actual value.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that a value starts with the expected value.
-         * @param actualValue - The actual value.
-         * @param expectedValueToStartWith - The value that the actual value should start with.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that a value does not start with the expected value.
-         * @param actualValue - The actual value.
-         * @param expectedValueToNotStartWith - The value that the actual value should not start with.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that a value ends with the expected value.
-         * @param actualValue - The actual value.
-         * @param expectedValueToEndWith - The value that the actual value should end with.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that a value does not end with the expected value.
-         * @param actualValue - The actual value.
-         * @param expectedValueToNotEndWith - The value that the actual value should not end with.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the target data matches the given JSON schema.
-         * @param targetData - The data to validate.
-         * @param jsonSchema - The JSON schema to validate against.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the target data matches the given JSON schema using AJV.
-         * @param targetData - The data to validate.
-         * @param jsonSchema - The JSON schema to validate against.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         * @param [ajvOptions = { allErrors: true }] - Options to pass to AJV.
-         */
-        softExpectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: string, ajvOptions?: any): void;
-        /**
-         * Softly asserts that the target data has the specified property.
-         * @param targetData - The data to check.
-         * @param propertyName - The property name to check for.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion
-         *    fails.
-         */
-        softExpectHasProperty(targetData: any, propertyName: string, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the target data has a property with the specified name.
-         * @param targetData - The data to check.
-         * @param propertyName - The property name to check for.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectHasAProperty(targetData: any, propertyName: string, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the target data is of a specific type.
-         * @param targetData - The data to check.
-         * @param type - The expected type (e.g., 'string', 'number').
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectToBeA(targetData: any, type: string, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the target data is of a specific type (alternative for articles).
-         * @param targetData - The data to check.
-         * @param type - The expected type (e.g., 'string', 'number').
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectToBeAn(targetData: any, type: string, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the target data has a specified length.
-         * @param targetData - The data to check.
-         * @param length - The expected length.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectLengthOf(targetData: any, length: number, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the target data is empty.
-         * @param targetData - The data to check.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectEmpty(targetData: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the target data is true.
-         * @param targetData - The data to check.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectTrue(targetData: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the target data is false.
-         * @param targetData - The data to check.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectFalse(targetData: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the target data is above a specified value.
-         * @param targetData - The data to check.
-         * @param aboveThan - The value that the target data should be above.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectAbove(targetData: any, aboveThan: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the target data is below a specified value.
-         * @param targetData - The data to check.
-         * @param belowThan - The value that the target data should be below.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectBelow(targetData: any, belowThan: any, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the length of the target data is above a specified value.
-         * @param targetData - The data to check.
-         * @param lengthAboveThan - The length that the target data should be above.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectLengthAboveThan(targetData: any, lengthAboveThan: number, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that the length of the target data is below a specified value.
-         * @param targetData - The data to check.
-         * @param lengthBelowThan - The length that the target data should be below.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectLengthBelowThan(targetData: any, lengthBelowThan: number, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that two values are equal, ignoring case.
-         * @param actualValue - The actual string value.
-         * @param expectedValue - The expected string value.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectEqualIgnoreCase(actualValue: string, expectedValue: string, customErrorMsg?: string): void;
-        /**
-         * Softly asserts that two arrays have deep equality, considering members in any order.
-         * @param actualValue - The actual array.
-         * @param expectedValue - The expected array.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectDeepMembers(actualValue: any[], expectedValue: any[], customErrorMsg?: string): void;
-        /**
-         * Softly asserts that an array (superset) deeply includes all members of another array (set).
-         * @param superset - The array that should contain the expected members.
-         * @param set - The array with members that should be included.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectDeepIncludeMembers(superset: any[], set: any[], customErrorMsg?: string): void;
-        /**
-         * Softly asserts that two objects are deeply equal, excluding specified fields.
-         * @param actualValue - The actual object.
-         * @param expectedValue - The expected object.
-         * @param fieldsToExclude - The fields to exclude from the comparison.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: string[], customErrorMsg?: string): void;
-        /**
-         * Softly asserts that a value matches the expected pattern.
-         * @param actualValue - The actual value.
-         * @param expectedPattern - The pattern the value should match.
-         * @param [customErrorMsg = ''] - A custom error message to display if the assertion fails.
-         */
-        softExpectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: string): void;
-    }
-    /**
-     * Client Functions
-     */
-    function getPageUrl(): void;
-    /**
-     * Uses [TestCafe](https://github.com/DevExpress/testcafe) library to run cross-browser tests.
-     * The browser version you want to use in tests must be installed on your system.
-     *
-     * Requires `testcafe` package to be installed.
-     *
-     * ```
-     * npm i testcafe --save-dev
-     * ```
-     *
-     * ## Configuration
-     *
-     * This helper should be configured in codecept.conf.ts or codecept.conf.js
-     *
-     * * `url`: base url of website to be tested
-     * * `show`: (optional, default: false) - show browser window.
-     * * `windowSize`: (optional) - set browser window width and height
-     * * `getPageTimeout` (optional, default: '30000') config option to set maximum navigation time in milliseconds.
-     * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 5000.
-     * * `browser`: (optional, default: chrome)  - See https://devexpress.github.io/testcafe/documentation/using-testcafe/common-concepts/browsers/browser-support.html
-     *
-     *
-     * #### Example #1: Show chrome browser window
-     *
-     * ```js
-     * {
-     *    helpers: {
-     *      TestCafe : {
-     *        url: "http://localhost",
-     *        waitForTimeout: 15000,
-     *        show: true,
-     *        browser: "chrome"
-     *      }
-     *    }
+     *    helpers: {
+     *      TestCafe : {
+     *        url: "http://localhost",
+     *        waitForTimeout: 15000,
+     *        show: true,
+     *        browser: "chrome"
+     *      }
+     *    }
      * }
      * ```
      *
@@ -10076,7 +9362,7 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.clearCookie();
-         * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
+         * I.clearCookie('test');
          * ```
          * @param [cookie = null] - (optional, `null` by default) cookie name
          */
@@ -10194,6 +9480,7 @@ declare namespace CodeceptJS {
      * 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 [bidiProtocol = false] - WebDriver Bidi Protocol. Default: false. More info: https://webdriver.io/docs/api/webdriverBidi/
      * @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.
@@ -10213,19 +9500,12 @@ declare namespace CodeceptJS {
      * @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
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;
+        bidiProtocol?: boolean;
         basicAuth?: string;
         host?: string;
         port?: number;
@@ -10245,7 +9525,6 @@ declare namespace CodeceptJS {
         timeouts?: any;
         highlightElement?: boolean;
         logLevel?: string;
-        devtoolsProtocol?: boolean;
     };
     /**
      * WebDriver helper which wraps [webdriverio](http://webdriver.io/) library to
@@ -10351,7 +9630,6 @@ declare namespace CodeceptJS {
      *      WebDriver : {
      *        url: "http://localhost",
      *        browser: "chrome",
-     *        devtoolsProtocol: true,
      *        desiredCapabilities: {
      *          chromeOptions: {
      *            args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
@@ -11572,7 +10850,7 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.clearCookie();
-         * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
+         * I.clearCookie('test');
          * ```
          * @param [cookie = null] - (optional, `null` by default) cookie name
          */
@@ -12155,34 +11433,6 @@ declare namespace CodeceptJS {
          * @returns scroll position
          */
         grabPageScrollPosition(): Promise<PageScrollPosition>;
-        /**
-         * This method is **deprecated**.
-         *
-         *
-         * Set the current geo location
-         *
-         *
-         * ```js
-         * I.setGeoLocation(121.21, 11.56);
-         * I.setGeoLocation(121.21, 11.56, 10);
-         * ```
-         * @param latitude - to set.
-         * @param longitude - 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.
-         *
-         * ```js
-         * let geoLocation = await I.grabGeoLocation();
-         * ```
-         */
-        grabGeoLocation(): Promise<{ latitude: number; longitude: number; altitude: number; }>;
         /**
          * Grab the width, height, location of given locator.
          * Provide `width` or `height`as second param to get your desired prop.
@@ -12209,123 +11459,15 @@ declare namespace CodeceptJS {
         /**
          * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
          */
-        runOnAndroid(caps: any, fn: any): void;
+        runOnIOS(caps: any, fn: any): void;
         /**
          * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
          */
-        runInWeb(): void;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Resets all recorded network requests.
-         *
-         * ```js
-         * I.flushNetworkTraffics();
-         * ```
-         */
-        flushNetworkTraffics(): void;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Stops recording of network traffic. Recorded traffic is not flashed.
-         *
-         * ```js
-         * I.stopRecordingTraffic();
-         * ```
-         */
-        stopRecordingTraffic(): void;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Starts recording the network traffics.
-         * This also resets recorded network requests.
-         *
-         * ```js
-         * I.startRecordingTraffic();
-         * ```
-         * @returns automatically synchronized promise through #recorder
-         */
-        startRecordingTraffic(): void;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * 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' });
-         * ```
-         * @returns recorded network traffics
-         */
-        grabRecordedNetworkTraffics(): any[];
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Verifies that a certain request is part of network traffic.
-         *
-         * ```js
-         * // checking the request url contains certain query strings
-         * I.amOnPage('https://openai.com/blog/chatgpt');
-         * I.startRecordingTraffic();
-         * await I.seeTraffic({
-         *     name: 'sentry event',
-         *     url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
-         *     parameters: {
-         *     width: '1919',
-         *     height: '1138',
-         *     },
-         *   });
-         * ```
-         *
-         * ```js
-         * // checking the request url contains certain post data
-         * I.amOnPage('https://openai.com/blog/chatgpt');
-         * I.startRecordingTraffic();
-         * await I.seeTraffic({
-         *     name: 'event',
-         *     url: 'https://cloudflareinsights.com/cdn-cgi/rum',
-         *     requestPostData: {
-         *     st: 2,
-         *     },
-         *   });
-         * ```
-         * @param opts - options when checking the traffic network.
-         * @param opts.name - A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
-         * @param opts.url - Expected URL of request in network traffic
-         * @param [opts.parameters] - Expected parameters of that request in network traffic
-         * @param [opts.requestPostData] - Expected that request contains post data in network traffic
-         * @param [opts.timeout] - Timeout to wait for request in seconds. Default is 10 seconds.
-         * @returns automatically synchronized promise through #recorder
-         */
-        seeTraffic(opts: {
-            name: string;
-            url: string;
-            parameters?: any;
-            requestPostData?: any;
-            timeout?: number;
-        }): void;
+        runOnAndroid(caps: any, fn: any): void;
         /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Verifies that a certain request is not part of network traffic.
-         *
-         * Examples:
-         *
-         * ```js
-         * I.dontSeeTraffic({ name: 'Unexpected API Call', url: 'https://api.example.com' });
-         * I.dontSeeTraffic({ name: 'Unexpected API Call of "user" endpoint', url: /api.example.com.*user/ });
-         * ```
-         * @param opts - options when checking the traffic network.
-         * @param opts.name - A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
-         * @param opts.url - Expected URL of request in network traffic. Can be a string or a regular expression.
-         * @returns automatically synchronized promise through #recorder
+         * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
          */
-        dontSeeTraffic(opts: {
-            name: string;
-            url: string | RegExp;
-        }): void;
+        runInWeb(): void;
     }
     interface ActorStatic {
         /**
@@ -12419,10 +11561,33 @@ declare namespace CodeceptJS {
             [key: string]: any;
         };
     }
+    /**
+     * Result of the test run
+     */
+    type Stats = {
+        passes: number;
+        failures: number;
+        tests: number;
+        pending: number;
+        failedHooks: number;
+        start: Date;
+        end: Date;
+        duration: number;
+    };
+    /**
+     * Create Result of the test run
+     */
+    class Result {
+        constructor();
+    }
     /**
      * Dependency Injection Container
      */
     class Container {
+        /**
+         * Get the standard acting helpers of CodeceptJS Container
+         */
+        static STANDARD_ACTING_HELPERS: any;
         /**
          * Create container with all required helpers and support objects
          */
@@ -12447,6 +11612,10 @@ declare namespace CodeceptJS {
          * Get Mocha instance
          */
         static mocha(): any;
+        /**
+         * Get result
+         */
+        static result(): Result;
         /**
          * Append new services to container
          */
@@ -12463,6 +11632,7 @@ declare namespace CodeceptJS {
         }, newPlugins: {
             [key: string]: any;
         }): void;
+        static started(fn: ((...params: any[]) => any) | null): Promise<void>;
         /**
          * Share data across worker threads
          * @param options - set {local: true} to not share among workers
@@ -12472,7 +11642,7 @@ declare namespace CodeceptJS {
     /**
      * Method collect own property and prototype
      */
-    function getObjectMethods(): void;
+    function loadTranslation(): void;
     /**
      * Datatable class to provide data driven testing
      */
@@ -12510,6 +11680,63 @@ declare namespace CodeceptJS {
          */
         transpose(): void;
     }
+    /**
+     * - Designed for use in CodeceptJS tests as a "soft assertion."
+     *   Unlike standard assertions, it does not stop the test execution on failure.
+     * - Starts a new recorder session named 'hopeThat' and manages state restoration.
+     * - Logs errors and attaches them as notes to the test, enabling post-test reporting of soft assertion failures.
+     * - Resets the `store.hopeThat` flag after the execution, ensuring clean state for subsequent operations.
+     * @example
+     * const { hopeThat } = require('codeceptjs/effects')
+     * await hopeThat(() => {
+     *   I.see('Welcome'); // Perform a soft assertion
+     * });
+     * @param callback - The callback function containing the logic to validate.
+     *                              This function should perform the desired assertion or condition check.
+     * @returns A promise resolving to `true` if the assertion or condition was successful,
+     *                             or `false` if an error occurred.
+     */
+    function hopeThat(callback: (...params: any[]) => any): Promise<boolean | any>;
+    /**
+     * - This function is designed for use in CodeceptJS tests to handle intermittent or flaky test steps.
+     * - Starts a new recorder session for each retry attempt, ensuring proper state management and error handling.
+     * - Logs errors and retries the callback until it either succeeds or the maximum number of attempts is reached.
+     * - Restores the session state after each attempt, whether successful or not.
+     * @example
+     * const { hopeThat } = require('codeceptjs/effects')
+     * await retryTo((tries) => {
+     *   if (tries < 3) {
+     *     I.see('Non-existent element'); // Simulates a failure
+     *   } else {
+     *     I.see('Welcome'); // Succeeds on the 3rd attempt
+     *   }
+     * }, 5, 300); // Retry up to 5 times, with a 300ms interval
+     * @param callback - The function to execute, which will be retried upon failure.
+     *                               Receives the current retry count as an argument.
+     * @param maxTries - The maximum number of attempts to retry the callback.
+     * @param [pollInterval = 200] - The delay (in milliseconds) between retry attempts.
+     * @returns A promise that resolves when the callback executes successfully, or rejects after reaching the maximum retries.
+     */
+    function retryTo(callback: (...params: any[]) => any, maxTries: number, pollInterval?: number): Promise<void | any>;
+    /**
+     * - Useful for scenarios where certain steps are optional or their failure should not interrupt the test flow.
+     * - Starts a new recorder session named 'tryTo' for isolation and error handling.
+     * - Captures errors during execution and logs them for debugging purposes.
+     * - Ensures the `store.tryTo` flag is reset after execution to maintain a clean state.
+     * @example
+     * const { tryTo } = require('codeceptjs/effects')
+     * const wasSuccessful = await tryTo(() => {
+     *   I.see('Welcome'); // Attempt to find an element on the page
+     * });
+     *
+     * if (!wasSuccessful) {
+     *   I.say('Optional step failed, but test continues.');
+     * }
+     * @param callback - The function to execute, which may succeed or fail.
+     *                               This function contains the logic to be attempted.
+     * @returns A promise resolving to `true` if the step succeeds, or `false` if it fails.
+     */
+    function tryTo(callback: (...params: any[]) => any): Promise<boolean | any>;
     namespace event {
         const dispatcher: NodeJS.EventEmitter;
         const test: {
@@ -12528,6 +11755,8 @@ declare namespace CodeceptJS {
         const hook: {
             started: 'hook.start';
             passed: 'hook.passed';
+            failed: 'hook.failed';
+            finished: 'hook.finished';
         };
         const step: {
             started: 'step.start';
@@ -12586,76 +11815,6 @@ declare namespace CodeceptJS {
         var store: typeof CodeceptJS.store;
         var locator: typeof CodeceptJS.Locator;
     }
-    function addStep(step: any, fn: any): void;
-    class FeatureConfig {
-        /**
-         * Retry this suite for x times
-         */
-        retry(retries: number): this;
-        /**
-         * Set timeout for this suite
-         */
-        timeout(timeout: number): this;
-        /**
-         * Configures a helper.
-         * Helper name can be omitted and values will be applied to first helper.
-         */
-        config(helper: string | {
-            [key: string]: any;
-        }, obj?: {
-            [key: string]: any;
-        }): this;
-        /**
-         * Append a tag name to scenario title
-         */
-        tag(tagName: string): this;
-    }
-    class ScenarioConfig {
-        /**
-         * Declares that test throws error.
-         * Can pass an Error object or regex matching expected message.
-         */
-        throws(err: any): this;
-        /**
-         * Declares that test should fail.
-         * If test passes - throws an error.
-         * Can pass an Error object or regex matching expected message.
-         */
-        fails(): this;
-        /**
-         * Retry this test for x times
-         */
-        retry(retries: number): this;
-        /**
-         * Set timeout for this test
-         */
-        timeout(timeout: number): this;
-        /**
-         * Pass in additional objects to inject into test
-         */
-        inject(obj: {
-            [key: string]: any;
-        }): this;
-        /**
-         * Configures a helper.
-         * Helper name can be omitted and values will be applied to first helper.
-         */
-        config(helper: string | {
-            [key: string]: any;
-        }, obj?: {
-            [key: string]: any;
-        }): this;
-        /**
-         * Append a tag name to scenario title
-         */
-        tag(tagName: string): this;
-        /**
-         * Dynamically injects dependencies, see https://codecept.io/pageobjects/#dynamic-injection
-         */
-        injectDependencies(dependencies: {
-            [key: string]: any;
-        }): this;
-    }
     class Locator {
         constructor(locator: CodeceptJS.LocatorOrString, defaultType?: string);
         toString(): string;
@@ -12718,7 +11877,7 @@ declare namespace CodeceptJS {
         inside(locator: CodeceptJS.LocatorOrString): Locator;
         after(locator: CodeceptJS.LocatorOrString): Locator;
         before(locator: CodeceptJS.LocatorOrString): Locator;
-        static build(locator: CodeceptJS.LocatorOrString): Locator;
+        static build(locator?: CodeceptJS.LocatorOrString): Locator;
         /**
          * Filters to modify locators
          */
@@ -12773,6 +11932,7 @@ declare namespace CodeceptJS {
             function skipped(test: Mocha.Test): void;
         }
         namespace scenario {
+            function started(test: Mocha.Test): void;
             function passed(test: Mocha.Test): void;
             function failed(test: Mocha.Test): void;
         }
@@ -12864,24 +12024,50 @@ declare namespace CodeceptJS {
     function session(sessionName: CodeceptJS.LocatorOrString, config: ((...params: any[]) => any) | {
         [key: string]: any;
     }, fn?: (...params: any[]) => any): any;
+    /**
+     * StepConfig is a configuration object for a step.
+     * It is used to create a new step that is a combination of other steps.
+     */
+    class StepConfig {
+        config: any;
+        /**
+         * Set the options for the step.
+         * @param opts - The options for the step.
+         * @returns - The step configuration object.
+         */
+        opts(opts: any): StepConfig;
+        /**
+         * Set the timeout for the step.
+         * @param timeout - The timeout for the step.
+         * @returns - The step configuration object.
+         */
+        timeout(timeout: number): StepConfig;
+        /**
+         * Set the retry for the step.
+         * @param retry - The retry for the step.
+         * @returns - The step configuration object.
+         */
+        retry(retry: number): StepConfig;
+    }
     /**
      * Each command in test executed through `I.` object is wrapped in Step.
      * Step allows logging executed commands and triggers hook before and after step execution.
      */
     class Step {
-        constructor(helper: CodeceptJS.Helper, name: string);
-        actor: string;
-        helper: CodeceptJS.Helper;
+        constructor(name: string);
         name: string;
-        helperMethod: string;
+        timeouts: Map<number, number>;
+        args: any[];
+        opts: Record<string, any>;
+        actor: string;
         status: string;
-        suffix: string;
         prefix: string;
         comment: string;
-        args: any[];
-        metaStep: MetaStep;
+        metaStep: any;
         stack: string;
-        getTimeout(): number | undefined;
+        helper: any;
+        helperMethod: string;
+        timeout: any;
         /**
          * @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.
@@ -12890,27 +12076,43 @@ declare namespace CodeceptJS {
         setTimeout(timeout: number, order: number): void;
         setTrace(): void;
         setArguments(args: any[]): void;
-        run(...args: any[]): any;
         setStatus(status: string): void;
         humanize(): string;
         humanizeArgs(): string;
         line(): string;
         toString(): string;
+        toCliStyled(): string;
         toCode(): string;
         hasBDDAncestor(): boolean;
-        static MetaStep: typeof MetaStep;
-    }
-    class MetaStep extends Step {
-        isBDD(): boolean;
-        run(): any;
     }
     /**
      * global values for current session
      */
     namespace store {
+        /**
+         * If we are in --debug mode
+         */
         var debugMode: boolean;
+        /**
+         * Is timeouts enabled
+         */
         var timeouts: boolean;
+        /**
+         * If auto-retries are enabled by retryFailedStep plugin
+         * tryTo effect disables them
+         */
+        var autoRetries: boolean;
+        /**
+         * Tests are executed via dry-run
+         */
         var dryRun: boolean;
+        /**
+         * If we are in pause mode
+         */
+        var onPause: boolean;
+        var currentTest: CodeceptJS.Test | null;
+        var currentStep: CodeceptJS.Step | null;
+        var currentSuite: CodeceptJS.Suite | null;
     }
     /**
      * Describe a "suite" with the given `title`
@@ -12932,6 +12134,139 @@ declare namespace CodeceptJS {
      * Pending test case with message: 'Test not implemented!'.
      */
     const todo: CodeceptJS.IScenario;
+    /**
+     * Configuration for a Feature.
+     * Can inject values and add custom configuration.
+     */
+    class FeatureConfig {
+        constructor(suite: CodeceptJS.Suite);
+        /**
+         * Set metadata for this suite
+         */
+        meta(key: string, value: string): this;
+        /**
+         * Retry this test for number of times
+         */
+        retry(retries: number): this;
+        /**
+         * Set timeout for this test
+         */
+        timeout(timeout: number): this;
+        /**
+         * Configures a helper.
+         * Helper name can be omitted and values will be applied to first helper.
+         */
+        config(helper: string | {
+            [key: string]: any;
+        } | FeatureConfigCallback, obj?: {
+            [key: string]: any;
+        }): this;
+        /**
+         * Append a tag name to scenario title
+         */
+        tag(tagName: string): this;
+    }
+    type FeatureConfigCallback = (suite: CodeceptJS.Suite) => {
+        [key: string]: any;
+    };
+    class ScenarioConfig {
+        constructor(test: CodeceptJS.Test);
+        /**
+         * Declares that test throws error.
+         * Can pass an Error object or regex matching expected message.
+         */
+        throws(err: any): this;
+        /**
+         * Declares that test should fail.
+         * If test passes - throws an error.
+         * Can pass an Error object or regex matching expected message.
+         */
+        fails(): this;
+        /**
+         * Retry this test for x times
+         */
+        retry(retries: number): this;
+        /**
+         * Set metadata for this test
+         */
+        meta(key: string, value: string): this;
+        /**
+         * Set timeout for this test
+         */
+        timeout(timeout: number): this;
+        /**
+         * Pass in additional objects to inject into test
+         */
+        inject(obj: {
+            [key: string]: any;
+        }): this;
+        /**
+         * Configures a helper.
+         * Helper name can be omitted and values will be applied to first helper.
+         */
+        config(helper: string | {
+            [key: string]: any;
+        } | ScenarioConfigCallback, obj?: {
+            [key: string]: any;
+        }): this;
+        /**
+         * Append a tag name to scenario title
+         */
+        tag(tagName: string): this;
+        /**
+         * Dynamically injects dependencies, see https://codecept.io/pageobjects/#dynamic-injection
+         */
+        injectDependencies(dependencies: {
+            [key: string]: any;
+        }): this;
+    }
+    type ScenarioConfigCallback = (test: CodeceptJS.Test) => {
+        [key: string]: any;
+    };
+    function addStep(step: any, fn: any): void;
+    /**
+     * Creates a new Hook instance
+     * @property suite - The test suite this hook belongs to
+     * @property test - The test object associated with this hook
+     * @property runnable - The current test being executed
+     * @property ctx - The context object
+     * @property err - The error that occurred during hook execution, if any
+     * @param context - The context object containing suite and test information
+     * @param context.suite - The test suite
+     * @param context.test - The test object
+     * @param context.ctx - The context object
+     * @param error - The error object if hook execution failed
+     */
+    class Hook {
+        constructor(context: {
+            suite: any;
+            test: any;
+            ctx: any;
+        }, error: Error);
+        /**
+         * The test suite this hook belongs to
+        */
+        suite: any;
+        /**
+         * The test object associated with this hook
+        */
+        test: any;
+        /**
+         * The current test being executed
+        */
+        runnable: any;
+        /**
+         * The context object
+        */
+        ctx: any;
+        /**
+         * The error that occurred during hook execution, if any
+        */
+        err: Error | null;
+    }
+    /**
+     * TODO: move to effects
+     */
     function within(context: CodeceptJS.LocatorOrString, fn: (...params: any[]) => any): Promise<any> | undefined;
     /**
      * This is a wrapper on top of [Detox](https://github.com/wix/Detox) library, aimied to unify testing experience for CodeceptJS framework.
@@ -13533,22 +12868,17 @@ 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
+ * corresponding helper
  */
-declare var stepTimeoutHard: any;
+declare var helper: CodeceptJS.Helper;
 
 /**
- * 10-19 - designated for timeouts set from code, 15 is order of I.setTimeout(t) operation
+ * name of method to be executed
  */
-declare var codeLimitTime: any;
+declare var helperMethod: string;
 
 /**
- * 20-29 - designated for timeout settings which could be overriden in tests code, 25 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=false
+ * hide children steps from output
  */
-declare var stepTimeoutSoft: any;
+declare var collsapsed: boolean;