codeceptjs 4.2.0-beta.3 → 4.2.0

package/typings/types.d.ts

@@ -770,6 +770,36 @@ declare namespace CodeceptJS {
          * @returns Appium: support both Android and iOS
          */
         closeApp(): Promise<void>;
+        /**
+         * Clears the system clipboard.
+         *
+         * ```js
+         * I.clearClipboard();
+         * I.seeClipboardEquals('');
+         * ```
+         * @returns automatically synchronized promise through #recorder
+         *
+         *
+         * Appium: support both Android and iOS
+         */
+        clearClipboard(): void;
+        /**
+         * Grabs the text content of the system clipboard and returns it to test.
+         * Resumes test execution, so **should be used inside async function with `await`** operator.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * let url = await I.grabFromClipboard();
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`) and is supported
+         * in Chromium-based browsers, where read access is granted automatically.
+         * @returns the system clipboard contents.
+         *
+         *
+         * Appium: support both Android and iOS
+         */
+        grabFromClipboard(): Promise<string>;
         /**
          * Appends text to a input field or textarea.
          * Field is located by name, label, CSS or XPath
@@ -2193,6 +2223,56 @@ declare namespace CodeceptJS {
          * @param [name = null] - (optional, `null` by default) cookie name
          */
         clearCookie(name?: string | null): Promise<void>;
+        /**
+         * Checks that the system clipboard contains the given text.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * I.seeInClipboard('https://codecept.io');
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`).
+         * @param text - value to check.
+         */
+        seeInClipboard(text: string): Promise<void>;
+        /**
+         * Checks that the system clipboard is equal to the given text.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * I.seeClipboardEquals('https://codecept.io');
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`).
+         * @param text - value to check.
+         */
+        seeClipboardEquals(text: string): Promise<void>;
+        /**
+         * Clears the system clipboard.
+         *
+         * ```js
+         * I.clearClipboard();
+         * I.seeClipboardEquals('');
+         * ```
+         */
+        clearClipboard(): Promise<void>;
+        /**
+         * Grabs the text content of the system clipboard.
+         * Resumes test execution, so **should be used inside async function with `await`** operator.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * const url = await I.grabFromClipboard();
+         * ```
+         * @returns the system clipboard contents.
+         */
+        grabFromClipboard(): Promise<string>;
+        /**
+         * Brings the current target to front and grants it clipboard read/write access, so
+         * `navigator.clipboard` does not reject with a permission or focus error. Failures are ignored:
+         * a browser without `Browser.grantPermissions` surfaces its own error from the read instead.
+         */
+        protected _grantClipboardAccess(): void;
         /**
          * Saves a screenshot to the output folder (set in codecept.conf.ts or codecept.conf.js).
          * Filename is relative to the output folder.
@@ -3456,6 +3536,17 @@ declare namespace CodeceptJS {
      * elements works, it only pins the config presets Obscura requires and manages the `obscura serve`
      * process lifecycle, the same way Playwright manages its own browser process.
      *
+     * > Obscura support is experimental in CodeceptJS 4.2. Pin the browser version in CI and keep a
+     * > Playwright/WebDriver job for browser-compatibility coverage.
+     *
+     * ## Compatibility
+     *
+     * | CodeceptJS | Recommended Obscura | Notes |
+     * | --- | --- | --- |
+     * | 4.2.x | 0.2.2 | Version used by the CodeceptJS Obscura CI workflow |
+     * | 4.2.x | 0.2.x | Supported; capabilities are detected at runtime |
+     * | 4.2.x | 0.1.x / `-no-render` | DOM-only mode; no layout, visibility assertions, or screenshots |
+     *
      * ## Modes
      *
      * - **ATTACH** — `endpoint` is set explicitly in the config. The helper only connects to it; it
@@ -3473,8 +3564,20 @@ declare namespace CodeceptJS {
      *
      * ## Install
      *
-     * Download a release binary and put it on your `PATH` (or point `binaryPath`/`OBSCURA_PATH` at
-     * it directly) and the helper launches and tears it down for you automatically:
+     * Download a release archive from [Obscura releases](https://github.com/h4ckf0r0day/obscura/releases).
+     * CodeceptJS 4.2 is tested with Obscura 0.2.2. Rendering archives are available for:
+     *
+     * | platform | archive |
+     * | --- | --- |
+     * | Linux x64 | `obscura-x86_64-linux.tar.gz` |
+     * | Linux ARM64 | `obscura-aarch64-linux.tar.gz` |
+     * | macOS Intel | `obscura-x86_64-macos.tar.gz` |
+     * | macOS Apple Silicon | `obscura-aarch64-macos.tar.gz` |
+     * | Windows x64 | `obscura-x86_64-windows.zip` |
+     *
+     * Extract the archive and put `obscura` (`obscura.exe` on Windows) on your `PATH`, or point
+     * `binaryPath`/`OBSCURA_PATH` at it. The helper then launches and tears it down automatically.
+     * For example, on Linux x64:
      *
      * ```sh
      * curl -sL https://github.com/h4ckf0r0day/obscura/releases/download/v0.2.2/obscura-x86_64-linux.tar.gz | tar xz
@@ -5173,6 +5276,58 @@ declare namespace CodeceptJS {
          * @param [cookie = null] - (optional, `null` by default) cookie name
          */
         clearCookie(cookie?: string): void;
+        /**
+         * Checks that the system clipboard contains the given text.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * I.seeInClipboard('https://codecept.io');
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`) and is supported
+         * in Chromium-based browsers, where read access is granted automatically.
+         * @param text - value to check.
+         * @returns automatically synchronized promise through #recorder
+         */
+        seeInClipboard(text: string): void;
+        /**
+         * Checks that the system clipboard is equal to the given text.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * I.seeClipboardEquals('https://codecept.io');
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`) and is supported
+         * in Chromium-based browsers, where read access is granted automatically.
+         * @param text - value to check.
+         * @returns automatically synchronized promise through #recorder
+         */
+        seeClipboardEquals(text: string): void;
+        /**
+         * Grabs the text content of the system clipboard and returns it to test.
+         * Resumes test execution, so **should be used inside async function with `await`** operator.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * let url = await I.grabFromClipboard();
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`) and is supported
+         * in Chromium-based browsers, where read access is granted automatically.
+         * @returns the system clipboard contents.
+         */
+        grabFromClipboard(): Promise<string>;
+        /**
+         * Clears the system clipboard.
+         *
+         * ```js
+         * I.clearClipboard();
+         * I.seeClipboardEquals('');
+         * ```
+         * @returns automatically synchronized promise through #recorder
+         */
+        clearClipboard(): void;
         /**
          * Executes a script on the page:
          *
@@ -7343,6 +7498,58 @@ declare namespace CodeceptJS {
          * @param [cookie = null] - (optional, `null` by default) cookie name
          */
         clearCookie(cookie?: string): void;
+        /**
+         * Checks that the system clipboard contains the given text.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * I.seeInClipboard('https://codecept.io');
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`) and is supported
+         * in Chromium-based browsers, where read access is granted automatically.
+         * @param text - value to check.
+         * @returns automatically synchronized promise through #recorder
+         */
+        seeInClipboard(text: string): void;
+        /**
+         * Checks that the system clipboard is equal to the given text.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * I.seeClipboardEquals('https://codecept.io');
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`) and is supported
+         * in Chromium-based browsers, where read access is granted automatically.
+         * @param text - value to check.
+         * @returns automatically synchronized promise through #recorder
+         */
+        seeClipboardEquals(text: string): void;
+        /**
+         * Grabs the text content of the system clipboard and returns it to test.
+         * Resumes test execution, so **should be used inside async function with `await`** operator.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * let url = await I.grabFromClipboard();
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`) and is supported
+         * in Chromium-based browsers, where read access is granted automatically.
+         * @returns the system clipboard contents.
+         */
+        grabFromClipboard(): Promise<string>;
+        /**
+         * Clears the system clipboard.
+         *
+         * ```js
+         * I.clearClipboard();
+         * I.seeClipboardEquals('');
+         * ```
+         * @returns automatically synchronized promise through #recorder
+         */
+        clearClipboard(): void;
         /**
          * If a function returns a Promise, tt will wait for its resolution.
          *
@@ -9738,6 +9945,58 @@ declare namespace CodeceptJS {
          * @returns attribute value
          */
         grabCookie(name?: string): any;
+        /**
+         * Checks that the system clipboard contains the given text.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * I.seeInClipboard('https://codecept.io');
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`) and is supported
+         * in Chromium-based browsers, where read access is granted automatically.
+         * @param text - value to check.
+         * @returns automatically synchronized promise through #recorder
+         */
+        seeInClipboard(text: string): void;
+        /**
+         * Checks that the system clipboard is equal to the given text.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * I.seeClipboardEquals('https://codecept.io');
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`) and is supported
+         * in Chromium-based browsers, where read access is granted automatically.
+         * @param text - value to check.
+         * @returns automatically synchronized promise through #recorder
+         */
+        seeClipboardEquals(text: string): void;
+        /**
+         * Grabs the text content of the system clipboard and returns it to test.
+         * Resumes test execution, so **should be used inside async function with `await`** operator.
+         *
+         * ```js
+         * I.click('Copy to clipboard');
+         * let url = await I.grabFromClipboard();
+         * ```
+         *
+         * Reading the clipboard requires a secure context (`https` or `localhost`) and is supported
+         * in Chromium-based browsers, where read access is granted automatically.
+         * @returns the system clipboard contents.
+         */
+        grabFromClipboard(): Promise<string>;
+        /**
+         * Clears the system clipboard.
+         *
+         * ```js
+         * I.clearClipboard();
+         * I.seeClipboardEquals('');
+         * ```
+         * @returns automatically synchronized promise through #recorder
+         */
+        clearClipboard(): void;
         /**
          * Waits for the specified cookie in the cookies.
          *