@applitools/eyes-images 4.30.1 → 4.30.3

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 +120 -0
  2. package/README.md +6 -7
  3. package/package.json +2 -2
  4. package/types/index.d.ts +16 -8
package/CHANGELOG.md CHANGED
@@ -1,5 +1,125 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.30.3](https://github.com/Applitools-Dev/sdk/compare/js/eyes-images@4.30.2...js/eyes-images@4.30.3) (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
+
106
+ ## [4.30.2](https://github.com/Applitools-Dev/sdk/compare/js/eyes-images@4.30.1...js/eyes-images@4.30.2) (2025-04-03)
107
+
108
+
109
+ ### Bug Fixes
110
+
111
+ * input range value render issue - add input range to need map list ([#2866](https://github.com/Applitools-Dev/sdk/issues/2866)) ([6b3c113](https://github.com/Applitools-Dev/sdk/commit/6b3c113ab3068fc89b3d3917a12fc51bad66ca97))
112
+
113
+
114
+ ### Dependencies
115
+
116
+ * @applitools/core bumped to 4.35.1
117
+ #### Bug Fixes
118
+
119
+ * dummy ([9b8ffef](https://github.com/Applitools-Dev/sdk/commit/9b8ffef6277015a9073caf50f5dc5741986fbf07))
120
+ * @applitools/eyes bumped to 1.33.2
121
+
122
+
3
123
  ## [4.30.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes-images@4.30.0...js/eyes-images@4.30.1) (2025-03-06)
4
124
 
5
125
 
package/README.md CHANGED
@@ -1,10 +1,9 @@
1
- @applitools/eyes-images
2
- ===================
1
+ ## Applitools Eyes SDK for JavaScript Images
3
2
 
4
- The simplest implementation of Applitools Eyes SDK, uploads images for validation
3
+ ## Further information
5
4
 
6
- [![npm](https://img.shields.io/npm/v/@applitools/eyes-images.svg?style=for-the-badge)](https://www.npmjs.com/package/@applitools/eyes-images)
5
+ For further information, see:
7
6
 
8
- ## Resources
9
- - [Quick start](https://applitools.com/tutorials/quickstart/images/code/javascript)
10
- - [API reference](https://applitools.com/docs/api-ref/category/images-javascript)
7
+ * [Quickstart](https://applitools.com/tutorials/sdks/images-js/quickstart)
8
+ <!-- * [Overview]() -->
9
+ * [Changelog](https://applitools.com/tutorials/sdks/images-js/changelog)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-images",
3
- "version": "4.30.1",
3
+ "version": "4.30.3",
4
4
  "description": "The simplest implementation of Applitools Eyes SDK, uploads images for validation",
5
5
  "keywords": [
6
6
  "eyes-images",
@@ -40,7 +40,7 @@
40
40
  "test:coverage": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-images' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage run --top-level mocha './test/generated-coverage/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-15}"
41
41
  },
42
42
  "dependencies": {
43
- "@applitools/eyes": "1.32.6"
43
+ "@applitools/eyes": "1.34.0"
44
44
  },
45
45
  "devDependencies": {
46
46
  "@applitools/api-extractor": "^1.2.22",
package/types/index.d.ts CHANGED
@@ -184,6 +184,7 @@ export type ConfigurationPlain = {
184
184
  enablePatterns?: undefined | boolean;
185
185
  environmentName?: undefined | string;
186
186
  forceFullPageScreenshot?: undefined | boolean;
187
+ fully?: undefined | boolean;
187
188
  gitMergeBaseTimestamp?: undefined | string;
188
189
  latestCommitInfo?: undefined | { timestamp: string; sha: string; };
189
190
  hideCaret?: undefined | boolean;
@@ -220,7 +221,7 @@ export type ConfigurationPlain = {
220
221
  useDom?: undefined | boolean;
221
222
  viewportSize?: undefined | RectangleSizePlain;
222
223
  visualGridOptions?: undefined | Record<string, any>;
223
- waitBeforeCapture?: undefined | number;
224
+ waitBeforeCapture?: undefined | number | (() => Promise<void>);
224
225
  waitBeforeScreenshots?: undefined | number;
225
226
  };
226
227
  export class Configuration implements Required<ConfigurationPlain> {
@@ -509,14 +510,19 @@ export class Configuration implements Required<ConfigurationPlain> {
509
510
  getVisualGridOptions(): { [key: string]: any; };
510
511
  setVisualGridOptions(visualGridOptions: { [key: string]: any; }): Configuration;
511
512
  setVisualGridOption(key: string, value: any): Configuration;
512
- get waitBeforeCapture(): number;
513
- set waitBeforeCapture(waitBeforeCapture: number);
514
- getWaitBeforeCapture(): number;
513
+ get waitBeforeCapture(): number | (() => Promise<void>);
514
+ set waitBeforeCapture(waitBeforeCapture: number | (() => Promise<void>));
515
+ getWaitBeforeCapture(): number | (() => Promise<void>);
515
516
  setWaitBeforeCapture(waitBeforeCapture: number): Configuration;
517
+ setWaitBeforeCapture(waitBeforeCapture: (() => Promise<void>)): Configuration;
516
518
  get waitBeforeScreenshots(): number;
517
519
  set waitBeforeScreenshots(waitBeforeScreenshots: number);
518
520
  getWaitBeforeScreenshots(): number;
519
521
  setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration;
522
+ get fully(): boolean;
523
+ set fully(fully: boolean);
524
+ getFully(): boolean;
525
+ setFully(fully: boolean): Configuration;
520
526
  }
521
527
  export type CheckSettingsImagePlain = {
522
528
  name?: undefined | string;
@@ -612,14 +618,14 @@ export type CheckSettingsAutomationPlain = {
612
618
  scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
613
619
  fully?: undefined | boolean;
614
620
  disableBrowserFetching?: undefined | boolean;
615
- layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
621
+ layoutBreakpoints?: undefined | (boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; } | { breakpoints: boolean; heightBreakpoints: boolean; reload?: undefined | boolean; });
616
622
  visualGridOptions?: undefined | { [key: string]: any; };
617
623
  ufgOptions?: undefined | { [key: string]: any; };
618
624
  nmgOptions?: undefined | { [key: string]: any; };
619
625
  useSystemScreenshot?: undefined | boolean;
620
626
  hooks?: undefined | { beforeCaptureScreenshot: string; };
621
627
  timeout?: undefined | number;
622
- waitBeforeCapture?: undefined | number;
628
+ waitBeforeCapture?: undefined | number | (() => Promise<void>);
623
629
  lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
624
630
  };
625
631
  export class CheckSettingsAutomation {
@@ -639,8 +645,9 @@ export class CheckSettingsAutomation {
639
645
  fully(fully?: undefined | boolean): CheckSettingsAutomation;
640
646
  stitchContent(stitchContent?: undefined | boolean): CheckSettingsAutomation;
641
647
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
642
- layoutBreakpoints(breakpoints?: undefined | boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
643
- layoutBreakpoints(breakpoints?: undefined | Array<number>, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
648
+ layoutBreakpoints(breakpoints: boolean, heightBreakpoints: boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
649
+ layoutBreakpoints(breakpoints: boolean, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
650
+ layoutBreakpoints(breakpoints: Array<number>, settings?: undefined | { reload?: undefined | boolean; }): CheckSettingsAutomation;
644
651
  hook(name: string, script: string): CheckSettingsAutomation;
645
652
  beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
646
653
  webHook(script: string): CheckSettingsAutomation;
@@ -653,6 +660,7 @@ export class CheckSettingsAutomation {
653
660
  useSystemScreenshot(useSystemScreenshot?: undefined | boolean): CheckSettingsAutomation;
654
661
  timeout(timeout: number): CheckSettingsAutomation;
655
662
  waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
663
+ waitBeforeCapture(waitBeforeCapture: (() => Promise<void>)): CheckSettingsAutomation;
656
664
  lazyLoad(options?: undefined | boolean): CheckSettingsAutomation;
657
665
  lazyLoad(options?: undefined | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
658
666
  densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;