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

package/typings/types.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): void;
+        /**
+         * Execute code only in Web mode.
+         *
+         * ```js
+         * I.runInWeb(() => {
+         *    I.waitForElement('#data');
+         *    I.seeInCurrentUrl('/data');
+         * });
+         * ```
+         */
+        runInWeb(): void;
         /**
          * 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.
          *
@@ -1204,14 +1228,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): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1323,14 +1339,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): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1672,7 +1680,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).
@@ -2005,14 +2013,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;
@@ -2137,14 +2137,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
@@ -3284,14 +3276,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';
@@ -6819,14 +6803,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;
@@ -8769,14 +8745,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;
@@ -8957,6 +8925,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.
@@ -10213,16 +10192,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;
@@ -10245,7 +10215,6 @@ declare namespace CodeceptJS {
         timeouts?: any;
         highlightElement?: boolean;
         logLevel?: string;
-        devtoolsProtocol?: boolean;
     };
     /**
      * WebDriver helper which wraps [webdriverio](http://webdriver.io/) library to
@@ -10351,7 +10320,6 @@ declare namespace CodeceptJS {
      *      WebDriver : {
      *        url: "http://localhost",
      *        browser: "chrome",
-     *        devtoolsProtocol: true,
      *        desiredCapabilities: {
      *          chromeOptions: {
      *            args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
@@ -12155,34 +12123,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
-         * @returns automatically synchronized promise through #recorder
-         */
-        setGeoLocation(latitude: number, longitude: number, altitude?: number): void;
-        /**
-         * 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.
@@ -12209,123 +12149,15 @@ declare namespace CodeceptJS {
         /**
          * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
          */
-        runOnAndroid(caps: any, fn: any): void;
+        runOnIOS(caps: any, fn: any): void;
         /**
          * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
          */
-        runInWeb(): void;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Resets all recorded network requests.
-         *
-         * ```js
-         * I.flushNetworkTraffics();
-         * ```
-         */
-        flushNetworkTraffics(): void;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Stops recording of network traffic. Recorded traffic is not flashed.
-         *
-         * ```js
-         * I.stopRecordingTraffic();
-         * ```
-         */
-        stopRecordingTraffic(): void;
-        /**
-         * _Note:_ Only works when devtoolsProtocol is enabled.
-         *
-         * Starts recording the network traffics.
-         * This also resets recorded network requests.
-         *
-         * ```js
-         * I.startRecordingTraffic();
-         * ```
-         * @returns automatically synchronized promise through #recorder
-         */
-        startRecordingTraffic(): void;
-        /**
-         * _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' });
-         * ```
-         * @returns recorded network traffics
-         */
-        grabRecordedNetworkTraffics(): 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.
-         * @returns automatically synchronized promise through #recorder
-         */
-        seeTraffic(opts: {
-            name: string;
-            url: string;
-            parameters?: any;
-            requestPostData?: any;
-            timeout?: number;
-        }): void;
+        runOnAndroid(caps: any, fn: any): void;
         /**
-         * _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.
-         * @returns automatically synchronized promise through #recorder
+         * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
          */
-        dontSeeTraffic(opts: {
-            name: string;
-            url: string | RegExp;
-        }): void;
+        runInWeb(): void;
     }
     interface ActorStatic {
         /**
@@ -12718,7 +12550,7 @@ declare namespace CodeceptJS {
         inside(locator: CodeceptJS.LocatorOrString): Locator;
         after(locator: CodeceptJS.LocatorOrString): Locator;
         before(locator: CodeceptJS.LocatorOrString): Locator;
-        static build(locator: CodeceptJS.LocatorOrString): Locator;
+        static build(locator?: CodeceptJS.LocatorOrString): Locator;
         /**
          * Filters to modify locators
          */
@@ -12773,6 +12605,7 @@ declare namespace CodeceptJS {
             function skipped(test: Mocha.Test): void;
         }
         namespace scenario {
+            function started(test: Mocha.Test): void;
             function passed(test: Mocha.Test): void;
             function failed(test: Mocha.Test): void;
         }

package/lib/helper/MockServer.js

@@ -1,221 +0,0 @@
-const { mock, settings } = require('pactum')
-
-/**
- * ## Configuration
- *
- * This helper should be configured in codecept.conf.(js|ts)
- *
- * @typedef MockServerConfig
- * @type {object}
- * @prop {number} [port=9393] - Mock server port
- * @prop {string} [host="0.0.0.0"] - Mock server host
- * @prop {object} [httpsOpts] - key & cert values are the paths to .key and .crt files
- */
-let config = {
-  port: 9393,
-  host: '0.0.0.0',
-  httpsOpts: {
-    key: '',
-    cert: '',
-  },
-}
-
-/**
- * MockServer
- *
- * The MockServer Helper in CodeceptJS empowers you to mock any server or service via HTTP or HTTPS, making it an excellent tool for simulating REST endpoints and other HTTP-based APIs.
- *
- * <!-- configuration -->
- *
- * #### Examples
- *
- * You can seamlessly integrate MockServer with other helpers like REST or Playwright. Here's a configuration example inside the `codecept.conf.js` file:
- *
- * ```javascript
- * {
- *   helpers: {
- *     REST: {...},
- *     MockServer: {
- *       // default mock server config
- *       port: 9393,
- *       host: '0.0.0.0',
- *       httpsOpts: {
- *         key: '',
- *         cert: '',
- *       },
- *     },
- *   }
- * }
- * ```
- *
- * #### Adding Interactions
- *
- * Interactions add behavior to the mock server. Use the `I.addInteractionToMockServer()` method to include interactions. It takes an interaction object as an argument, containing request and response details.
- *
- * ```javascript
- * I.addInteractionToMockServer({
- *    request: {
- *      method: 'GET',
- *      path: '/api/hello'
- *    },
- *    response: {
- *      status: 200,
- *      body: {
- *        'say': 'hello to mock server'
- *      }
- *    }
- * });
- * ```
- *
- * #### Request Matching
- *
- * When a real request is sent to the mock server, it matches the received request with the interactions. If a match is found, it returns the specified response; otherwise, a 404 status code is returned.
- *
- * - Strong match on HTTP Method, Path, Query Params & JSON body.
- * - Loose match on Headers.
- *
- * ##### Strong Match on Query Params
- *
- * You can send different responses based on query parameters:
- *
- * ```javascript
- * I.addInteractionToMockServer({
- *   request: {
- *     method: 'GET',
- *     path: '/api/users',
- *     queryParams: {
- *       id: 1
- *     }
- *   },
- *   response: {
- *     status: 200,
- *     body: 'user 1'
- *   }
- * });
- *
- * I.addInteractionToMockServer({
- *   request: {
- *     method: 'GET',
- *     path: '/api/users',
- *     queryParams: {
- *       id: 2
- *     }
- *   },
- *   response: {
- *     status: 200,
- *     body: 'user 2'
- *   }
- * });
- * ```
- *
- * - GET to `/api/users?id=1` will return 'user 1'.
- * - GET to `/api/users?id=2` will return 'user 2'.
- * - For all other requests, it returns a 404 status code.
- *
- * ##### Loose Match on Body
- *
- * When `strict` is set to false, it performs a loose match on query params and response body:
- *
- * ```javascript
- * I.addInteractionToMockServer({
- *   strict: false,
- *   request: {
- *     method: 'POST',
- *     path: '/api/users',
- *     body: {
- *       name: 'john'
- *     }
- *   },
- *   response: {
- *     status: 200
- *   }
- * });
- * ```
- *
- * - POST to `/api/users` with the body containing `name` as 'john' will return a 200 status code.
- * - POST to `/api/users` without the `name` property in the body will return a 404 status code.
- *
- * Happy testing with MockServer in CodeceptJS! 🚀
- *
- * ## Methods
- */
-class MockServer {
-  constructor(passedConfig) {
-    settings.setLogLevel('SILENT')
-    config = { ...passedConfig }
-    if (global.debugMode) {
-      settings.setLogLevel('VERBOSE')
-    }
-  }
-
-  /**
-   * Start the mock server
-   * @param {number} [port] start the mock server with given port
-   *
-   * @returns void
-   */
-  async startMockServer(port) {
-    const _config = { ...config }
-    if (port) _config.port = port
-    await mock.setDefaults(_config)
-    await mock.start()
-  }
-
-  /**
-   * Stop the mock server
-   *
-   * @returns void
-   *
-   */
-  async stopMockServer() {
-    await mock.stop()
-  }
-
-  /**
-   * An interaction adds behavior to the mock server
-   *
-   *
-   * ```js
-   * I.addInteractionToMockServer({
-   *    request: {
-   *      method: 'GET',
-   *      path: '/api/hello'
-   *    },
-   *    response: {
-   *      status: 200,
-   *      body: {
-   *        'say': 'hello to mock server'
-   *      }
-   *    }
-   * });
-   * ```
-   * ```js
-   * // with query params
-   * I.addInteractionToMockServer({
-   *    request: {
-   *      method: 'GET',
-   *      path: '/api/hello',
-   *      queryParams: {
-   *       id: 2
-   *     }
-   *    },
-   *    response: {
-   *      status: 200,
-   *      body: {
-   *        'say': 'hello to mock server'
-   *      }
-   *    }
-   * });
-   * ```
-   *
-   * @param {CodeceptJS.MockInteraction|object} interaction add behavior to the mock server
-   *
-   * @returns void
-   *
-   */
-  async addInteractionToMockServer(interaction) {
-    await mock.addInteraction(interaction)
-  }
-}
-
-module.exports = MockServer