codeceptjs 3.3.0-beta.5 → 3.3.2

package/docs/changelog.md

@@ -7,6 +7,105 @@ layout: Section
 
 # Releases
 
+## 3.3.2
+
+* **[REST]** Fixed override of headers/token in `haveRequestHeaders()` and `amBearerAuthenticated()`. See [#3304](https://github.com/codeceptjs/CodeceptJS/issues/3304) by **[mirao](https://github.com/mirao)**
+* Reverted typings change introduced in [#3245](https://github.com/codeceptjs/CodeceptJS/issues/3245). [More details on this](https://twitter.com/CodeceptJS/status/1519725963856207873) 
+
+## 3.3.1
+
+🛩️ Features:
+
+* Add option to avoid duplicate gherkin step definitions ([#3257](https://github.com/codeceptjs/CodeceptJS/issues/3257)) - **[raywiis](https://github.com/raywiis)**
+* Added `step.*` for run-workers [#3272](https://github.com/codeceptjs/CodeceptJS/issues/3272). Thanks to **[abhimanyupandian](https://github.com/abhimanyupandian)**
+* Fixed loading tests for `codecept run` using glob patterns. By **[jayudey-wf](https://github.com/jayudey-wf)** 
+
+```
+npx codeceptjs run test-dir/*"
+```
+
+* **[Playwright]** **Possible breaking change.** By default `timeout` is changed to 5000ms. The value set in 3.3.0 was too low. Please set `timeout` explicitly to not depend on release values.
+* **[Playwright]** Added for color scheme option by **[PeterNgTr](https://github.com/PeterNgTr)**
+
+```js
+ helpers: {
+  Playwright : {
+    url: "http://localhost",
+    colorScheme: "dark",
+  }
+ }
+```
+
+
+🐛 Bugfixes:
+
+* **[Playwright]** Fixed `Cannot read property 'video' of undefined`
+* Fixed haveRequestHeaders() and amBearerAuthenticated() of REST helper ([#3260](https://github.com/codeceptjs/CodeceptJS/issues/3260)) - **[mirao](https://github.com/mirao)**
+* Fixed: allure attachment fails if screenshot failed [#3298](https://github.com/codeceptjs/CodeceptJS/issues/3298) by **[ruudvanderweijde](https://github.com/ruudvanderweijde)** 
+* Fixed [#3105](https://github.com/codeceptjs/CodeceptJS/issues/3105) using autoLogin() plugin with TypeScript. Fix [#3290](https://github.com/codeceptjs/CodeceptJS/issues/3290) by **[PeterNgTr](https://github.com/PeterNgTr)** 
+* **[Playwright]** Added extra params for click and dragAndDrop to type definitions by **[mirao](https://github.com/mirao)**
+
+
+📖 Documentation
+* Improving the typings in many places
+* Improving the return type of helpers for TS users ([#3245](https://github.com/codeceptjs/CodeceptJS/issues/3245)) - **[nlespiaucq](https://github.com/nlespiaucq)**
+
+🇺🇦 Added #StandWithUkraine hashtag notice to CLI
+
+## 3.3.0
+
+🛩️ Features:
+
+* [**API Testing introduced**](/api)
+  * Introduced [`JSONResponse`](/helpers/JSONResponse) helper which connects to REST, GraphQL or Playwright helper
+  * **[REST]** Added `amBearerAuthenticated` method
+  * **[REST]** Added `haveRequestHeaders` method
+  * Added dependency on `joi` and `chai`
+* **[Playwright]** Added `timeout` option to set [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) for all Playwright actions. If an action fails, Playwright keeps retrying it for a time set by timeout.
+* **[Playwright]** **Possible breaking change.** By default `timeout` is set to 1000ms. *Previous default was set by Playwright internally to 30s. This was causing contradiction to CodeceptJS retries, so triggered up to 3 retries for 30s of time. This timeout option was lowered so retryFailedStep plugin would not cause long delays.*
+* **[Playwright]** Updated `restart` config option to include 3 restart strategies:
+  * '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 prior CodeceptJS 3.1
+* **[Playwright]** Extended methods to provide more options from engine. These methods were updated so additional options can be be passed as the last argument:
+  * [`click`](/helpers/Playwright#click)
+  * [`dragAndDrop`](/helpers/Playwright#dragAndDrop)
+  * [`checkOption`](/helpers/Playwright#checkOption)
+  * [`uncheckOption`](/helpers/Playwright#uncheckOption)
+
+```js
+// use Playwright click options as 3rd argument
+I.click('canvas', '.model', { position: { x: 20, y: 40 } })
+// check option also has options
+I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
+```
+
+* `eachElement` plugin introduced. It allows you to iterate over elements and perform some action on them using direct engines API
+
+```js
+await eachElement('click all links in .list', '.list a', (el) => {
+  await el.click();
+})
+```
+* **[Playwright]** Added support to `playwright-core` package if `playwright` is not installed. See [#3190](https://github.com/codeceptjs/CodeceptJS/issues/3190), fixes [#2663](https://github.com/codeceptjs/CodeceptJS/issues/2663).
+* **[Playwright]** Added `makeApiRequest` action to perform API requests. Requires Playwright >= 1.18
+* Added support to `codecept.config.js` for name consistency across other JS tools. See motivation at [#3195](https://github.com/codeceptjs/CodeceptJS/issues/3195) by **[JiLiZART](https://github.com/JiLiZART)** 
+* **[ApiDataFactory]** Added options arg to `have` method. See [#3197](https://github.com/codeceptjs/CodeceptJS/issues/3197) by **[JJlokidoki](https://github.com/JJlokidoki)**
+* Improved pt-br translations to include keywords: 'Funcionalidade', 'Cenário', 'Antes', 'Depois', 'AntesDaSuite', 'DepoisDaSuite'. See [#3206](https://github.com/codeceptjs/CodeceptJS/issues/3206) by **[danilolutz](https://github.com/danilolutz)** 
+* [allure plugin] Introduced `addStep` method to add comments and attachments. See [#3104](https://github.com/codeceptjs/CodeceptJS/issues/3104) by **[EgorBodnar](https://github.com/EgorBodnar)** 
+
+🐛 Bugfixes:
+
+* Fixed [#3212](https://github.com/codeceptjs/CodeceptJS/issues/3212): using Regex flags for Cucumber steps. See [#3214](https://github.com/codeceptjs/CodeceptJS/issues/3214) by **[anils92](https://github.com/anils92)**
+
+📖 Documentation
+
+* Added [Testomat.io reporter](/reports#testomatio)
+* Added [api testing](/api) guides
+* Added [internal api](/internal-api) guides
+* **[Appium]** Fixed documentation for `performSwipe`
+* **[Playwright]** update docs for `usePlaywrightTo` method by **[dbudzins](https://github.com/dbudzins)** 
+
 ## 3.2.3
 
 * Documentation improvements by **[maojunxyz](https://github.com/maojunxyz)**

package/docs/custom-helpers.md

@@ -7,7 +7,7 @@ title: Custom Helpers
 
 Helper is the core concept of CodeceptJS. Helper is a wrapper on top of various libraries providing unified interface around them. When `I` object is used in tests it delegates execution of its functions to currently enabled helper classes. 
 
-Use Helpers to introduce low-level API to your tests without polluting test scenarios. Helpers can also be used to share functionality accross different project and installed as npm packages.
+Use Helpers to introduce low-level API to your tests without polluting test scenarios. Helpers can also be used to share functionality across different project and installed as npm packages.
 
 ## Development
 

package/docs/data.md

@@ -206,7 +206,7 @@ See the example providing a factory for User generation:
 ```js
 // factories/post.js
 var Factory = require('rosie').Factory;
-var faker = require('faker');
+var faker = require('@faker-js/faker');
 
 module.exports = new Factory()
   .attr('name', () => faker.name.findName())
@@ -262,7 +262,7 @@ See the example providing a factory for User generation:
 ```js
 // factories/post.js
 var Factory = require('rosie').Factory;
-var faker = require('faker');
+var faker = require('@faker-js/faker');
 
 module.exports = new Factory((buildObj) => {
   return {

package/docs/email.md

@@ -145,6 +145,8 @@ After opening an email assertion methods are available.
 * `seeEmailIsFrom`
 * `seeInEmailBody`
 * `dontSeeInEmailBody`
+* `seeNumberOfEmailAttachments`
+* `seeEmailAttachment`
 
 And here is an example of their usage:
 
@@ -153,6 +155,9 @@ I.waitForLatestEmail()
 I.seeEmailIsFrom('@mysite.com');
 I.seeInEmailSubject('Awesome Proposal!');
 I.seeInEmailBody('To unsubscribe click here');
+I.seeNumberOfEmailAttachments(2);
+I.seeEmailAttachment('Attachment_1.pdf')
+I.seeEmailAttachment('Attachment_2.pdf')
 ```
 
 > More methods are listed in [helper's API reference](https://github.com/codeceptjs/mailslurp-helper/blob/master/README.md#api)

package/docs/helpers/ApiDataFactory.md

@@ -43,7 +43,7 @@ To make this work you need
 Install [Rosie][1] and [Faker][2] libraries.
 
 ```sh
-npm i rosie faker --save-dev
+npm i rosie @faker-js/faker --save-dev
 ```
 
 Create a factory file for a resource.
@@ -53,8 +53,8 @@ See the example for Posts factories:
 ```js
 // tests/factories/posts.js
 
-var Factory = require('rosie').Factory;
-var faker = require('faker');
+const Factory = require('rosie').Factory;
+const faker = require('@faker-js/faker');
 
 module.exports = new Factory()
    // no need to set id, it will be set by REST API
@@ -231,6 +231,8 @@ I.have('user', { }, { age: 33, height: 55 })
 -   `params` **any** predefined parameters
 -   `options` **any** options for programmatically generate the attributes
 
+Returns **[Promise][5]<any>** 
+
 ### haveMultiple
 
 Generates bunch of records and saves multiple API requests to store them.
@@ -260,3 +262,5 @@ I.haveMultiple('post', 3, { author: 'davert' }, { publish_date: '01.01.1997' });
 [3]: http://codecept.io/helpers/REST/
 
 [4]: https://github.com/axios/axios#request-config
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise