codeceptjs 3.5.4 → 3.5.6

package/lib/plugin/tryTo.js

@@ -81,10 +81,8 @@ module.exports = function (config) {
 };
 
 function tryTo(callback) {
-  const mode = store.debugMode;
   let result = false;
   return recorder.add('tryTo', () => {
-    store.debugMode = true;
     recorder.session.start('tryTo');
     callback();
     recorder.add(() => {
@@ -100,7 +98,6 @@ function tryTo(callback) {
       return result;
     });
     return recorder.add('result', () => {
-      store.debugMode = mode;
       return result;
     }, true, false);
   }, false, false);

package/lib/session.js

@@ -19,7 +19,7 @@ const savedSessions = {};
  * @param {CodeceptJS.LocatorOrString}  sessionName
  * @param {Function | Object<string, *>}  config
  * @param {Function}  [fn]
- * @return {Promise<*> | undefined}
+ * @return {any}
  */
 function session(sessionName, config, fn) {
   if (typeof config === 'function') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.4",
+  "version": "3.5.6",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -40,8 +40,8 @@
     "lint": "eslint bin/ examples/ lib/ test/ translations/ runok.js",
     "lint-fix": "eslint bin/ examples/ lib/ test/ translations/ runok.js --fix",
     "docs": "./runok.js docs",
-    "test:unit": "mocha test/unit --recursive --timeout 5000",
-    "test:runner": "mocha test/runner --recursive --timeout 5000",
+    "test:unit": "mocha test/unit --recursive --timeout 10000",
+    "test:runner": "mocha test/runner --recursive --timeout 10000",
     "test": "npm run test:unit && npm run test:runner",
     "test:appium-quick": "mocha test/helper/Appium_test.js --grep 'quick'",
     "test:appium-other": "mocha test/helper/Appium_test.js --grep 'second'",
@@ -59,93 +59,93 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "@codeceptjs/configure": "^0.10.0",
-    "@codeceptjs/helper": "^2.0.1",
-    "@cucumber/cucumber-expressions": "^16",
-    "@cucumber/gherkin": "^26",
-    "@cucumber/messages": "^22.0.0",
-    "@xmldom/xmldom": "^0.8.10",
-    "acorn": "^8.10.0",
-    "arrify": "^2.0.1",
-    "axios": "^1.3.3",
-    "chai": "^4.3.6",
-    "chai-deep-match": "^1.2.1",
-    "chalk": "^4.1.2",
-    "commander": "^11.0.0",
-    "cross-spawn": "^7.0.3",
-    "css-to-xpath": "^0.1.0",
-    "envinfo": "^7.8.1",
-    "escape-string-regexp": "^4.0.0",
-    "figures": "^3.2.0",
-    "fn-args": "^4.0.0",
-    "fs-extra": "^8.1.0",
-    "glob": "^6.0.1",
-    "html-minifier": "^4.0.0",
-    "inquirer": "^6.5.2",
-    "joi": "^17.6.0",
-    "js-beautify": "^1.14.0",
-    "lodash.clonedeep": "^4.5.0",
-    "lodash.merge": "^4.6.2",
-    "mkdirp": "^1.0.4",
-    "mocha": "^10.2.0",
-    "ms": "^2.1.3",
-    "openai": "^3.2.1",
-    "ora-classic": "^5.4.2",
-    "parse-function": "^5.6.4",
-    "parse5": "^7.1.2",
-    "promise-retry": "^1.1.1",
-    "resq": "^1.10.2",
-    "sprintf-js": "^1.1.1",
-    "uuid": "^9.0"
+    "@codeceptjs/configure": "0.10.0",
+    "@codeceptjs/helper": "2.0.1",
+    "@cucumber/cucumber-expressions": "16",
+    "@cucumber/gherkin": "26",
+    "@cucumber/messages": "22.0.0",
+    "@xmldom/xmldom": "0.8.10",
+    "acorn": "8.10.0",
+    "arrify": "2.0.1",
+    "axios": "1.3.3",
+    "chai": "4.3.8",
+    "chai-deep-match": "1.2.1",
+    "chalk": "4.1.2",
+    "commander": "11.0.0",
+    "cross-spawn": "7.0.3",
+    "css-to-xpath": "0.1.0",
+    "envinfo": "7.8.1",
+    "escape-string-regexp": "4.0.0",
+    "figures": "3.2.0",
+    "fn-args": "4.0.0",
+    "fs-extra": "8.1.0",
+    "glob": "6.0.1",
+    "html-minifier": "4.0.0",
+    "inquirer": "6.5.2",
+    "joi": "17.6.0",
+    "js-beautify": "1.14.9",
+    "lodash.clonedeep": "4.5.0",
+    "lodash.merge": "4.6.2",
+    "mkdirp": "1.0.4",
+    "mocha": "10.2.0",
+    "ms": "2.1.3",
+    "openai": "3.2.1",
+    "ora-classic": "5.4.2",
+    "parse-function": "5.6.4",
+    "parse5": "7.1.2",
+    "promise-retry": "1.1.1",
+    "resq": "1.10.2",
+    "sprintf-js": "1.1.1",
+    "uuid": "9.0"
   },
   "devDependencies": {
-    "@codeceptjs/detox-helper": "^1.0.2",
-    "@codeceptjs/mock-request": "^0.3.1",
-    "@faker-js/faker": "^7.6.0",
-    "@pollyjs/adapter-puppeteer": "^6.0.5",
-    "@pollyjs/core": "^5.1.0",
-    "@types/inquirer": "^9.0.3",
-    "@types/node": "^20.4.4",
-    "@wdio/sauce-service": "^8.3.8",
-    "@wdio/selenium-standalone-service": "^8.3.2",
-    "@wdio/utils": "^8.3.0",
+    "@codeceptjs/detox-helper": "1.0.2",
+    "@codeceptjs/mock-request": "0.3.1",
+    "@faker-js/faker": "7.6.0",
+    "@pollyjs/adapter-puppeteer": "6.0.6",
+    "@pollyjs/core": "5.1.0",
+    "@types/inquirer": "9.0.3",
+    "@types/node": "20.4.4",
+    "@wdio/sauce-service": "8.3.8",
+    "@wdio/selenium-standalone-service": "8.3.2",
+    "@wdio/utils": "8.16.22",
     "apollo-server-express": "2.25.3",
-    "chai-as-promised": "^7.1.1",
-    "chai-subset": "^1.6.0",
-    "contributor-faces": "^1.0.3",
-    "documentation": "^12.3.0",
-    "dtslint": "^4.1.6",
-    "electron": "^26.1.0",
-    "eslint": "^8.45.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-mocha": "^6.3.0",
-    "expect": "^29.6.2",
-    "express": "^4.17.2",
-    "graphql": "^14.6.0",
-    "husky": "^8.0.1",
-    "inquirer-test": "^2.0.1",
-    "jsdoc": "^3.6.10",
-    "jsdoc-typeof-plugin": "^1.0.0",
-    "json-server": "^0.10.1",
-    "playwright": "^1.35.1",
-    "puppeteer": "^10.4.0",
-    "qrcode-terminal": "^0.12.0",
-    "rosie": "^2.1.0",
-    "runok": "^0.9.2",
-    "sinon": "^15.2.0",
-    "sinon-chai": "^3.7.0",
-    "testcafe": "^3.0.1",
-    "ts-morph": "^3.1.3",
-    "ts-node": "^10.9.1",
-    "tsd-jsdoc": "^2.5.0",
-    "typedoc": "^0.24.8",
-    "typedoc-plugin-markdown": "^3.13.4",
-    "typescript": "^5.1.6",
-    "wdio-docker-service": "^1.5.0",
-    "webdriverio": "^8.3.8",
-    "xml2js": "^0.6.0",
-    "xmldom": "^0.6.0",
+    "chai-as-promised": "7.1.1",
+    "chai-subset": "1.6.0",
+    "contributor-faces": "1.0.3",
+    "documentation": "12.3.0",
+    "dtslint": "4.1.6",
+    "electron": "26.1.0",
+    "eslint": "8.50.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-mocha": "6.3.0",
+    "expect": "29.7.0",
+    "express": "4.17.2",
+    "graphql": "14.6.0",
+    "husky": "8.0.3",
+    "inquirer-test": "2.0.1",
+    "jsdoc": "3.6.10",
+    "jsdoc-typeof-plugin": "1.0.0",
+    "json-server": "0.10.1",
+    "playwright": "1.38.1",
+    "puppeteer": "21.1.1",
+    "qrcode-terminal": "0.12.0",
+    "rosie": "2.1.0",
+    "runok": "0.9.3",
+    "sinon": "15.2.0",
+    "sinon-chai": "3.7.0",
+    "testcafe": "3.0.1",
+    "ts-morph": "19.0.0",
+    "ts-node": "10.9.1",
+    "tsd-jsdoc": "2.5.0",
+    "typedoc": "0.24.8",
+    "typedoc-plugin-markdown": "3.13.4",
+    "typescript": "5.1.6",
+    "wdio-docker-service": "1.5.0",
+    "webdriverio": "8.3.8",
+    "xml2js": "0.6.0",
+    "xmldom": "0.6.0",
     "xpath": "0.0.33"
   },
   "engines": {
@@ -153,4 +153,4 @@
     "npm": ">=5.6.0"
   },
   "es6": true
-}
+}

package/translations/fr-FR.js

@@ -12,11 +12,15 @@ module.exports = {
     amOutsideAngularApp: 'suisALExtérieurDeLApplicationAngular',
     amInsideAngularApp: 'suisALIntérieurDeLApplicationAngular',
     waitForElement: 'attendsLElément',
-    waitForClickable: 'attends',
+    waitForClickable: 'attendsDeCliquer',
     waitForVisible: 'attendsPourVoir',
+    waitForEnabled: 'attendsLActivationDe',
+    waitForInvisible: 'attendsLInvisibilitéDe',
+    waitInUrl: 'attendsDansLUrl',
     waitForText: 'attendsLeTexte',
     moveTo: 'vaisSur',
     refresh: 'rafraîchis',
+    refreshPage: 'rafraîchisLaPage',
     haveModule: 'ajouteLeModule',
     resetModule: 'réinitialiseLeModule',
     amOnPage: 'suisSurLaPage',
@@ -59,5 +63,13 @@ module.exports = {
     grabCookie: 'prendsLeCookie',
     resizeWindow: 'redimensionneLaFenêtre',
     wait: 'attends',
+    clearField: 'effaceLeChamp',
+    dontSeeElementInDOM: 'neVoisPasDansLeDOM',
+    moveCursorTo: 'bougeLeCurseurSur',
+    scrollTo: 'défileVers',
+    sendGetRequest: 'envoieLaRequêteGet',
+    sendPutRequest: 'envoieLaRequêtePut',
+    sendDeleteRequest: 'envoieLaRequêteDelete',
+    sendPostRequest: 'envoieLaRequêtePost',
   },
 };

package/typings/promiseBasedTypes.d.ts

@@ -1147,7 +1147,7 @@ declare namespace CodeceptJS {
          */
         amInPath(openPath: string): Promise<any>;
         /**
-         * Writes test to file
+         * Writes text to file
          */
         writeToFile(name: string, text: string): Promise<any>;
         /**
@@ -2071,6 +2071,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -2100,6 +2102,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -5564,6 +5568,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
@@ -5590,6 +5596,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
@@ -7314,6 +7322,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -7343,6 +7353,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -8596,6 +8608,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -10076,6 +10090,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -10106,6 +10122,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;

package/typings/types.d.ts

@@ -1147,7 +1147,7 @@ declare namespace CodeceptJS {
          */
         amInPath(openPath: string): void;
         /**
-         * Writes test to file
+         * Writes text to file
          */
         writeToFile(name: string, text: string): void;
         /**
@@ -2075,12 +2075,14 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          * Wrapper for synchronous [evaluate](https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2)
          */
-        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Executes async script on page.
          * Provided function should execute a passed callback (as first argument) to signal it is finished.
@@ -2104,13 +2106,15 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          * Wrapper for asynchronous [evaluate](https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2).
          * Unlike NightmareJS implementation calling `done` will return its first argument.
          */
-        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Resize the current window to provided width and height.
          * First parameter can be set to `maximize`.
@@ -2774,7 +2778,7 @@ declare namespace CodeceptJS {
      * @property [ignoreLog] - An array with console message types that are not logged to debug log. Default value is `['warning', 'log']`. E.g. you can set `[]` to log all messages. See all possible [values](https://playwright.dev/docs/api/class-consolemessage#console-message-type).
      * @property [ignoreHTTPSErrors] - Allows access to untrustworthy pages, e.g. to a page with an expired certificate. Default value is `false`
      * @property [bypassCSP] - bypass Content Security Policy or CSP
-     * @property [highlightElement] - highlight the interacting elements. Default: false
+     * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      */
     type PlaywrightConfig = {
         url?: string;
@@ -5648,9 +5652,11 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Executes async script on page.
          * Provided function should execute a passed callback (as first argument) to signal it is finished.
@@ -5674,9 +5680,11 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Checks that current url contains a provided fragment.
          *
@@ -6196,7 +6204,7 @@ declare namespace CodeceptJS {
      * @property [manualStart = false] - do not start browser before a test, start it manually inside a helper with `this.helpers["Puppeteer"]._startBrowser()`.
      * @property [browser = chrome] - can be changed to `firefox` when using [puppeteer-firefox](https://codecept.io/helpers/Puppeteer-firefox).
      * @property [chrome] - pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
-     * @property [highlightElement] - highlight the interacting elements. Default: false
+     * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      */
     type PuppeteerConfig = {
         url: string;
@@ -7446,12 +7454,14 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          * If a function returns a Promise It will wait for it resolution.
          */
-        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Executes async script on page.
          * Provided function should execute a passed callback (as first argument) to signal it is finished.
@@ -7475,12 +7485,14 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          * Asynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
          */
-        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * 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.
@@ -8748,12 +8760,14 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          * If a function returns a Promise It will wait for its resolution.
          */
-        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * 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.
@@ -9105,7 +9119,7 @@ declare namespace CodeceptJS {
      * @property [desiredCapabilities] - Selenium's [desired capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities).
      * @property [manualStart = false] - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriver"]._startBrowser()`.
      * @property [timeouts] - [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
-     * @property [highlightElement] - highlight the interacting elements. Default: false
+     * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      */
     type WebDriverConfig = {
         url: string;
@@ -10276,13 +10290,15 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
          *
          * Wraps [execute](http://webdriver.io/api/protocol/execute.html) command.
          */
-        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Executes async script on page.
          * Provided function should execute a passed callback (as first argument) to signal it is finished.
@@ -10306,9 +10322,11 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
-        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
+        executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
          * Scroll element into viewport.
          *
@@ -11075,7 +11093,7 @@ declare namespace CodeceptJS {
         /**
          * Run a specific test or all loaded tests.
          */
-        run(test?: string): void;
+        run(test?: string): Promise<void>;
     }
     /**
      * Current configuration
@@ -11449,7 +11467,9 @@ declare namespace CodeceptJS {
     /**
      * Pauses test execution and starts interactive shell
      */
-    function pause(): void;
+    function pause(passedObject?: {
+        [key: string]: any;
+    }): void;
     /**
      * Singleton object to record all test steps as promises and run them in chain.
      */
@@ -11525,7 +11545,7 @@ declare namespace CodeceptJS {
     }
     function session(sessionName: CodeceptJS.LocatorOrString, config: ((...params: any[]) => any) | {
         [key: string]: any;
-    }, fn?: (...params: any[]) => any): Promise<any> | undefined;
+    }, fn?: (...params: any[]) => any): any;
     /**
      * Each command in test executed through `I.` object is wrapped in Step.
      * Step allows logging executed commands and triggers hook before and after step execution.