@applitools/eyes-webdriverio 5.58.0 → 5.58.2

package/CHANGELOG.md

@@ -1,5 +1,120 @@
 # Changelog
 
+## [5.58.2](https://github.com/Applitools-Dev/sdk/compare/js/eyes-webdriverio@5.58.1...js/eyes-webdriverio@5.58.2) (2025-04-17)
+
+
+### 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))
+
+
+
+
+## [5.58.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes-webdriverio@5.58.0...js/eyes-webdriverio@5.58.1) (2025-04-03)
+
+
+### 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
+
+
 ## [5.58.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-webdriverio@5.57.1...js/eyes-webdriverio@5.58.0) (2025-03-31)
 
 

package/README.md

@@ -1,12 +1,61 @@
-<div align="center">
+## Applitools Eyes SDK for [WebdriverIO](https://webdriver.io/)
 
-![Applitools Eyes](https://i.ibb.co/3hWJK68/applitools-eyes-logo.png)
-### Applitools Eyes SDK for [webdriver.io](https://webdriver.io)
-[![npm](https://img.shields.io/npm/v/@applitools/eyes-webdriverio.svg?style=for-the-badge)](https://www.npmjs.com/package/@applitools/eyes-webdriverio)
+## Installation
 
-</div>
-<br/>
+To install Eyes-WebdriverIO as a local development dependency in your test project:
 
-## Resources
-- [Quick start](https://applitools.com/tutorials/quickstart/web/webdriverio)
-- [API reference](https://applitools.com/docs/api-ref/sdk-api/wdiogeneric/javascript/)
+```shell
+npm install --save-dev @applitools/eyes-webdriverio
+```
+This command will add the `@applitools/eyes-webdriverio` package to your project's `package.json` file and install it in the `node_modules` directory.
+
+## Setting API Key and Server URL
+
+To get started with this SDK, you need to set the following:
+
+* [Applitools API key](#API)
+* [Eyes server URL](#URL) - Only required if the Eyes server is not deployed on the Eyes public server.
+
+### Entering the Applitools API Key {#API}
+
+To authenticate via the Applitools server and run tests, set the environment variable `APPLITOOLS_API_KEY` to the API key provided by Applitools Eyes. For details on how to retrieve your API key, see [the Applitools documentation](/getting-started/retrieve-api-key).
+
+To set the API Key on Linux or macOS:
+
+```bash
+export APPLITOOLS_API_KEY=<API_key>
+```
+
+To set the API Key on Windows:
+
+```bash
+set APPLITOOLS_API_KEY=<API_key>
+```
+
+### Eyes Server URL {#URL}
+
+If the Eyes server is not deployed at `https://eyes.applitools.com`, set the server URL in the environment variable `APPLITOOLS_SERVER_URL`.
+
+The server URL of your Applitools Eyes dashboard should follow the format `https://<MY_COMPANY>.applitools.com`
+
+To set the server URL on Linux or macOS:
+
+```bash
+export APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>
+```
+
+To set 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/webdriverio/quickstart)
+* [Overview](https://applitools.com/tutorials/sdks/webdriverio)
+* [Changelog](https://applitools.com/tutorials/sdks/webdriverio/changelog)	

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-webdriverio",
-  "version": "5.58.0",
+  "version": "5.58.2",
   "description": "Applitools Eyes SDK for WebdriverIO",
   "keywords": [
     "eyes-webdriverio",
@@ -71,9 +71,9 @@
     "up:framework": "echo \"$(jq '.devDependencies |= . + ([\"webdriverio\", \"@wdio/cli\", \"@wdio/local-runner\", \"@wdio/mocha-framework\"] | with_entries({key: .value, value: $ENV.APPLITOOLS_FRAMEWORK_VERSION}))' ./package.json)\" > ./package.json"
   },
   "dependencies": {
-    "@applitools/driver": "1.21.0",
-    "@applitools/eyes": "1.33.1",
-    "@applitools/spec-driver-webdriver": "1.2.1"
+    "@applitools/driver": "1.21.1",
+    "@applitools/eyes": "1.34.0",
+    "@applitools/spec-driver-webdriver": "1.2.2"
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.22",

package/types/index.d.ts

@@ -266,7 +266,7 @@ export type CheckSettingsAutomationPlain = {
     scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
     fully?: undefined | boolean;
     disableBrowserFetching?: undefined | boolean;
-    layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
+    layoutBreakpoints?: undefined | (boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; } | { breakpoints: boolean; heightBreakpoints: boolean; reload?: undefined | boolean; });
     visualGridOptions?: undefined | { [key: string]: any; };
     ufgOptions?: undefined | { [key: string]: any; };
     nmgOptions?: undefined | { [key: string]: any; };
@@ -295,8 +295,9 @@ export class CheckSettingsAutomation {
     fully(fully?: undefined | boolean): CheckSettingsAutomation;
     stitchContent(stitchContent?: undefined | boolean): CheckSettingsAutomation;
     disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
-    layoutBreakpoints(breakpoints?: undefined | boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
-    layoutBreakpoints(breakpoints?: undefined | Array<number>, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
+    layoutBreakpoints(breakpoints: boolean, heightBreakpoints: boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
+    layoutBreakpoints(breakpoints: boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
+    layoutBreakpoints(breakpoints: Array<number>, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
     hook(name: string, script: string): CheckSettingsAutomation;
     beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
     webHook(script: string): CheckSettingsAutomation;