@applitools/eyes-webdriverio 5.58.1 → 5.58.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +103 -0
  2. package/README.md +58 -9
  3. package/package.json +4 -4
  4. package/types/index.d.ts +4 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,108 @@
1
1
  # Changelog
2
2
 
3
+ ## [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)
4
+
5
+
6
+ ### Performance Improvements
7
+
8
+ * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * @applitools/dom-snapshot bumped to 4.11.18
14
+ #### Bug Fixes
15
+
16
+ * 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))
17
+
18
+
19
+
20
+ * @applitools/snippets bumped to 2.6.5
21
+ #### Performance Improvements
22
+
23
+ * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
24
+ * @applitools/driver bumped to 1.21.1
25
+ #### Bug Fixes
26
+
27
+ * executePoll error logging FLD-2870 ([#2890](https://github.com/Applitools-Dev/sdk/issues/2890)) ([a8ff720](https://github.com/Applitools-Dev/sdk/commit/a8ff720efafacabe2023282748a6d8a0f1b3ff73))
28
+
29
+
30
+
31
+ * @applitools/spec-driver-webdriver bumped to 1.2.2
32
+ #### Performance Improvements
33
+
34
+ * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
35
+
36
+
37
+
38
+ * @applitools/spec-driver-selenium bumped to 1.5.98
39
+ #### Performance Improvements
40
+
41
+ * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
42
+
43
+
44
+
45
+ * @applitools/spec-driver-puppeteer bumped to 1.4.27
46
+ #### Performance Improvements
47
+
48
+ * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
49
+
50
+
51
+
52
+ * @applitools/screenshoter bumped to 3.11.1
53
+ #### Performance Improvements
54
+
55
+ * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
56
+
57
+
58
+
59
+ * @applitools/nml-client bumped to 1.9.1
60
+ #### Performance Improvements
61
+
62
+ * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
63
+
64
+
65
+
66
+ * @applitools/tunnel-client bumped to 1.6.5
67
+ #### Bug Fixes
68
+
69
+ * enhance error messages in tunnel client ([cab26e6](https://github.com/Applitools-Dev/sdk/commit/cab26e6e3d56fa3cbabaa1a9c68de13046b8f57e))
70
+ * @applitools/ufg-client bumped to 1.16.9
71
+ #### Bug Fixes
72
+
73
+ * 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))
74
+
75
+
76
+ #### Performance Improvements
77
+
78
+ * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
79
+ * @applitools/ec-client bumped to 1.10.9
80
+ #### Performance Improvements
81
+
82
+ * cachify http agent ([#2466](https://github.com/Applitools-Dev/sdk/issues/2466)) ([bc2f4a1](https://github.com/Applitools-Dev/sdk/commit/bc2f4a1fae3c379f061c9199edf4c5257769fb44))
83
+
84
+
85
+
86
+ * @applitools/core bumped to 4.37.0
87
+ #### Features
88
+
89
+ * height layout breakpoints ([#2801](https://github.com/Applitools-Dev/sdk/issues/2801)) ([819e241](https://github.com/Applitools-Dev/sdk/commit/819e2418f1fd93220a07dfbcf1157ffcf4995dd7))
90
+
91
+
92
+
93
+ * @applitools/eyes bumped to 1.34.0
94
+ #### Features
95
+
96
+ * height layout breakpoints ([#2801](https://github.com/Applitools-Dev/sdk/issues/2801)) ([819e241](https://github.com/Applitools-Dev/sdk/commit/819e2418f1fd93220a07dfbcf1157ffcf4995dd7))
97
+
98
+
99
+ #### Bug Fixes
100
+
101
+ * 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))
102
+
103
+
104
+
105
+
3
106
  ## [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)
4
107
 
5
108
 
package/README.md CHANGED
@@ -1,12 +1,61 @@
1
- <div align="center">
1
+ ## Applitools Eyes SDK for [WebdriverIO](https://webdriver.io/)
2
2
 
3
- ![Applitools Eyes](https://i.ibb.co/3hWJK68/applitools-eyes-logo.png)
4
- ### Applitools Eyes SDK for [webdriver.io](https://webdriver.io)
5
- [![npm](https://img.shields.io/npm/v/@applitools/eyes-webdriverio.svg?style=for-the-badge)](https://www.npmjs.com/package/@applitools/eyes-webdriverio)
3
+ ## Installation
6
4
 
7
- </div>
8
- <br/>
5
+ To install Eyes-WebdriverIO as a local development dependency in your test project:
9
6
 
10
- ## Resources
11
- - [Quick start](https://applitools.com/tutorials/quickstart/web/webdriverio)
12
- - [API reference](https://applitools.com/docs/api-ref/sdk-api/wdiogeneric/javascript/)
7
+ ```shell
8
+ npm install --save-dev @applitools/eyes-webdriverio
9
+ ```
10
+ This command will add the `@applitools/eyes-webdriverio` package to your project's `package.json` file and install it in the `node_modules` directory.
11
+
12
+ ## Setting API Key and Server URL
13
+
14
+ To get started with this SDK, you need to set the following:
15
+
16
+ * [Applitools API key](#API)
17
+ * [Eyes server URL](#URL) - Only required if the Eyes server is not deployed on the Eyes public server.
18
+
19
+ ### Entering the Applitools API Key {#API}
20
+
21
+ 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).
22
+
23
+ To set the API Key on Linux or macOS:
24
+
25
+ ```bash
26
+ export APPLITOOLS_API_KEY=<API_key>
27
+ ```
28
+
29
+ To set the API Key on Windows:
30
+
31
+ ```bash
32
+ set APPLITOOLS_API_KEY=<API_key>
33
+ ```
34
+
35
+ ### Eyes Server URL {#URL}
36
+
37
+ If the Eyes server is not deployed at `https://eyes.applitools.com`, set the server URL in the environment variable `APPLITOOLS_SERVER_URL`.
38
+
39
+ The server URL of your Applitools Eyes dashboard should follow the format `https://<MY_COMPANY>.applitools.com`
40
+
41
+ To set the server URL on Linux or macOS:
42
+
43
+ ```bash
44
+ export APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>
45
+ ```
46
+
47
+ To set the server URL on Windows:
48
+
49
+ ```bash
50
+ set APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>
51
+ ```
52
+
53
+
54
+
55
+ ## Further information
56
+
57
+ For further information, see:
58
+
59
+ * [Quickstart](https://applitools.com/tutorials/sdks/webdriverio/quickstart)
60
+ * [Overview](https://applitools.com/tutorials/sdks/webdriverio)
61
+ * [Changelog](https://applitools.com/tutorials/sdks/webdriverio/changelog)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-webdriverio",
3
- "version": "5.58.1",
3
+ "version": "5.58.2",
4
4
  "description": "Applitools Eyes SDK for WebdriverIO",
5
5
  "keywords": [
6
6
  "eyes-webdriverio",
@@ -71,9 +71,9 @@
71
71
  "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"
72
72
  },
73
73
  "dependencies": {
74
- "@applitools/driver": "1.21.0",
75
- "@applitools/eyes": "1.33.2",
76
- "@applitools/spec-driver-webdriver": "1.2.1"
74
+ "@applitools/driver": "1.21.1",
75
+ "@applitools/eyes": "1.34.0",
76
+ "@applitools/spec-driver-webdriver": "1.2.2"
77
77
  },
78
78
  "devDependencies": {
79
79
  "@applitools/api-extractor": "^1.2.22",
package/types/index.d.ts CHANGED
@@ -266,7 +266,7 @@ export type CheckSettingsAutomationPlain = {
266
266
  scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
267
267
  fully?: undefined | boolean;
268
268
  disableBrowserFetching?: undefined | boolean;
269
- layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
269
+ layoutBreakpoints?: undefined | (boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; } | { breakpoints: boolean; heightBreakpoints: boolean; reload?: undefined | boolean; });
270
270
  visualGridOptions?: undefined | { [key: string]: any; };
271
271
  ufgOptions?: undefined | { [key: string]: any; };
272
272
  nmgOptions?: undefined | { [key: string]: any; };
@@ -295,8 +295,9 @@ export class CheckSettingsAutomation {
295
295
  fully(fully?: undefined | boolean): CheckSettingsAutomation;
296
296
  stitchContent(stitchContent?: undefined | boolean): CheckSettingsAutomation;
297
297
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
298
- layoutBreakpoints(breakpoints?: undefined | boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
299
- layoutBreakpoints(breakpoints?: undefined | Array<number>, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
298
+ layoutBreakpoints(breakpoints: boolean, heightBreakpoints: boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
299
+ layoutBreakpoints(breakpoints: boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
300
+ layoutBreakpoints(breakpoints: Array<number>, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
300
301
  hook(name: string, script: string): CheckSettingsAutomation;
301
302
  beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
302
303
  webHook(script: string): CheckSettingsAutomation;