@applitools/eyes-cypress 3.50.3 → 3.52.0

package/CHANGELOG.md

@@ -1,5 +1,135 @@
 # Changelog
 
+## [3.52.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-cypress@3.51.0...js/eyes-cypress@3.52.0) (2025-04-17)
+
+
+### Features
+
+* height layout breakpoints ([#2801](https://github.com/Applitools-Dev/sdk/issues/2801)) ([819e241](https://github.com/Applitools-Dev/sdk/commit/819e2418f1fd93220a07dfbcf1157ffcf4995dd7))
+
+
+### Bug Fixes
+
+* simplify sandbox creation and ensure cleanup after execution ([#2869](https://github.com/Applitools-Dev/sdk/issues/2869)) ([72c5e01](https://github.com/Applitools-Dev/sdk/commit/72c5e01307f6abd83fab365a7e235124caae0694))
+
+
+### Performance Improvements
+
+* cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.18
+  #### Bug Fixes
+
+  * simplify sandbox creation and ensure cleanup after execution ([#2869](https://github.com/Applitools-Dev/sdk/issues/2869)) ([72c5e01](https://github.com/Applitools-Dev/sdk/commit/72c5e01307f6abd83fab365a7e235124caae0694))
+
+
+
+* @applitools/snippets bumped to 2.6.5
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+* @applitools/driver bumped to 1.21.1
+  #### Bug Fixes
+
+  * executePoll error logging FLD-2870 ([#2890](https://github.com/Applitools-Dev/sdk/issues/2890)) ([a8ff720](https://github.com/Applitools-Dev/sdk/commit/a8ff720efafacabe2023282748a6d8a0f1b3ff73))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.2.2
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/spec-driver-selenium bumped to 1.5.98
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.27
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/screenshoter bumped to 3.11.1
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/nml-client bumped to 1.9.1
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/tunnel-client bumped to 1.6.5
+  #### Bug Fixes
+
+  * enhance error messages in tunnel client ([cab26e6](https://github.com/Applitools-Dev/sdk/commit/cab26e6e3d56fa3cbabaa1a9c68de13046b8f57e))
+* @applitools/ufg-client bumped to 1.16.9
+  #### Bug Fixes
+
+  * basic auth protected resources | FLD-2761 | FMRI-120 ([#2444](https://github.com/Applitools-Dev/sdk/issues/2444)) ([b48cf49](https://github.com/Applitools-Dev/sdk/commit/b48cf49dec50bbf1ed2ba111608a48cf09962565))
+
+
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+* @applitools/ec-client bumped to 1.10.9
+  #### Performance Improvements
+
+  * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
+
+
+
+* @applitools/core bumped to 4.37.0
+  #### Features
+
+  * height layout breakpoints ([#2801](https://github.com/Applitools-Dev/sdk/issues/2801)) ([819e241](https://github.com/Applitools-Dev/sdk/commit/819e2418f1fd93220a07dfbcf1157ffcf4995dd7))
+
+
+
+* @applitools/eyes bumped to 1.34.0
+  #### Features
+
+  * height layout breakpoints ([#2801](https://github.com/Applitools-Dev/sdk/issues/2801)) ([819e241](https://github.com/Applitools-Dev/sdk/commit/819e2418f1fd93220a07dfbcf1157ffcf4995dd7))
+
+
+  #### Bug Fixes
+
+  * add checks for undefined regions in CheckSettings | AD-9042 ([#2868](https://github.com/Applitools-Dev/sdk/issues/2868)) ([0f7c991](https://github.com/Applitools-Dev/sdk/commit/0f7c9913d64e0535ba5ffe632923a3bf440be65f))
+
+
+
+
+## [3.51.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-cypress@3.50.3...js/eyes-cypress@3.51.0) (2025-04-03)
+
+
+### Features
+
+* allow sending callback functions to waitBeforeCapture ([#2780](https://github.com/Applitools-Dev/sdk/issues/2780)) ([4caa2e8](https://github.com/Applitools-Dev/sdk/commit/4caa2e8ae055d3dd48164eeceaa4c691eeadcdd4))
+
+
+### Dependencies
+
+* @applitools/core bumped to 4.35.1
+  #### Bug Fixes
+
+  * dummy ([9b8ffef](https://github.com/Applitools-Dev/sdk/commit/9b8ffef6277015a9073caf50f5dc5741986fbf07))
+* @applitools/eyes bumped to 1.33.2
+
+
 ## [3.50.3](https://github.com/Applitools-Dev/sdk/compare/js/eyes-cypress@3.50.2...js/eyes-cypress@3.50.3) (2025-03-06)
 
 

package/README.md

@@ -1,12 +1,147 @@
-<div align="center">
+## Applitools Eyes SDK for [Cypress](https://www.cypress.io/)
 
-![Applitools Eyes](https://i.ibb.co/3hWJK68/applitools-eyes-logo.png)
-### Applitools Eyes SDK for [Cypress](https://www.cypress.io/)
-[![npm](https://img.shields.io/npm/v/@applitools/eyes-cypress.svg?style=for-the-badge)](https://www.npmjs.com/package/@applitools/eyes-cypress)
+The Cypress SDK allows you to leverage the Applitools [Ultrafast Grid](/concepts/test-execution/ultrafast-grid) to automatically run tests across all major browsers.
 
-</div>
-<br/>
+For general information about working with Cypress, see [Cypress Testing Framework](https://applitools.com/learn/frameworks/cypress-testing/) on the Applitools website.
 
-## Resources
-- [Quick start](https://applitools.com/tutorials/quickstart/web/cypress)
-- [API reference](https://applitools.com/docs/api-ref/sdk-api/cypress/)
+## Installing Eyes Cypress
+
+Run the following
+```bash
+npm i --save @applitools/eyes-cypress
+```
+
+or
+```bash
+yarn add @applitools/eyes-cypress
+```
+
+
+## Setting up the project
+
+On the project, run the following:
+
+```bash
+npx eyes-setup
+```
+
+### Modifying the configuration file
+
+If `npx eyes-setup` did not run successfully, modify the configuration file as follows:
+
+#### Cypress version 10 or later
+
+Add the following to the `cypress.config.js` file:
+
+```js
+const { defineConfig } = require('cypress')
+const eyesPlugin = require('@applitools/eyes-cypress')
+module.exports = eyesPlugin(defineConfig({
+  // the e2e or component configuration
+  e2e: {
+    setupNodeEvents(on, config) {
+    }
+  }
+}))
+```
+
+#### Cypress version earlier than version 10:
+
+In the `pluginsFile` file, add the following **after** the definition of `module.exports`:
+
+```js
+require('@applitools/eyes-cypress')(module)
+```
+
+### IntelliSense code completion
+
+You can add Eyes-Cypress IntelliSense to your tests using one of the following methods:
+
+* [Triple slash directives](#slash)
+* [Reference type declarations via `tsconfig`](#reference)
+
+
+### Triple slash directives {#slash}
+
+The simplest way to see IntelliSense when typing an Eyes-Cypress command is to add a [triple-slash](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html) directive to the head of your JavaScript or TypeScript testing file. This will turn the IntelliSense on a per file basis:
+
+```
+  /// <reference types="@applitools/eyes-cypress" />
+```
+
+### Reference type declarations via `tsconfig` {#reference}
+
+Eyes-Cypress ships with official type declarations for TypeScript. This allows you to add eyes commands to your TypeScript tests.
+If you do not have TypeScript, for example you use JavaScript, you can add IntelliSense declarations to the project using one of the following:
+
+- Add  the path to your [`tsconfig`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) file:
+
+```json
+{
+  "compileroptions": {
+    "types": ["@applitools/eyes-cypress", "cypress", "node"]
+   }
+}
+```
+
+- In the `cypress/support` folder, create a file `index.d.ts`  that contains:
+```js
+import "@applitools/eyes-cypress"
+```
+
+Normally, this is `cypress/plugins/index.js`. For details, see the [Cypress documentation](https://docs.cypress.io/guides/references/configuration.html#Folders-Files).
+
+
+
+#### Configure custom commands manually
+
+Eyes-Cypress exposes new commands to your tests. This means that additional methods will be available on the `cy` object.
+If `npx eyes-setup` does not work, you need to configure these custom commands. As with the plugin, there is no automatic way to configure this in Cypress, so you need to manually add the following code to your `supportFile`:
+
+```js
+import '@applitools/eyes-cypress/commands'
+```
+
+### Entering the Applitools API key{#API}
+
+To authenticate via the Applitools server and run tests, you need to set the environment variable `APPLITOOLS_API_KEY` to the API key provided from Applitools Eyes. For details how to retrieve your API key, see [the Applitools documentation](/getting-started/retrieve-api-key).
+
+
+#### Entering the API Key on Linux or a Mac
+
+```bash
+export APPLITOOLS_API_KEY=<API_key>
+npx cypress open
+```
+
+#### Entering the API Key on Windows
+
+```bash
+set APPLITOOLS_API_KEY=<API_key>
+npx cypress open
+```
+
+### Eyes server URL {#URL}
+
+If the Eyes server is not deployed in `https://eyes.applitools.com`, you need to set the Server URL in the environment variable `APPLITOOLS_SERVER_URL`  before running tests.
+
+The server URL of your Applitools Eyes dashboard is in the format `https://<MY_COMPANY>.applitools.com`
+
+#### Entering the server URL on Linux or a Mac
+
+```bash
+export APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>
+```
+
+#### Entering the server URL on Windows
+
+```bash
+set APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>
+```
+## Further information
+
+For further information, see:
+
+* [Quickstart](https://applitools.com/tutorials/sdks/cypress/quickstart)
+* [Overview](https://applitools.com/tutorials/sdks/cypress)
+* [Changelog](https://applitools.com/tutorials/sdks/cypress/changelog)	

package/dist/browser/refer.js

@@ -0,0 +1,82 @@
+"use strict";
+/* global Node */
+Object.defineProperty(exports, "__esModule", { value: true });
+const uuid = require('uuid');
+const REF_ID = 'applitools-ref-id';
+class Refer {
+    constructor() {
+        this.store = new Map();
+        this.relation = new Map();
+    }
+    isRef(ref) {
+        // isRef(ref) {
+        return Boolean(ref && ref[REF_ID]);
+    }
+    check(value) {
+        // check(value) {
+        if (!value)
+            return;
+        if (value === '__CYPRESS_DRIVER__') {
+            return 'cypress-driver';
+        }
+        else if (value.nodeType === Node.ELEMENT_NODE) {
+            return 'element';
+        }
+        else if (value.nodeType === Node.DOCUMENT_NODE || value.ownerDocument) {
+            return 'context';
+        }
+        else if (value.constructor && value.constructor.name === 'Window') {
+            return 'driver';
+        }
+        else if (typeof value === 'function') {
+            return 'function';
+        }
+    }
+    ref(value, parentRef) {
+        // ref(value, parentRef) {
+        const refType = this.check(value);
+        if (refType) {
+            const ref = uuid.v4();
+            this.store.set(ref, value);
+            if (parentRef) {
+                let childRefs = this.relation.get(parentRef[REF_ID]);
+                if (!childRefs) {
+                    childRefs = new Set();
+                    this.relation.set(parentRef[REF_ID], childRefs);
+                }
+                childRefs.add({ [REF_ID]: ref });
+            }
+            return { [REF_ID]: ref, type: refType };
+        }
+        else if (Array.isArray(value)) {
+            return value.map(value => this.ref(value, parentRef));
+        }
+        else if (typeof value === 'object' && value !== null) {
+            return Object.entries(value).reduce((obj, [key, value]) => {
+                return Object.assign(obj, { [key]: this.ref(value, parentRef) });
+            }, {});
+        }
+        else {
+            return value;
+        }
+    }
+    deref(ref) {
+        if (this.isRef(ref)) {
+            const value = this.store.get(ref[REF_ID]);
+            return value === '__CYPRESS_DRIVER__' ? cy.state('document') : value;
+        }
+        else {
+            return ref;
+        }
+    }
+    destroy(ref) {
+        if (!this.isRef(ref))
+            return;
+        const childRefs = this.relation.get(ref[REF_ID]);
+        if (childRefs) {
+            childRefs.forEach(childRef => this.destroy(childRef));
+        }
+        this.store.delete(ref[REF_ID]);
+    }
+}
+module.exports = Refer;

package/dist/browser/spec-driver.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reload = exports.getCookies = exports.getUrl = exports.getTitle = exports.findElements = exports.findElement = exports.transformSelector = exports.setViewportSize = exports.getViewportSize = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = void 0;
+exports.executeUserFunction = exports.reload = exports.getCookies = exports.getUrl = exports.getTitle = exports.findElements = exports.findElement = exports.transformSelector = exports.setViewportSize = exports.getViewportSize = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = void 0;
 function executeScript(context, script, arg) {
     let scriptToExecute;
     if (script.includes('dom-snapshot') || script.includes('dom-capture') || script.includes('dom-shared')) {
@@ -118,6 +118,14 @@ function reload() {
     });
 }
 exports.reload = reload;
+async function executeUserFunction(fn) {
+    if (typeof fn !== 'function') {
+        console.error('Not a function:', fn);
+        throw new Error(`Not a function: ${JSON.stringify(fn)}`);
+    }
+    return fn();
+}
+exports.executeUserFunction = executeUserFunction;
 // export function takeScreenshot(page: Driver): Promise<Buffer>;
 // export function visit(page: Driver, url: string): Promise<void>; (??)
 // export function isStaleElementError(err: any): boolean;

package/dist/browser/transformCypressCheckSettings.js

@@ -54,7 +54,9 @@ function transformCypressCheckSettings(settings, refer) {
         ignoreCaret: settings.ignoreCaret,
         ignoreDisplacements: settings.ignoreDisplacements,
         fully: settings.fully,
-        waitBeforeCapture: settings.waitBeforeCapture,
+        waitBeforeCapture: typeof settings.waitBeforeCapture === 'number'
+            ? settings.waitBeforeCapture
+            : settings.waitBeforeCapture && refer.ref(settings.waitBeforeCapture),
         lazyLoad: settings.lazyLoad,
         matchLevel: settings.matchLevel,
         useDom: settings.useDom,

package/dist/browser/transformCypressConfig.js

@@ -26,7 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformCypressConfig = void 0;
 const utils_1 = require("./utils");
 const utils = __importStar(require("@applitools/utils"));
-function transformCypressConfig(config) {
+function transformCypressConfig(config, refer) {
     var _a, _b, _c, _d, _e, _f, _g, _h;
     return {
         open: {
@@ -85,10 +85,14 @@ function transformCypressConfig(config) {
             stitchMode: config.stitchMode,
             autProxy: config.autProxy,
             scrollRootElement: config.scrollRootElement,
-            waitBeforeCapture: config.waitBeforeCapture,
+            waitBeforeCapture: typeof config.waitBeforeCapture === 'number'
+                ? config.waitBeforeCapture
+                : config.waitBeforeCapture && refer.ref(config.waitBeforeCapture),
         },
         screenshot: {
-            waitBeforeCapture: config.waitBeforeCapture,
+            waitBeforeCapture: typeof config.waitBeforeCapture === 'number'
+                ? config.waitBeforeCapture
+                : config.waitBeforeCapture && refer.ref(config.waitBeforeCapture),
             autProxy: config.autProxy,
             scrollRootElement: config.scrollRootElement,
             hideScrollbars: config.hideScrollbars,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.50.3",
+  "version": "3.52.0",
   "homepage": "https://applitools.com/docs/api-ref/sdk-api/cypress/",
   "license": "SEE LICENSE IN LICENSE",
   "main": "./index.js",
@@ -54,11 +54,11 @@
     "setup": "run --top-level xvfb:setup"
   },
   "dependencies": {
-    "@applitools/core": "4.32.2",
-    "@applitools/eyes": "1.32.6",
+    "@applitools/core": "4.37.0",
+    "@applitools/eyes": "1.34.0",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "2.1.1",
-    "@applitools/utils": "1.7.8",
+    "@applitools/logger": "2.1.2",
+    "@applitools/utils": "1.8.0",
     "boxen": "5.1.2",
     "chalk": "3.0.0",
     "semver": "7.6.2",

package/src/browser/commands.js

@@ -1,7 +1,7 @@
 /* global Cypress,cy,after */
 'use strict'
 const spec = require('../../dist/browser/spec-driver')
-const Refer = require('./refer')
+const Refer = require('../../dist/browser/refer')
 const Socket = require('./socket')
 const {socketCommands} = require('./socketCommands')
 const {TestResultsSummaryData: TestResultsSummary} = require('@applitools/eyes/dist/output/TestResultsSummary')
@@ -147,11 +147,14 @@ Cypress.Commands.add('eyesOpen', function (args = {}) {
 
     const appliConfFile = Cypress.config('appliConfFile')
     const mergedConfig = mergeCypressConfigs({globalConfig: appliConfFile, openConfig: {testName, ...args}})
-    openAndGlobalConfig = transformCypressConfig({
-      ...mergedConfig,
-      shouldDoPostSpecTasks,
-      isComponentTest: Cypress.config('isComponent'),
-    })
+    openAndGlobalConfig = transformCypressConfig(
+      {
+        ...mergedConfig,
+        shouldDoPostSpecTasks,
+        isComponentTest: Cypress.config('isComponent'),
+      },
+      refer,
+    )
 
     eyes = await socket.request('EyesManager.openEyes', {manager, target, config: openAndGlobalConfig})
   })

package/src/browser/{refer.js → refer.ts}

@@ -3,29 +3,29 @@
 const uuid = require('uuid')
 const REF_ID = 'applitools-ref-id'
 
-// type RefType = 'cypress-driver' | 'element' | 'context' | 'driver'
+type RefType = 'cypress-driver' | 'element' | 'context' | 'driver' | 'function'
 
-// type Ref = {
-//   [REF_ID]: string
-//   type?: RefType
-// }
+type Ref = {
+  [REF_ID]: string
+  type?: RefType
+}
 
 class Refer {
-  // store: Map<string, any>
-  // relation: Map<string, Set<Ref>>
+  store: Map<string, any>
+  relation: Map<string, Set<Ref>>
 
   constructor() {
     this.store = new Map()
     this.relation = new Map()
   }
 
-  // isRef(ref: any): ref is Ref {
-  isRef(ref) {
+  isRef(ref: any): ref is Ref {
+    // isRef(ref) {
     return Boolean(ref && ref[REF_ID])
   }
 
-  // check(value: any): RefType | undefined {
-  check(value) {
+  check(value: any): RefType | undefined {
+    // check(value) {
     if (!value) return
     if (value === '__CYPRESS_DRIVER__') {
       return 'cypress-driver'
@@ -35,11 +35,13 @@ class Refer {
       return 'context'
     } else if (value.constructor && value.constructor.name === 'Window') {
       return 'driver'
+    } else if (typeof value === 'function') {
+      return 'function'
     }
   }
 
-  // ref(value: any, parentRef?: Ref) {
-  ref(value, parentRef) {
+  ref(value: any, parentRef?: Ref) {
+    // ref(value, parentRef) {
     const refType = this.check(value)
     if (refType) {
       const ref = uuid.v4()
@@ -67,7 +69,7 @@ class Refer {
   deref(ref) {
     if (this.isRef(ref)) {
       const value = this.store.get(ref[REF_ID])
-      return value === '__CYPRESS_DRIVER__' ? cy.state('document') : value
+      return value === '__CYPRESS_DRIVER__' ? (cy as any).state('document') : value
     } else {
       return ref
     }

package/src/browser/socketCommands.js

@@ -49,6 +49,10 @@ function socketCommands(socket, refer) {
   socket.command('Driver.reload', async () => {
     await spec.reload()
   })
+
+  socket.command('Driver.executeUserFunction', fn => {
+    return spec.executeUserFunction(refer.deref(fn))
+  })
 }
 
 module.exports = {socketCommands}

package/src/browser/spec-driver.ts

@@ -120,6 +120,14 @@ export function reload(): Promise<void> {
   })
 }
 
+export async function executeUserFunction(fn: any) {
+  if (typeof fn !== 'function') {
+    console.error('Not a function:', fn)
+    throw new Error(`Not a function: ${JSON.stringify(fn)}`)
+  }
+  return fn()
+}
+
 // export function takeScreenshot(page: Driver): Promise<Buffer>;
 
 // export function visit(page: Driver, url: string): Promise<void>; (??)

package/src/browser/transformCypressCheckSettings.ts

@@ -50,7 +50,10 @@ export function transformCypressCheckSettings(
     ignoreCaret: settings.ignoreCaret,
     ignoreDisplacements: settings.ignoreDisplacements,
     fully: settings.fully,
-    waitBeforeCapture: settings.waitBeforeCapture,
+    waitBeforeCapture:
+      typeof settings.waitBeforeCapture === 'number'
+        ? settings.waitBeforeCapture
+        : settings.waitBeforeCapture && refer.ref(settings.waitBeforeCapture),
     lazyLoad: settings.lazyLoad,
     matchLevel: settings.matchLevel,
     useDom: settings.useDom,

package/src/browser/transformCypressConfig.ts

@@ -3,7 +3,7 @@ import type {SpecType, Config} from '@applitools/core'
 import {transformBrowsers, transformAccessibilityValidation} from './utils'
 import * as utils from '@applitools/utils'
 
-export function transformCypressConfig(config: appliConfFile): Config<SpecType, 'ufg'> {
+export function transformCypressConfig(config: appliConfFile, refer): Config<SpecType, 'ufg'> {
   return {
     open: {
       apiKey: config.apiKey,
@@ -61,10 +61,16 @@ export function transformCypressConfig(config: appliConfFile): Config<SpecType,
       stitchMode: config.stitchMode,
       autProxy: config.autProxy,
       scrollRootElement: config.scrollRootElement,
-      waitBeforeCapture: config.waitBeforeCapture,
+      waitBeforeCapture:
+        typeof config.waitBeforeCapture === 'number'
+          ? config.waitBeforeCapture
+          : config.waitBeforeCapture && refer.ref(config.waitBeforeCapture),
     },
     screenshot: {
-      waitBeforeCapture: config.waitBeforeCapture,
+      waitBeforeCapture:
+        typeof config.waitBeforeCapture === 'number'
+          ? config.waitBeforeCapture
+          : config.waitBeforeCapture && refer.ref(config.waitBeforeCapture),
       autProxy: config.autProxy,
       scrollRootElement: config.scrollRootElement,
       hideScrollbars: config.hideScrollbars,

package/types/expose.d.ts

@@ -237,14 +237,14 @@ export type CypressCheckSettings = {
     scrollRootElement?: Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; });
     fully?: boolean;
     disableBrowserFetching?: boolean;
-    layoutBreakpoints?: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: boolean; };
+    layoutBreakpoints?: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: boolean; } | { breakpoints: boolean; heightBreakpoints: boolean; reload?: boolean; };
     visualGridOptions?: { [key: string]: any; };
     ufgOptions?: { [key: string]: any; };
     nmgOptions?: { [key: string]: any; };
     useSystemScreenshot?: boolean;
     hooks?: { beforeCaptureScreenshot: string; };
     timeout?: number;
-    waitBeforeCapture?: number;
+    waitBeforeCapture?: number | (() => Promise<void>);
     lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
     tag?: string;
     target?: "window" | "region";
@@ -358,6 +358,7 @@ export type CypressEyesConfig = {
     enablePatterns?: boolean;
     environmentName?: string;
     forceFullPageScreenshot?: boolean;
+    fully?: boolean;
     gitMergeBaseTimestamp?: string;
     latestCommitInfo?: { timestamp: string; sha: string; };
     hideCaret?: boolean;
@@ -394,7 +395,7 @@ export type CypressEyesConfig = {
     useDom?: boolean;
     viewportSize?: { width: number; height: number; };
     visualGridOptions?: Record<string, any>;
-    waitBeforeCapture?: number;
+    waitBeforeCapture?: number | (() => Promise<void>);
     waitBeforeScreenshots?: number;
     browser?: MaybeArray<(({ name?: "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "iPhone 4" | "iPhone 5/SE" | "iPhone SE 3rd Gen" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone 13 Mini" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone 15 Pro" | "BlackBerry Z30" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Pixel 2" | "Pixel 2 XL" | "LG Optimus L70" | "Nokia N9" | "Nokia Lumia 520" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Galaxy S3" | "Galaxy S III" | "Galaxy S5" | "Kindle Fire HDX" | "iPad Mini" | "iPad" | "iPad Pro" | "iPad 8th Gen" | "iPad 10th Gen" | "iPad Mini 4th Gen" | "iPad Mini 6th Gen" | "Blackberry PlayBook" | "Nexus 10" | "Nexus 7" | "Galaxy Note 3" | "Galaxy Note II" | "Galaxy Note 2" | "Galaxy S20" | "Galaxy S22" | "Galaxy S21" | "Galaxy S21 Ultra" | "Galaxy S22 Ultra" | "Laptop with touch" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "iPhone XR" | "iPhone XS Max" | "iPhone XS" | "Samsung Galaxy A5" | "Galaxy A5" | "Samsung Galaxy S8" | "Galaxy S8" | "LG G6" | "iPad Air 2" | "iPad 6th Gen" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "Galaxy S10" | "Galaxy S9 Plus" | "Galaxy S9" | "Galaxy S10 Plus" | "Galaxy S8 Plus" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 9" | "Galaxy Note 8" | "Galaxy Note 4" | "Galaxy Tab A SM-T510" | "Galaxy Tab A7 SM-T500" | "Galaxy Tab S8" | "Galaxy Tab A8" | "Galaxy S23" | "Galaxy S23 Ultra" | "Galaxy A52s" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "iPad 7th Gen" | "OnePlus 7T" | "OnePlus 7T Pro" | "Galaxy Tab S7" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11" | "Huawei P30" | "Xiaomi Mi A3" | "Huawei P40" | "Xiaomi Redmi Note 8" | "Xiaomi Mi Poco X3 Pro" | "Xiaomi Poco X3"; screenOrientation?: ScreenOrientationPlain; }; } | { iosDeviceInfo: { deviceName: "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone 15 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad (10th generation)" | "iPad mini (6th generation)" | "iPad Air (4th generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 15" | "iPhone 15 Pro Max" | "iPhone 15 Plus" | "iPhone 16" | "iPhone 16 Pro Max" | "iPhone 16 Pro" | "iPhone 16 Plus"; iosVersion?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })) | { deviceName: DeviceName; screenOrientation?: ScreenOrientationPlain; name?: string; }>;
     batchId?: string;
@@ -504,6 +505,7 @@ export type appliConfFile = {
     enablePatterns?: boolean;
     environmentName?: string;
     forceFullPageScreenshot?: boolean;
+    fully?: boolean;
     gitMergeBaseTimestamp?: string;
     latestCommitInfo?: { timestamp: string; sha: string; };
     hideCaret?: boolean;
@@ -540,7 +542,7 @@ export type appliConfFile = {
     useDom?: boolean;
     viewportSize?: { width: number; height: number; };
     visualGridOptions?: Record<string, any>;
-    waitBeforeCapture?: number;
+    waitBeforeCapture?: number | (() => Promise<void>);
     waitBeforeScreenshots?: number;
     browser?: MaybeArray<(({ name?: "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "iPhone 4" | "iPhone 5/SE" | "iPhone SE 3rd Gen" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone 13 Mini" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone 15 Pro" | "BlackBerry Z30" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Pixel 2" | "Pixel 2 XL" | "LG Optimus L70" | "Nokia N9" | "Nokia Lumia 520" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Galaxy S3" | "Galaxy S III" | "Galaxy S5" | "Kindle Fire HDX" | "iPad Mini" | "iPad" | "iPad Pro" | "iPad 8th Gen" | "iPad 10th Gen" | "iPad Mini 4th Gen" | "iPad Mini 6th Gen" | "Blackberry PlayBook" | "Nexus 10" | "Nexus 7" | "Galaxy Note 3" | "Galaxy Note II" | "Galaxy Note 2" | "Galaxy S20" | "Galaxy S22" | "Galaxy S21" | "Galaxy S21 Ultra" | "Galaxy S22 Ultra" | "Laptop with touch" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "iPhone XR" | "iPhone XS Max" | "iPhone XS" | "Samsung Galaxy A5" | "Galaxy A5" | "Samsung Galaxy S8" | "Galaxy S8" | "LG G6" | "iPad Air 2" | "iPad 6th Gen" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "Galaxy S10" | "Galaxy S9 Plus" | "Galaxy S9" | "Galaxy S10 Plus" | "Galaxy S8 Plus" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 9" | "Galaxy Note 8" | "Galaxy Note 4" | "Galaxy Tab A SM-T510" | "Galaxy Tab A7 SM-T500" | "Galaxy Tab S8" | "Galaxy Tab A8" | "Galaxy S23" | "Galaxy S23 Ultra" | "Galaxy A52s" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "iPad 7th Gen" | "OnePlus 7T" | "OnePlus 7T Pro" | "Galaxy Tab S7" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11" | "Huawei P30" | "Xiaomi Mi A3" | "Huawei P40" | "Xiaomi Redmi Note 8" | "Xiaomi Mi Poco X3 Pro" | "Xiaomi Poco X3"; screenOrientation?: ScreenOrientationPlain; }; } | { iosDeviceInfo: { deviceName: "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone 15 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad (10th generation)" | "iPad mini (6th generation)" | "iPad Air (4th generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 15" | "iPhone 15 Pro Max" | "iPhone 15 Plus" | "iPhone 16" | "iPhone 16 Pro Max" | "iPhone 16 Pro" | "iPhone 16 Plus"; iosVersion?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })) | { deviceName: DeviceName; screenOrientation?: ScreenOrientationPlain; name?: string; }>;
     batchId?: string;