codeceptjs 3.5.13-beta.2 → 3.5.13

package/typings/promiseBasedTypes.d.ts

@@ -4725,11 +4725,10 @@ declare namespace CodeceptJS {
          */
         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>;
@@ -4743,7 +4742,7 @@ declare namespace CodeceptJS {
          * expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
          * ```
          */
-        grabRecordedNetworkTraffics(): Promise<any[]>;
+        grabRecordedNetworkTraffics(): Promise<any>;
         /**
          * Blocks traffic of a given URL or a list of URLs.
          *
@@ -4780,6 +4779,10 @@ declare namespace CodeceptJS {
         mockTraffic(urls: any, responseString: any, contentType?: any): Promise<any>;
         /**
          * Resets all recorded network requests.
+         *
+         * ```js
+         * I.flushNetworkTraffics();
+         * ```
          */
         flushNetworkTraffics(): Promise<any>;
         /**
@@ -4798,13 +4801,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
@@ -4812,12 +4815,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.
@@ -10735,6 +10738,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>;
     }
 }
 

package/typings/types.d.ts

@@ -4973,11 +4973,10 @@ declare namespace CodeceptJS {
          */
         stopMockingRoute(url?: string | RegExp, handler?: (...params: any[]) => any): void;
         /**
-         * Starts recording the network traffics.
-         * This also resets recorded network requests.
+         * Resets all recorded network requests.
          *
          * ```js
-         * I.startRecordingTraffic();
+         * I.flushNetworkTraffics();
          * ```
          */
         startRecordingTraffic(): void;
@@ -4990,8 +4989,9 @@ declare namespace CodeceptJS {
          * expect(traffics[0].response.status).to.equal(200);
          * expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
          * ```
+         * @returns recorded network traffics
          */
-        grabRecordedNetworkTraffics(): Promise<any[]>;
+        grabRecordedNetworkTraffics(): any[];
         /**
          * Blocks traffic of a given URL or a list of URLs.
          *
@@ -5028,6 +5028,10 @@ declare namespace CodeceptJS {
         mockTraffic(urls: any, responseString: any, contentType?: any): void;
         /**
          * Resets all recorded network requests.
+         *
+         * ```js
+         * I.flushNetworkTraffics();
+         * ```
          */
         flushNetworkTraffics(): void;
         /**
@@ -5046,13 +5050,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
@@ -5060,12 +5064,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.
@@ -5073,6 +5077,7 @@ declare namespace CodeceptJS {
          * @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;
@@ -5080,7 +5085,7 @@ declare namespace CodeceptJS {
             parameters?: any;
             requestPostData?: any;
             timeout?: number;
-        }): Promise<any>;
+        }): void;
         /**
          * 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.
@@ -5105,6 +5110,7 @@ declare namespace CodeceptJS {
          * @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
          */
         dontSeeTraffic(opts: {
             name: string;
@@ -11478,6 +11484,118 @@ declare namespace CodeceptJS {
          * 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;
+        /**
+         * _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
+         */
+        dontSeeTraffic(opts: {
+            name: string;
+            url: string | RegExp;
+        }): void;
     }
     interface ActorStatic {
         /**