codeceptjs 3.7.4 → 3.7.5-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.4",
+  "version": "3.7.5-beta.1",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -42,7 +42,7 @@
   },
   "repository": "Codeception/codeceptjs",
   "scripts": {
-    "json-server": "json-server test/data/rest/db.json --host 0.0.0.0 -p 8010 --watch -m test/data/rest/headers.js",
+    "test-server": "node bin/test-server.js test/data/rest/db.json --host 0.0.0.0 -p 8010",
     "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",
@@ -86,6 +86,7 @@
     "axios": "1.11.0",
     "chalk": "4.1.2",
     "cheerio": "^1.0.0",
+    "chokidar": "^4.0.3",
     "commander": "11.1.0",
     "cross-spawn": "7.0.6",
     "css-to-xpath": "0.1.0",
@@ -98,17 +99,18 @@
     "fuse.js": "^7.0.0",
     "glob": ">=9.0.0 <12",
     "html-minifier-terser": "7.2.0",
-    "inquirer": "8.2.6",
+    "inquirer": "^8.2.7",
     "invisi-data": "^1.0.0",
     "joi": "17.13.3",
     "js-beautify": "1.15.4",
     "lodash.clonedeep": "4.5.0",
-    "lodash.shuffle": "4.2.0",
     "lodash.merge": "4.6.2",
+    "lodash.shuffle": "4.2.0",
     "mkdirp": "3.0.1",
     "mocha": "11.6.0",
     "monocart-coverage-reports": "2.12.6",
     "ms": "2.1.3",
+    "multer": "^2.0.2",
     "ora-classic": "5.4.2",
     "parse-function": "5.6.10",
     "parse5": "7.3.0",
@@ -125,7 +127,7 @@
     "@codeceptjs/expect-helper": "^1.0.2",
     "@codeceptjs/mock-request": "0.3.1",
     "@eslint/eslintrc": "3.3.1",
-    "@eslint/js": "9.31.0",
+    "@eslint/js": "9.34.0",
     "@faker-js/faker": "9.8.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "6.0.6",
@@ -145,7 +147,7 @@
     "eslint-plugin-import": "2.32.0",
     "eslint-plugin-mocha": "11.1.0",
     "expect": "30.0.5",
-    "express": "5.1.0",
+    "express": "^5.1.0",
     "globals": "16.2.0",
     "graphql": "16.11.0",
     "graphql-tag": "^2.12.6",

package/typings/index.d.ts

@@ -440,7 +440,7 @@ declare namespace CodeceptJS {
   interface IHook {}
   interface IScenario {}
   interface IFeature {
-    (title: string): FeatureConfig
+    (title: string, opts?: { [key: string]: any }): FeatureConfig
   }
   interface CallbackOrder extends Array<any> {}
   interface SupportObject {
@@ -486,6 +486,7 @@ declare namespace CodeceptJS {
     todo: IScenario
   }
   interface Feature extends IFeature {
+    only: IFeature
     skip: IFeature
   }
   interface IData {
@@ -519,11 +520,17 @@ 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>;
+
+
 // Globals
 declare const codecept_dir: string
 declare const output_dir: string
-declare function tryTo(...fn): Promise<boolean>
-declare function retryTo(...fn): Promise<null>
+declare const tryTo: TryTo;
+declare const retryTo: RetryTo;
+declare const hopeThat: HopeThat;
 
 declare const actor: CodeceptJS.actor
 declare const codecept_actor: CodeceptJS.actor
@@ -545,7 +552,7 @@ declare const Given: typeof CodeceptJS.addStep
 declare const When: typeof CodeceptJS.addStep
 declare const Then: typeof CodeceptJS.addStep
 
-declare const Feature: typeof CodeceptJS.Feature
+declare const Feature: CodeceptJS.Feature
 declare const Scenario: CodeceptJS.Scenario
 declare const xScenario: CodeceptJS.IScenario
 declare const xFeature: CodeceptJS.IFeature
@@ -634,3 +641,9 @@ declare module 'codeceptjs' {
 declare module '@codeceptjs/helper' {
   export = CodeceptJS.Helper
 }
+
+declare module 'codeceptjs/effects' {
+  export const tryTo: TryTo;
+  export const retryTo: RetryTo;
+  export const hopeThat: HopeThat;
+}

package/typings/promiseBasedTypes.d.ts

@@ -2734,6 +2734,7 @@ declare namespace CodeceptJS {
      * @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).
      */
+    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6110,6 +6111,7 @@ 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
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -6533,6 +6535,17 @@ declare namespace CodeceptJS {
          * {{ react }}
          */
         _locate(): Promise<any>;
+        /**
+         * Get single element by different locator types, including strict locator
+         * Should be used in custom helpers:
+         *
+         * ```js
+         * const element = await this.helpers['Puppeteer']._locateElement({name: 'password'});
+         * ```
+         *
+         * {{ react }}
+         */
+        _locateElement(): Promise<any>;
         /**
          * Find a checkbox by providing human-readable text:
          * NOTE: Assumes the checkable element exists
@@ -6569,6 +6582,17 @@ declare namespace CodeceptJS {
          * @returns WebElement of being used Web helper
          */
         grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElement for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElement = await I.grabWebElement('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
          *
@@ -7904,6 +7928,22 @@ declare namespace CodeceptJS {
          */
         flushWebSocketMessages(): Promise<any>;
     }
+    /**
+     * Find elements using Puppeteer's native element discovery methods
+     * Note: Unlike Playwright, Puppeteer's Locator API doesn't have .all() method for multiple elements
+     * @param matcher - Puppeteer context to search within
+     * @param locator - Locator specification
+     * @returns Array of ElementHandle objects
+     */
+    function findElements(matcher: any, locator: any | string): Promise<any[]>;
+    /**
+     * Find a single element using Puppeteer's native element discovery methods
+     * Note: Puppeteer Locator API doesn't have .first() method like Playwright
+     * @param matcher - Puppeteer context to search within
+     * @param locator - Locator specification
+     * @returns Single ElementHandle object
+     */
+    function findElement(matcher: any, locator: any | string): Promise<object>;
     /**
      * ## Configuration
      * @property [endpoint] - API base URL
@@ -7916,6 +7956,7 @@ 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
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9061,6 +9102,7 @@ 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
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -9531,6 +9573,17 @@ declare namespace CodeceptJS {
          * @returns WebElement of being used Web helper
          */
         grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElement for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElement = await I.grabWebElement('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Set [WebDriver timeouts](https://webdriver.io/docs/timeouts.html) in realtime.
          *

package/typings/types.d.ts

@@ -2824,6 +2824,7 @@ declare namespace CodeceptJS {
      * @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).
      */
+    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6351,6 +6352,7 @@ 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
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -6790,6 +6792,17 @@ declare namespace CodeceptJS {
          * {{ react }}
          */
         _locate(): void;
+        /**
+         * Get single element by different locator types, including strict locator
+         * Should be used in custom helpers:
+         *
+         * ```js
+         * const element = await this.helpers['Puppeteer']._locateElement({name: 'password'});
+         * ```
+         *
+         * {{ react }}
+         */
+        _locateElement(): void;
         /**
          * Find a checkbox by providing human-readable text:
          * NOTE: Assumes the checkable element exists
@@ -6826,6 +6839,17 @@ declare namespace CodeceptJS {
          * @returns WebElement of being used Web helper
          */
         grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElement for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElement = await I.grabWebElement('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
          *
@@ -8281,6 +8305,22 @@ declare namespace CodeceptJS {
          */
         flushWebSocketMessages(): void;
     }
+    /**
+     * Find elements using Puppeteer's native element discovery methods
+     * Note: Unlike Playwright, Puppeteer's Locator API doesn't have .all() method for multiple elements
+     * @param matcher - Puppeteer context to search within
+     * @param locator - Locator specification
+     * @returns Array of ElementHandle objects
+     */
+    function findElements(matcher: any, locator: any | string): Promise<any[]>;
+    /**
+     * Find a single element using Puppeteer's native element discovery methods
+     * Note: Puppeteer Locator API doesn't have .first() method like Playwright
+     * @param matcher - Puppeteer context to search within
+     * @param locator - Locator specification
+     * @returns Single ElementHandle object
+     */
+    function findElement(matcher: any, locator: any | string): Promise<object>;
     /**
      * ## Configuration
      * @property [endpoint] - API base URL
@@ -8293,6 +8333,7 @@ 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
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9498,6 +9539,7 @@ 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
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -9968,6 +10010,17 @@ declare namespace CodeceptJS {
          * @returns WebElement of being used Web helper
          */
         grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElement for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElement = await I.grabWebElement('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Set [WebDriver timeouts](https://webdriver.io/docs/timeouts.html) in realtime.
          *
@@ -11512,6 +11565,13 @@ declare namespace CodeceptJS {
          * Loads tests by pattern or by config.tests
          */
         loadTests(pattern?: string): void;
+        /**
+         * Apply sharding to test files based on shard configuration
+         * @param testFiles - Array of test file paths
+         * @param shardConfig - Shard configuration in format "index/total" (e.g., "1/4")
+         * @returns - Filtered array of test files for this shard
+         */
+        _applySharding(testFiles: string[], shardConfig: string): string[];
         /**
          * Run a specific test or all loaded tests.
          */
@@ -12005,6 +12065,10 @@ declare namespace CodeceptJS {
          * Get a state of current queue and tasks
          */
         toString(): string;
+        /**
+         * Get current session ID
+         */
+        getCurrentSessionId(): string | null;
     }
     interface RecorderSession {
         running: boolean;
@@ -12118,6 +12182,10 @@ declare namespace CodeceptJS {
     function Feature(title: string, opts?: {
         [key: string]: any;
     }): FeatureConfig;
+    /**
+     * Exclusive test suite - runs only this feature.
+     */
+    const only: CodeceptJS.IFeature;
     /**
      * Pending test suite.
      */