codeceptjs 3.7.0-beta.1 → 3.7.0-beta.10

package/typings/types.d.ts

@@ -608,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
@@ -1209,6 +1203,266 @@ 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
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @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
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @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:
@@ -1799,6 +2053,18 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1930,6 +2196,18 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -2985,6 +3263,46 @@ 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
      *
@@ -3036,6 +3354,18 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @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';
@@ -6570,6 +6900,18 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8519,6 +8861,18 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -8711,6 +9065,250 @@ 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
      */
@@ -9730,6 +10328,18 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -12165,24 +12775,49 @@ 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;
+        timeouts: Map<number, number>;
+        args: any[];
+        opts: Record<string, any>;
+        actor: string;
         helperMethod: string;
         status: string;
-        suffix: string;
         prefix: string;
         comment: string;
-        args: any[];
-        metaStep: MetaStep;
+        metaStep: any;
         stack: string;
-        getTimeout(): number | undefined;
+        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.
@@ -12191,7 +12826,6 @@ 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;
@@ -12200,11 +12834,6 @@ declare namespace CodeceptJS {
         toCliStyled(): string;
         toCode(): string;
         hasBDDAncestor(): boolean;
-        static MetaStep: typeof MetaStep;
-    }
-    class MetaStep extends Step {
-        isBDD(): boolean;
-        run(): any;
     }
     /**
      * global values for current session
@@ -12213,7 +12842,9 @@ declare namespace CodeceptJS {
         var debugMode: boolean;
         var timeouts: boolean;
         var dryRun: boolean;
+        var onPause: boolean;
         var currentTest: CodeceptJS.Test | null;
+        var currentStep: any;
     }
     /**
      * Describe a "suite" with the given `title`
@@ -12240,6 +12871,10 @@ declare namespace CodeceptJS {
      * Can inject values and add custom configuration.
      */
     class FeatureConfig {
+        /**
+         * Set metadata for this suite
+         */
+        meta(key: string, value: string): this;
         /**
          * Retry this test for number of times
          */
@@ -12274,6 +12909,10 @@ declare namespace CodeceptJS {
          * 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
          */
@@ -12906,22 +13545,12 @@ declare namespace CodeceptJS {
 }
 
 /**
- * timeouts set with order below zero only override timeouts of higher order if their value is smaller
- */
-declare var testOrSuite: any;
-
-/**
- * 0-9 - designated for override of timeouts set from code, 5 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=true
- */
-declare var stepTimeoutHard: any;
-
-/**
- * 10-19 - designated for timeouts set from code, 15 is order of I.setTimeout(t) operation
+ * corresponding helper
  */
-declare var codeLimitTime: any;
+declare var helper: CodeceptJS.Helper;
 
 /**
- * 20-29 - designated for timeout settings which could be overriden in tests code, 25 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=false
+ * name of method to be executed
  */
-declare var stepTimeoutSoft: any;
+declare var helperMethod: string;