codeceptjs 3.3.7-beta.1 → 3.3.7

package/typings/types.d.ts

@@ -288,6 +288,16 @@ declare namespace CodeceptJS {
          * ```
          */
         runOnAndroid(caps: any, fn: any): void;
+        /**
+         * Returns app installation status.
+         *
+         * ```js
+         * I.checkIfAppIsInstalled("com.example.android.apis");
+         * ```
+         * @param bundleId - String  ID of bundled app
+         * @returns Appium: support only Android
+         */
+        checkIfAppIsInstalled(bundleId: string): Promise<boolean>;
         /**
          * Check if an app is installed.
          *
@@ -329,6 +339,14 @@ declare namespace CodeceptJS {
          * @param [bundleId] - ID of bundle
          */
         removeApp(appId: string, bundleId?: string): void;
+        /**
+         * Reset the currently running app for current session.
+         *
+         * ```js
+         * I.resetApp();
+         * ```
+         */
+        resetApp(): void;
         /**
          * Check current activity on an Android device.
          *
@@ -1248,11 +1266,11 @@ declare namespace CodeceptJS {
          * )
          * const user = response.data.data;
          * ```
-         * @param variables - that may go along with the query
-         * @param options - are additional query options
+         * @param [variables] - that may go along with the query
+         * @param [options] - are additional query options
          * @returns Promise<any>
          */
-        sendQuery(query: string, variables: any, options: any, headers: any): any;
+        sendQuery(query: string, variables?: any, options?: any, headers?: any): any;
         /**
          * Send query to GraphQL endpoint over http
          *
@@ -1273,11 +1291,11 @@ declare namespace CodeceptJS {
          *   },
          * });
          * ```
-         * @param variables - that may go along with the mutation
-         * @param options - are additional query options
+         * @param [variables] - that may go along with the mutation
+         * @param [options] - are additional query options
          * @returns Promise<any>
          */
-        sendMutation(mutation: string, variables: any, options: any, headers: any): any;
+        sendMutation(mutation: string, variables?: any, options?: any, headers?: any): any;
     }
     /**
      * Helper for managing remote data using GraphQL queries.
@@ -2670,7 +2688,7 @@ declare namespace CodeceptJS {
         /**
          * a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
          */
-        browser: string;
+        browser?: string;
         /**
          * show browser window.
          */
@@ -2772,6 +2790,10 @@ declare namespace CodeceptJS {
          * pass additional chromium options
          */
         chromium?: any;
+        /**
+         * pass additional firefox options
+         */
+        firefox?: any;
         /**
          * (pass additional electron options
          */
@@ -2780,6 +2802,14 @@ declare namespace CodeceptJS {
          * (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).
          */
         channel?: any;
+        /**
+         * 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).
+         */
+        ignoreLog?: string[];
+        /**
+         * Allows access to untrustworthy pages, e.g. to a page with an expired certificate. Default value is `false`
+         */
+        ignoreHTTPSErrors?: boolean;
     };
     /**
      * Uses [Playwright](https://github.com/microsoft/playwright) library to run tests inside:
@@ -3045,6 +3075,12 @@ declare namespace CodeceptJS {
          * ```
          */
         grabPopupText(): Promise<string | null>;
+        /**
+         * Create a new browser context with a page. \
+         * Usually it should be run from a custom helper after call of `_startBrowser()`
+         * @param [contextOptions] - See https://playwright.dev/docs/api/class-browser#browser-new-context
+         */
+        _createContextPage(contextOptions?: any): void;
         /**
          * Opens a web page in a browser. Requires relative or absolute url.
          * If url starts with `/`, opens a web page of a site defined in `url` config parameter.
@@ -3123,6 +3159,20 @@ declare namespace CodeceptJS {
          * > By default option `force: true` is set
          */
         dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString, options?: any): void;
+        /**
+         * Restart browser with a new context and a new page
+         *
+         * ```js
+         * // Restart browser and use a new timezone
+         * I.restartBrowser({ timezoneId: 'America/Phoenix' });
+         * // Open URL in a new page in changed timezone
+         * I.amOnPage('/');
+         * // Restart browser, allow reading/copying of text from/into clipboard in Chrome
+         * I.restartBrowser({ permissions: ['clipboard-read', 'clipboard-write'] });
+         * ```
+         * @param [contextOptions] - [Options for browser context](https://playwright.dev/docs/api/class-browser#browser-new-context) when starting new browser
+         */
+        restartBrowser(contextOptions?: any): void;
         /**
          * Reload the current page.
          *
@@ -3350,7 +3400,7 @@ declare namespace CodeceptJS {
          */
         dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
         /**
-         * Handles a file download.Aa file name is required to save the file on disk.
+         * Handles a file download. A file name is required to save the file on disk.
          * Files are saved to "output" directory.
          *
          * Should be used with [FileSystem helper](https://codecept.io/helpers/FileSystem) to check that file were downloaded correctly.
@@ -3359,10 +3409,10 @@ declare namespace CodeceptJS {
          * I.handleDownloads('downloads/avatar.jpg');
          * I.click('Download Avatar');
          * I.amInPath('output/downloads');
-         * I.waitForFile('downloads/avatar.jpg', 5);
+         * I.waitForFile('avatar.jpg', 5);
          *
          * ```
-         * @param [fileName = downloads] - set filename for downloaded file
+         * @param [fileName] - set filename for downloaded file
          */
         handleDownloads(fileName?: string): Promise<void>;
         /**
@@ -4023,7 +4073,7 @@ declare namespace CodeceptJS {
          * @param fn - function to be executed in browser context.
          * @param [arg] - optional argument to pass to the function
          */
-        executeScript(fn: string | ((...params: any[]) => any), arg?: any): void;
+        executeScript(fn: string | ((...params: any[]) => any), arg?: any): Promise<any>;
         /**
          * Grab Locator if called within Context
          */
@@ -8857,7 +8907,7 @@ declare namespace CodeceptJS {
          */
         protocol?: string;
         /**
-         * path to WebDriver server,
+         * path to WebDriver server.
          * @defaultValue /wd/hub
          */
         path?: string;