codeceptjs 3.7.6-beta.1 → 3.7.6-beta.3

package/typings/types.d.ts

@@ -2823,10 +2823,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
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -2865,6 +2869,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:
@@ -3805,7 +3810,7 @@ declare namespace CodeceptJS {
          */
         pressKeyUp(key: string): void;
         /**
-         * _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).
          *
@@ -4227,6 +4232,27 @@ declare namespace CodeceptJS {
          * @returns attribute value
          */
         grabCookie(name?: string): 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;
+        }): void;
         /**
          * Clears a cookie by name,
          * if none provided clears all cookies.
@@ -4678,7 +4704,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): void;
         /**
@@ -6344,7 +6370,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.
@@ -6352,11 +6378,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
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -6370,7 +6394,7 @@ declare namespace CodeceptJS {
         keepBrowserState?: boolean;
         keepCookies?: boolean;
         waitForAction?: number;
-        waitForNavigation?: string;
+        waitForNavigation?: string | string[];
         pressKeyDelay?: number;
         getPageTimeout?: number;
         waitForTimeout?: number;
@@ -6382,7 +6406,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.
      *
@@ -7174,7 +7198,7 @@ declare namespace CodeceptJS {
          */
         pressKeyUp(key: string): void;
         /**
-         * _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).
          *
@@ -8100,7 +8124,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): void;
         /**
@@ -8337,8 +8361,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
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9554,8 +9576,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
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -11572,11 +11592,11 @@ declare namespace CodeceptJS {
         /**
          * Executes bootstrap.
          */
-        bootstrap(): void;
+        bootstrap(): Promise<void>;
         /**
          * Executes teardown.
          */
-        teardown(): void;
+        teardown(): Promise<void>;
         /**
          * Loads tests by pattern or by config.tests
          */
@@ -11592,6 +11612,11 @@ declare namespace CodeceptJS {
          * Run a specific test or all loaded tests.
          */
         run(test?: string): Promise<void>;
+        /**
+         * Returns the version string of CodeceptJS.
+         * @returns The version string.
+         */
+        static version(): string;
     }
     /**
      * Current configuration
@@ -11634,7 +11659,15 @@ declare namespace CodeceptJS {
         };
     }
     /**
-     * Result of the test run
+     * Statistics for a test result.
+     * @property passes - Number of passed tests.
+     * @property failures - Number of failed tests.
+     * @property tests - Total number of tests.
+     * @property pending - Number of pending tests.
+     * @property failedHooks - Number of failed hooks.
+     * @property start - Start time of the test run.
+     * @property end - End time of the test run.
+     * @property duration - Duration of the test run, in milliseconds.
      */
     type Stats = {
         passes: number;
@@ -11647,10 +11680,82 @@ declare namespace CodeceptJS {
         duration: number;
     };
     /**
-     * Create Result of the test run
+     * Result of a test run. Will be emitted for example in "event.all.result" events.
      */
     class Result {
-        constructor();
+        /**
+         * Resets all collected stats, tests, and failure reports.
+         */
+        reset(): void;
+        /**
+         * Sets the start time to the current time.
+         */
+        start(): void;
+        /**
+         * Sets the end time to the current time.
+         */
+        finish(): void;
+        /**
+         * Whether this result contains any failed tests.
+         */
+        readonly hasFailed: boolean;
+        /**
+         * All collected tests.
+         */
+        readonly tests: CodeceptJS.Test[];
+        /**
+         * The failure reports (array of strings per failed test).
+         */
+        readonly failures: string[][];
+        /**
+         * The test statistics.
+         */
+        readonly stats: Stats;
+        /**
+         * The start time of the test run.
+         */
+        readonly startTime: Date;
+        /**
+         * Adds a test to this result.
+         */
+        addTest(test: CodeceptJS.Test): void;
+        /**
+         * Adds failure reports to this result.
+         */
+        addFailures(newFailures: string[][]): void;
+        /**
+         * Whether this result contains any failed tests.
+         */
+        readonly hasFailures: boolean;
+        /**
+         * The duration of the test run, in milliseconds.
+         */
+        readonly duration: number;
+        /**
+         * All failed tests.
+         */
+        failedTests: CodeceptJS.Test[];
+        /**
+         * All passed tests.
+         */
+        readonly passedTests: CodeceptJS.Test[];
+        /**
+         * All skipped tests.
+         */
+        readonly skippedTests: CodeceptJS.Test[];
+        /**
+         * @returns The JSON representation of this result.
+         */
+        simplify(): any;
+        /**
+         * Saves this result to a JSON file.
+         * @param [fileName] - Path to the JSON file, relative to `output_dir`. Defaults to "result.json".
+         */
+        save(fileName?: string): void;
+        /**
+         * Adds stats to this result.
+         */
+        addStats(newStats?: Partial<Stats>): void;
     }
     /**
      * Dependency Injection Container