codeceptjs 3.6.0-beta.1.ai-healers → 3.6.0

package/typings/promiseBasedTypes.d.ts

@@ -1167,9 +1167,9 @@ declare namespace CodeceptJS {
         expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): Promise<any>;
         expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): Promise<any>;
         /**
-         * @param ajvOptions - Pass AJV options
+         * @param [ajvOptions] - Pass AJV options
          */
-        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions: any): Promise<any>;
+        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions?: any): Promise<any>;
         expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): Promise<any>;
         expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): Promise<any>;
         expectToBeA(targetData: any, type: any, customErrorMsg?: any): Promise<any>;
@@ -1772,6 +1772,188 @@ declare namespace CodeceptJS {
          */
         seeResponseMatchesJsonSchema(fnOrSchema: any): Promise<any>;
     }
+    /**
+     * ## Configuration
+     *
+     * This helper should be configured in codecept.conf.(js|ts)
+     * @property [port = 9393] - Mock server port
+     * @property [host = "0.0.0.0"] - Mock server host
+     * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
+     */
+    type MockServerConfig = {
+        port?: number;
+        host?: string;
+        httpsOpts?: any;
+    };
+    /**
+     * 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 {
+        /**
+         * Start the mock server
+         * @param [port] - start the mock server with given port
+         */
+        startMockServer(port?: number): Promise<any>;
+        /**
+         * Stop the mock server
+         */
+        stopMockServer(): Promise<any>;
+        /**
+         * 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 interaction - add behavior to the mock server
+         */
+        addInteractionToMockServer(interaction: CodeceptJS.MockInteraction | any): Promise<any>;
+    }
     /**
      * Nightmare helper wraps [Nightmare](https://github.com/segmentio/nightmare) library to provide
      * fastest headless testing using Electron engine. Unlike Selenium-based drivers this uses
@@ -4504,6 +4686,16 @@ declare namespace CodeceptJS {
          * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
          */
         waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
+        /**
+         * Waits for the specified cookie in the cookies.
+         *
+         * ```js
+         * I.waitForCookie("token");
+         * ```
+         * @param name - expected cookie name.
+         * @param [sec = 3] - (optional, `3` by default) time in seconds to wait
+         */
+        waitForCookie(name: string, sec?: number): Promise<any>;
         /**
          * Grab the data from performance timing using Navigation Timing API.
          * The returned data will contain following things in ms:
@@ -4557,7 +4749,7 @@ declare namespace CodeceptJS {
          * ```
          * This method allows intercepting and mocking requests & responses. [Learn more about it](https://playwright.dev/docs/network#handle-requests)
          * @param [url] - URL, regex or pattern for to match URL
-         * @param [handler] - a function to process reques
+         * @param [handler] - a function to process request
          */
         mockRoute(url?: string | RegExp, handler?: (...params: any[]) => any): Promise<any>;
         /**
@@ -4569,29 +4761,17 @@ declare namespace CodeceptJS {
          * ```
          * If no handler is passed, all mock requests for the rote are disabled.
          * @param [url] - URL, regex or pattern for to match URL
-         * @param [handler] - a function to process reques
+         * @param [handler] - a function to process request
          */
         stopMockingRoute(url?: string | RegExp, handler?: (...params: any[]) => any): Promise<any>;
         /**
-         * Starts recording the network traffics.
-         * This also resets recorded network requests.
+         * Resets all recorded network requests.
          *
          * ```js
-         * I.startRecordingTraffic();
+         * I.flushNetworkTraffics();
          * ```
          */
         startRecordingTraffic(): Promise<any>;
-        /**
-         * 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[]>;
         /**
          * Blocks traffic of a given URL or a list of URLs.
          *
@@ -4628,6 +4808,10 @@ declare namespace CodeceptJS {
         mockTraffic(urls: any, responseString: any, contentType?: any): Promise<any>;
         /**
          * Resets all recorded network requests.
+         *
+         * ```js
+         * I.flushNetworkTraffics();
+         * ```
          */
         flushNetworkTraffics(): Promise<any>;
         /**
@@ -4638,6 +4822,29 @@ declare namespace CodeceptJS {
          * ```
          */
         stopRecordingTraffic(): Promise<any>;
+        /**
+         * Returns full URL of request matching parameter "urlMatch".
+         * @param urlMatch - Expected URL of request in network traffic. Can be a string or a regular expression.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.grabTrafficUrl('https://api.example.com/session');
+         * I.grabTrafficUrl(/session.*start/);
+         * ```
+         */
+        grabTrafficUrl(urlMatch: string | RegExp): Promise<any>;
+        /**
+         * 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>;
         /**
          * Verifies that a certain request is part of network traffic.
          *
@@ -4646,13 +4853,13 @@ declare namespace CodeceptJS {
          * 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',
+         *     name: 'sentry event',
+         *     url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
+         *     parameters: {
+         *     width: '1919',
+         *     height: '1138',
          *     },
-         * });
+         *   });
          * ```
          *
          * ```js
@@ -4660,12 +4867,12 @@ declare namespace CodeceptJS {
          * I.amOnPage('https://openai.com/blog/chatgpt');
          * I.startRecordingTraffic();
          * await I.seeTraffic({
-         *    name: 'event',
-         *    url: 'https://cloudflareinsights.com/cdn-cgi/rum',
-         *    requestPostData: {
-         *       st: 2,
+         *     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.
@@ -4681,18 +4888,6 @@ declare namespace CodeceptJS {
             requestPostData?: any;
             timeout?: number;
         }): Promise<any>;
-        /**
-         * Returns full URL of request matching parameter "urlMatch".
-         * @param urlMatch - Expected URL of request in network traffic. Can be a string or a regular expression.
-         *
-         * Examples:
-         *
-         * ```js
-         * I.grabTrafficUrl('https://api.example.com/session');
-         * I.grabTrafficUrl(/session.*start/);
-         * ```
-         */
-        grabTrafficUrl(urlMatch: string | RegExp): Promise<any>;
         /**
          * Verifies that a certain request is not part of network traffic.
          *
@@ -7154,6 +7349,16 @@ declare namespace CodeceptJS {
          * @param [name = null] - cookie name.
          */
         grabCookie(name?: string): Promise<any>;
+        /**
+         * Waits for the specified cookie in the cookies.
+         *
+         * ```js
+         * I.waitForCookie("token");
+         * ```
+         * @param name - expected cookie name.
+         * @param [sec = 3] - (optional, `3` by default) time in seconds to wait
+         */
+        waitForCookie(name: string, sec?: number): Promise<any>;
         /**
          * Clears a cookie by name,
          * if none provided clears all cookies.
@@ -7659,6 +7864,147 @@ declare namespace CodeceptJS {
          * @returns Element bounding rectangle
          */
         grabElementBoundingRect(locator: LocatorOrString, elementSize?: string): Promise<DOMRect> | Promise<number>;
+        /**
+         * Mocks network request using [`Request Interception`](https://pptr.dev/next/guides/request-interception)
+         *
+         * ```js
+         * I.mockRoute(/(\.png$)|(\.jpg$)/, route => route.abort());
+         * ```
+         * This method allows intercepting and mocking requests & responses. [Learn more about it](https://pptr.dev/next/guides/request-interception)
+         * @param [url] - URL, regex or pattern for to match URL
+         * @param [handler] - a function to process request
+         */
+        mockRoute(url?: string | RegExp, handler?: (...params: any[]) => any): Promise<any>;
+        /**
+         * Stops network mocking created by `mockRoute`.
+         *
+         * ```js
+         * I.stopMockingRoute(/(\.png$)|(\.jpg$)/);
+         * ```
+         * @param [url] - URL, regex or pattern for to match URL
+         */
+        stopMockingRoute(url?: string | RegExp): Promise<any>;
+        /**
+         * Resets all recorded network requests.
+         *
+         * ```js
+         * I.flushNetworkTraffics();
+         * ```
+         */
+        flushNetworkTraffics(): Promise<any>;
+        /**
+         * Stops recording of network traffic. Recorded traffic is not flashed.
+         *
+         * ```js
+         * I.stopRecordingTraffic();
+         * ```
+         */
+        stopRecordingTraffic(): Promise<any>;
+        /**
+         * Starts recording the network traffics.
+         * This also resets recorded network requests.
+         *
+         * ```js
+         * I.startRecordingTraffic();
+         * ```
+         */
+        startRecordingTraffic(): Promise<any>;
+        /**
+         * 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>;
+        /**
+         * 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>;
+        /**
+         * 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.
+         */
+        dontSeeTraffic(opts: {
+            name: string;
+            url: string | RegExp;
+        }): Promise<any>;
+        /**
+         * Starts recording of websocket messages.
+         * This also resets recorded websocket messages.
+         *
+         * ```js
+         * await I.startRecordingWebSocketMessages();
+         * ```
+         */
+        startRecordingWebSocketMessages(): Promise<any>;
+        /**
+         * Stops recording WS messages. Recorded WS messages is not flashed.
+         *
+         * ```js
+         * await I.stopRecordingWebSocketMessages();
+         * ```
+         */
+        stopRecordingWebSocketMessages(): Promise<any>;
+        /**
+         * Grab the recording WS messages
+         */
+        grabWebSocketMessages(): Promise<any>;
+        /**
+         * Resets all recorded WS messages.
+         */
+        flushWebSocketMessages(): Promise<any>;
     }
     /**
      * REST helper allows to send additional requests to the REST API during acceptance tests.
@@ -10004,6 +10350,16 @@ declare namespace CodeceptJS {
          * @param [name = null] - cookie name.
          */
         grabCookie(name?: string): Promise<any>;
+        /**
+         * Waits for the specified cookie in the cookies.
+         *
+         * ```js
+         * I.waitForCookie("token");
+         * ```
+         * @param name - expected cookie name.
+         * @param [sec = 3] - (optional, `3` by default) time in seconds to wait
+         */
+        waitForCookie(name: string, sec?: number): Promise<any>;
         /**
          * Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt.
          * Don't confuse popups with modal windows, as created by [various
@@ -10563,6 +10919,114 @@ declare namespace CodeceptJS {
          * 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>;
+        /**
+         * _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.
+         */
+        dontSeeTraffic(opts: {
+            name: string;
+            url: string | RegExp;
+        }): Promise<any>;
     }
 }