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

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.
@@ -1732,188 +1772,6 @@ 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
@@ -4646,16 +4504,6 @@ 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:
@@ -4725,10 +4573,11 @@ declare namespace CodeceptJS {
          */
         stopMockingRoute(url?: string | RegExp, handler?: (...params: any[]) => any): Promise<any>;
         /**
-         * Resets all recorded network requests.
+         * Starts recording the network traffics.
+         * This also resets recorded network requests.
          *
          * ```js
-         * I.flushNetworkTraffics();
+         * I.startRecordingTraffic();
          * ```
          */
         startRecordingTraffic(): Promise<any>;
@@ -4742,7 +4591,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.
          *
@@ -4779,10 +4628,6 @@ declare namespace CodeceptJS {
         mockTraffic(urls: any, responseString: any, contentType?: any): Promise<any>;
         /**
          * Resets all recorded network requests.
-         *
-         * ```js
-         * I.flushNetworkTraffics();
-         * ```
          */
         flushNetworkTraffics(): Promise<any>;
         /**
@@ -4801,13 +4646,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
@@ -4815,12 +4660,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.
@@ -7309,16 +7154,6 @@ 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.
@@ -10169,16 +10004,6 @@ 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
@@ -10738,114 +10563,6 @@ 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>;
     }
 }