codeceptjs 3.3.1 → 3.3.2

package/docs/webapi/waitNumberOfVisibleElements.mustache

@@ -7,4 +7,4 @@ I.waitNumberOfVisibleElements('a', 3);
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} num number of elements.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@return {Promise<any>}
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/waitToHide.mustache

@@ -7,4 +7,4 @@ I.waitToHide('#popup');
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@return {Promise<any>}
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/waitUrlEquals.mustache

@@ -7,4 +7,4 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 @param {string} urlPart value to check.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@return {Promise<any>}
+[!] returns a _promise_ which is synchronized internally by recorder

package/lib/helper/Appium.js

@@ -332,7 +332,6 @@ class Appium extends Webdriver {
    *
    * @param {*} caps
    * @param {*} fn
-   * @return {Promise<any>}
    */
   async runOnIOS(caps, fn) {
     if (this.platform !== 'ios') return;
@@ -375,7 +374,6 @@ class Appium extends Webdriver {
    *
    * @param {*} caps
    * @param {*} fn
-   * @return {Promise<any>}
    */
   async runOnAndroid(caps, fn) {
     if (this.platform !== 'android') return;
@@ -396,7 +394,6 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {*} fn
-   * @return {Promise<any>}
    */
   /* eslint-disable */
   async runInWeb(fn) {
@@ -493,7 +490,6 @@ class Appium extends Webdriver {
    *
    * @param {string} appId
    * @param {string} [bundleId] ID of bundle
-   * @return {Promise<any>}
    */
   async removeApp(appId, bundleId) {
     onlyForApps.call(this, 'Android');
@@ -601,7 +597,6 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {'LANDSCAPE'|'PORTRAIT'} orientation LANDSCAPE or PORTRAIT
-   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -730,7 +725,6 @@ class Appium extends Webdriver {
    * Switch to the specified context.
    *
    * @param {*} context the context to switch to
-   * @return {Promise<any>}
    */
   async _switchToContext(context) {
     return this.browser.switchContext(context);
@@ -836,7 +830,6 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {object} settings object
-   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -861,7 +854,6 @@ class Appium extends Webdriver {
    *
    * @param {'tapOutside' | 'pressKey'} [strategy] Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
    * @param {string} [key] Optional key
-   * @return {Promise<any>}
    */
   async hideDeviceKeyboard(strategy, key) {
     onlyForApps.call(this);
@@ -984,7 +976,6 @@ class Appium extends Webdriver {
    *
    * @param {object} from
    * @param {object} to
-   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -1217,7 +1208,6 @@ class Appium extends Webdriver {
    * Appium: support Android and iOS
    *
    * @param {Array} actions Array of touch actions
-   * @return {Promise<any>}
    */
   async touchPerform(actions) {
     onlyForApps.call(this);

package/lib/helper/Playwright.js

@@ -553,8 +553,7 @@ class Playwright extends Helper {
   * ```
   *
   * @param {string} description used to show in logs.
-  * @param {function} fn async function that executed with Playwright helper as argument
-  * @return {Promise<any>}
+  * @param {function} fn async function that executed with Playwright helper as argumen
   */
   usePlaywrightTo(description, fn) {
     return this._useTo(...arguments);
@@ -569,7 +568,6 @@ class Playwright extends Helper {
    * I.click('#triggerPopup');
    * I.acceptPopup();
    * ```
-   * @return {Promise<any>}
    */
   amAcceptingPopups() {
     popupStore.actionType = 'accept';
@@ -579,7 +577,6 @@ class Playwright extends Helper {
    * Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt.
    * Don't confuse popups with modal windows, as created by [various
    * libraries](http://jster.net/category/windows-modals-popups).
-   * @return {Promise<any>}
    */
   acceptPopup() {
     popupStore.assertPopupActionType('accept');
@@ -594,7 +591,6 @@ class Playwright extends Helper {
    * I.click('#triggerPopup');
    * I.cancelPopup();
    * ```
-   * @return {Promise<any>}
    */
   amCancellingPopups() {
     popupStore.actionType = 'cancel';
@@ -602,7 +598,6 @@ class Playwright extends Helper {
 
   /**
    * Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.
-   * @return {Promise<any>}
    */
   cancelPopup() {
     popupStore.assertPopupActionType('cancel');
@@ -620,7 +615,6 @@ class Playwright extends Helper {
   /**
    * Set current page
    * @param {object} page page to set
-   * @return {Promise<any>}
    */
   async _setPage(page) {
     page = await page;
@@ -645,7 +639,6 @@ class Playwright extends Helper {
   /**
    * Add the 'dialog' event listener to a page
    * @page {playwright.Page}
-   * @return {Promise<any>}
    *
    * The popup listener handles the dialog with the predefined action when it appears on the page.
    * It also saves a reference to the object which is used in seeInPopup.
@@ -676,7 +669,6 @@ class Playwright extends Helper {
 
   /**
    * Gets page URL including hash.
-   * @return {Promise<any>}
    */
   async _getPageUrl() {
     return this.executeScript(() => window.location.href);
@@ -849,7 +841,6 @@ class Playwright extends Helper {
    * ```
    *
    * @param {object} customHeaders headers to set
-   * @return {Promise<any>}
    */
   async haveRequestHeaders(customHeaders) {
     if (!customHeaders) {
@@ -996,7 +987,6 @@ class Playwright extends Helper {
    * ```js
    * const elements = await this.helpers['Playwright']._locate({name: 'password'});
    * ```
-   * @return {Promise<any>}
    */
   async _locate(locator) {
     const context = await this.context || await this._getContext();
@@ -1010,7 +1000,6 @@ class Playwright extends Helper {
    * ```js
    * this.helpers['Playwright']._locateCheckable('I agree with terms and conditions').then // ...
    * ```
-   * @return {Promise<any>}
    */
   async _locateCheckable(locator, providedContext = null) {
     const context = providedContext || await this._getContext();
@@ -1025,7 +1014,6 @@ class Playwright extends Helper {
    * ```js
    * this.helpers['Playwright']._locateClickable('Next page').then // ...
    * ```
-   * @return {Promise<any>}
    */
   async _locateClickable(locator) {
     const context = await this._getContext();
@@ -1038,7 +1026,6 @@ class Playwright extends Helper {
    * ```js
    * this.helpers['Playwright']._locateFields('Your email').then // ...
    * ```
-   * @return {Promise<any>}
    */
   async _locateFields(locator) {
     return findFields.call(this, locator);
@@ -1053,7 +1040,6 @@ class Playwright extends Helper {
    * ```
    *
    * @param {number} [num=1]
-   * @return {Promise<any>}
    */
   async switchToNextTab(num = 1) {
     if (this.isElectron) {
@@ -1080,7 +1066,6 @@ class Playwright extends Helper {
    * I.switchToPreviousTab(2);
    * ```
    * @param {number} [num=1]
-   * @return {Promise<any>}
    */
   async switchToPreviousTab(num = 1) {
     if (this.isElectron) {
@@ -1105,7 +1090,6 @@ class Playwright extends Helper {
    * ```js
    * I.closeCurrentTab();
    * ```
-   * @return {Promise<any>}
    */
   async closeCurrentTab() {
     if (this.isElectron) {
@@ -1123,7 +1107,6 @@ class Playwright extends Helper {
    * ```js
    * I.closeOtherTabs();
    * ```
-   * @return {Promise<any>}
    */
   async closeOtherTabs() {
     const pages = await this.browserContext.pages();
@@ -1148,7 +1131,6 @@ class Playwright extends Helper {
    * // enable mobile
    * I.openNewTab({ isMobile: true });
    * ```
-   * @return {Promise<any>}
    */
   async openNewTab(options) {
     if (this.isElectron) {
@@ -1255,7 +1237,6 @@ class Playwright extends Helper {
 
   /**
    * Clicks link and waits for navigation (deprecated)
-   * @return {Promise<any>}
    */
   async clickLink(locator, context = null) {
     console.log('clickLink deprecated: Playwright automatically waits for navigation to happen.');
@@ -1702,7 +1683,6 @@ class Playwright extends Helper {
    *
    * @param {string|function} fn function to be executed in browser context.
    * @param {any} [arg] optional argument to pass to the function
-   * @return {Promise<any>}
    */
   async executeScript(fn, arg) {
     let context = this.page;
@@ -2303,7 +2283,6 @@ class Playwright extends Helper {
    *
    * @param {string|function} urlOrPredicate
    * @param {?number} [sec=null] seconds to wait
-   * @return {Promise<any>}
    */
   async waitForRequest(urlOrPredicate, sec = null) {
     const timeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2320,7 +2299,6 @@ class Playwright extends Helper {
    *
    * @param {string|function} urlOrPredicate
    * @param {?number} [sec=null] number of seconds to wait
-   * @return {Promise<any>}
    */
   async waitForResponse(urlOrPredicate, sec = null) {
     const timeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2392,7 +2370,6 @@ class Playwright extends Helper {
    * See [Playwright's reference](https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions)
    *
    * @param {*} opts
-   * @return {Promise<any>}
    */
   async waitForNavigation(opts = {}) {
     opts = {
@@ -2464,8 +2441,7 @@ class Playwright extends Helper {
   * This method allows intercepting and mocking requests & responses. [Learn more about it](https://playwright.dev/docs/network#handle-requests)
   *
   * @param {string|RegExp} [url] URL, regex or pattern for to match URL
-  * @param {function} [handler] a function to process request
-  * @return {Promise<any>}
+  * @param {function} [handler] a function to process reques
   */
   async mockRoute(url, handler) {
     return this.browserContext.route(...arguments);
@@ -2481,8 +2457,7 @@ class Playwright extends Helper {
   * If no handler is passed, all mock requests for the rote are disabled.
   *
   * @param {string|RegExp} [url] URL, regex or pattern for to match URL
-  * @param {function} [handler] a function to process request
-  * @return {Promise<any>}
+  * @param {function} [handler] a function to process reques
   */
   async stopMockingRoute(url, handler) {
     return this.browserContext.unroute(...arguments);

package/lib/helper/REST.js

@@ -87,7 +87,7 @@ class REST extends Helper {
    * @param {object} headers headers list
    */
   haveRequestHeaders(headers) {
-    this.headers = { ...headers, ...this.headers };
+    this.headers = { ...this.headers, ...headers };
   }
 
   /**
@@ -113,7 +113,7 @@ class REST extends Helper {
    */
   async _executeRequest(request) {
     // Add custom headers. They can be set by amBearerAuthenticated() or haveRequestHeaders()
-    request.headers = { ...request.headers, ...this.headers };
+    request.headers = { ...this.headers, ...request.headers };
 
     const _debugRequest = { ...request };
     this.axios.defaults.timeout = request.timeout || this.options.timeout;

package/lib/helper/WebDriver.js

@@ -2553,7 +2553,6 @@ class WebDriver extends Helper {
    * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
    * @param {*} caps
    * @param {*} fn
-   * @return {Promise<any>}
    */
   /* eslint-disable */
   runOnIOS(caps, fn) {
@@ -2563,7 +2562,6 @@ class WebDriver extends Helper {
    * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
    * @param {*} caps
    * @param {*} fn
-   * @return {Promise<any>}
    */
   runOnAndroid(caps, fn) {
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.3.1",
+  "version": "3.3.2",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",