codeceptjs 3.7.3 → 3.7.4

package/typings/types.d.ts

@@ -1203,228 +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
-     */
-    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
-     */
-    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:
@@ -2000,191 +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
-     */
-    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
-     */
-    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
@@ -3187,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
      *
@@ -8932,250 +8485,6 @@ declare namespace CodeceptJS {
          */
         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.
-     *
-     * ### Examples
-     *
-     * Zero-configuration when paired with other helpers like REST, Playwright:
-     *
-     * ```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
      */
@@ -12367,6 +11676,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: {