@applitools/eyes-cypress 3.51.0 → 3.52.0

package/CHANGELOG.md

@@ -1,5 +1,118 @@
 # 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)
 
 

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.51.0",
+  "version": "3.52.0",
   "homepage": "https://applitools.com/docs/api-ref/sdk-api/cypress/",
   "license": "SEE LICENSE IN LICENSE",
   "main": "./index.js",
@@ -54,8 +54,8 @@
     "setup": "run --top-level xvfb:setup"
   },
   "dependencies": {
-    "@applitools/core": "4.35.1",
-    "@applitools/eyes": "1.33.2",
+    "@applitools/core": "4.37.0",
+    "@applitools/eyes": "1.34.0",
     "@applitools/functional-commons": "1.6.0",
     "@applitools/logger": "2.1.2",
     "@applitools/utils": "1.8.0",

package/types/expose.d.ts

@@ -237,7 +237,7 @@ 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; };