codeceptjs 3.4.0 → 3.5.0

package/typings/types.d.ts

@@ -756,6 +756,8 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.appendField('#myTextField', 'appended');
+         * // typing secret
+         * I.appendField('password', secret('123456'));
          * ```
          * @param field - located by label|name|CSS|XPath|strict locator
          * @param value - text value to append.
@@ -1658,16 +1660,16 @@ declare namespace CodeceptJS {
          *
          * I.seeResponseMatchesJsonSchema(joi => {
          *   return joi.object({
-         *     name: joi.string();
-         *     id: joi.number();
+         *     name: joi.string(),
+         *     id: joi.number()
          *   })
          * });
          *
          * // or pass a valid schema
-         * const joi = require('joi);
+         * const joi = require('joi');
          *
          * I.seeResponseMatchesJsonSchema(joi.object({
-         *   name: joi.string();
+         *   name: joi.string(),
          *   id: joi.number();
          * });
          * ```
@@ -2171,6 +2173,8 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.appendField('#myTextField', 'appended');
+         * // typing secret
+         * I.appendField('password', secret('123456'));
          * ```
          * @param field - located by label|name|CSS|XPath|strict locator
          * @param value - text value to append.
@@ -2675,12 +2679,52 @@ declare namespace CodeceptJS {
          */
         grabPageScrollPosition(): Promise<PageScrollPosition>;
     }
+    /**
+     * OpenAI Helper for CodeceptJS.
+     *
+     * This helper class provides integration with the OpenAI 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 OpenAI API at once. We split HTML fragments by 8000 chars to not exceed token limit. Increase this value if you use GPT-4.
+     */
+    class OpenAI {
+        /**
+         * Asks the OpenAI 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 OpenAI GPT-3.5 language model 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>;
+    }
     /**
      * ## Configuration
      *
      * This helper should be configured in codecept.conf.js
      * @property url - base url of website to be tested
-     * @property [browser] - a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
+     * @property [browser = 'chromium'] - a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
      * @property [show = false] - show browser window.
      * @property [restart = false] - restart strategy between tests. Possible values:
      *   * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated.
@@ -2714,10 +2758,12 @@ declare namespace CodeceptJS {
      * @property [channel] - (While Playwright can operate against the stock Google Chrome and Microsoft Edge browsers available on the machine. In particular, current Playwright version will support Stable and Beta channels of these browsers. See [Google Chrome & Microsoft Edge](https://playwright.dev/docs/browsers/#google-chrome--microsoft-edge).
      * @property [ignoreLog] - An array with console message types that are not logged to debug log. Default value is `['warning', 'log']`. E.g. you can set `[]` to log all messages. See all possible [values](https://playwright.dev/docs/api/class-consolemessage#console-message-type).
      * @property [ignoreHTTPSErrors] - Allows access to untrustworthy pages, e.g. to a page with an expired certificate. Default value is `false`
+     * @property [bypassCSP] - bypass Content Security Policy or CSP
+     * @property [highlightElement] - highlight the interacting elements
      */
     type PlaywrightConfig = {
         url: string;
-        browser?: string;
+        browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
         show?: boolean;
         restart?: string | boolean;
         timeout?: number;
@@ -2732,13 +2778,13 @@ declare namespace CodeceptJS {
         keepBrowserState?: boolean;
         keepCookies?: boolean;
         waitForAction?: number;
-        waitForNavigation?: string;
+        waitForNavigation?: 'load' | 'domcontentloaded' | 'networkidle';
         pressKeyDelay?: number;
         getPageTimeout?: number;
         waitForTimeout?: number;
         basicAuth?: any;
         windowSize?: string;
-        colorScheme?: string;
+        colorScheme?: 'dark' | 'light' | 'no-preference';
         userAgent?: string;
         locale?: string;
         manualStart?: boolean;
@@ -2748,6 +2794,8 @@ declare namespace CodeceptJS {
         channel?: any;
         ignoreLog?: string[];
         ignoreHTTPSErrors?: boolean;
+        bypassCSP?: boolean;
+        highlightElement?: boolean;
     };
     /**
      * Uses [Playwright](https://github.com/microsoft/playwright) library to run tests inside:
@@ -2783,7 +2831,7 @@ declare namespace CodeceptJS {
      *
      * #### Trace Recording Customization
      *
-     * Trace recording provides a complete information on test execution and includes DOM snapshots, screenshots, and network requests logged during run.
+     * Trace recording provides complete information on test execution and includes DOM snapshots, screenshots, and network requests logged during run.
      * Traces will be saved to `output/trace`
      *
      * * `trace`: enables trace recording for failed tests; trace are saved into `output/trace` folder
@@ -3078,6 +3126,39 @@ declare namespace CodeceptJS {
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
+        /**
+         * Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.dontSee('#add-to-cart-btn');
+         * I.focus('#product-tile')
+         * I.see('#add-to-cart-bnt');
+         * ```
+         */
+        focus(locator: CodeceptJS.LocatorOrString, options?: any): void;
+        /**
+         * Remove focus from a text input, button, etc
+         * Calls [blur](https://playwright.dev/docs/api/class-locator#locator-blur) on the element.
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.blur('.text-area')
+         * ```
+         * ```js
+         * //element `#product-tile` is focused
+         * I.see('#add-to-cart-btn');
+         * I.blur('#product-tile')
+         * I.dontSee('#add-to-cart-btn');
+         * ```
+         */
+        blur(locator: CodeceptJS.LocatorOrString, options?: any): void;
         /**
          * Drag an item to a destination element.
          *
@@ -3094,7 +3175,7 @@ declare namespace CodeceptJS {
          * I.dragAndDrop('img.src', 'img.dst', { sourcePosition: {x: 10, y: 10} })
          * ```
          *
-         * > By default option `force: true` is set
+         * > When no option is set, custom drag and drop would be used, to use the dragAndDrop API from Playwright, please set options, for example `force: true`
          */
         dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString, options?: any): void;
         /**
@@ -3378,7 +3459,7 @@ declare namespace CodeceptJS {
          * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
          * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
-         * @param [opts] - [Additional options](https://playwright.dev/docs/api/class-page#page-click) for click available as 3rd argument.
+         * @param [options] - [Additional options](https://playwright.dev/docs/api/class-page#page-click) for click available as 3rd argument.
          *
          * Examples:
          *
@@ -3390,7 +3471,7 @@ declare namespace CodeceptJS {
          * I.click('.edit', null, { modifiers: ['Ctrl'] } )
          * ```
          */
-        click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null, opts?: any): void;
+        click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null, options?: any): void;
         /**
          * Clicks link and waits for navigation (deprecated)
          */
@@ -3641,6 +3722,9 @@ declare namespace CodeceptJS {
          *
          * // passing in an array
          * I.type(['T', 'E', 'X', 'T']);
+         *
+         * // passing a secret
+         * I.type(secret('123456'));
          * ```
          * @param key - or array of keys to type.
          * @param [delay = null] - (optional) delay in ms between key presses
@@ -3667,23 +3751,28 @@ declare namespace CodeceptJS {
          */
         fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
-         * Clears a `<textarea>` or text `<input>` element's value.
+         * Clear the <input>, <textarea> or [contenteditable] .
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - [Additional options](https://playwright.dev/docs/api/class-locator#locator-clear) for available options object as 2nd argument.
+         *
+         * Examples:
          *
          * ```js
-         * I.clearField('Email');
-         * I.clearField('user[email]');
-         * I.clearField('#email');
+         * I.clearField('.text-area')
+         * ```
+         * ```js
+         * I.clearField('#submit', { force: true }) // force to bypass the [actionability](https://playwright.dev/docs/actionability) checks.
          * ```
-         * @param editable - field located by label|name|CSS|XPath|strict locator.
-         * ⚠️ returns a _promise_ which is synchronized internally by recorder.
          */
-        clearField(editable: LocatorOrString): void;
+        clearField(locator: CodeceptJS.LocatorOrString, options?: any): void;
         /**
          * Appends text to a input field or textarea.
          * Field is located by name, label, CSS or XPath
          *
          * ```js
          * I.appendField('#myTextField', 'appended');
+         * // typing secret
+         * I.appendField('password', secret('123456'));
          * ```
          * @param field - located by label|name|CSS|XPath|strict locator
          * @param value - text value to append.
@@ -4413,7 +4502,7 @@ declare namespace CodeceptJS {
          *
          * See [Playwright's reference](https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions)
          */
-        waitForNavigation(opts: any): void;
+        waitForNavigation(options: any): void;
         /**
          * Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
          * Element can be located by CSS or XPath.
@@ -4939,6 +5028,8 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.appendField('#myTextField', 'appended');
+         * // typing secret
+         * I.appendField('password', secret('123456'));
          * ```
          * @param field - located by label|name|CSS|XPath|strict locator
          * @param value - text value to append.
@@ -5875,6 +5966,7 @@ declare namespace CodeceptJS {
      * @property [manualStart = false] - do not start browser before a test, start it manually inside a helper with `this.helpers["Puppeteer"]._startBrowser()`.
      * @property [browser = chrome] - can be changed to `firefox` when using [puppeteer-firefox](https://codecept.io/helpers/Puppeteer-firefox).
      * @property [chrome] - pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
+     * @property [highlightElement] - highlight the interacting elements
      */
     type PuppeteerConfig = {
         url: string;
@@ -5896,6 +5988,7 @@ declare namespace CodeceptJS {
         manualStart?: boolean;
         browser?: string;
         chrome?: any;
+        highlightElement?: boolean;
     };
     /**
      * Uses [Google Chrome's Puppeteer](https://github.com/GoogleChrome/puppeteer) library to run tests inside headless Chrome.
@@ -6693,6 +6786,9 @@ declare namespace CodeceptJS {
          *
          * // passing in an array
          * I.type(['T', 'E', 'X', 'T']);
+         *
+         * // passing a secret
+         * I.type(secret('123456'));
          * ```
          * @param key - or array of keys to type.
          * @param [delay = null] - (optional) delay in ms between key presses
@@ -6738,6 +6834,8 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.appendField('#myTextField', 'appended');
+         * // typing secret
+         * I.appendField('password', secret('123456'));
          * ```
          * @param field - located by label|name|CSS|XPath|strict locator
          * @param value - text value to append.
@@ -7616,7 +7714,8 @@ declare namespace CodeceptJS {
      *       endpoint: 'http://site.com/api',
      *       prettyPrintJson: true,
      *       onRequest: (request) => {
-     *       request.headers.auth = '123';
+     *         request.headers.auth = '123';
+     *       }
      *     }
      *   }
      * }
@@ -7675,7 +7774,7 @@ declare namespace CodeceptJS {
          * ```js
          * I.sendGetRequest('/api/users.json');
          * ```
-         * @param [headers = {}] - the headers object 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
          */
         sendGetRequest(url: any, headers?: any): Promise<any>;
@@ -7689,8 +7788,8 @@ declare namespace CodeceptJS {
          * I.sendPostRequest('/api/users.json', secret({ "email": "user@user.com" }));
          *
          * ```
-         * @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
+         * @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
          */
         sendPostRequest(url: any, payload?: any, headers?: any): Promise<any>;
@@ -7730,7 +7829,7 @@ declare namespace CodeceptJS {
          * ```js
          * I.sendDeleteRequest('/api/users/1');
          * ```
-         * @param [headers = {}] - the headers object 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
          */
         sendDeleteRequest(url: any, headers?: any): Promise<any>;
@@ -8005,6 +8104,8 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.appendField('#myTextField', 'appended');
+         * // typing secret
+         * I.appendField('password', secret('123456'));
          * ```
          * @param field - located by label|name|CSS|XPath|strict locator
          * @param value - text value to append.
@@ -8756,7 +8857,7 @@ declare namespace CodeceptJS {
      *
      * This helper should be configured in codecept.conf.js
      * @property url - base url of website to be tested.
-     * @property browser - browser in which to perform testing.
+     * @property browser - Browser in which to perform testing.
      * @property [basicAuth] - (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
      * @property [host = localhost] - WebDriver host to connect.
      * @property [port = 4444] - WebDriver port to connect.
@@ -8774,6 +8875,7 @@ declare namespace CodeceptJS {
      * @property [desiredCapabilities] - Selenium's [desired capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities).
      * @property [manualStart = false] - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriver"]._startBrowser()`.
      * @property [timeouts] - [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
+     * @property [highlightElement] - highlight the interacting elements
      */
     type WebDriverConfig = {
         url: string;
@@ -8795,6 +8897,7 @@ declare namespace CodeceptJS {
         desiredCapabilities?: any;
         manualStart?: boolean;
         timeouts?: any;
+        highlightElement?: boolean;
     };
     /**
      * WebDriver helper which wraps [webdriverio](http://webdriver.io/) library to
@@ -9157,7 +9260,7 @@ declare namespace CodeceptJS {
          */
         _locate(locator: CodeceptJS.LocatorOrString): void;
         /**
-         * Find a checkbox by providing human readable text:
+         * Find a checkbox by providing human-readable text:
          *
          * ```js
          * this.helpers['WebDriver']._locateCheckable('I agree with terms and conditions').then // ...
@@ -9166,7 +9269,7 @@ declare namespace CodeceptJS {
          */
         _locateCheckable(locator: CodeceptJS.LocatorOrString): void;
         /**
-         * Find a clickable element by providing human readable text:
+         * Find a clickable element by providing human-readable text:
          *
          * ```js
          * const els = await this.helpers.WebDriver._locateClickable('Next page');
@@ -9176,7 +9279,7 @@ declare namespace CodeceptJS {
          */
         _locateClickable(locator: CodeceptJS.LocatorOrString): void;
         /**
-         * Find field elements by providing human readable text:
+         * Find field elements by providing human-readable text:
          *
          * ```js
          * this.helpers['WebDriver']._locateFields('Your email').then // ...
@@ -9360,6 +9463,8 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.appendField('#myTextField', 'appended');
+         * // typing secret
+         * I.appendField('password', secret('123456'));
          * ```
          * @param field - located by label|name|CSS|XPath|strict locator
          * @param value - text value to append.
@@ -10239,6 +10344,9 @@ declare namespace CodeceptJS {
          *
          * // passing in an array
          * I.type(['T', 'E', 'X', 'T']);
+         *
+         * // passing a secret
+         * I.type(secret('123456'));
          * ```
          * @param key - or array of keys to type.
          * @param [delay = null] - (optional) delay in ms between key presses
@@ -11134,7 +11242,7 @@ declare namespace CodeceptJS {
          *     true: it will retries if `retryOpts` set.
          *     false: ignore `retryOpts` and won't retry.
          */
-        add(taskName: string | ((...params: any[]) => any), fn?: (...params: any[]) => any, force?: boolean, retry?: boolean, timeout?: number): Promise<any> | undefined;
+        add(taskName: string | ((...params: any[]) => any), fn?: (...params: any[]) => any, force?: boolean, retry?: boolean, timeout?: number): Promise<any>;
         retry(opts: any): any;
         catch(customErrFn?: (...params: any[]) => any): Promise<any>;
         catchWithoutStop(customErrFn: (...params: any[]) => any): Promise<any>;