codeceptjs 3.6.10 → 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
@@ -1228,6 +1222,25 @@ declare namespace CodeceptJS {
      *
      * ## 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;
@@ -1339,6 +1352,25 @@ declare namespace CodeceptJS {
      *
      * ## 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;
@@ -1957,13 +1989,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);
          * });
          * ```
          */
@@ -2013,6 +2046,25 @@ declare namespace CodeceptJS {
      * @property [host = "0.0.0.0"] - Mock server host
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @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
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2137,6 +2189,25 @@ declare namespace CodeceptJS {
      *
      * ## 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 MockServer {
         /**
          * Start the mock server
@@ -2977,7 +3048,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
          */
@@ -3276,6 +3347,25 @@ declare namespace CodeceptJS {
      * @property [recordHar] - record HAR and will be saved to `output/har`. See more of [HAR options](https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har).
      * @property [testIdAttribute = data-testid] - locate elements based on the testIdAttribute. See more of [locate by test id](https://playwright.dev/docs/locators#locate-by-test-id).
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @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
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -4681,7 +4771,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
          */
@@ -6354,7 +6444,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
          */
@@ -6803,6 +6893,25 @@ declare namespace CodeceptJS {
      * @property [chrome] - pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @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
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8051,7 +8160,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
          */
@@ -8745,6 +8854,25 @@ declare namespace CodeceptJS {
      * @property [onResponse] - an async function which can update response object.
      * @property [maxUploadFileSize] - set the max content file size in MB when performing api calls.
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @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
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -10055,7 +10183,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
          */
@@ -10193,6 +10321,25 @@ declare namespace CodeceptJS {
      * @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
      */
+    // @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
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -11540,7 +11687,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
          */
@@ -12295,6 +12442,7 @@ declare namespace CodeceptJS {
         }, newPlugins: {
             [key: string]: any;
         }): void;
+        static started(fn: (...params: any[]) => any): Promise<void>;
         /**
          * Share data across worker threads
          * @param options - set {local: true} to not share among workers
@@ -12304,7 +12452,7 @@ declare namespace CodeceptJS {
     /**
      * Method collect own property and prototype
      */
-    function getObjectMethods(): void;
+    function loadTranslation(): void;
     /**
      * Datatable class to provide data driven testing
      */
@@ -12418,76 +12566,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;
@@ -12697,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.
@@ -12723,19 +12826,14 @@ 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
@@ -12744,6 +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`
@@ -12765,6 +12866,84 @@ 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 {
+        /**
+         * 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 | number, obj: 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 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;
+        }, 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;
+    }
+    function addStep(step: any, fn: any): void;
     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.
@@ -13366,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;