codeceptjs 3.3.0-beta.2 → 3.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.3.0-beta.2",
+  "version": "3.3.0",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -53,12 +53,13 @@
     "dtslint": "dtslint typings --localTs './node_modules/typescript/lib'"
   },
   "dependencies": {
-    "@codeceptjs/configure": "^0.6.2",
+    "@codeceptjs/configure": "^0.8.0",
     "@codeceptjs/helper": "^1.0.2",
     "acorn": "^7.4.1",
     "allure-js-commons": "^1.3.2",
     "arrify": "^2.0.1",
     "axios": "^0.21.4",
+    "chai": "^4.3.6",
     "chai-deep-match": "^1.2.1",
     "chalk": "^4.1.2",
     "commander": "^2.20.3",
@@ -99,7 +100,6 @@
     "@wdio/selenium-standalone-service": "^5.16.10",
     "@wdio/utils": "^5.23.0",
     "apollo-server-express": "^2.25.3",
-    "chai": "^3.5.0",
     "chai-as-promised": "^5.2.0",
     "chai-subset": "^1.6.0",
     "contributor-faces": "^1.0.3",

package/typings/types.d.ts

@@ -2583,15 +2583,19 @@ declare namespace CodeceptJS {
      * * `url`: base url of website to be tested
      * * `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.
+     * * `restart`: (optional, default: false) - restart strategy between tests. Possible values:
+     *   * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated.
+     *   * 'browser' or **true** - closes browser and opens it again between tests.
+     *   * 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default before CodeceptJS 3.1
+     * * `timeout`: (optional, default: 1000) -  [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) in ms of all Playwright actions .
      * * `disableScreenshots`: (optional, default: false)  - don't save screenshot on failure.
      * * `emulate`: (optional, default: {}) launch browser in device emulation mode.
      * * `video`: (optional, default: false) enables video recording for failed tests; videos are saved into `output/videos` folder
      * * `trace`: (optional, default: false) record [tracing information](https://playwright.dev/docs/trace-viewer) with screenshots and snapshots.
      * * `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure.
      * * `uniqueScreenshotNames`: (optional, default: false)  - option to prevent screenshot override if you have scenarios with the same name in different suites.
-     * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to false.
-     * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to false.
+     * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to 'session'.
+     * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to 'session'.
      * * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
      * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/main/docs/api.md#pagewaitfornavigationoptions).
      * * `pressKeyDelay`: (optional, default: '10'). Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
@@ -2896,6 +2900,16 @@ declare namespace CodeceptJS {
          * ```
          * @param srcElement - located by CSS|XPath|strict locator.
          * @param destElement - located by CSS|XPath|strict locator.
+         *
+         *
+         * [Additional options](https://playwright.dev/docs/api/class-page#page-drag-and-drop) can be passed as 3rd argument.
+         *
+         * ```js
+         * // specify coordinates for source position
+         * I.dragAndDrop('img.src', 'img.dst', { sourcePosition: {x: 10, y: 10} })
+         * ```
+         *
+         * > By default option `force: true` is set
          */
         dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString): void;
         /**
@@ -3153,6 +3167,19 @@ declare namespace CodeceptJS {
          * ```
          * @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.
+         *
+         *
+         * [Additional options](https://playwright.dev/docs/api/class-page#page-click) for click available as 3rd argument.
+         *
+         * Examples:
+         *
+         * ```js
+         * // click on element at position
+         * I.click('canvas', '.model', { position: { x: 20, y: 40 } })
+         *
+         * // make ctrl-click
+         * I.click('.edit', null, { modifiers: ['Ctrl'] } )
+         * ```
          */
         click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
         /**
@@ -3230,6 +3257,16 @@ declare namespace CodeceptJS {
          * ```
          * @param field - checkbox located by label | name | CSS | XPath | strict locator.
          * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
+         *
+         * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-check) for check available as 3rd argument.
+         *
+         * Examples:
+         *
+         * ```js
+         * // click on element at position
+         * I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
+         * ```
+         * > ⚠️ To avoid flakiness, option `force: true` is set by default
          */
         checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
         /**
@@ -3245,6 +3282,16 @@ declare namespace CodeceptJS {
          * ```
          * @param field - checkbox located by label | name | CSS | XPath | strict locator.
          * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
+         *
+         * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-uncheck) for uncheck available as 3rd argument.
+         *
+         * Examples:
+         *
+         * ```js
+         * // click on element at position
+         * I.uncheckOption('Agree', '.signup', { position: { x: 5, y: 5 } })
+         * ```
+         * > ⚠️ To avoid flakiness, option `force: true` is set by default
          */
         uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
         /**