codeceptjs 3.7.6-beta.2 → 3.7.6-beta.4

package/lib/result.js

@@ -3,22 +3,21 @@ const path = require('path')
 const { serializeTest } = require('./mocha/test')
 
 /**
- * Result of the test run
- *
- * @typedef {Object} Stats
- * @property {number} passes
- * @property {number} failures
- * @property {number} tests
- * @property {number} pending
- * @property {number} failedHooks
- * @property {Date} start
- * @property {Date} end
- * @property {number} duration
+ * @typedef {Object} Stats Statistics for a test result.
+ * @property {number} passes Number of passed tests.
+ * @property {number} failures Number of failed tests.
+ * @property {number} tests Total number of tests.
+ * @property {number} pending Number of pending tests.
+ * @property {number} failedHooks Number of failed hooks.
+ * @property {Date} start Start time of the test run.
+ * @property {Date} end End time of the test run.
+ * @property {number} duration Duration of the test run, in milliseconds.
+ */
+
+/**
+ * Result of a test run. Will be emitted for example in "event.all.result" events.
  */
 class Result {
-  /**
-   * Create Result of the test run
-   */
   constructor() {
     this._startTime = new Date()
     this._endTime = null
@@ -27,6 +26,9 @@ class Result {
     this.start()
   }
 
+  /**
+   * Resets all collected stats, tests, and failure reports.
+   */
   reset() {
     this._stats = {
       passes: 0,
@@ -39,43 +41,85 @@ class Result {
       duration: 0,
     }
 
-    /** @type {CodeceptJS.Test[]} */
+    /**
+     * @type {CodeceptJS.Test[]}
+     * @private
+     */
     this._tests = []
 
-    /** @type {String[]} */
+    /**
+     * @type {string[][]}
+     * @private
+     */
     this._failures = []
   }
 
+  /**
+   * Sets the start time to the current time.
+   */
   start() {
     this._startTime = new Date()
   }
 
+  /**
+   * Sets the end time to the current time.
+   */
   finish() {
     this._endTime = new Date()
   }
 
+  /**
+   * Whether this result contains any failed tests.
+   *
+   * @type {boolean}
+   * @readonly
+   */
   get hasFailed() {
     return this._stats.failures > 0
   }
 
+  /**
+   * All collected tests.
+   *
+   * @type {CodeceptJS.Test[]}
+   * @readonly
+   */
   get tests() {
     return this._tests
   }
 
+  /**
+   * The failure reports (array of strings per failed test).
+   *
+   * @type {string[][]}
+   * @readonly
+   */
   get failures() {
     return this._failures.filter(f => f && (!Array.isArray(f) || f.length > 0))
   }
 
+  /**
+   * The test statistics.
+   *
+   * @type {Stats}
+   * @readonly
+   */
   get stats() {
     return this._stats
   }
 
+  /**
+   * The start time of the test run.
+   *
+   * @type {Date}
+   * @readonly
+   */
   get startTime() {
     return this._startTime
   }
 
   /**
-   * Add test to result
+   * Adds a test to this result.
    *
    * @param {CodeceptJS.Test} test
    */
@@ -90,34 +134,67 @@ class Result {
   }
 
   /**
-   * Add failures to result
+   * Adds failure reports to this result.
    *
-   * @param {String[]} newFailures
+   * @param {string[][]} newFailures
    */
   addFailures(newFailures) {
     this._failures.push(...newFailures)
   }
 
+  /**
+   * Whether this result contains any failed tests.
+   *
+   * @type {boolean}
+   * @readonly
+   */
   get hasFailures() {
     return this.stats.failures > 0
   }
 
+  /**
+   * The duration of the test run, in milliseconds.
+   *
+   * @type {number}
+   * @readonly
+   */
   get duration() {
     return this._endTime ? +this._endTime - +this._startTime : 0
   }
 
+  /**
+   * All failed tests.
+   *
+   * @type {CodeceptJS.Test[]}
+   * readonly
+   */
   get failedTests() {
     return this._tests.filter(test => test.state === 'failed')
   }
 
+  /**
+   * All passed tests.
+   *
+   * @type {CodeceptJS.Test[]}
+   * @readonly
+   */
   get passedTests() {
     return this._tests.filter(test => test.state === 'passed')
   }
 
+  /**
+   * All skipped tests.
+   *
+   * @type {CodeceptJS.Test[]}
+   * @readonly
+   */
   get skippedTests() {
     return this._tests.filter(test => test.state === 'skipped' || test.state === 'pending')
   }
 
+  /**
+   * @returns {object} The JSON representation of this result.
+   */
   simplify() {
     return {
       hasFailed: this.hasFailed,
@@ -129,9 +206,9 @@ class Result {
   }
 
   /**
-   * Save result to json file
+   * Saves this result to a JSON file.
    *
-   * @param {string} fileName
+   * @param {string} [fileName] Path to the JSON file, relative to `output_dir`. Defaults to "result.json".
    */
   save(fileName) {
     if (!fileName) fileName = 'result.json'
@@ -139,9 +216,9 @@ class Result {
   }
 
   /**
-   * Add stats to result
+   * Adds stats to this result.
    *
-   * @param {object} newStats
+   * @param {Partial<Stats>} [newStats]
    */
   addStats(newStats = {}) {
     this._stats.passes += newStats.passes || 0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.6-beta.2",
+  "version": "3.7.6-beta.4",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -48,6 +48,9 @@
   "repository": "Codeception/codeceptjs",
   "scripts": {
     "test-server": "node bin/test-server.js test/data/rest/db.json --host 0.0.0.0 -p 8010",
+    "mock-server:start": "node test/mock-server/start-mock-server.js",
+    "mock-server:stop": "kill -9 $(lsof -t -i:3001)",
+    "test:with-mock-server": "npm run mock-server:start && npm test",
     "json-server:graphql": "node test/data/graphql/index.js",
     "lint": "eslint bin/ examples/ lib/ test/ translations/ runok.js",
     "lint-fix": "eslint bin/ examples/ lib/ test/ translations/ runok.js --fix",
@@ -138,7 +141,7 @@
     "@pollyjs/core": "6.0.6",
     "@types/chai": "5.2.2",
     "@types/inquirer": "9.0.9",
-    "@types/node": "24.6.0",
+    "@types/node": "^24.6.2",
     "@wdio/sauce-service": "9.12.5",
     "@wdio/selenium-standalone-service": "8.15.0",
     "@wdio/utils": "9.19.2",

package/typings/promiseBasedTypes.d.ts

@@ -2733,12 +2733,14 @@ declare namespace CodeceptJS {
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      * @property [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).
      * @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}\"]\`) } }`
+     * @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}"]`) } }`
+     * @property [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.
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -2777,6 +2779,7 @@ declare namespace CodeceptJS {
         recordHar?: any;
         testIdAttribute?: string;
         customLocatorStrategies?: any;
+        storageState?: string | any;
     };
     /**
      * Uses [Playwright](https://github.com/microsoft/playwright) library to run tests inside:
@@ -3688,7 +3691,7 @@ declare namespace CodeceptJS {
          */
         pressKeyUp(key: string): Promise<any>;
         /**
-         * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
+         * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([puppeteer/puppeteer#1313](https://github.com/puppeteer/puppeteer/issues/1313)).
          *
          * Presses a key in the browser (on a focused element).
          *
@@ -4087,6 +4090,27 @@ declare namespace CodeceptJS {
          * @param [name = null] - cookie name.
          */
         grabCookie(name?: string): Promise<any>;
+        /**
+         * 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 [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 });
+         * ```
+         */
+        grabStorageState(options?: {
+            indexedDB?: boolean;
+        }): Promise<any>;
         /**
          * Clears a cookie by name,
          * if none provided clears all cookies.
@@ -4517,7 +4541,7 @@ declare namespace CodeceptJS {
         /**
          * Waits for navigation to finish. By default, it takes configured `waitForNavigation` option.
          *
-         * See [Playwright's reference](https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions)
+         * See [Playwright's reference](https://playwright.dev/docs/api/class-page#page-wait-for-navigation)
          */
         waitForNavigation(options: any): Promise<any>;
         /**
@@ -6105,7 +6129,7 @@ declare namespace CodeceptJS {
      * @property [keepBrowserState = false] - keep browser state between tests when `restart` is set to false.
      * @property [keepCookies = false] - keep cookies between tests when `restart` is set to false.
      * @property [waitForAction = 100] - how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
-     * @property [waitForNavigation = load] - when to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions). Array values are accepted as well.
+     * @property [waitForNavigation = load] - when to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.waitforoptions.md). Array values are accepted as well.
      * @property [pressKeyDelay = 10] - delay between key presses in ms. Used when calling Puppeteers page.type(...) in fillField/appendField
      * @property [getPageTimeout = 30000] - config option to set maximum navigation time in milliseconds. If the timeout is set to 0, then timeout will be disabled.
      * @property [waitForTimeout = 1000] - default wait* timeout in ms.
@@ -6113,13 +6137,9 @@ declare namespace CodeceptJS {
      * @property [userAgent] - user-agent string.
      * @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 [chrome] - pass additional [Puppeteer run options](https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.launchoptions.md).
      * @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;
@@ -6133,7 +6153,7 @@ declare namespace CodeceptJS {
         keepBrowserState?: boolean;
         keepCookies?: boolean;
         waitForAction?: number;
-        waitForNavigation?: string;
+        waitForNavigation?: string | string[];
         pressKeyDelay?: number;
         getPageTimeout?: number;
         waitForTimeout?: number;
@@ -6145,7 +6165,7 @@ declare namespace CodeceptJS {
         highlightElement?: boolean;
     };
     /**
-     * Uses [Google Chrome's Puppeteer](https://github.com/GoogleChrome/puppeteer) library to run tests inside headless Chrome.
+     * Uses [Google Chrome's Puppeteer](https://github.com/puppeteer/puppeteer) library to run tests inside headless Chrome.
      * Browser control is executed via DevTools Protocol (instead of Selenium).
      * This helper works with a browser out of the box with no additional tools required to install.
      *
@@ -6887,7 +6907,7 @@ declare namespace CodeceptJS {
          */
         pressKeyUp(key: string): Promise<any>;
         /**
-         * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
+         * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([puppeteer/puppeteer#1313](https://github.com/puppeteer/puppeteer/issues/1313)).
          *
          * Presses a key in the browser (on a focused element).
          *
@@ -7735,7 +7755,7 @@ declare namespace CodeceptJS {
         /**
          * Waits for navigation to finish. By default, takes configured `waitForNavigation` option.
          *
-         * See [Puppeteer's reference](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions)
+         * See [Puppeteer's reference](https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.page.waitfornavigation.md)
          */
         waitForNavigation(opts: any): Promise<any>;
         /**
@@ -7964,10 +7984,6 @@ 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;
@@ -9123,10 +9139,6 @@ 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;