codeceptjs 3.5.15 → 3.6.0

package/typings/promiseBasedTypes.d.ts

@@ -1,4 +1,44 @@
 declare namespace CodeceptJS {
+    /**
+     * AI Helper for CodeceptJS.
+     *
+     * This helper class provides integration with the AI GPT-3.5 or 4 language model for generating responses to questions or prompts within the context of web pages. It allows you to interact with the GPT-3.5 model to obtain intelligent responses based on HTML fragments or general prompts.
+     * This helper should be enabled with any web helpers like Playwright or Puppeteer or WebDrvier to ensure the HTML context is available.
+     *
+     * ## Configuration
+     *
+     * This helper should be configured in codecept.json or codecept.conf.js
+     *
+     * * `chunkSize`: (optional, default: 80000) - The maximum number of characters to send to the AI API at once. We split HTML fragments by 8000 chars to not exceed token limit. Increase this value if you use GPT-4.
+     */
+    class AITs {
+        /**
+         * Asks the AI GPT language model a question based on the provided prompt within the context of the current page's HTML.
+         *
+         * ```js
+         * I.askGptOnPage('what does this page do?');
+         * ```
+         * @param prompt - The question or prompt to ask the GPT model.
+         * @returns - A Promise that resolves to the generated responses from the GPT model, joined by newlines.
+         */
+        askGptOnPage(prompt: string): Promise<string>;
+        /**
+         * Asks the AI a question based on the provided prompt within the context of a specific HTML fragment on the current page.
+         *
+         * ```js
+         * I.askGptOnPageFragment('describe features of this screen', '.screen');
+         * ```
+         * @param prompt - The question or prompt to ask the GPT-3.5 model.
+         * @param locator - The locator or selector used to identify the HTML fragment on the page.
+         * @returns - A Promise that resolves to the generated response from the GPT model.
+         */
+        askGptOnPageFragment(prompt: string, locator: string): Promise<string>;
+        /**
+         * Send a general request to ChatGPT and return response.
+         * @returns - A Promise that resolves to the generated response from the GPT model.
+         */
+        askGptGeneralPrompt(prompt: string): Promise<string>;
+    }
     /**
      * Helper for managing remote data using REST API.
      * Uses data generators like [rosie](https://github.com/rosiejs/rosie) or factory girl to create new record.
@@ -4709,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>;
         /**
@@ -4721,7 +4761,7 @@ 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>;
         /**
@@ -4732,17 +4772,6 @@ declare namespace CodeceptJS {
          * ```
          */
         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.
          *
@@ -4793,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.
          *
@@ -4836,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.
          *
@@ -7824,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.

package/typings/types.d.ts

@@ -1,4 +1,44 @@
 declare namespace CodeceptJS {
+    /**
+     * AI Helper for CodeceptJS.
+     *
+     * This helper class provides integration with the AI GPT-3.5 or 4 language model for generating responses to questions or prompts within the context of web pages. It allows you to interact with the GPT-3.5 model to obtain intelligent responses based on HTML fragments or general prompts.
+     * This helper should be enabled with any web helpers like Playwright or Puppeteer or WebDrvier to ensure the HTML context is available.
+     *
+     * ## Configuration
+     *
+     * This helper should be configured in codecept.json or codecept.conf.js
+     *
+     * * `chunkSize`: (optional, default: 80000) - The maximum number of characters to send to the AI API at once. We split HTML fragments by 8000 chars to not exceed token limit. Increase this value if you use GPT-4.
+     */
+    class AI {
+        /**
+         * Asks the AI GPT language model a question based on the provided prompt within the context of the current page's HTML.
+         *
+         * ```js
+         * I.askGptOnPage('what does this page do?');
+         * ```
+         * @param prompt - The question or prompt to ask the GPT model.
+         * @returns - A Promise that resolves to the generated responses from the GPT model, joined by newlines.
+         */
+        askGptOnPage(prompt: string): Promise<string>;
+        /**
+         * Asks the AI a question based on the provided prompt within the context of a specific HTML fragment on the current page.
+         *
+         * ```js
+         * I.askGptOnPageFragment('describe features of this screen', '.screen');
+         * ```
+         * @param prompt - The question or prompt to ask the GPT-3.5 model.
+         * @param locator - The locator or selector used to identify the HTML fragment on the page.
+         * @returns - A Promise that resolves to the generated response from the GPT model.
+         */
+        askGptOnPageFragment(prompt: string, locator: string): Promise<string>;
+        /**
+         * Send a general request to ChatGPT and return response.
+         * @returns - A Promise that resolves to the generated response from the GPT model.
+         */
+        askGptGeneralPrompt(prompt: string): Promise<string>;
+    }
     /**
      * Helper for managing remote data using REST API.
      * Uses data generators like [rosie](https://github.com/rosiejs/rosie) or factory girl to create new record.
@@ -3028,6 +3068,7 @@ declare namespace CodeceptJS {
      * @property [bypassCSP] - bypass Content Security Policy or CSP
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      * @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).
      */
     type PlaywrightConfig = {
         url?: string;
@@ -3065,6 +3106,7 @@ declare namespace CodeceptJS {
         bypassCSP?: boolean;
         highlightElement?: boolean;
         recordHar?: any;
+        testIdAttribute?: string;
     };
     /**
      * Uses [Playwright](https://github.com/microsoft/playwright) library to run tests inside:
@@ -4957,7 +4999,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): void;
         /**
@@ -4969,7 +5011,7 @@ 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): void;
         /**
@@ -4980,18 +5022,6 @@ declare namespace CodeceptJS {
          * ```
          */
         startRecordingTraffic(): void;
-        /**
-         * 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[];
         /**
          * Blocks traffic of a given URL or a list of URLs.
          *
@@ -5042,6 +5072,30 @@ declare namespace CodeceptJS {
          * ```
          */
         stopRecordingTraffic(): 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.
+         *
+         * 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' });
+         * ```
+         * @returns recorded network traffics
+         */
+        grabRecordedNetworkTraffics(): any[];
         /**
          * Verifies that a certain request is part of network traffic.
          *
@@ -5086,18 +5140,6 @@ declare namespace CodeceptJS {
             requestPostData?: any;
             timeout?: number;
         }): 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.
-         *
-         * 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.
          *
@@ -5123,6 +5165,7 @@ declare namespace CodeceptJS {
          * ```js
          * await I.startRecordingWebSocketMessages();
          * ```
+         * @returns automatically synchronized promise through #recorder
          */
         startRecordingWebSocketMessages(): void;
         /**
@@ -5131,6 +5174,7 @@ declare namespace CodeceptJS {
          * ```js
          * await I.stopRecordingWebSocketMessages();
          * ```
+         * @returns automatically synchronized promise through #recorder
          */
         stopRecordingWebSocketMessages(): void;
         /**
@@ -8325,6 +8369,153 @@ 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): void;
+        /**
+         * 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): void;
+        /**
+         * Resets all recorded network requests.
+         *
+         * ```js
+         * I.flushNetworkTraffics();
+         * ```
+         */
+        flushNetworkTraffics(): void;
+        /**
+         * Stops recording of network traffic. Recorded traffic is not flashed.
+         *
+         * ```js
+         * I.stopRecordingTraffic();
+         * ```
+         */
+        stopRecordingTraffic(): void;
+        /**
+         * Starts recording the network traffics.
+         * This also resets recorded network requests.
+         *
+         * ```js
+         * I.startRecordingTraffic();
+         * ```
+         * @returns automatically synchronized promise through #recorder
+         */
+        startRecordingTraffic(): void;
+        /**
+         * 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[];
+        /**
+         * 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;
+        /**
+         * 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;
+        /**
+         * Starts recording of websocket messages.
+         * This also resets recorded websocket messages.
+         *
+         * ```js
+         * await I.startRecordingWebSocketMessages();
+         * ```
+         * @returns automatically synchronized promise through #recorder
+         */
+        startRecordingWebSocketMessages(): void;
+        /**
+         * Stops recording WS messages. Recorded WS messages is not flashed.
+         *
+         * ```js
+         * await I.stopRecordingWebSocketMessages();
+         * ```
+         * @returns automatically synchronized promise through #recorder
+         */
+        stopRecordingWebSocketMessages(): void;
+        /**
+         * Grab the recording WS messages
+         */
+        grabWebSocketMessages(): any[] | undefined;
+        /**
+         * Resets all recorded WS messages.
+         */
+        flushWebSocketMessages(): void;
     }
     /**
      * ## Configuration
@@ -11933,6 +12124,7 @@ declare namespace CodeceptJS {
         isShadow(): boolean;
         isFrame(): boolean;
         isCSS(): boolean;
+        isPlaywrightLocator(): boolean;
         isNull(): boolean;
         isXPath(): boolean;
         isCustom(): boolean;
@@ -12157,6 +12349,7 @@ declare namespace CodeceptJS {
     namespace store {
         var debugMode: boolean;
         var timeouts: boolean;
+        var dryRun: boolean;
     }
     /**
      * Describe a "suite" with the given `title`