codeceptjs 3.0.4 → 3.0.5

package/typings/types.d.ts

@@ -862,7 +862,7 @@ declare namespace CodeceptJS {
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @param value - text value to fill.
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Retrieves all texts from an element located by CSS or XPath and returns it to test.
          * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -1847,7 +1847,7 @@ declare namespace CodeceptJS {
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @param value - text value to fill.
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Clears a `<textarea>` or text `<input>` element's value.
          *
@@ -1973,17 +1973,16 @@ declare namespace CodeceptJS {
          */
         grabTextFrom(locator: CodeceptJS.LocatorOrString): Promise<string>;
         /**
-         * Retrieves a value from a form element located by CSS or XPath and returns it to test.
+         * Retrieves an array of value from a form located by CSS or XPath and returns it to test.
          * Resumes test execution, so **should be used inside async function with `await`** operator.
-         * If more than one element is found - value of first element is returned.
          *
          * ```js
-         * let email = await I.grabValueFrom('input[name=email]');
+         * let inputs = await I.grabValueFromAll('//form/input');
          * ```
          * @param locator - field located by label|name|CSS|XPath|strict locator.
          * @returns attribute value
          */
-        grabValueFromAll(locator: CodeceptJS.LocatorOrString): Promise<string>;
+        grabValueFromAll(locator: CodeceptJS.LocatorOrString): Promise<string[]>;
         /**
          * Retrieves a value from a form element located by CSS or XPath and returns it to test.
          * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -2705,11 +2704,12 @@ declare namespace CodeceptJS {
         /**
          * Checks that title is equal to provided one.
          *
-         * ```js
-         * I.seeTitleEquals('Test title.');
-         * ```
+         *  ```js
+         *  I.seeTitleEquals('Test title.');
+         *  ```
+         * @param text - value to check.
          */
-        seeTitleEquals(): void;
+        seeTitleEquals(text: string): void;
         /**
          * Checks that title does not contain text.
          *
@@ -2907,14 +2907,34 @@ declare namespace CodeceptJS {
          */
         clickLink(): void;
         /**
-         * Force clicks an element without waiting for it to become visible and not animating.
+         * Perform an emulated click on a link or a button, given by a locator.
+         * Unlike normal click instead of sending native event, emulates a click with JavaScript.
+         * This works on hidden, animated or inactive elements as well.
+         *
+         * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
+         * For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
+         * For images, the "alt" attribute and inner text of any parent links are searched.
+         *
+         * The second parameter is a context (CSS or XPath locator) to narrow the search.
          *
          * ```js
-         * I.forceClick('#hiddenButton');
-         * I.forceClick('Click me', '#hidden');
+         * // simple link
+         * I.forceClick('Logout');
+         * // button of form
+         * I.forceClick('Submit');
+         * // CSS button
+         * I.forceClick('#form input[type=submit]');
+         * // XPath
+         * I.forceClick('//form/*[@type=submit]');
+         * // link in context
+         * I.forceClick('Logout', '#nav');
+         * // using strict locator
+         * I.forceClick({css: 'nav a.login'});
          * ```
+         * @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.
          */
-        forceClick(): void;
+        forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
         /**
          * Performs a double-click on an element matched by link|button|label|CSS or XPath.
          * Context can be specified as second parameter to narrow search.
@@ -3122,7 +3142,7 @@ declare namespace CodeceptJS {
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @param value - text value to fill.
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Clears a `<textarea>` or text `<input>` element's value.
          *
@@ -3442,8 +3462,10 @@ declare namespace CodeceptJS {
          * I.executeScript(([x, y]) => x + y, [x, y]);
          * ```
          * If a function returns a Promise it will wait for its resolution.
+         * @param fn - function to be executed in browser context.
+         * @param [arg] - optional argument to pass to the function
          */
-        executeScript(): void;
+        executeScript(fn: string | ((...params: any[]) => any), arg?: any): Promise<any>;
         /**
          * Retrieves a text from an element located by CSS or XPath and returns it to test.
          * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -3803,7 +3825,7 @@ declare namespace CodeceptJS {
         /**
          * Waits for navigation to finish. By default takes configured `waitForNavigation` option.
          *
-         * See [Pupeteer's reference](https://github.com/microsoft/Playwright/blob/master/docs/api.md#pagewaitfornavigationoptions)
+         * See [Playwright's reference](https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions)
          */
         waitForNavigation(opts: any): void;
         /**
@@ -4243,7 +4265,7 @@ declare namespace CodeceptJS {
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @param value - text value to fill.
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Presses a key on a focused element.
          * Special keys like 'Enter', 'Control', [etc](https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value)
@@ -5961,7 +5983,7 @@ declare namespace CodeceptJS {
          *
          * {{ react }}
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Clears a `<textarea>` or text `<input>` element's value.
          *
@@ -6850,6 +6872,10 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.sendPostRequest('/api/users.json', { "email": "user@user.com" });
+         *
+         * // To mask the payload in logs
+         * 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
@@ -6860,6 +6886,10 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.sendPatchRequest('/api/users.json', { "email": "user@user.com" });
+         *
+         * // To mask the payload in logs
+         * I.sendPatchRequest('/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
@@ -6870,6 +6900,10 @@ declare namespace CodeceptJS {
          *
          * ```js
          * I.sendPutRequest('/api/users.json', { "email": "user@user.com" });
+         *
+         * // To mask the payload in logs
+         * I.sendPutRequest('/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
@@ -7130,7 +7164,7 @@ declare namespace CodeceptJS {
          * @param field - located by label|name|CSS|XPath|strict locator.
          * @param value - text value to fill.
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Clears a `<textarea>` or text `<input>` element's value.
          *
@@ -8418,7 +8452,7 @@ declare namespace CodeceptJS {
          *
          * {{ react }}
          */
-        fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
          * Appends text to a input field or textarea.
          * Field is located by name, label, CSS or XPath