codeceptjs 3.0.3 → 3.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.0.3",
+  "version": "3.0.7",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -55,13 +55,14 @@
   },
   "dependencies": {
     "@codeceptjs/configure": "^0.6.2",
-    "@codeceptjs/helper": "^1.0.1",
+    "@codeceptjs/helper": "^1.0.2",
     "acorn": "^7.4.1",
     "allure-js-commons": "^1.3.2",
     "arrify": "^2.0.1",
-    "axios": "^0.19.1",
+    "axios": "^0.21.1",
     "chalk": "^4.1.0",
     "commander": "^2.20.3",
+    "cross-spawn": "^7.0.3",
     "css-to-xpath": "^0.1.0",
     "cucumber-expressions": "^6.6.2",
     "envinfo": "^7.5.1",
@@ -83,14 +84,13 @@
     "promise-retry": "^1.1.1",
     "requireg": "^0.2.2",
     "resq": "^1.10.0",
-    "semver": "^6.2.0",
     "sprintf-js": "^1.1.1"
   },
   "devDependencies": {
     "@codeceptjs/detox-helper": "^1.0.2",
     "@codeceptjs/mock-request": "^0.3.0",
-    "@pollyjs/adapter-puppeteer": "^2.6.3",
-    "@pollyjs/core": "^2.6.3",
+    "@pollyjs/adapter-puppeteer": "^5.1.0",
+    "@pollyjs/core": "^5.1.0",
     "@types/inquirer": "^0.0.35",
     "@types/node": "^8.10.66",
     "@wdio/sauce-service": "^5.22.5",
@@ -103,13 +103,14 @@
     "contributor-faces": "^1.0.3",
     "documentation": "^12.3.0",
     "dtslint": "^3.6.12",
+    "electron": "^12.0.0",
     "eslint": "^6.8.0",
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-mocha": "^6.3.0",
     "expect": "^26.6.2",
     "express": "^4.17.1",
-    "faker": "^4.1.0",
+    "faker": "^5.5.1",
     "form-data": "^3.0.0",
     "graphql": "^14.6.0",
     "husky": "^4.3.5",
@@ -119,12 +120,13 @@
     "mocha-parallel-tests": "^2.3.0",
     "nightmare": "^3.0.2",
     "nodemon": "^1.19.4",
-    "playwright": "^1.6.2",
+    "playwright": "^1.9.1",
     "protractor": "^5.4.4",
-    "puppeteer": "^4.0.0",
+    "puppeteer": "^8.0.0",
     "qrcode-terminal": "^0.12.0",
     "rosie": "^1.6.0",
     "runok": "^0.9.2",
+    "semver": "^6.3.0",
     "sinon": "^9.2.2",
     "sinon-chai": "^3.5.0",
     "testcafe": "^1.9.4",
@@ -141,6 +143,9 @@
     "node": ">=8.9.1",
     "npm": ">=5.6.0"
   },
+  "peerDependencies": {
+    "faker": "^5.5.1"
+  },
   "es6": true,
   "husky": {
     "hooks": {

package/typings/index.d.ts

@@ -8,13 +8,13 @@ declare namespace CodeceptJS {
     import("./utils").Translate<T, Translation.Actions>;
 
   type Cookie = {
-    name: string
-    value: string
-  }
+    name: string;
+    value: string;
+  };
 
   interface PageScrollPosition {
-    x: number,
-    y: number
+    x: number;
+    y: number;
   }
 
   // Could get extended by user generated typings
@@ -22,7 +22,9 @@ declare namespace CodeceptJS {
   interface I {}
   interface IHook {}
   interface IScenario {}
-  interface IFeature {}
+  interface IFeature {
+    (title: string): FeatureConfig;
+  }
   interface CallbackOrder extends Array<any> {}
   interface SupportObject {
     I: CodeceptJS.I;
@@ -49,22 +51,48 @@ declare namespace CodeceptJS {
     | { frame: string }
     | { android: string }
     | { ios: string }
-    | { android: string, ios: string }
-    | { react: string };
-
-  type LocatorOrString = string | ILocator | Locator;
-
-  interface HookCallback { (args: SupportObject): void; }
-  interface Scenario extends IScenario { only: IScenario, skip: IScenario, todo: IScenario}
-  interface Feature extends IFeature { skip: IFeature }
-  interface IData { Scenario: IScenario, only: { Scenario: IScenario } }
+    | { android: string; ios: string }
+    | { react: string }
+    | { shadow: string }
+    | { custom: string };
+
+  interface CustomLocators {}
+  type LocatorOrString =
+    | string
+    | ILocator
+    | Locator
+    | CustomLocators[keyof CustomLocators];
+
+  type StringOrSecret = string | CodeceptJS.Secret;
+
+  interface HookCallback {
+    (args: SupportObject): void;
+  }
+  interface Scenario extends IScenario {
+    only: IScenario;
+    skip: IScenario;
+    todo: IScenario;
+  }
+  interface Feature extends IFeature {
+    skip: IFeature;
+  }
+  interface IData {
+    Scenario: IScenario;
+    only: { Scenario: IScenario };
+  }
 
   interface IScenario {
     // Scenario.todo can be called only with a title.
     (title: string, callback?: HookCallback): ScenarioConfig;
-    (title: string, opts: { [key: string]: any }, callback: HookCallback): ScenarioConfig;
+    (
+      title: string,
+      opts: { [key: string]: any },
+      callback: HookCallback
+    ): ScenarioConfig;
+  }
+  interface IHook {
+    (callback: HookCallback): void;
   }
-  interface IHook { (callback: HookCallback): void; }
 
   interface Globals {
     codeceptjs: typeof codeceptjs;
@@ -159,12 +187,12 @@ declare namespace Mocha {
   }
 
   interface Suite extends SuiteRunnable {
-    tags: any[]
-    comment: string
-    feature: any
+    tags: any[];
+    comment: string;
+    feature: any;
   }
 
-  interface Test  extends Runnable {
+  interface Test extends Runnable {
     tags: any[];
   }
 }

package/typings/types.d.ts

@@ -862,7 +862,7 @@ declare namespace CodeceptJS {
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @param value - text value to fill.
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Retrieves all texts from an element located by CSS or XPath and returns it to test.
          * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -1847,7 +1847,7 @@ declare namespace CodeceptJS {
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @param value - text value to fill.
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Clears a `<textarea>` or text `<input>` element's value.
          *
@@ -1973,17 +1973,16 @@ declare namespace CodeceptJS {
          */
         grabTextFrom(locator: CodeceptJS.LocatorOrString): Promise<string>;
         /**
-         * Retrieves a value from a form element located by CSS or XPath and returns it to test.
+         * Retrieves an array of value from a form located by CSS or XPath and returns it to test.
          * Resumes test execution, so **should be used inside async function with `await`** operator.
-         * If more than one element is found - value of first element is returned.
          *
          * ```js
-         * let email = await I.grabValueFrom('input[name=email]');
+         * let inputs = await I.grabValueFromAll('//form/input');
          * ```
          * @param locator - field located by label|name|CSS|XPath|strict locator.
          * @returns attribute value
          */
-        grabValueFromAll(locator: CodeceptJS.LocatorOrString): Promise<string>;
+        grabValueFromAll(locator: CodeceptJS.LocatorOrString): Promise<string[]>;
         /**
          * Retrieves a value from a form element located by CSS or XPath and returns it to test.
          * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -2364,7 +2363,7 @@ declare namespace CodeceptJS {
      * This helper should be configured in codecept.json or codecept.conf.js
      *
      * * `url`: base url of website to be tested
-     * * `browser`: a browser to test on, either: `chromium`, `firefox`, `webkit`. Default: chromium.
+     * * `browser`: a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
      * * `show`: (optional, default: false) - show browser window.
      * * `restart`: (optional, default: true) - restart browser between tests.
      * * `disableScreenshots`: (optional, default: false)  - don't save screenshot on failure.
@@ -2383,6 +2382,7 @@ declare namespace CodeceptJS {
      * * `userAgent`: (optional) user-agent string.
      * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
      * * `chromium`: (optional) pass additional chromium options
+     * * `electron`: (optional) pass additional electron options
      *
      * #### Example #1: Wait for 0 network connections.
      *
@@ -2427,7 +2427,7 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
-     * #### Example #4: Connect to remote browser by specifying [websocket endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target)
+     * #### Example #4: Connect to remote browser by specifying [websocket endpoint](https://playwright.dev/docs/api/class-browsertype#browsertypeconnectparams)
      *
      * ```js
      * {
@@ -2435,7 +2435,7 @@ declare namespace CodeceptJS {
      *      Playwright: {
      *        url: "http://localhost",
      *        chromium: {
-     *          browserWSEndpoint: "ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a"
+     *          browserWSEndpoint: { wsEndpoint: 'ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a' }
      *        }
      *      }
      *    }
@@ -2453,6 +2453,7 @@ declare namespace CodeceptJS {
      *      url: "http://localhost",
      *      show: true // headless mode not supported for extensions
      *      chromium: {
+     *        userDataDir: '/tmp/playwright-tmp', // necessary to launch the browser in normal mode instead of incognito,
      *        args: [
      *           `--disable-extensions-except=${pathToExtension}`,
      *           `--load-extension=${pathToExtension}`
@@ -2705,11 +2706,12 @@ declare namespace CodeceptJS {
         /**
          * Checks that title is equal to provided one.
          *
-         * ```js
-         * I.seeTitleEquals('Test title.');
-         * ```
+         *  ```js
+         *  I.seeTitleEquals('Test title.');
+         *  ```
+         * @param text - value to check.
          */
-        seeTitleEquals(): void;
+        seeTitleEquals(text: string): void;
         /**
          * Checks that title does not contain text.
          *
@@ -2907,14 +2909,34 @@ declare namespace CodeceptJS {
          */
         clickLink(): void;
         /**
-         * Force clicks an element without waiting for it to become visible and not animating.
+         * Perform an emulated click on a link or a button, given by a locator.
+         * Unlike normal click instead of sending native event, emulates a click with JavaScript.
+         * This works on hidden, animated or inactive elements as well.
+         *
+         * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
+         * For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
+         * For images, the "alt" attribute and inner text of any parent links are searched.
+         *
+         * The second parameter is a context (CSS or XPath locator) to narrow the search.
          *
          * ```js
-         * I.forceClick('#hiddenButton');
-         * I.forceClick('Click me', '#hidden');
+         * // simple link
+         * I.forceClick('Logout');
+         * // button of form
+         * I.forceClick('Submit');
+         * // CSS button
+         * I.forceClick('#form input[type=submit]');
+         * // XPath
+         * I.forceClick('//form/*[@type=submit]');
+         * // link in context
+         * I.forceClick('Logout', '#nav');
+         * // using strict locator
+         * I.forceClick({css: 'nav a.login'});
          * ```
+         * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+         * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
          */
-        forceClick(): void;
+        forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
         /**
          * Performs a double-click on an element matched by link|button|label|CSS or XPath.
          * Context can be specified as second parameter to narrow search.
@@ -3122,7 +3144,7 @@ declare namespace CodeceptJS {
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @param value - text value to fill.
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Clears a `<textarea>` or text `<input>` element's value.
          *
@@ -3442,8 +3464,14 @@ declare namespace CodeceptJS {
          * I.executeScript(([x, y]) => x + y, [x, y]);
          * ```
          * If a function returns a Promise it will wait for its resolution.
+         * @param fn - function to be executed in browser context.
+         * @param [arg] - optional argument to pass to the function
          */
-        executeScript(): void;
+        executeScript(fn: string | ((...params: any[]) => any), arg?: any): Promise<any>;
+        /**
+         * Grab Locator if called within Context
+         */
+        _contextLocator(locator: any): void;
         /**
          * Retrieves a text from an element located by CSS or XPath and returns it to test.
          * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -3803,7 +3831,7 @@ declare namespace CodeceptJS {
         /**
          * Waits for navigation to finish. By default takes configured `waitForNavigation` option.
          *
-         * See [Pupeteer's reference](https://github.com/microsoft/Playwright/blob/master/docs/api.md#pagewaitfornavigationoptions)
+         * See [Playwright's reference](https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions)
          */
         waitForNavigation(opts: any): void;
         /**
@@ -4243,7 +4271,7 @@ declare namespace CodeceptJS {
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @param value - text value to fill.
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Presses a key on a focused element.
          * Special keys like 'Enter', 'Control', [etc](https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value)
@@ -5961,7 +5989,7 @@ declare namespace CodeceptJS {
          *
          * {{ react }}
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Clears a `<textarea>` or text `<input>` element's value.
          *
@@ -6850,6 +6878,10 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.sendPostRequest('/api/users.json', { "email": "user@user.com" });
+         *
+         * // To mask the payload in logs
+         * I.sendPostRequest('/api/users.json', secret({ "email": "user@user.com" }));
+         *
          * ```
          * @param [payload = {}] - the payload to be sent. By default it is sent as an empty object
          * @param [headers = {}] - the headers object to be sent. By default it is sent as an empty object
@@ -6860,6 +6892,10 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.sendPatchRequest('/api/users.json', { "email": "user@user.com" });
+         *
+         * // To mask the payload in logs
+         * I.sendPatchRequest('/api/users.json', secret({ "email": "user@user.com" }));
+         *
          * ```
          * @param [payload = {}] - the payload to be sent. By default it is sent as an empty object
          * @param [headers = {}] - the headers object to be sent. By default it is sent as an empty object
@@ -6870,6 +6906,10 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.sendPutRequest('/api/users.json', { "email": "user@user.com" });
+         *
+         * // To mask the payload in logs
+         * I.sendPutRequest('/api/users.json', secret({ "email": "user@user.com" }));
+         *
          * ```
          * @param [payload = {}] - the payload to be sent. By default it is sent as an empty object
          * @param [headers = {}] - the headers object to be sent. By default it is sent as an empty object
@@ -7130,7 +7170,7 @@ declare namespace CodeceptJS {
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @param value - text value to fill.
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Clears a `<textarea>` or text `<input>` element's value.
          *
@@ -8417,8 +8457,9 @@ declare namespace CodeceptJS {
          * @param value - text value to fill.
          *
          * {{ react }}
+         * {{ custom }}
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Appends text to a input field or textarea.
          * Field is located by name, label, CSS or XPath
@@ -9719,7 +9760,7 @@ declare namespace CodeceptJS {
         /**
          * Get current config.
          */
-        static get(key: string, val: any): any;
+        static get(key?: string, val?: any): any;
         /**
          * Appends values to current config
          */
@@ -9834,6 +9875,7 @@ declare namespace CodeceptJS {
             before: 'global.before';
             after: 'global.after';
             result: 'global.result';
+            failures: 'global.failures';
         };
         const multiple: {
             before: 'multiple.before';
@@ -10014,7 +10056,7 @@ declare namespace CodeceptJS {
          * Print information for a process
          * Used in multiple-run
          */
-        function process(process: string): string;
+        function process(process: string | null): string;
         /**
          * Print information in --debug mode
          */
@@ -10115,6 +10157,10 @@ declare namespace CodeceptJS {
          * Get a list of all chained tasks
          */
         scheduled(): string;
+        /**
+         * Get the queue id
+         */
+        getQueueId(): number;
         /**
          * Get a state of current queue and tasks
          */