codeceptjs 3.7.5 → 3.7.6-beta.2

package/lib/codecept.js

@@ -122,6 +122,7 @@ class Codecept {
   /**
    * Executes bootstrap.
    *
+   * @returns {Promise<void>}
    */
   async bootstrap() {
     return runHook(this.config.bootstrap, 'bootstrap')
@@ -129,7 +130,8 @@ class Codecept {
 
   /**
    * Executes teardown.
-
+   *
+   * @returns {Promise<void>}
    */
   async teardown() {
     return runHook(this.config.teardown, 'teardown')
@@ -262,6 +264,11 @@ class Codecept {
     })
   }
 
+  /**
+   * Returns the version string of CodeceptJS.
+   *
+   * @returns {string} The version string.
+   */
   static version() {
     return JSON.parse(readFileSync(`${__dirname}/../package.json`, 'utf8')).version
   }

package/lib/command/workers/runTests.js

@@ -23,11 +23,49 @@ const Codecept = require(process.env.CODECEPT_CLASS_PATH || '../../codecept')
 const { options, tests, testRoot, workerIndex, poolMode } = workerData
 
 // hide worker output
-if (!options.debug && !options.verbose)
+// In pool mode, only suppress output if debug is NOT enabled
+// In regular mode, hide result output but allow step output in verbose/debug
+if (poolMode && !options.debug) {
+  // In pool mode without debug, suppress only result summaries and failures, but allow Scenario Steps
+  const originalWrite = process.stdout.write
+  process.stdout.write = string => {
+    // Always allow Scenario Steps output (including the circle symbol)
+    if (string.includes('Scenario Steps:') || string.includes('◯ Scenario Steps:')) {
+      return originalWrite.call(process.stdout, string)
+    }
+    if (string.includes('  FAIL  |') || string.includes('  OK  |') || string.includes('-- FAILURES:') || string.includes('AssertionError:') || string.includes('◯ File:')) {
+      return true
+    }
+    return originalWrite.call(process.stdout, string)
+  }
+} else if (!poolMode && !options.debug && !options.verbose) {
   process.stdout.write = string => {
     stdout += string
     return true
   }
+} else {
+  // In verbose/debug mode for test/suite modes, show step details
+  // but suppress individual worker result summaries to avoid duplicate output
+  const originalWrite = process.stdout.write
+  const originalConsoleLog = console.log
+
+  process.stdout.write = string => {
+    // Suppress individual worker result summaries and failure reports
+    if (string.includes('  FAIL  |') || string.includes('  OK  |') || string.includes('-- FAILURES:') || string.includes('AssertionError:') || string.includes('◯ File:') || string.includes('◯ Scenario Steps:')) {
+      return true
+    }
+    return originalWrite.call(process.stdout, string)
+  }
+
+  // Override console.log to catch result summaries
+  console.log = (...args) => {
+    const fullMessage = args.join(' ')
+    if (fullMessage.includes('  FAIL  |') || fullMessage.includes('  OK  |') || fullMessage.includes('-- FAILURES:')) {
+      return
+    }
+    return originalConsoleLog.apply(console, args)
+  }
+}
 
 const overrideConfigs = tryOrDefault(() => JSON.parse(options.override), {})
 

package/lib/effects.js

@@ -89,7 +89,7 @@ async function hopeThat(callback) {
  * - Restores the session state after each attempt, whether successful or not.
  *
  * @example
- * const { hopeThat } = require('codeceptjs/effects')
+ * const { retryTo } = require('codeceptjs/effects')
  * await retryTo((tries) => {
  *   if (tries < 3) {
  *     I.see('Non-existent element'); // Simulates a failure

package/lib/helper/Appium.js

@@ -261,11 +261,13 @@ class Appium extends Webdriver {
 
     this.platform = null
     if (config.capabilities[`${vendorPrefix.appium}:platformName`]) {
-      this.platform = config.capabilities[`${vendorPrefix.appium}:platformName`].toLowerCase()
+      config.capabilities[`${vendorPrefix.appium}:platformName`] = config.capabilities[`${vendorPrefix.appium}:platformName`].toLowerCase()
+      this.platform = config.capabilities[`${vendorPrefix.appium}:platformName`]
     }
 
     if (config.capabilities.platformName) {
-      this.platform = config.capabilities.platformName.toLowerCase()
+      config.capabilities.platformName = config.capabilities.platformName.toLowerCase()
+      this.platform = config.capabilities.platformName
     }
 
     return config
@@ -275,7 +277,7 @@ class Appium extends Webdriver {
     const _convertedCaps = {}
     for (const [key, value] of Object.entries(capabilities)) {
       if (!key.startsWith(vendorPrefix.appium)) {
-        if (key !== 'platformName' && key !== 'bstack:options') {
+        if (key !== 'platformName' && key !== 'bstack:options' && key !== 'sauce:options') {
           _convertedCaps[`${vendorPrefix.appium}:${key}`] = value
         } else {
           _convertedCaps[`${key}`] = value

package/lib/helper/Playwright.js

@@ -98,7 +98,13 @@ const pathSeparator = path.sep
  * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
  * @prop {object} [recordHar] - record HAR and will be saved to `output/har`. See more of [HAR options](https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har).
  * @prop {string} [testIdAttribute=data-testid] - locate elements based on the testIdAttribute. See more of [locate by test id](https://playwright.dev/docs/locators#locate-by-test-id).
- * @prop {object} [customLocatorStrategies] - custom locator strategies. An object with keys as strategy names and values as JavaScript functions. Example: `{ byRole: (selector, root) => { return root.querySelector(\`[role="\${selector}\"]\`) } }`
+ * @prop {object} [customLocatorStrategies] - custom locator strategies. An object with keys as strategy names and values as JavaScript functions. Example: `{ byRole: (selector, root) => { return root.querySelector(`[role="${selector}"]`) } }`
+ * @prop {string|object} [storageState] - Playwright storage state (path to JSON file or object)
+ *   passed directly to `browser.newContext`.
+ *   If a Scenario is declared with a `cookies` option (e.g. `Scenario('name', { cookies: [...] }, fn)`),
+ *   those cookies are used instead and the configured `storageState` is ignored (no merge).
+ *   May include session cookies, auth tokens, localStorage and (if captured with
+ *   `grabStorageState({ indexedDB: true })`) IndexedDB data; treat as sensitive and do not commit.
  */
 const config = {}
 
@@ -360,10 +366,11 @@ class Playwright extends Helper {
     // override defaults with config
     this._setConfig(config)
 
-    // Call _init() to register selector engines - use setTimeout to avoid blocking constructor
-    setTimeout(() => {
-      this._init().catch(console.error)
-    }, 0)
+    // pass storageState directly (string path or object) and let Playwright handle errors/missing file
+    if (typeof config.storageState !== 'undefined') {
+      this.storageState = config.storageState
+    }
+
   }
 
   _validateConfig(config) {
@@ -390,6 +397,7 @@ class Playwright extends Helper {
       use: { actionTimeout: 0 },
       ignoreHTTPSErrors: false, // Adding it here o that context can be set up to ignore the SSL errors,
       highlightElement: false,
+      storageState: undefined,
     }
 
     process.env.testIdAttribute = 'data-testid'
@@ -593,8 +601,7 @@ class Playwright extends Helper {
 
       // load pre-saved cookies
       if (test?.opts?.cookies) contextOptions.storageState = { cookies: test.opts.cookies }
-
-      if (this.storageState) contextOptions.storageState = this.storageState
+      else if (this.storageState) contextOptions.storageState = this.storageState
       if (this.options.userAgent) contextOptions.userAgent = this.options.userAgent
       if (this.options.locale) contextOptions.locale = this.options.locale
       if (this.options.colorScheme) contextOptions.colorScheme = this.options.colorScheme
@@ -2166,6 +2173,30 @@ class Playwright extends Helper {
     if (cookie[0]) return cookie[0]
   }
 
+  /**
+   * Grab the current storage state (cookies, localStorage, etc.) via Playwright's `browserContext.storageState()`.
+   * Returns the raw object that Playwright provides.
+   *
+   * Security: The returned object can contain authentication tokens, session cookies
+   * and (when `indexedDB: true` is used) data that may include user PII. Treat it as a secret.
+   * Avoid committing it to source control and prefer storing it in a protected secrets store / CI artifact vault.
+   *
+   * @param {object} [options]
+   * @param {boolean} [options.indexedDB] set to true to include IndexedDB in snapshot (Playwright >=1.51)
+   *
+   * ```js
+   * // basic usage
+   * const state = await I.grabStorageState();
+   * require('fs').writeFileSync('authState.json', JSON.stringify(state));
+   *
+   * // include IndexedDB when using Firebase Auth, etc.
+   * const stateWithIDB = await I.grabStorageState({ indexedDB: true });
+   * ```
+   */
+  async grabStorageState(options = {}) {
+    return this.browserContext.storageState(options)
+  }
+
   /**
    * {{> clearCookie }}
    */

package/lib/helper/REST.js

@@ -281,6 +281,27 @@ class REST extends Helper {
     return this._executeRequest(request)
   }
 
+  /**
+   * Send HEAD request to REST API
+   *
+   * ```js
+   * I.sendHeadRequest('/api/users.json');
+   * ```
+   *
+   * @param {*} url
+   * @param {object} [headers={}] - the headers object to be sent. By default, it is sent as an empty object
+   *
+   * @returns {Promise<*>} response
+   */
+  async sendHeadRequest(url, headers = {}) {
+    const request = {
+      baseURL: this._url(url),
+      method: 'HEAD',
+      headers,
+    }
+    return this._executeRequest(request)
+  }
+
   /**
    * Sends POST request to API.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.5",
+  "version": "3.7.6-beta.2",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -29,14 +29,19 @@
     "docs/webapi/**"
   ],
   "main": "lib/index.js",
+  "module": "lib/index.js",
+  "types": "typings/index.d.ts",
   "exports": {
-    ".": "./lib/index.js",
+    ".": {
+      "import": "./lib/index.js",
+      "require": "./lib/index.js",
+      "types": "./typings/index.d.ts"
+    },
     "./lib/*": "./lib/*.js",
     "./els": "./lib/els.js",
     "./effects": "./lib/effects.js",
     "./steps": "./lib/steps.js"
   },
-  "types": "typings/index.d.ts",
   "bin": {
     "codeceptjs": "./bin/codecept.js"
   },
@@ -91,7 +96,7 @@
     "cross-spawn": "7.0.6",
     "css-to-xpath": "0.1.0",
     "csstoxpath": "1.6.0",
-    "envinfo": "7.14.0",
+    "envinfo": "7.15.0",
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
     "fn-args": "4.0.0",
@@ -120,7 +125,7 @@
     "uuid": "11.1.0"
   },
   "optionalDependencies": {
-    "@codeceptjs/detox-helper": "1.1.12"
+    "@codeceptjs/detox-helper": "1.1.13"
   },
   "devDependencies": {
     "@apollo/server": "^5",
@@ -133,20 +138,20 @@
     "@pollyjs/core": "6.0.6",
     "@types/chai": "5.2.2",
     "@types/inquirer": "9.0.9",
-    "@types/node": "24.5.2",
+    "@types/node": "24.6.0",
     "@wdio/sauce-service": "9.12.5",
     "@wdio/selenium-standalone-service": "8.15.0",
-    "@wdio/utils": "9.15.0",
+    "@wdio/utils": "9.19.2",
     "@xmldom/xmldom": "0.9.8",
     "chai": "^4.0.0",
     "chai-as-promised": "7.1.2",
     "chai-subset": "1.6.0",
     "documentation": "14.0.3",
-    "electron": "38.1.2",
+    "electron": "38.2.0",
     "eslint": "^9.36.0",
     "eslint-plugin-import": "2.32.0",
     "eslint-plugin-mocha": "11.1.0",
-    "expect": "30.1.2",
+    "expect": "30.2.0",
     "express": "^5.1.0",
     "globals": "16.4.0",
     "graphql": "16.11.0",
@@ -157,7 +162,7 @@
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.17.4",
     "mochawesome": "^7.1.3",
-    "playwright": "1.55.0",
+    "playwright": "1.55.1",
     "prettier": "^3.3.2",
     "puppeteer": "24.15.0",
     "qrcode-terminal": "0.12.0",

package/typings/index.d.ts

@@ -97,7 +97,7 @@ declare namespace CodeceptJS {
      * tests: 'tests/**.test.ts'
      * ```
      */
-    tests: string
+    tests: string | string[]
     /**
      * Where to store failure screenshots, artifacts, etc
      *
@@ -520,17 +520,16 @@ declare namespace CodeceptJS {
   }
 }
 
-type TryTo = <T>(fn: () => Promise<T> | T) => Promise<T | false>;
-type HopeThat = <T>(fn: () => Promise<T> | T) => Promise<T | false>;
-type RetryTo = <T>(fn: () => Promise<T> | T, retries?: number) => Promise<T>;
-
+type TryTo = <T>(fn: () => Promise<T> | T) => Promise<T | false>
+type HopeThat = <T>(fn: () => Promise<T> | T) => Promise<T | false>
+type RetryTo = <T>(fn: () => Promise<T> | T, retries?: number) => Promise<T>
 
 // Globals
 declare const codecept_dir: string
 declare const output_dir: string
-declare const tryTo: TryTo;
-declare const retryTo: RetryTo;
-declare const hopeThat: HopeThat;
+declare const tryTo: TryTo
+declare const retryTo: RetryTo
+declare const hopeThat: HopeThat
 
 declare const actor: CodeceptJS.actor
 declare const codecept_actor: CodeceptJS.actor
@@ -643,7 +642,7 @@ declare module '@codeceptjs/helper' {
 }
 
 declare module 'codeceptjs/effects' {
-  export const tryTo: TryTo;
-  export const retryTo: RetryTo;
-  export const hopeThat: HopeThat;
+  export const tryTo: TryTo
+  export const retryTo: RetryTo
+  export const hopeThat: HopeThat
 }

package/typings/promiseBasedTypes.d.ts

@@ -2735,6 +2735,10 @@ declare namespace CodeceptJS {
      * @property [testIdAttribute = data-testid] - locate elements based on the testIdAttribute. See more of [locate by test id](https://playwright.dev/docs/locators#locate-by-test-id).
      * @property [customLocatorStrategies] - custom locator strategies. An object with keys as strategy names and values as JavaScript functions. Example: `{ byRole: (selector, root) => { return root.querySelector(\`[role="\${selector}\"]\`) } }`
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6112,6 +6116,10 @@ declare namespace CodeceptJS {
      * @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. Note: only activate under verbose mode (--verbose).
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -7956,6 +7964,10 @@ declare namespace CodeceptJS {
      * @property [onResponse] - an async function which can update response object.
      * @property [maxUploadFileSize] - set the max content file size in MB when performing api calls.
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -8081,6 +8093,16 @@ declare namespace CodeceptJS {
          * @returns response
          */
         sendGetRequest(url: any, headers?: any): Promise<any>;
+        /**
+         * Send HEAD request to REST API
+         *
+         * ```js
+         * I.sendHeadRequest('/api/users.json');
+         * ```
+         * @param [headers = {}] - the headers object to be sent. By default, it is sent as an empty object
+         * @returns response
+         */
+        sendHeadRequest(url: any, headers?: any): Promise<any>;
         /**
          * Sends POST request to API.
          *
@@ -9101,6 +9123,10 @@ declare namespace CodeceptJS {
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      * @property [logLevel = silent] - level of logging verbosity. Default: silent. Options: trace | debug | info | warn | error | silent. More info: https://webdriver.io/docs/configuration/#loglevel
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;

package/typings/types.d.ts

@@ -2825,6 +2825,10 @@ declare namespace CodeceptJS {
      * @property [testIdAttribute = data-testid] - locate elements based on the testIdAttribute. See more of [locate by test id](https://playwright.dev/docs/locators#locate-by-test-id).
      * @property [customLocatorStrategies] - custom locator strategies. An object with keys as strategy names and values as JavaScript functions. Example: `{ byRole: (selector, root) => { return root.querySelector(\`[role="\${selector}\"]\`) } }`
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6353,6 +6357,10 @@ declare namespace CodeceptJS {
      * @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. Note: only activate under verbose mode (--verbose).
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8333,6 +8341,10 @@ declare namespace CodeceptJS {
      * @property [onResponse] - an async function which can update response object.
      * @property [maxUploadFileSize] - set the max content file size in MB when performing api calls.
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -8458,6 +8470,16 @@ declare namespace CodeceptJS {
          * @returns response
          */
         sendGetRequest(url: any, headers?: any): Promise<any>;
+        /**
+         * Send HEAD request to REST API
+         *
+         * ```js
+         * I.sendHeadRequest('/api/users.json');
+         * ```
+         * @param [headers = {}] - the headers object to be sent. By default, it is sent as an empty object
+         * @returns response
+         */
+        sendHeadRequest(url: any, headers?: any): Promise<any>;
         /**
          * Sends POST request to API.
          *
@@ -9538,6 +9560,10 @@ declare namespace CodeceptJS {
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      * @property [logLevel = silent] - level of logging verbosity. Default: silent. Options: trace | debug | info | warn | error | silent. More info: https://webdriver.io/docs/configuration/#loglevel
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -11757,7 +11783,7 @@ declare namespace CodeceptJS {
      * - Logs errors and retries the callback until it either succeeds or the maximum number of attempts is reached.
      * - Restores the session state after each attempt, whether successful or not.
      * @example
-     * const { hopeThat } = require('codeceptjs/effects')
+     * const { retryTo } = require('codeceptjs/effects')
      * await retryTo((tries) => {
      *   if (tries < 3) {
      *     I.see('Non-existent element'); // Simulates a failure