codeceptjs 3.5.0 → 3.5.2

package/typings/promiseBasedTypes.d.ts

@@ -2879,6 +2879,22 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
+     * * #### Example #9: Launch electron test
+     *
+     * ```js
+     * {
+     *  helpers: {
+     *     Playwright: {
+     *       browser: 'electron',
+     *       electron: {
+     *         executablePath: require("electron"),
+     *         args: [path.join('../', "main.js")],
+     *       },
+     *     }
+     *   },
+     * }
+     * ```
+     *
      * Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
      *
      * ## Access From Helpers
@@ -3045,8 +3061,6 @@ declare namespace CodeceptJS {
         moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
         /**
          * 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:
          *
@@ -3055,13 +3069,13 @@ declare namespace CodeceptJS {
          * I.focus('#product-tile')
          * I.see('#add-to-cart-bnt');
          * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
          */
         focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
         /**
-         * 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.
+         * Remove focus from a text input, button, etc.
+         * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
          *
          * Examples:
          *
@@ -3074,6 +3088,8 @@ declare namespace CodeceptJS {
          * I.blur('#product-tile')
          * I.dontSee('#add-to-cart-btn');
          * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
          */
         blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
         /**
@@ -3668,18 +3684,20 @@ declare namespace CodeceptJS {
          */
         fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
         /**
-         * 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.
+         * Clears the text input element: `<input>`, `<textarea>` or `[contenteditable]` .
+         *
          *
          * Examples:
          *
          * ```js
          * I.clearField('.text-area')
+         *
+         * // if this doesn't work use force option
+         * I.clearField('#submit', { force: true })
          * ```
-         * ```js
-         * I.clearField('#submit', { force: true }) // force to bypass the [actionability](https://playwright.dev/docs/actionability) checks.
-         * ```
+         * Use `force` to bypass the [actionability](https://playwright.dev/docs/actionability) checks.
+         * @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.
          */
         clearField(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
         /**
@@ -6118,6 +6136,39 @@ declare namespace CodeceptJS {
          * {{ react }}
          */
         moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
+        /**
+         * Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.dontSee('#add-to-cart-btn');
+         * I.focus('#product-tile')
+         * I.see('#add-to-cart-bnt');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
+         */
+        focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
+        /**
+         * Remove focus from a text input, button, etc.
+         * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
+         *
+         * 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');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
+         */
+        blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
         /**
          * Drag an item to a destination element.
          *
@@ -7867,6 +7918,39 @@ declare namespace CodeceptJS {
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         resizeWindow(width: number, height: number): Promise<any>;
+        /**
+         * Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.dontSee('#add-to-cart-btn');
+         * I.focus('#product-tile')
+         * I.see('#add-to-cart-bnt');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
+         */
+        focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
+        /**
+         * Remove focus from a text input, button, etc.
+         * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
+         *
+         * 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');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
+         */
+        blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
         /**
          * Perform a click on a link or a button, given by a locator.
          * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
@@ -8369,7 +8453,7 @@ declare namespace CodeceptJS {
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
-         * If a function returns a Promise It will wait for it resolution.
+         * If a function returns a Promise It will wait for its resolution.
          */
         executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
         /**
@@ -10163,6 +10247,39 @@ declare namespace CodeceptJS {
          * Appium: not tested in web, in apps doesn't work
          */
         resizeWindow(width: number, height: number): Promise<any>;
+        /**
+         * Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.dontSee('#add-to-cart-btn');
+         * I.focus('#product-tile')
+         * I.see('#add-to-cart-bnt');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
+         */
+        focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
+        /**
+         * Remove focus from a text input, button, etc.
+         * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
+         *
+         * 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');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
+         */
+        blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
         /**
          * Drag an item to a destination element.
          *

package/typings/types.d.ts

@@ -2722,10 +2722,10 @@ declare namespace CodeceptJS {
     /**
      * ## Configuration
      *
-     * This helper should be configured in codecept.conf.js
-     * @property url - base url of website to be tested
+     * This helper should be configured in codecept.conf.(js|ts)
+     * @property [url] - base url of website to be tested
      * @property [browser = 'chromium'] - a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
-     * @property [show = false] - show browser window.
+     * @property [show = true] - 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.
      *   * 'browser' or **true** - closes browser and opens it again between tests.
@@ -2762,7 +2762,7 @@ declare namespace CodeceptJS {
      * @property [highlightElement] - highlight the interacting elements
      */
     type PlaywrightConfig = {
-        url: string;
+        url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
         show?: boolean;
         restart?: string | boolean;
@@ -2961,6 +2961,22 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
+     * * #### Example #9: Launch electron test
+     *
+     * ```js
+     * {
+     *  helpers: {
+     *     Playwright: {
+     *       browser: 'electron',
+     *       electron: {
+     *         executablePath: require("electron"),
+     *         args: [path.join('../', "main.js")],
+     *       },
+     *     }
+     *   },
+     * }
+     * ```
+     *
      * Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
      *
      * ## Access From Helpers
@@ -3128,8 +3144,6 @@ declare namespace CodeceptJS {
         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:
          *
@@ -3138,13 +3152,13 @@ declare namespace CodeceptJS {
          * I.focus('#product-tile')
          * I.see('#add-to-cart-bnt');
          * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
          */
         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.
+         * Remove focus from a text input, button, etc.
+         * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
          *
          * Examples:
          *
@@ -3157,6 +3171,8 @@ declare namespace CodeceptJS {
          * I.blur('#product-tile')
          * I.dontSee('#add-to-cart-btn');
          * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
          */
         blur(locator: CodeceptJS.LocatorOrString, options?: any): void;
         /**
@@ -3751,18 +3767,20 @@ declare namespace CodeceptJS {
          */
         fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
-         * 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.
+         * Clears the text input element: `<input>`, `<textarea>` or `[contenteditable]` .
+         *
          *
          * Examples:
          *
          * ```js
          * I.clearField('.text-area')
+         *
+         * // if this doesn't work use force option
+         * I.clearField('#submit', { force: true })
          * ```
-         * ```js
-         * I.clearField('#submit', { force: true }) // force to bypass the [actionability](https://playwright.dev/docs/actionability) checks.
-         * ```
+         * Use `force` to bypass the [actionability](https://playwright.dev/docs/actionability) checks.
+         * @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.
          */
         clearField(locator: CodeceptJS.LocatorOrString, options?: any): void;
         /**
@@ -6250,6 +6268,39 @@ declare namespace CodeceptJS {
          * {{ react }}
          */
         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.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.dontSee('#add-to-cart-btn');
+         * I.focus('#product-tile')
+         * I.see('#add-to-cart-bnt');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
+         */
+        focus(locator: CodeceptJS.LocatorOrString, options?: any): void;
+        /**
+         * Remove focus from a text input, button, etc.
+         * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
+         *
+         * 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');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
+         */
+        blur(locator: CodeceptJS.LocatorOrString, options?: any): void;
         /**
          * Drag an item to a destination element.
          *
@@ -8019,6 +8070,39 @@ declare namespace CodeceptJS {
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         resizeWindow(width: number, height: number): void;
+        /**
+         * Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.dontSee('#add-to-cart-btn');
+         * I.focus('#product-tile')
+         * I.see('#add-to-cart-bnt');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
+         */
+        focus(locator: CodeceptJS.LocatorOrString, options?: any): void;
+        /**
+         * Remove focus from a text input, button, etc.
+         * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
+         *
+         * 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');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
+         */
+        blur(locator: CodeceptJS.LocatorOrString, options?: any): void;
         /**
          * Perform a click on a link or a button, given by a locator.
          * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
@@ -8521,7 +8605,7 @@ declare namespace CodeceptJS {
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
-         * If a function returns a Promise It will wait for it resolution.
+         * If a function returns a Promise It will wait for its resolution.
          */
         executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): void;
         /**
@@ -10363,6 +10447,39 @@ declare namespace CodeceptJS {
          * Appium: not tested in web, in apps doesn't work
          */
         resizeWindow(width: number, height: number): void;
+        /**
+         * Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.dontSee('#add-to-cart-btn');
+         * I.focus('#product-tile')
+         * I.see('#add-to-cart-bnt');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
+         */
+        focus(locator: CodeceptJS.LocatorOrString, options?: any): void;
+        /**
+         * Remove focus from a text input, button, etc.
+         * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
+         *
+         * 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');
+         * ```
+         * @param locator - field located by label|name|CSS|XPath|strict locator.
+         * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
+         */
+        blur(locator: CodeceptJS.LocatorOrString, options?: any): void;
         /**
          * Drag an item to a destination element.
          *