codeceptjs 3.3.0 → 3.3.1

package/docs/changelog.md

@@ -7,6 +7,44 @@ layout: Section
 
 # Releases
 
+## 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)**
+
 ## 3.3.0
 
 🛩️ Features:
@@ -55,7 +93,7 @@ await eachElement('click all links in .list', '.list a', (el) => {
 
 📖 Documentation
 
-* Added [Testomat.io reporter](/reporters#testomatio)
+* Added [Testomat.io reporter](/reports#testomatio)
 * Added [api testing](/api) guides
 * Added [internal api](/internal-api) guides
 * **[Appium]** Fixed documentation for `performSwipe`

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/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

package/docs/helpers/Appium.md

@@ -264,6 +264,8 @@ Appium: support only Android
 -   `appId` **[string][5]** 
 -   `bundleId` **[string][5]?** ID of bundle
 
+Returns **[Promise][4]<any>** 
+
 ### seeCurrentActivityIs
 
 Check current activity on an Android device.
@@ -396,6 +398,8 @@ Switch to the specified context.
 
 -   `context` **any** the context to switch to
 
+Returns **[Promise][4]<any>** 
+
 ### switchToWeb
 
 Switches to web context.
@@ -429,7 +433,7 @@ I.switchToNative('SOME_OTHER_CONTEXT');
 
 #### Parameters
 
--   `context` **any**  (optional, default `null`)
+-   `context` **any?**  (optional, default `null`)
 
 Returns **[Promise][4]<void>** 
 
@@ -506,6 +510,8 @@ Appium: support Android and iOS
 -   `strategy` **(`"tapOutside"` \| `"pressKey"`)?** Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
 -   `key` **[string][5]?** Optional key
 
+Returns **[Promise][4]<any>** 
+
 ### sendDeviceKeyEvent
 
 Send a key event to the device.
@@ -597,7 +603,9 @@ I.performSwipe({ x: 300, y: 100 }, { x: 200, y: 100 });
 #### Parameters
 
 -   `from` **[object][8]** 
--   `to` **[object][8]** Appium: support Android and iOS
+-   `to` **[object][8]** 
+
+Returns **[Promise][4]<any>** Appium: support Android and iOS
 
 ### swipeDown
 
@@ -731,6 +739,8 @@ Appium: support Android and iOS
 
 -   `actions` **[Array][6]** Array of touch actions
 
+Returns **[Promise][4]<any>** 
+
 ### pullFile
 
 Pulls a file from the device.
@@ -833,6 +843,8 @@ I.appendField('#myTextField', 'appended');
 -   `field` **([string][5] \| [object][8])** located by label|name|CSS|XPath|strict locator
 -   `value` **[string][5]** text value to append.
 
+Returns **[Promise][4]<any>** 
+
 ### checkOption
 
 Selects a checkbox or radio button.
@@ -851,6 +863,8 @@ I.checkOption('agree', '//form');
 -   `field` **([string][5] \| [object][8])** checkbox located by label | name | CSS | XPath | strict locator.
 -   `context` **([string][5]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator. (optional, default `null`)
 
+Returns **[Promise][4]<any>** 
+
 ### click
 
 Perform a click on a link or a button, given by a locator.
@@ -878,7 +892,9 @@ I.click({css: 'nav a.login'});
 #### Parameters
 
 -   `locator` **([string][5] \| [object][8])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][5]? | [object][8])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. (optional, default `null`)
+-   `context` **([string][5]? | [object][8] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. (optional, default `null`)
+
+Returns **[Promise][4]<any>** 
 
 ### dontSeeCheckboxIsChecked
 
@@ -894,6 +910,8 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 
 -   `field` **([string][5] \| [object][8])** located by label|name|CSS|XPath|strict locator.
 
+Returns **[Promise][4]<any>** 
+
 ### dontSeeElement
 
 Opposite to `seeElement`. Checks that element is not visible (or in DOM)
@@ -906,6 +924,8 @@ I.dontSeeElement('.modal'); // modal is not shown
 
 -   `locator` **([string][5] \| [object][8])** located by CSS|XPath|Strict locator.
 
+Returns **[Promise][4]<any>** 
+
 ### dontSeeInField
 
 Checks that value of input field or textarea doesn't equal to given value
@@ -921,6 +941,8 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 -   `field` **([string][5] \| [object][8])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][5]** value to check.
 
+Returns **[Promise][4]<any>** 
+
 ### dontSee
 
 Opposite to `see`. Checks that a text is not present on a page.
@@ -936,6 +958,8 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 -   `text` **[string][5]** which is not present.
 -   `context` **([string][5] \| [object][8])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. (optional, default `null`)
 
+Returns **[Promise][4]<any>** 
+
 ### fillField
 
 Fills a text field or textarea, after clearing its value, with the given string.
@@ -957,6 +981,8 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 -   `field` **([string][5] \| [object][8])** located by label|name|CSS|XPath|strict locator.
 -   `value` **([string][5] \| [object][8])** text value to fill.
 
+Returns **[Promise][4]<any>** 
+
 ### grabTextFromAll
 
 Retrieves all texts from an element located by CSS or XPath and returns it to test.
@@ -1099,7 +1125,9 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
 #### Parameters
 
 -   `locator` **([string][5] \| [object][8])** located by CSS|XPath|strict locator.
--   `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][15].Supported only for web testing
+-   `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][15].
+
+Returns **[Promise][4]<any>** Supported only for web testing
 
 ### seeCheckboxIsChecked
 
@@ -1115,6 +1143,8 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 -   `field` **([string][5] \| [object][8])** located by label|name|CSS|XPath|strict locator.
 
+Returns **[Promise][4]<any>** 
+
 ### seeElement
 
 Checks that a given Element is visible
@@ -1128,6 +1158,8 @@ I.seeElement('#modal');
 
 -   `locator` **([string][5] \| [object][8])** located by CSS|XPath|strict locator.
 
+Returns **[Promise][4]<any>** 
+
 ### seeInField
 
 Checks that the given input field or textarea equals to given value.
@@ -1145,6 +1177,8 @@ I.seeInField('#searchform input','Search');
 -   `field` **([string][5] \| [object][8])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][5]** value to check.
 
+Returns **[Promise][4]<any>** 
+
 ### see
 
 Checks that a page contains a visible text.
@@ -1161,6 +1195,8 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 -   `text` **[string][5]** expected on page.
 -   `context` **([string][5]? | [object][8])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. (optional, default `null`)
 
+Returns **[Promise][4]<any>** 
+
 ### selectOption
 
 Selects an option in a drop-down select.
@@ -1185,7 +1221,9 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 #### Parameters
 
 -   `select` **([string][5] \| [object][8])** field located by label|name|CSS|XPath|strict locator.
--   `option` **([string][5] \| [Array][6]<any>)** visible text or value of option.Supported only for web testing
+-   `option` **([string][5] \| [Array][6]<any>)** visible text or value of option.
+
+Returns **[Promise][4]<any>** Supported only for web testing
 
 ### waitForElement
 
@@ -1202,6 +1240,8 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 -   `locator` **([string][5] \| [object][8])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait (optional, default `null`)
 
+Returns **[Promise][4]<any>** 
+
 ### waitForVisible
 
 Waits for an element to become visible on a page (by default waits for 1sec).
@@ -1216,6 +1256,8 @@ I.waitForVisible('#popup');
 -   `locator` **([string][5] \| [object][8])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
 
+Returns **[Promise][4]<any>** 
+
 ### waitForInvisible
 
 Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
@@ -1230,6 +1272,8 @@ I.waitForInvisible('#popup');
 -   `locator` **([string][5] \| [object][8])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
 
+Returns **[Promise][4]<any>** 
+
 ### waitForText
 
 Waits for a text to appear (by default waits for 1sec).
@@ -1247,6 +1291,8 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 -   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
 -   `context` **([string][5] \| [object][8])?** (optional) element located by CSS|XPath|strict locator. (optional, default `null`)
 
+Returns **[Promise][4]<any>** 
+
 ### useWebDriverTo
 
 Use [webdriverio][16] API inside a test.
@@ -1374,6 +1420,8 @@ I.amOnPage('/login'); // opens a login page
 
 -   `url` **[string][5]** url path or global url.
 
+Returns **[Promise][4]<any>** 
+
 ### forceClick
 
 Perform an emulated click on a link or a button, given by a locator.
@@ -1404,7 +1452,9 @@ I.forceClick({css: 'nav a.login'});
 #### Parameters
 
 -   `locator` **([string][5] \| [object][8])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][5]? | [object][8])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.{{ react }} (optional, default `null`)
+-   `context` **([string][5]? | [object][8])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. (optional, default `null`)
+
+Returns **[Promise][4]<any>** {{ react }}
 
 ### doubleClick
 
@@ -1421,7 +1471,9 @@ I.doubleClick('.btn.edit');
 #### Parameters
 
 -   `locator` **([string][5] \| [object][8])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][5]? | [object][8])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.{{ react }} (optional, default `null`)
+-   `context` **([string][5]? | [object][8])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. (optional, default `null`)
+
+Returns **[Promise][4]<any>** {{ react }}
 
 ### rightClick
 
@@ -1439,7 +1491,9 @@ I.rightClick('Click me', '.context');
 #### Parameters
 
 -   `locator` **([string][5] \| [object][8])** clickable element located by CSS|XPath|strict locator.
--   `context` **([string][5]? | [object][8])** (optional, `null` by default) element located by CSS|XPath|strict locator.{{ react }} (optional, default `null`)
+-   `context` **([string][5]? | [object][8])** (optional, `null` by default) element located by CSS|XPath|strict locator. (optional, default `null`)
+
+Returns **[Promise][4]<any>** {{ react }}
 
 ### forceRightClick
 
@@ -1461,7 +1515,9 @@ I.forceRightClick('Menu');
 #### Parameters
 
 -   `locator` **([string][5] \| [object][8])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][5]? | [object][8])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.{{ react }} (optional, default `null`)
+-   `context` **([string][5]? | [object][8])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. (optional, default `null`)
+
+Returns **[Promise][4]<any>** {{ react }}
 
 ### clearField
 
@@ -1478,6 +1534,8 @@ I.clearField('#email');
 -   `field`  
 -   `editable` **([string][5] \| [object][8])** field located by label|name|CSS|XPath|strict locator.
 
+Returns **[Promise][4]<any>** 
+
 ### attachFile
 
 Attaches a file to element located by label, name, CSS or XPath
@@ -1493,7 +1551,8 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 -   `locator` **([string][5] \| [object][8])** field located by label|name|CSS|XPath|strict locator.
 -   `pathToFile` **[string][5]** local file path relative to codecept.json config file.
-    Appium: not tested
+
+Returns **[Promise][4]<any>** Appium: not tested
 
 ### uncheckOption
 
@@ -1511,8 +1570,9 @@ I.uncheckOption('agree', '//form');
 #### Parameters
 
 -   `field` **([string][5] \| [object][8])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][5]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
-    Appium: not tested (optional, default `null`)
+-   `context` **([string][5]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator. (optional, default `null`)
+
+Returns **[Promise][4]<any>** Appium: not tested
 
 ### grabHTMLFromAll
 
@@ -1560,6 +1620,8 @@ I.seeTextEquals('text', 'h1');
 -   `text` **[string][5]** element value to check.
 -   `context` **([string][5] \| [object][8])?** element located by CSS|XPath|strict locator. (optional, default `null`)
 
+Returns **[Promise][4]<any>** 
+
 ### seeElementInDOM
 
 Checks that a given Element is present in the DOM
@@ -1573,6 +1635,8 @@ I.seeElementInDOM('#modal');
 
 -   `locator` **([string][5] \| [object][8])** element located by CSS|XPath|strict locator.
 
+Returns **[Promise][4]<any>** 
+
 ### dontSeeElementInDOM
 
 Opposite to `seeElementInDOM`. Checks that element is not on page.
@@ -1585,6 +1649,8 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
 
 -   `locator` **([string][5] \| [object][8])** located by CSS|XPath|Strict locator.
 
+Returns **[Promise][4]<any>** 
+
 ### seeInSource
 
 Checks that the current page contains the given string in its raw source code.
@@ -1597,6 +1663,8 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 
 -   `text` **[string][5]** value to check.
 
+Returns **[Promise][4]&lt;any>** 
+
 ### grabSource
 
 Retrieves page source and returns it to test.
@@ -1633,6 +1701,8 @@ I.dontSeeInSource('<!--'); // no comments in source
 -   `text`  
 -   `value` **[string][5]** to check.
 
+Returns **[Promise][4]&lt;any>** 
+
 ### seeNumberOfElements
 
 Asserts that an element appears a given number of times in the DOM.
@@ -1645,7 +1715,9 @@ I.seeNumberOfElements('#submitBtn', 1);
 #### Parameters
 
 -   `locator` **([string][5] \| [object][8])** element located by CSS|XPath|strict locator.
--   `num` **[number][10]** number of elements.{{ react }}
+-   `num` **[number][10]** number of elements.
+
+Returns **[Promise][4]&lt;any>** {{ react }}
 
 ### seeNumberOfVisibleElements
 
@@ -1659,7 +1731,9 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 #### Parameters
 
 -   `locator` **([string][5] \| [object][8])** element located by CSS|XPath|strict locator.
--   `num` **[number][10]** number of elements.{{ react }}
+-   `num` **[number][10]** number of elements.
+
+Returns **[Promise][4]&lt;any>** {{ react }}
 
 ### seeAttributesOnElements
 
@@ -1674,6 +1748,8 @@ I.seeAttributesOnElements('//form', { method: "post"});
 -   `locator` **([string][5] \| [object][8])** located by CSS|XPath|strict locator.
 -   `attributes` **[object][8]** attributes and their values to check.
 
+Returns **[Promise][4]&lt;any>** 
+
 ### scrollTo
 
 Scrolls to element matched by locator.
@@ -1690,6 +1766,8 @@ I.scrollTo('#submit', 5, 5);
 -   `offsetX` **[number][10]** (optional, `0` by default) X-axis offset. (optional, default `0`)
 -   `offsetY` **[number][10]** (optional, `0` by default) Y-axis offset. (optional, default `0`)
 
+Returns **[Promise][4]&lt;any>** 
+
 ### moveCursorTo
 
 Moves cursor to element matched by locator.
@@ -1708,6 +1786,8 @@ I.moveCursorTo('#submit', 5,5);
 -   `offsetX` **[number][10]** (optional, `0` by default) X-axis offset. (optional, default `0`)
 -   `offsetY` **[number][10]** (optional, `0` by default) Y-axis offset. (optional, default `0`)
 
+Returns **[Promise][4]&lt;any>** 
+
 ### saveElementScreenshot
 
 Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
@@ -1722,6 +1802,8 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 -   `locator` **([string][5] \| [object][8])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][5]** file name to save.
 
+Returns **[Promise][4]&lt;any>** 
+
 ### type
 
 Types out the given text into an active field.
@@ -1745,6 +1827,8 @@ I.type(['T', 'E', 'X', 'T']);
 -   `delay` **[number][10]?** (optional) delay in ms between key presses (optional, default `null`)
 -   `key` **([string][5] \| [Array][6]&lt;[string][5]>)** or array of keys to type.
 
+Returns **[Promise][4]&lt;any>** 
+
 ### dragAndDrop
 
 Drag an item to a destination element.
@@ -1756,7 +1840,9 @@ I.dragAndDrop('#dragHandle', '#container');
 #### Parameters
 
 -   `srcElement` **([string][5] \| [object][8])** located by CSS|XPath|strict locator.
--   `destElement` **([string][5] \| [object][8])** located by CSS|XPath|strict locator.Appium: not tested
+-   `destElement` **([string][5] \| [object][8])** located by CSS|XPath|strict locator.
+
+Returns **[Promise][4]&lt;any>** Appium: not tested
 
 ### dragSlider
 
@@ -1773,6 +1859,8 @@ I.dragSlider('#slider', -70);
 -   `locator` **([string][5] \| [object][8])** located by label|name|CSS|XPath|strict locator.
 -   `offsetX` **[number][10]** position to drag. (optional, default `0`)
 
+Returns **[Promise][4]&lt;any>** 
+
 ### grabAllWindowHandles
 
 Get all Window Handles.
@@ -1821,6 +1909,8 @@ Close all tabs except for the current one.
 I.closeOtherTabs();
 ```
 
+Returns **[Promise][4]&lt;any>** 
+
 ### switchTo
 
 Switches frame or in case of null locator reverts to parent.
@@ -1834,6 +1924,8 @@ I.switchTo(); // switch back to main page
 
 -   `locator` **([string][5]? | [object][8])** (optional, `null` by default) element located by CSS|XPath|strict locator. (optional, default `null`)
 
+Returns **[Promise][4]&lt;any>** 
+
 ### grabNumberOfOpenTabs
 
 Grab number of open tabs.
@@ -1853,6 +1945,8 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
+Returns **[Promise][4]&lt;any>** 
+
 ### scrollPageToBottom
 
 Scroll page to the bottom.
@@ -1861,6 +1955,8 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
+Returns **[Promise][4]&lt;any>** 
+
 ### grabPageScrollPosition
 
 Retrieves a page scroll position and returns it to test.
@@ -1887,6 +1983,8 @@ I.setGeoLocation(121.21, 11.56, 10);
 -   `longitude` **[number][10]** to set
 -   `altitude` **[number][10]?** (optional, null by default) to set (optional, default `null`)
 
+Returns **[Promise][4]&lt;any>** 
+
 ### grabGeoLocation
 
 Return the current geo location 

package/docs/helpers/GraphQL.md

@@ -66,6 +66,8 @@ Prepares request for axios call
 -   `operation` **[object][2]** 
 -   `headers` **[object][2]** 
 
+Returns **[object][2]** graphQLRequest
+
 ### sendMutation
 
 Send query to GraphQL endpoint over http
@@ -95,6 +97,8 @@ I.sendMutation(`
 -   `options` **[object][2]** are additional query options 
 -   `headers` **[object][2]**  
 
+Returns **any** Promise<any>
+
 ### sendQuery
 
 Send query to GraphQL endpoint over http.
@@ -117,6 +121,8 @@ const user = response.data.data;
 -   `options` **[object][2]** are additional query options 
 -   `headers` **[object][2]**  
 
+Returns **any** Promise<any>
+
 [1]: https://github.com/axios/axios
 
 [2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

package/docs/helpers/GraphQLDataFactory.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 Users factories:
 ```js
 // tests/factories/users.js
 
-var Factory = require('rosie').Factory;
-var faker = require('faker');
+const Factory = require('rosie').Factory;
+const faker = require('@faker-js/faker');
 
 // Used with a constructor function passed to Factory, so that the final build
 // object matches the necessary pattern to be sent as the variables object.

package/docs/helpers/JSONResponse.md

@@ -207,7 +207,7 @@ Executes a callback function passing in `response` object and chai assertions wi
 Use it to perform custom checks of response data
 
 ```js
-I.seeResponseValidByCallback({ data, status, expect } => {
+I.seeResponseValidByCallback(({ data, status, expect }) => {
   expect(status).to.eql(200);
   expect(data).keys.to.include(['user', 'company']);
 });