codeceptjs 4.0.0-beta.3 → 4.0.0-beta.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "4.0.0-beta.3",
+  "version": "4.0.0-beta.4",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -35,7 +35,7 @@
   },
   "repository": "Codeception/codeceptjs",
   "scripts": {
-    "json-server": "./node_modules/json-server/bin/index.js test/data/rest/db.json -p 8010 --watch -m test/data/rest/headers.js",
+    "json-server": "json-server test/data/rest/db.json --host 0.0.0.0 -p 8010 --watch -m test/data/rest/headers.js",
     "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",
@@ -54,10 +54,8 @@
     "test:unit:webbapi:puppeteer": "mocha test/helper/Puppeteer_test.js",
     "test:unit:webbapi:webDriver": "mocha test/helper/WebDriver_test.js",
     "test:unit:webbapi:webDriver:noSeleniumServer": "mocha test/helper/WebDriver.noSeleniumServer_test.js",
-    "test:unit:webbapi:webDriver:devtools": "mocha test/helper/WebDriver_devtools_test.js --exit",
     "test:unit:webbapi:testCafe": "mocha test/helper/TestCafe_test.js",
     "test:unit:expect": "mocha test/helper/Expect_test.js",
-    "test:unit:mockServer": "mocha test/helper/MockServer_test.js",
     "test:plugin": "mocha test/plugin/plugin_test.js",
     "def": "./runok.js def",
     "dev:graphql": "node test/data/graphql/index.js",
@@ -72,11 +70,11 @@
   "dependencies": {
     "@codeceptjs/configure": "1.0.1",
     "@codeceptjs/helper": "2.0.4",
-    "@cucumber/cucumber-expressions": "17",
-    "@cucumber/gherkin": "29",
-    "@cucumber/messages": "25.0.1",
-    "@xmldom/xmldom": "0.9.4",
-    "acorn": "8.12.1",
+    "@cucumber/cucumber-expressions": "18",
+    "@cucumber/gherkin": "30",
+    "@cucumber/messages": "27.0.0",
+    "@xmldom/xmldom": "0.9.5",
+    "acorn": "8.14.0",
     "arrify": "2.0.1",
     "axios": "1.7.7",
     "chai": "5.1.1",
@@ -88,10 +86,9 @@
     "chai-string": "1.5.0",
     "chalk": "4.1.2",
     "commander": "11.1.0",
-    "cross-spawn": "7.0.3",
+    "cross-spawn": "7.0.5",
     "css-to-xpath": "0.1.0",
     "csstoxpath": "1.6.0",
-    "devtools": "8.40.2",
     "envinfo": "7.14.0",
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
@@ -99,77 +96,80 @@
     "fs-extra": "11.2.0",
     "glob": "6.0.1",
     "html-minifier-terser": "7.2.0",
+    "invisi-data": "^1.0.0",
     "inquirer": "6.5.2",
     "joi": "17.13.3",
     "js-beautify": "1.15.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
     "mkdirp": "1.0.4",
-    "mocha": "10.7.3",
-    "monocart-coverage-reports": "2.10.3",
+    "mocha": "10.8.2",
+    "monocart-coverage-reports": "2.11.3",
     "ms": "2.1.3",
     "ora-classic": "5.4.2",
-    "pactum": "3.7.1",
     "parse-function": "5.6.10",
-    "parse5": "7.1.2",
+    "parse5": "7.2.1",
     "promise-retry": "1.1.1",
     "resq": "1.11.0",
     "sprintf-js": "1.1.1",
-    "uuid": "10.0"
+    "uuid": "11.0"
   },
   "optionalDependencies": {
     "@codeceptjs/detox-helper": "1.1.2"
   },
   "devDependencies": {
     "@codeceptjs/mock-request": "0.3.1",
-    "@faker-js/faker": "9.0.3",
+    "@eslint/eslintrc": "3.2.0",
+    "@eslint/js": "9.16.0",
+    "@faker-js/faker": "9.3.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "5.1.0",
     "@types/chai": "4.3.19",
     "@types/inquirer": "9.0.3",
-    "@types/node": "22.5.5",
-    "@wdio/sauce-service": "9.0.9",
+    "@types/node": "22.10.1",
+    "@wdio/sauce-service": "9.2.13",
     "@wdio/selenium-standalone-service": "8.3.2",
-    "@wdio/utils": "9.1.2",
-    "@xmldom/xmldom": "0.9.4",
-    "apollo-server-express": "2.25.3",
+    "@wdio/utils": "9.2.8",
+    "@xmldom/xmldom": "0.9.5",
+    "apollo-server-express": "3.13.0",
     "chai-as-promised": "7.1.2",
     "chai-subset": "1.6.0",
     "cheerio": "^1.0.0",
     "contributor-faces": "1.1.0",
-    "documentation": "12.3.0",
-    "electron": "31.3.1",
-    "eslint": "8.57.0",
+    "documentation": "14.0.3",
+    "electron": "33.2.1",
+    "eslint": "9.16.0",
     "eslint-config-airbnb-base": "15.0.0",
-    "eslint-plugin-import": "2.30.0",
+    "eslint-plugin-import": "2.31.0",
     "eslint-plugin-mocha": "10.5.0",
     "expect": "29.7.0",
-    "express": "4.19.2",
+    "express": "4.21.1",
+    "globals": "15.12.0",
     "graphql": "16.9.0",
-    "husky": "9.1.6",
+    "husky": "9.1.7",
     "inquirer-test": "2.0.1",
-    "jsdoc": "4.0.3",
+    "jsdoc": "4.0.4",
     "jsdoc-typeof-plugin": "1.0.0",
-    "json-server": "0.10.1",
-    "playwright": "1.45.3",
+    "json-server": "0.17.4",
+    "playwright": "1.49.0",
     "prettier": "^3.3.2",
-    "puppeteer": "23.3.0",
+    "puppeteer": "23.8.0",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
     "runok": "0.9.3",
     "semver": "7.6.3",
-    "sinon": "18.0.0",
+    "sinon": "19.0.2",
     "sinon-chai": "3.7.0",
-    "testcafe": "3.5.0",
-    "ts-morph": "23.0.0",
+    "testcafe": "3.7.0",
+    "ts-morph": "24.0.0",
     "ts-node": "10.9.2",
     "tsd": "^0.31.0",
     "tsd-jsdoc": "2.5.0",
-    "typedoc": "0.26.7",
-    "typedoc-plugin-markdown": "4.2.9",
-    "typescript": "5.6.3",
+    "typedoc": "0.26.11",
+    "typedoc-plugin-markdown": "4.2.10",
+    "typescript": "5.7.2",
     "wdio-docker-service": "1.5.0",
-    "webdriverio": "8.39.1",
+    "webdriverio": "8.40.6",
     "xml2js": "0.6.2",
     "xpath": "0.0.34"
   },

package/translations/de-DE.js

@@ -68,6 +68,7 @@ module.exports = {
     sendGetRequest: 'mache_einen_get_request',
     sendPutRequest: 'mache_einen_put_request',
     sendDeleteRequest: 'mache_einen_delete_request',
+    sendDeleteRequestWithPayload: 'mache_einen_delete_request_mit_payload',
     sendPostRequest: 'mache_einen_post_request',
     switchTo: 'wechlse_in_iframe',
   },

package/translations/fr-FR.js

@@ -70,7 +70,7 @@ module.exports = {
     scrollTo: 'défileVers',
     sendGetRequest: 'envoieLaRequêteGet',
     sendPutRequest: 'envoieLaRequêtePut',
-    sendDeleteRequest: 'envoieLaRequêteDelete',
+    sendDeleteRequest: 'envoieLaRequêteDeleteAvecPayload',
     sendPostRequest: 'envoieLaRequêtePost',
   },
 }

package/typings/index.d.ts

@@ -114,6 +114,14 @@ declare namespace CodeceptJS {
      * ```
      */
     emptyOutputFolder?: boolean;
+    /**
+     * mask sensitive data in output logs
+     *
+     * ```js
+     * maskSensitiveData: true
+     * ```
+     */
+    maskSensitiveData?: boolean;
     /**
      * Pattern to filter tests by name.
      * This option is useful if you plan to use multiple configs for different environments.
@@ -554,7 +562,7 @@ declare const xScenario: CodeceptJS.IScenario;
 declare const xFeature: CodeceptJS.IFeature;
 declare function Data(data: any): CodeceptJS.IData;
 declare function xData(data: any): CodeceptJS.IData;
-declare function defineParameterType(options: CodeceptJS.IParameterTypeDefinition<any>): void
+declare function DefineParameterType(options: CodeceptJS.IParameterTypeDefinition<any>): void
 
 // Hooks
 declare const BeforeSuite: CodeceptJS.IHook;
@@ -599,7 +607,7 @@ declare namespace NodeJS {
     Given: typeof Given;
     When: typeof When;
     Then: typeof Then;
-    DefineParameterType: typeof defineParameterType
+    DefineParameterType: typeof DefineParameterType
   }
 }
 

package/typings/promiseBasedTypes.d.ts

@@ -113,7 +113,7 @@ declare namespace CodeceptJS {
      *
      * module.exports = new Factory()
      *    // no need to set id, it will be set by REST API
-     *    .attr('author', () => faker.name.findName())
+     *    .attr('author', () => faker.person.findName())
      *    .attr('title', () => faker.lorem.sentence())
      *    .attr('body', () => faker.lorem.paragraph());
      * ```
@@ -354,6 +354,17 @@ declare namespace CodeceptJS {
          * ```
          */
         runOnAndroid(caps: any, fn: any): Promise<any>;
+        /**
+         * Execute code only in Web mode.
+         *
+         * ```js
+         * I.runInWeb(() => {
+         *    I.waitForElement('#data');
+         *    I.seeInCurrentUrl('/data');
+         * });
+         * ```
+         */
+        runInWeb(): Promise<any>;
         /**
          * Returns app installation status.
          *
@@ -651,6 +662,19 @@ declare namespace CodeceptJS {
          * Shortcut for `makeTouchAction`
          */
         tap(locator: any): Promise<void>;
+        /**
+         * Perform a swipe on the screen or an element.
+         *
+         * ```js
+         * let locator = "#io.selendroid.testapp:id/LinearLayout1";
+         * I.swipe(locator, 800, 1200, 1000);
+         * ```
+         *
+         * [See complete reference](http://webdriver.io/api/mobile/swipe.html)
+         * @param [speed = 1000] - (optional), 1000 by default
+         * @returns Appium: support Android and iOS
+         */
+        swipe(locator: CodeceptJS.LocatorOrString, xoffset: number, yoffset: number, speed?: number): Promise<void>;
         /**
          * Perform a swipe on the screen.
          *
@@ -1180,14 +1204,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1299,14 +1315,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1645,7 +1653,7 @@ declare namespace CodeceptJS {
      *    input: { ...buildObj },
      * }))
      *    // 'attr'-id can be left out depending on the GraphQl resolvers
-     *    .attr('name', () => faker.name.findName())
+     *    .attr('name', () => faker.person.findName())
      *    .attr('email', () => faker.interact.email())
      * ```
      * For more options see [rosie documentation](https://github.com/rosiejs/rosie).
@@ -1978,14 +1986,6 @@ declare namespace CodeceptJS {
      * @property [host = "0.0.0.0"] - Mock server host
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2110,14 +2110,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3191,14 +3183,6 @@ 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
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6575,14 +6559,6 @@ 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
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8389,14 +8365,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
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -8577,6 +8545,17 @@ declare namespace CodeceptJS {
          * @returns response
          */
         sendDeleteRequest(url: any, headers?: any): Promise<any>;
+        /**
+         * Sends DELETE request to API with payload.
+         *
+         * ```js
+         * I.sendDeleteRequestWithPayload('/api/users/1', { author: 'john' });
+         * ```
+         * @param [payload = {}] - the payload to be sent. By default it is sent as an empty object
+         * @param [headers = {}] - the headers object to be sent. By default, it is sent as an empty object
+         * @returns response
+         */
+        sendDeleteRequestWithPayload(url: any, payload?: any, headers?: any): Promise<any>;
     }
     /**
      * SoftAssertHelper is a utility class for performing soft assertions.
@@ -9773,16 +9752,7 @@ declare namespace CodeceptJS {
      * @property [timeouts] - [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
      * @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
-     * @property [devtoolsProtocol = false] - enable devtools protocol. Default: false. More info: https://webdriver.io/docs/automationProtocols/#devtools-protocol.
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -9805,7 +9775,6 @@ declare namespace CodeceptJS {
         timeouts?: any;
         highlightElement?: boolean;
         logLevel?: string;
-        devtoolsProtocol?: boolean;
     };
     /**
      * WebDriver helper which wraps [webdriverio](http://webdriver.io/) library to
@@ -9911,7 +9880,6 @@ declare namespace CodeceptJS {
      *      WebDriver : {
      *        url: "http://localhost",
      *        browser: "chrome",
-     *        devtoolsProtocol: true,
      *        desiredCapabilities: {
      *          chromeOptions: {
      *            args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
@@ -11601,33 +11569,6 @@ declare namespace CodeceptJS {
          * @returns scroll position
          */
         grabPageScrollPosition(): Promise<PageScrollPosition>;
-        /**
-         * This method is **deprecated**.
-         *
-         *
-         * Set the current geo location
-         *
-         *
-         * ```js
-         * I.setGeoLocation(121.21, 11.56);
-         * I.setGeoLocation(121.21, 11.56, 10);
-         * ```
-         * @param latitude - to set.
-         * @param longitude - to set
-         * @param [altitude] - (optional, null by default) to set
-         */
-        setGeoLocation(latitude: number, longitude: number, altitude?: number): Promise<any>;
-        /**
-         * This method is **deprecated**.
-         *
-         * Return the current geo location
-         * Resumes test execution, so **should be used inside async function with `await`** operator.
-         *
-         * ```js
-         * let geoLocation = await I.grabGeoLocation();
-         * ```
-         */
-        grabGeoLocation(): Promise<{ latitude: number; longitude: number; altitude: number; }>;
         /**
          * Grab the width, height, location of given locator.
          * Provide `width` or `height`as second param to get your desired prop.
@@ -11654,119 +11595,15 @@ declare namespace CodeceptJS {
         /**
          * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
          */
-        runOnAndroid(caps: any, fn: any): Promise<any>;
+        runOnIOS(caps: any, fn: any): Promise<any>;
         /**
          * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
          */
-        runInWeb(): Promise<any>;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Resets all recorded network requests.
-         *
-         * ```js
-         * I.flushNetworkTraffics();
-         * ```
-         */
-        flushNetworkTraffics(): Promise<any>;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Stops recording of network traffic. Recorded traffic is not flashed.
-         *
-         * ```js
-         * I.stopRecordingTraffic();
-         * ```
-         */
-        stopRecordingTraffic(): Promise<any>;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Starts recording the network traffics.
-         * This also resets recorded network requests.
-         *
-         * ```js
-         * I.startRecordingTraffic();
-         * ```
-         */
-        startRecordingTraffic(): Promise<any>;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Grab the recording network traffics
-         *
-         * ```js
-         * const traffics = await I.grabRecordedNetworkTraffics();
-         * expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
-         * expect(traffics[0].response.status).to.equal(200);
-         * expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
-         * ```
-         */
-        grabRecordedNetworkTraffics(): Promise<any>;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Verifies that a certain request is part of network traffic.
-         *
-         * ```js
-         * // checking the request url contains certain query strings
-         * I.amOnPage('https://openai.com/blog/chatgpt');
-         * I.startRecordingTraffic();
-         * await I.seeTraffic({
-         *     name: 'sentry event',
-         *     url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
-         *     parameters: {
-         *     width: '1919',
-         *     height: '1138',
-         *     },
-         *   });
-         * ```
-         *
-         * ```js
-         * // checking the request url contains certain post data
-         * I.amOnPage('https://openai.com/blog/chatgpt');
-         * I.startRecordingTraffic();
-         * await I.seeTraffic({
-         *     name: 'event',
-         *     url: 'https://cloudflareinsights.com/cdn-cgi/rum',
-         *     requestPostData: {
-         *     st: 2,
-         *     },
-         *   });
-         * ```
-         * @param opts - options when checking the traffic network.
-         * @param opts.name - A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
-         * @param opts.url - Expected URL of request in network traffic
-         * @param [opts.parameters] - Expected parameters of that request in network traffic
-         * @param [opts.requestPostData] - Expected that request contains post data in network traffic
-         * @param [opts.timeout] - Timeout to wait for request in seconds. Default is 10 seconds.
-         */
-        seeTraffic(opts: {
-            name: string;
-            url: string;
-            parameters?: any;
-            requestPostData?: any;
-            timeout?: number;
-        }): Promise<any>;
+        runOnAndroid(caps: any, fn: any): Promise<any>;
         /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Verifies that a certain request is not part of network traffic.
-         *
-         * Examples:
-         *
-         * ```js
-         * I.dontSeeTraffic({ name: 'Unexpected API Call', url: 'https://api.example.com' });
-         * I.dontSeeTraffic({ name: 'Unexpected API Call of "user" endpoint', url: /api.example.com.*user/ });
-         * ```
-         * @param opts - options when checking the traffic network.
-         * @param opts.name - A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
-         * @param opts.url - Expected URL of request in network traffic. Can be a string or a regular expression.
+         * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
          */
-        dontSeeTraffic(opts: {
-            name: string;
-            url: string | RegExp;
-        }): Promise<any>;
+        runInWeb(): Promise<any>;
     }
 }