@applitools/eyes-testcafe 6.2.11 → 6.2.14

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 (3) hide show
  1. package/CHANGELOG.md +123 -0
  2. package/package.json +5 -5
  3. package/types/index.d.ts +334 -350
package/CHANGELOG.md CHANGED
@@ -13,6 +13,129 @@
13
13
 
14
14
 
15
15
 
16
+ ## [6.2.14](https://github.com/Applitools-Dev/sdk/compare/js/eyes-testcafe-v6.2.13...js/eyes-testcafe@6.2.14) (2024-12-18)
17
+
18
+
19
+ ### Bug Fixes
20
+
21
+ * plain object target syntax ([#2515](https://github.com/Applitools-Dev/sdk/issues/2515)) ([71842b8](https://github.com/Applitools-Dev/sdk/commit/71842b89bd05b68482df7ed16a6483ec716ddf55))
22
+
23
+
24
+ ### Dependencies
25
+
26
+ * @applitools/utils bumped to 1.7.6
27
+ #### Bug Fixes
28
+
29
+ * support webdriver.io 9 ([baee5ce](https://github.com/Applitools-Dev/sdk/commit/baee5ce96e8220c337b007e3a517b5546ce0fedc))
30
+ * @applitools/spec-driver-webdriver bumped to 1.1.21
31
+ #### Bug Fixes
32
+
33
+ * support webdriver.io 9 ([baee5ce](https://github.com/Applitools-Dev/sdk/commit/baee5ce96e8220c337b007e3a517b5546ce0fedc))
34
+
35
+
36
+
37
+ * @applitools/core-base bumped to 1.21.0
38
+ #### Features
39
+
40
+ * check for new ufg balancer - cache result in getAccountInfo instead of makeCoreRequests ([#2692](https://github.com/Applitools-Dev/sdk/issues/2692)) ([e2a9705](https://github.com/Applitools-Dev/sdk/commit/e2a970594ffa6527798c5fac7a72188e30da986d))
41
+ * check for new ufg balancer ([#2683](https://github.com/Applitools-Dev/sdk/issues/2683)) ([60ca9f9](https://github.com/Applitools-Dev/sdk/commit/60ca9f98d37374c918e9c634af46d7f8266b95fc))
42
+
43
+
44
+ #### Bug Fixes
45
+
46
+ * move apiKey from query param to request header ([d1d2642](https://github.com/Applitools-Dev/sdk/commit/d1d26424c64d8e03981b1482ca49870a866bc164))
47
+
48
+
49
+
50
+ * @applitools/core bumped to 4.27.0
51
+ #### Features
52
+
53
+ * check for new ufg balancer - cache result in getAccountInfo instead of makeCoreRequests ([#2692](https://github.com/Applitools-Dev/sdk/issues/2692)) ([e2a9705](https://github.com/Applitools-Dev/sdk/commit/e2a970594ffa6527798c5fac7a72188e30da986d))
54
+
55
+
56
+ #### Bug Fixes
57
+
58
+ * support webdriver.io 9 ([baee5ce](https://github.com/Applitools-Dev/sdk/commit/baee5ce96e8220c337b007e3a517b5546ce0fedc))
59
+
60
+
61
+
62
+ * @applitools/logger bumped to 2.0.20
63
+
64
+ * @applitools/dom-snapshot bumped to 4.11.12
65
+
66
+ * @applitools/socket bumped to 1.1.20
67
+
68
+ * @applitools/req bumped to 1.7.5
69
+
70
+ * @applitools/image bumped to 1.1.15
71
+
72
+ * @applitools/driver bumped to 1.20.1
73
+
74
+ * @applitools/spec-driver-selenium bumped to 1.5.92
75
+
76
+ * @applitools/spec-driver-puppeteer bumped to 1.4.21
77
+
78
+ * @applitools/screenshoter bumped to 3.10.1
79
+
80
+ * @applitools/nml-client bumped to 1.8.20
81
+
82
+ * @applitools/tunnel-client bumped to 1.5.11
83
+
84
+ * @applitools/ufg-client bumped to 1.15.1
85
+
86
+ * @applitools/ec-client bumped to 1.9.17
87
+
88
+ * @applitools/eyes bumped to 1.29.3
89
+
90
+
91
+ ## [6.2.12](https://github.com/Applitools-Dev/sdk/compare/js/eyes-testcafe@6.2.11...js/eyes-testcafe@6.2.12) (2024-11-27)
92
+
93
+
94
+ ### Dependencies
95
+
96
+ * @applitools/dom-shared bumped to 1.0.16
97
+ #### Bug Fixes
98
+
99
+ * enhance error logging in takeScreenshots and pollify functions ([#2644](https://github.com/Applitools-Dev/sdk/issues/2644)) ([2428fa5](https://github.com/Applitools-Dev/sdk/commit/2428fa500a9fd47a803aa5aca9f79e5c5b3584f9))
100
+ * @applitools/dom-snapshot bumped to 4.11.11
101
+
102
+ * @applitools/req bumped to 1.7.4
103
+ #### Bug Fixes
104
+
105
+ * set heartbeat request timeout as the request interval ([#2587](https://github.com/Applitools-Dev/sdk/issues/2587)) ([0251d27](https://github.com/Applitools-Dev/sdk/commit/0251d27d9ed44ec247732f66904ae3d4fa4123f1))
106
+ * @applitools/core bumped to 4.24.2
107
+ #### Bug Fixes
108
+
109
+ * don't populate branchName and parentBranchName when scm integration exists ([#2634](https://github.com/Applitools-Dev/sdk/issues/2634)) ([e45d671](https://github.com/Applitools-Dev/sdk/commit/e45d671e11ed40a82de1bd5ab22e757aff00b63f))
110
+ * enhance error logging in takeScreenshots and pollify functions ([#2644](https://github.com/Applitools-Dev/sdk/issues/2644)) ([2428fa5](https://github.com/Applitools-Dev/sdk/commit/2428fa500a9fd47a803aa5aca9f79e5c5b3584f9))
111
+
112
+
113
+
114
+ * @applitools/dom-capture bumped to 11.5.2
115
+
116
+ * @applitools/nml-client bumped to 1.8.19
117
+
118
+ * @applitools/tunnel-client bumped to 1.5.10
119
+
120
+ * @applitools/ufg-client bumped to 1.14.1
121
+
122
+ * @applitools/core-base bumped to 1.19.3
123
+ #### Bug Fixes
124
+
125
+ * set heartbeat request timeout as the request interval ([#2587](https://github.com/Applitools-Dev/sdk/issues/2587)) ([0251d27](https://github.com/Applitools-Dev/sdk/commit/0251d27d9ed44ec247732f66904ae3d4fa4123f1))
126
+
127
+
128
+
129
+ * @applitools/ec-client bumped to 1.9.15
130
+
131
+ * @applitools/eyes bumped to 1.28.0
132
+ #### Features
133
+
134
+ * remove Android NMG API ([#2566](https://github.com/Applitools-Dev/sdk/issues/2566)) ([750c0f0](https://github.com/Applitools-Dev/sdk/commit/750c0f0263e5ff06f86055e7ba0c3fb47cadb620))
135
+
136
+
137
+
138
+
16
139
  ## [6.2.11](https://github.com/Applitools-Dev/sdk/compare/js/eyes-testcafe@6.2.10...js/eyes-testcafe@6.2.11) (2024-10-29)
17
140
 
18
141
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-testcafe",
3
- "version": "6.2.11",
3
+ "version": "6.2.14",
4
4
  "description": "Applitools Eyes SDK for TestCafe",
5
5
  "keywords": [
6
6
  "eyes-testcafe",
@@ -68,14 +68,14 @@
68
68
  "up:framework": "echo \"$(jq '.devDependencies.testcafe = $ENV.APPLITOOLS_FRAMEWORK_VERSION' ./package.json)\" > ./package.json"
69
69
  },
70
70
  "dependencies": {
71
- "@applitools/driver": "1.19.4",
72
- "@applitools/eyes": "1.25.1",
73
- "@applitools/utils": "1.7.4"
71
+ "@applitools/driver": "1.20.1",
72
+ "@applitools/eyes": "1.29.3",
73
+ "@applitools/utils": "1.7.6"
74
74
  },
75
75
  "devDependencies": {
76
76
  "@applitools/api-extractor": "^1.2.22",
77
77
  "@applitools/bongo": "^5.10.0",
78
- "@applitools/generic": "^3.9.1",
78
+ "@applitools/generic": "^3.9.2",
79
79
  "@applitools/test-server": "^1.2.2",
80
80
  "@applitools/test-utils": "^1.5.17",
81
81
  "testcafe": "^3.4.0"
package/types/index.d.ts CHANGED
@@ -172,7 +172,7 @@ export class Eyes {
172
172
  }
173
173
  export type CheckSettingsImagePlain = {
174
174
  name?: undefined | string;
175
- region?: undefined | RegionPlain;
175
+ region?: undefined | RegionPlain | LegacyRegionPlain;
176
176
  matchLevel?: undefined | MatchLevelPlain;
177
177
  useDom?: undefined | boolean;
178
178
  sendDom?: undefined | boolean;
@@ -180,17 +180,17 @@ export type CheckSettingsImagePlain = {
180
180
  ignoreDisplacements?: undefined | boolean;
181
181
  ignoreMismatch?: undefined | boolean;
182
182
  ignoreCaret?: undefined | boolean;
183
- ignoreRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
184
- layoutRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
185
- strictRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
186
- contentRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
187
- floatingRegions?: undefined | Array<RegionPlain | {
188
- region: RegionPlain;
183
+ ignoreRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
184
+ layoutRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
185
+ strictRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
186
+ contentRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
187
+ floatingRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | {
188
+ region: RegionPlain | LegacyRegionPlain;
189
189
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
190
190
  regionId?: undefined | string;
191
191
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
192
192
  } | {
193
- region: RegionPlain;
193
+ region: RegionPlain | LegacyRegionPlain;
194
194
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
195
195
  regionId?: undefined | string;
196
196
  maxUpOffset?: undefined | number;
@@ -198,14 +198,14 @@ export type CheckSettingsImagePlain = {
198
198
  maxLeftOffset?: undefined | number;
199
199
  maxRightOffset?: undefined | number;
200
200
  }>;
201
- accessibilityRegions?: undefined | Array<RegionPlain | {
202
- region: RegionPlain;
201
+ accessibilityRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | {
202
+ region: RegionPlain | LegacyRegionPlain;
203
203
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
204
204
  regionId?: undefined | string;
205
205
  type?: undefined | AccessibilityRegionTypePlain;
206
206
  }>;
207
207
  dynamicRegions?: undefined | Array<RegionPlain | {
208
- region: RegionPlain;
208
+ region: RegionPlain | LegacyRegionPlain;
209
209
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
210
210
  regionId?: undefined | string;
211
211
  type?: undefined | string | Array<string>;
@@ -216,7 +216,7 @@ export type CheckSettingsImagePlain = {
216
216
  };
217
217
  export type CheckSettingsAutomationPlain = {
218
218
  name?: undefined | string;
219
- region?: undefined | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })));
219
+ region?: undefined | (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })));
220
220
  matchLevel?: undefined | MatchLevelPlain;
221
221
  useDom?: undefined | boolean;
222
222
  sendDom?: undefined | boolean;
@@ -224,17 +224,17 @@ export type CheckSettingsAutomationPlain = {
224
224
  ignoreDisplacements?: undefined | boolean;
225
225
  ignoreMismatch?: undefined | boolean;
226
226
  ignoreCaret?: undefined | boolean;
227
- ignoreRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
228
- layoutRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
229
- strictRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
230
- contentRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
231
- floatingRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
232
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
227
+ ignoreRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
228
+ layoutRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
229
+ strictRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
230
+ contentRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
231
+ floatingRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
232
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
233
233
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
234
234
  regionId?: undefined | string;
235
235
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
236
236
  } | {
237
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
237
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
238
238
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
239
239
  regionId?: undefined | string;
240
240
  maxUpOffset?: undefined | number;
@@ -242,14 +242,14 @@ export type CheckSettingsAutomationPlain = {
242
242
  maxLeftOffset?: undefined | number;
243
243
  maxRightOffset?: undefined | number;
244
244
  }>;
245
- accessibilityRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
246
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
245
+ accessibilityRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
246
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
247
247
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
248
248
  regionId?: undefined | string;
249
249
  type?: undefined | AccessibilityRegionTypePlain;
250
250
  }>;
251
- dynamicRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
252
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
251
+ dynamicRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
252
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
253
253
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
254
254
  regionId?: undefined | string;
255
255
  type?: undefined | string | Array<string>;
@@ -264,6 +264,7 @@ export type CheckSettingsAutomationPlain = {
264
264
  disableBrowserFetching?: undefined | boolean;
265
265
  layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
266
266
  visualGridOptions?: undefined | { [key: string]: any; };
267
+ ufgOptions?: undefined | { [key: string]: any; };
267
268
  nmgOptions?: undefined | { [key: string]: any; };
268
269
  useSystemScreenshot?: undefined | boolean;
269
270
  hooks?: undefined | { beforeCaptureScreenshot: string; };
@@ -273,7 +274,7 @@ export type CheckSettingsAutomationPlain = {
273
274
  };
274
275
  export class CheckSettingsAutomation {
275
276
  constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain);
276
- region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
277
+ region(region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
277
278
  shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
278
279
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
279
280
  frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
@@ -299,24 +300,24 @@ export class CheckSettingsAutomation {
299
300
  densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
300
301
  name(name: string): CheckSettingsAutomation;
301
302
  withName(name: string): CheckSettingsAutomation;
302
- ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
303
- ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
304
- ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
305
- ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
306
- layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
307
- layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
308
- strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
309
- strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
310
- contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
311
- contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
303
+ ignoreRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
304
+ ignoreRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
305
+ ignore(region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
306
+ ignores(...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
307
+ layoutRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
308
+ layoutRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
309
+ strictRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
310
+ strictRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
311
+ contentRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
312
+ contentRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
312
313
  floatingRegion(region: {
313
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
314
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
314
315
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
315
316
  regionId?: undefined | string;
316
317
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
317
318
  }): CheckSettingsAutomation;
318
319
  floatingRegion(region: {
319
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
320
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
320
321
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
321
322
  regionId?: undefined | string;
322
323
  maxUpOffset?: undefined | number;
@@ -324,52 +325,52 @@ export class CheckSettingsAutomation {
324
325
  maxLeftOffset?: undefined | number;
325
326
  maxRightOffset?: undefined | number;
326
327
  }): CheckSettingsAutomation;
327
- floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
328
- floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
329
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
328
+ floatingRegion(region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
329
+ floatingRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
330
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
330
331
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
331
332
  regionId?: undefined | string;
332
333
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
333
334
  }>): CheckSettingsAutomation;
334
- floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
335
+ floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
335
336
  floating(region: {
336
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
337
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
337
338
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
338
339
  regionId?: undefined | string;
339
340
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
340
341
  }): CheckSettingsAutomation;
341
- floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
342
- floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
343
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
342
+ floating(region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
343
+ floatings(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
344
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
344
345
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
345
346
  regionId?: undefined | string;
346
347
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
347
348
  }>): CheckSettingsAutomation;
348
- floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
349
+ floatings(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
349
350
  accessibilityRegion(region: {
350
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
351
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
351
352
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
352
353
  regionId?: undefined | string;
353
354
  type?: undefined | AccessibilityRegionTypePlain;
354
355
  }): CheckSettingsAutomation;
355
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
356
- accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
357
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
356
+ accessibilityRegion(region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
357
+ accessibilityRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
358
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
358
359
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
359
360
  regionId?: undefined | string;
360
361
  type?: undefined | AccessibilityRegionTypePlain;
361
362
  }>): CheckSettingsAutomation;
362
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
363
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
363
364
  dynamicRegion(region: {
364
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
365
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
365
366
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
366
367
  regionId?: undefined | string;
367
368
  type?: undefined | string | Array<string>;
368
369
  }): CheckSettingsAutomation;
369
- dynamicRegion(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
370
- dynamicRegion(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | string | Array<string>): CheckSettingsAutomation;
371
- dynamicRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
372
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
370
+ dynamicRegion(region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
371
+ dynamicRegion(region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | string | Array<string>): CheckSettingsAutomation;
372
+ dynamicRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
373
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
373
374
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
374
375
  regionId?: undefined | string;
375
376
  type?: undefined | string | Array<string>;
@@ -393,7 +394,7 @@ export class CheckSettings extends CheckSettingsAutomation {
393
394
  }
394
395
  export type TargetAutomation = {
395
396
  window(): CheckSettingsAutomation;
396
- region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
397
+ region(region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
397
398
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
398
399
  frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
399
400
  shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
@@ -401,7 +402,7 @@ export type TargetAutomation = {
401
402
  };
402
403
  export const TargetAutomation: {
403
404
  window(): CheckSettingsAutomation;
404
- region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
405
+ region(region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
405
406
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
406
407
  frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
407
408
  shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
@@ -411,64 +412,136 @@ export type Target = TargetImage & TargetAutomation;
411
412
  export const Target: TargetImage & TargetAutomation;
412
413
  export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
413
414
  export type ConfigurationPlain = {
414
- debugScreenshots?: undefined | { save: boolean; path?: undefined | string; prefix?: undefined | string; };
415
+ accessibilityValidation?: undefined | AccessibilitySettings;
415
416
  agentId?: undefined | string;
416
417
  apiKey?: undefined | string;
417
- serverUrl?: undefined | string;
418
- proxy?: undefined | ProxySettingsPlain;
419
- autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
420
- isDisabled?: undefined | boolean;
421
- connectionTimeout?: undefined | number;
422
- removeSession?: undefined | boolean;
423
418
  appName?: undefined | string;
424
- testName?: undefined | string;
425
- displayName?: undefined | string;
426
- viewportSize?: undefined | RectangleSizePlain;
427
- sessionType?: undefined | SessionTypePlain;
428
- properties?: undefined | Array<PropertyDataPlain>;
419
+ autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
420
+ baselineBranchName?: undefined | string;
421
+ baselineEnvName?: undefined | string;
429
422
  batch?: undefined | BatchInfoPlain;
423
+ branchName?: undefined | string;
424
+ browsersInfo?: undefined | Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (3rd generation)" | "iPhone SE (2nd generation)" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 13 mini" | "iPhone 12 mini" | "iPhone Xs" | "iPhone Xs Max" | "iPhone 12" | "iPhone 12 Pro" | "iPhone 12 Pro Max" | "iPhone 13" | "iPhone 13 Pro" | "iPhone 13 Pro Max" | "iPhone 14" | "iPhone 14 Pro Max"; }; })>;
425
+ captureStatusBar?: undefined | boolean;
426
+ compareWithParentBranch?: undefined | boolean;
427
+ concurrentSessions?: undefined | number;
428
+ connectionTimeout?: undefined | number;
429
+ cut?: undefined | CutProviderPlain;
430
+ debugScreenshots?: undefined | { save: boolean; path?: undefined | string; prefix?: undefined | string; };
430
431
  defaultMatchSettings?: undefined | ImageMatchSettingsPlain;
431
- hostApp?: undefined | string;
432
- hostOS?: undefined | string;
433
- hostAppInfo?: undefined | string;
434
- hostOSInfo?: undefined | string;
435
432
  deviceInfo?: undefined | string;
436
- baselineEnvName?: undefined | string;
433
+ disableBrowserFetching?: undefined | boolean;
434
+ disableNMLUrlCache?: undefined | boolean;
435
+ displayName?: undefined | string;
436
+ dontCloseBatches?: undefined | boolean;
437
+ enablePatterns?: undefined | boolean;
437
438
  environmentName?: undefined | string;
438
- branchName?: undefined | string;
439
- parentBranchName?: undefined | string;
439
+ forceFullPageScreenshot?: undefined | boolean;
440
440
  gitMergeBaseTimestamp?: undefined | string;
441
- baselineBranchName?: undefined | string;
442
- compareWithParentBranch?: undefined | boolean;
441
+ hideCaret?: undefined | boolean;
442
+ hideScrollbars?: undefined | boolean;
443
+ hostApp?: undefined | string;
444
+ hostAppInfo?: undefined | string;
445
+ hostOS?: undefined | string;
446
+ hostOSInfo?: undefined | string;
443
447
  ignoreBaseline?: undefined | boolean;
448
+ ignoreCaret?: undefined | boolean;
449
+ ignoreDisplacements?: undefined | boolean;
444
450
  ignoreGitMergeBase?: undefined | boolean;
451
+ isDisabled?: undefined | boolean;
452
+ layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
453
+ matchLevel?: undefined | MatchLevelPlain;
454
+ matchTimeout?: undefined | number;
455
+ mobileOptions?: undefined | { keepNavigationBar?: undefined | boolean; };
456
+ parentBranchName?: undefined | string;
457
+ properties?: undefined | Array<PropertyDataPlain>;
458
+ proxy?: undefined | ProxySettingsPlain;
459
+ removeSession?: undefined | boolean;
460
+ rotation?: undefined | ImageRotationPlain;
461
+ saveDiffs?: undefined | boolean;
445
462
  saveFailedTests?: undefined | boolean;
446
463
  saveNewTests?: undefined | boolean;
447
- saveDiffs?: undefined | boolean;
448
- dontCloseBatches?: undefined | boolean;
464
+ scaleRatio?: undefined | number;
465
+ scrollRootElement?: undefined | Element | EyesSelector<Selector>;
449
466
  sendDom?: undefined | boolean;
450
- matchTimeout?: undefined | number;
451
- forceFullPageScreenshot?: undefined | boolean;
452
- waitBeforeScreenshots?: undefined | number;
467
+ serverUrl?: undefined | string;
468
+ sessionType?: undefined | SessionTypePlain;
453
469
  stitchMode?: undefined | StitchModePlain;
454
- hideScrollbars?: undefined | boolean;
455
- hideCaret?: undefined | boolean;
456
470
  stitchOverlap?: undefined | number;
457
- scrollRootElement?: undefined | Element | EyesSelector<Selector>;
458
- cut?: undefined | CutProviderPlain;
459
- rotation?: undefined | ImageRotationPlain;
460
- scaleRatio?: undefined | number;
461
- concurrentSessions?: undefined | number;
462
- browsersInfo?: undefined | Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { 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"; }; })>;
471
+ testName?: undefined | string;
472
+ useDom?: undefined | boolean;
473
+ viewportSize?: undefined | RectangleSizePlain;
463
474
  visualGridOptions?: undefined | Record<string, any>;
464
- layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
465
- disableBrowserFetching?: undefined | boolean;
466
475
  waitBeforeCapture?: undefined | number;
467
- disableNMLUrlCache?: undefined | boolean;
468
- captureStatusBar?: undefined | boolean;
476
+ waitBeforeScreenshots?: undefined | number;
469
477
  };
470
478
  export class Configuration implements Required<ConfigurationPlain> {
471
479
  constructor(config?: undefined | ConfigurationPlain);
480
+ get accessibilityValidation(): AccessibilitySettings;
481
+ set accessibilityValidation(accessibilityValidation: AccessibilitySettings);
482
+ getAccessibilityValidation(): AccessibilitySettings;
483
+ setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): Configuration;
484
+ get agentId(): string;
485
+ set agentId(agentId: string);
486
+ getAgentId(): string;
487
+ setAgentId(agentId: string): Configuration;
488
+ get apiKey(): string;
489
+ set apiKey(apiKey: string);
490
+ getApiKey(): string;
491
+ setApiKey(apiKey: string): Configuration;
492
+ get appName(): string;
493
+ set appName(appName: string);
494
+ getAppName(): string;
495
+ setAppName(appName: string): Configuration;
496
+ get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
497
+ set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
498
+ getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
499
+ setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
500
+ get baselineBranchName(): string;
501
+ set baselineBranchName(baselineBranchName: string);
502
+ getBaselineBranchName(): string;
503
+ setBaselineBranchName(baselineBranchName: string): Configuration;
504
+ get baselineEnvName(): string;
505
+ set baselineEnvName(baselineEnvName: string);
506
+ getBaselineEnvName(): string;
507
+ setBaselineEnvName(baselineEnvName: string): Configuration;
508
+ get batch(): BatchInfoPlain;
509
+ set batch(batch: BatchInfoPlain);
510
+ getBatch(): BatchInfo;
511
+ setBatch(batch: BatchInfoPlain): Configuration;
512
+ get branchName(): string;
513
+ set branchName(branchName: string);
514
+ getBranchName(): string;
515
+ setBranchName(branchName: string): Configuration;
516
+ get browsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (3rd generation)" | "iPhone SE (2nd generation)" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 13 mini" | "iPhone 12 mini" | "iPhone Xs" | "iPhone Xs Max" | "iPhone 12" | "iPhone 12 Pro" | "iPhone 12 Pro Max" | "iPhone 13" | "iPhone 13 Pro" | "iPhone 13 Pro Max" | "iPhone 14" | "iPhone 14 Pro Max"; }; })>;
517
+ set browsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (3rd generation)" | "iPhone SE (2nd generation)" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 13 mini" | "iPhone 12 mini" | "iPhone Xs" | "iPhone Xs Max" | "iPhone 12" | "iPhone 12 Pro" | "iPhone 12 Pro Max" | "iPhone 13" | "iPhone 13 Pro" | "iPhone 13 Pro Max" | "iPhone 14" | "iPhone 14 Pro Max"; }; })>);
518
+ getBrowsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (3rd generation)" | "iPhone SE (2nd generation)" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 13 mini" | "iPhone 12 mini" | "iPhone Xs" | "iPhone Xs Max" | "iPhone 12" | "iPhone 12 Pro" | "iPhone 12 Pro Max" | "iPhone 13" | "iPhone 13 Pro" | "iPhone 13 Pro Max" | "iPhone 14" | "iPhone 14 Pro Max"; }; })>;
519
+ setBrowsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
520
+ addBrowsers(...browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
521
+ addBrowser(browserInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })): Configuration;
522
+ addBrowser(width: number, height: number, name?: undefined | BrowserTypePlain): Configuration;
523
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | ScreenOrientationPlain): Configuration;
524
+ addMultiDeviceTarget(deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (3rd generation)" | "iPhone SE (2nd generation)" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 13 mini" | "iPhone 12 mini" | "iPhone Xs" | "iPhone Xs Max" | "iPhone 12" | "iPhone 12 Pro" | "iPhone 12 Pro Max" | "iPhone 13" | "iPhone 13 Pro" | "iPhone 13 Pro Max" | "iPhone 14" | "iPhone 14 Pro Max"): Configuration;
525
+ get captureStatusBar(): boolean;
526
+ set captureStatusBar(captureStatusBar: boolean);
527
+ getCaptureStatusBar(): boolean;
528
+ setCaptureStatusBar(captureStatusBar: boolean): Configuration;
529
+ get compareWithParentBranch(): boolean;
530
+ set compareWithParentBranch(compareWithParentBranch: boolean);
531
+ getCompareWithParentBranch(): boolean;
532
+ setCompareWithParentBranch(compareWithParentBranch: boolean): Configuration;
533
+ get concurrentSessions(): number;
534
+ set concurrentSessions(concurrentSessions: number);
535
+ getConcurrentSessions(): number;
536
+ setConcurrentSessions(concurrentSessions: number): Configuration;
537
+ get connectionTimeout(): number;
538
+ set connectionTimeout(connectionTimeout: number);
539
+ getConnectionTimeout(): number;
540
+ setConnectionTimeout(connectionTimeout: number): Configuration;
541
+ get cut(): CutProviderPlain;
542
+ set cut(cut: CutProviderPlain);
543
+ getCut(): CutProviderPlain;
544
+ setCut(cut: CutProviderPlain): Configuration;
472
545
  get debugScreenshots(): { save: boolean; path?: undefined | string; prefix?: undefined | string; };
473
546
  set debugScreenshots(debugScreenshots: { save: boolean; path?: undefined | string; prefix?: undefined | string; });
474
547
  getSaveDebugScreenshots(): boolean;
@@ -477,111 +550,135 @@ export class Configuration implements Required<ConfigurationPlain> {
477
550
  setDebugScreenshotsPath(path: string): Configuration;
478
551
  getDebugScreenshotsPrefix(): string;
479
552
  setDebugScreenshotsPrefix(prefix: string): Configuration;
480
- get appName(): string;
481
- set appName(appName: string);
482
- getAppName(): string;
483
- setAppName(appName: string): Configuration;
484
- get testName(): string;
485
- set testName(testName: string);
486
- getTestName(): string;
487
- setTestName(testName: string): Configuration;
553
+ get defaultMatchSettings(): ImageMatchSettingsPlain;
554
+ set defaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain);
555
+ getDefaultMatchSettings(): ImageMatchSettingsPlain;
556
+ setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain): Configuration;
557
+ get deviceInfo(): string;
558
+ set deviceInfo(deviceInfo: string);
559
+ getDeviceInfo(): string;
560
+ setDeviceInfo(deviceInfo: string): Configuration;
561
+ get disableBrowserFetching(): boolean;
562
+ set disableBrowserFetching(disableBrowserFetching: boolean);
563
+ getDisableBrowserFetching(): boolean;
564
+ setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
565
+ get disableNMLUrlCache(): boolean;
566
+ set disableNMLUrlCache(disableNMLUrlCache: boolean);
567
+ getDisableNMLUrlCache(): boolean;
568
+ setDisableNMLUrlCache(disableNMLUrlCache: boolean): Configuration;
488
569
  get displayName(): string;
489
570
  set displayName(displayName: string);
490
571
  getDisplayName(): string;
491
572
  setDisplayName(displayName: string): Configuration;
573
+ get dontCloseBatches(): boolean;
574
+ set dontCloseBatches(dontCloseBatches: boolean);
575
+ getDontCloseBatches(): boolean;
576
+ setDontCloseBatches(dontCloseBatches: boolean): Configuration;
577
+ get enablePatterns(): boolean;
578
+ set enablePatterns(enablePatterns: boolean);
579
+ getEnablePatterns(): boolean;
580
+ setEnablePatterns(enablePatterns: boolean): Configuration;
581
+ get environmentName(): string;
582
+ set environmentName(environmentName: string);
583
+ getEnvironmentName(): string;
584
+ setEnvironmentName(environmentName: string): Configuration;
585
+ get forceFullPageScreenshot(): boolean;
586
+ set forceFullPageScreenshot(forceFullPageScreenshot: boolean);
587
+ getForceFullPageScreenshot(): boolean;
588
+ setForceFullPageScreenshot(forceFullPageScreenshot: boolean): Configuration;
589
+ get gitMergeBaseTimestamp(): string;
590
+ set gitMergeBaseTimestamp(gitMergeBaseTimestamp: string);
591
+ getGitMergeBaseTimestamp(): string;
592
+ setGitMergeBaseTimestamp(gitMergeBaseTimestamp: string): Configuration;
593
+ get hideCaret(): boolean;
594
+ set hideCaret(hideCaret: boolean);
595
+ getHideCaret(): boolean;
596
+ setHideCaret(hideCaret: boolean): Configuration;
597
+ get hideScrollbars(): boolean;
598
+ set hideScrollbars(hideScrollbars: boolean);
599
+ getHideScrollbars(): boolean;
600
+ setHideScrollbars(hideScrollbars: boolean): Configuration;
601
+ get hostApp(): string;
602
+ set hostApp(hostApp: string);
603
+ getHostApp(): string;
604
+ setHostApp(hostApp: string): Configuration;
605
+ get hostAppInfo(): string;
606
+ set hostAppInfo(hostAppInfo: string);
607
+ getHostAppInfo(): string;
608
+ setHostAppInfo(hostAppInfo: string): Configuration;
609
+ get hostOS(): string;
610
+ set hostOS(hostOS: string);
611
+ getHostOS(): string;
612
+ setHostOS(hostOS: string): Configuration;
613
+ get hostOSInfo(): string;
614
+ set hostOSInfo(hostOSInfo: string);
615
+ getHostOSInfo(): string;
616
+ setHostOSInfo(hostOSInfo: string): Configuration;
617
+ get ignoreBaseline(): boolean;
618
+ set ignoreBaseline(ignoreBaseline: boolean);
619
+ getIgnoreBaseline(): boolean;
620
+ setIgnoreBaseline(ignoreBaseline: boolean): Configuration;
621
+ get ignoreCaret(): boolean;
622
+ set ignoreCaret(ignoreCaret: boolean);
623
+ getIgnoreCaret(): boolean;
624
+ setIgnoreCaret(ignoreCaret: boolean): Configuration;
625
+ get ignoreDisplacements(): boolean;
626
+ set ignoreDisplacements(ignoreDisplacements: boolean);
627
+ getIgnoreDisplacements(): boolean;
628
+ setIgnoreDisplacements(ignoreDisplacements: boolean): Configuration;
629
+ get ignoreGitMergeBase(): boolean;
630
+ set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
631
+ getIgnoreGitMergeBase(): boolean;
632
+ setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): Configuration;
492
633
  get isDisabled(): boolean;
493
634
  set isDisabled(isDisabled: boolean);
494
635
  getIsDisabled(): boolean;
495
636
  setIsDisabled(isDisabled: boolean): Configuration;
637
+ get layoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
638
+ set layoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; });
639
+ getLayoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
640
+ setLayoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; }): Configuration;
641
+ get matchLevel(): MatchLevelPlain;
642
+ set matchLevel(matchLevel: MatchLevelPlain);
643
+ getMatchLevel(): MatchLevel;
644
+ setMatchLevel(matchLevel: MatchLevelPlain): Configuration;
496
645
  get matchTimeout(): number;
497
646
  set matchTimeout(matchTimeout: number);
498
647
  getMatchTimeout(): number;
499
648
  setMatchTimeout(matchTimeout: number): Configuration;
500
- get sessionType(): SessionTypePlain;
501
- set sessionType(sessionType: SessionTypePlain);
502
- getSessionType(): SessionType;
503
- setSessionType(sessionType: SessionTypePlain): Configuration;
504
- get viewportSize(): RectangleSizePlain;
505
- set viewportSize(viewportSize: RectangleSizePlain);
506
- getViewportSize(): RectangleSize;
507
- setViewportSize(viewportSize: RectangleSizePlain): Configuration;
508
- get agentId(): string;
509
- set agentId(agentId: string);
510
- getAgentId(): string;
511
- setAgentId(agentId: string): Configuration;
512
- get apiKey(): string;
513
- set apiKey(apiKey: string);
514
- getApiKey(): string;
515
- setApiKey(apiKey: string): Configuration;
516
- get serverUrl(): string;
517
- set serverUrl(serverUrl: string);
518
- getServerUrl(): string;
519
- setServerUrl(serverUrl: string): Configuration;
649
+ get mobileOptions(): { keepNavigationBar?: undefined | boolean; };
650
+ set mobileOptions(mobileOptions: { keepNavigationBar?: undefined | boolean; });
651
+ getMobileOptions(): { keepNavigationBar?: undefined | boolean; };
652
+ setMobileOptions(mobileOptions: { keepNavigationBar?: undefined | boolean; }): Configuration;
653
+ get parentBranchName(): string;
654
+ set parentBranchName(parentBranchName: string);
655
+ getParentBranchName(): string;
656
+ setParentBranchName(parentBranchName: string): Configuration;
657
+ get properties(): Array<PropertyDataPlain>;
658
+ set properties(properties: Array<PropertyDataPlain>);
659
+ getProperties(): Array<PropertyData>;
660
+ setProperties(properties: Array<PropertyDataPlain>): Configuration;
661
+ addProperty(name: string, value: string): Configuration;
662
+ addProperty(prop: PropertyDataPlain): Configuration;
663
+ clearProperties(): Configuration;
520
664
  get proxy(): ProxySettingsPlain;
521
665
  set proxy(proxy: ProxySettingsPlain);
522
666
  getProxy(): ProxySettings;
523
667
  setProxy(proxy: ProxySettingsPlain): Configuration;
524
668
  setProxy(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean): Configuration;
525
669
  setProxy(isEnabled: false): Configuration;
526
- get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
527
- set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
528
- getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
529
- setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
530
- get connectionTimeout(): number;
531
- set connectionTimeout(connectionTimeout: number);
532
- getConnectionTimeout(): number;
533
- setConnectionTimeout(connectionTimeout: number): Configuration;
534
670
  get removeSession(): boolean;
535
671
  set removeSession(removeSession: boolean);
536
672
  getRemoveSession(): boolean;
537
673
  setRemoveSession(removeSession: boolean): Configuration;
538
- get batch(): BatchInfoPlain;
539
- set batch(batch: BatchInfoPlain);
540
- getBatch(): BatchInfo;
541
- setBatch(batch: BatchInfoPlain): Configuration;
542
- get properties(): Array<PropertyDataPlain>;
543
- set properties(properties: Array<PropertyDataPlain>);
544
- getProperties(): Array<PropertyData>;
545
- setProperties(properties: Array<PropertyDataPlain>): Configuration;
546
- addProperty(name: string, value: string): Configuration;
547
- addProperty(prop: PropertyDataPlain): Configuration;
548
- clearProperties(): Configuration;
549
- get baselineEnvName(): string;
550
- set baselineEnvName(baselineEnvName: string);
551
- getBaselineEnvName(): string;
552
- setBaselineEnvName(baselineEnvName: string): Configuration;
553
- get environmentName(): string;
554
- set environmentName(environmentName: string);
555
- getEnvironmentName(): string;
556
- setEnvironmentName(environmentName: string): Configuration;
557
- get branchName(): string;
558
- set branchName(branchName: string);
559
- getBranchName(): string;
560
- setBranchName(branchName: string): Configuration;
561
- get parentBranchName(): string;
562
- set parentBranchName(parentBranchName: string);
563
- getParentBranchName(): string;
564
- setParentBranchName(parentBranchName: string): Configuration;
565
- get baselineBranchName(): string;
566
- set baselineBranchName(baselineBranchName: string);
567
- getBaselineBranchName(): string;
568
- setBaselineBranchName(baselineBranchName: string): Configuration;
569
- get gitMergeBaseTimestamp(): string;
570
- set gitMergeBaseTimestamp(gitMergeBaseTimestamp: string);
571
- getGitMergeBaseTimestamp(): string;
572
- setGitMergeBaseTimestamp(gitMergeBaseTimestamp: string): Configuration;
573
- get compareWithParentBranch(): boolean;
574
- set compareWithParentBranch(compareWithParentBranch: boolean);
575
- getCompareWithParentBranch(): boolean;
576
- setCompareWithParentBranch(compareWithParentBranch: boolean): Configuration;
577
- get ignoreGitMergeBase(): boolean;
578
- set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
579
- getIgnoreGitMergeBase(): boolean;
580
- setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): Configuration;
581
- get ignoreBaseline(): boolean;
582
- set ignoreBaseline(ignoreBaseline: boolean);
583
- getIgnoreBaseline(): boolean;
584
- setIgnoreBaseline(ignoreBaseline: boolean): Configuration;
674
+ get rotation(): ImageRotationPlain;
675
+ set rotation(rotation: ImageRotationPlain);
676
+ getRotation(): ImageRotation;
677
+ setRotation(rotation: ImageRotation | ImageRotationPlain): Configuration;
678
+ get saveDiffs(): boolean;
679
+ set saveDiffs(saveDiffs: boolean);
680
+ getSaveDiffs(): boolean;
681
+ setSaveDiffs(saveDiffs: boolean): Configuration;
585
682
  get saveFailedTests(): boolean;
586
683
  set saveFailedTests(saveFailedTests: boolean);
587
684
  getSaveFailedTests(): boolean;
@@ -590,134 +687,59 @@ export class Configuration implements Required<ConfigurationPlain> {
590
687
  set saveNewTests(saveNewTests: boolean);
591
688
  getSaveNewTests(): boolean;
592
689
  setSaveNewTests(saveNewTests: boolean): Configuration;
593
- get saveDiffs(): boolean;
594
- set saveDiffs(saveDiffs: boolean);
595
- getSaveDiffs(): boolean;
596
- setSaveDiffs(saveDiffs: boolean): Configuration;
690
+ get scaleRatio(): number;
691
+ set scaleRatio(scaleRatio: number);
692
+ getScaleRatio(): number;
693
+ setScaleRatio(scaleRatio: number): Configuration;
694
+ get scrollRootElement(): Element | EyesSelector<Selector>;
695
+ set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
696
+ getScrollRootElement(): Element | EyesSelector<Selector>;
697
+ setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): Configuration;
597
698
  get sendDom(): boolean;
598
699
  set sendDom(sendDom: boolean);
599
700
  getSendDom(): boolean;
600
701
  setSendDom(sendDom: boolean): Configuration;
601
- get hostApp(): string;
602
- set hostApp(hostApp: string);
603
- getHostApp(): string;
604
- setHostApp(hostApp: string): Configuration;
605
- get hostOS(): string;
606
- set hostOS(hostOS: string);
607
- getHostOS(): string;
608
- setHostOS(hostOS: string): Configuration;
609
- get hostAppInfo(): string;
610
- set hostAppInfo(hostAppInfo: string);
611
- getHostAppInfo(): string;
612
- setHostAppInfo(hostAppInfo: string): Configuration;
613
- get hostOSInfo(): string;
614
- set hostOSInfo(hostOSInfo: string);
615
- getHostOSInfo(): string;
616
- setHostOSInfo(hostOSInfo: string): Configuration;
617
- get deviceInfo(): string;
618
- set deviceInfo(deviceInfo: string);
619
- getDeviceInfo(): string;
620
- setDeviceInfo(deviceInfo: string): Configuration;
621
- get defaultMatchSettings(): ImageMatchSettingsPlain;
622
- set defaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain);
623
- getDefaultMatchSettings(): ImageMatchSettingsPlain;
624
- setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain): Configuration;
625
- getMatchLevel(): MatchLevel;
626
- setMatchLevel(matchLevel: MatchLevelPlain): Configuration;
627
- getAccessibilityValidation(): AccessibilitySettings;
628
- setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): Configuration;
629
- getUseDom(): boolean;
630
- setUseDom(useDom: boolean): Configuration;
631
- getEnablePatterns(): boolean;
632
- setEnablePatterns(enablePatterns: boolean): Configuration;
633
- getIgnoreDisplacements(): boolean;
634
- setIgnoreDisplacements(ignoreDisplacements: boolean): Configuration;
635
- getIgnoreCaret(): boolean;
636
- setIgnoreCaret(ignoreCaret: boolean): Configuration;
637
- get forceFullPageScreenshot(): boolean;
638
- set forceFullPageScreenshot(forceFullPageScreenshot: boolean);
639
- getForceFullPageScreenshot(): boolean;
640
- setForceFullPageScreenshot(forceFullPageScreenshot: boolean): Configuration;
641
- get waitBeforeScreenshots(): number;
642
- set waitBeforeScreenshots(waitBeforeScreenshots: number);
643
- getWaitBeforeScreenshots(): number;
644
- setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration;
645
- get waitBeforeCapture(): number;
646
- set waitBeforeCapture(waitBeforeCapture: number);
647
- getWaitBeforeCapture(): number;
648
- setWaitBeforeCapture(waitBeforeCapture: number): Configuration;
702
+ get serverUrl(): string;
703
+ set serverUrl(serverUrl: string);
704
+ getServerUrl(): string;
705
+ setServerUrl(serverUrl: string): Configuration;
706
+ get sessionType(): SessionTypePlain;
707
+ set sessionType(sessionType: SessionTypePlain);
708
+ getSessionType(): SessionType;
709
+ setSessionType(sessionType: SessionTypePlain): Configuration;
649
710
  get stitchMode(): StitchModePlain;
650
711
  set stitchMode(stitchMode: StitchModePlain);
651
712
  getStitchMode(): StitchMode;
652
713
  setStitchMode(stitchMode: StitchModePlain): Configuration;
653
- get hideScrollbars(): boolean;
654
- set hideScrollbars(hideScrollbars: boolean);
655
- getHideScrollbars(): boolean;
656
- setHideScrollbars(hideScrollbars: boolean): Configuration;
657
- get hideCaret(): boolean;
658
- set hideCaret(hideCaret: boolean);
659
- getHideCaret(): boolean;
660
- setHideCaret(hideCaret: boolean): Configuration;
661
714
  get stitchOverlap(): number;
662
715
  set stitchOverlap(stitchOverlap: number);
663
716
  getStitchOverlap(): number;
664
717
  setStitchOverlap(stitchOverlap: number): Configuration;
665
- get scrollRootElement(): Element | EyesSelector<Selector>;
666
- set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
667
- getScrollRootElement(): Element | EyesSelector<Selector>;
668
- setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): Configuration;
669
- get cut(): CutProviderPlain;
670
- set cut(cut: CutProviderPlain);
671
- getCut(): CutProviderPlain;
672
- setCut(cut: CutProviderPlain): Configuration;
673
- get rotation(): ImageRotationPlain;
674
- set rotation(rotation: ImageRotationPlain);
675
- getRotation(): ImageRotation;
676
- setRotation(rotation: ImageRotation | ImageRotationPlain): Configuration;
677
- get scaleRatio(): number;
678
- set scaleRatio(scaleRatio: number);
679
- getScaleRatio(): number;
680
- setScaleRatio(scaleRatio: number): Configuration;
681
- get concurrentSessions(): number;
682
- set concurrentSessions(concurrentSessions: number);
683
- getConcurrentSessions(): number;
684
- setConcurrentSessions(concurrentSessions: number): Configuration;
685
- get browsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { 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"; }; })>;
686
- set browsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { 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"; }; })>);
687
- getBrowsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { 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"; }; })>;
688
- setBrowsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
689
- addBrowsers(...browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
690
- addBrowser(browserInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })): Configuration;
691
- addBrowser(width: number, height: number, name?: undefined | BrowserTypePlain): Configuration;
692
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | ScreenOrientationPlain): Configuration;
693
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
694
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
695
- addMultiDeviceTarget(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"): Configuration;
718
+ get testName(): string;
719
+ set testName(testName: string);
720
+ getTestName(): string;
721
+ setTestName(testName: string): Configuration;
722
+ get useDom(): boolean;
723
+ set useDom(useDom: boolean);
724
+ getUseDom(): boolean;
725
+ setUseDom(useDom: boolean): Configuration;
726
+ get viewportSize(): RectangleSizePlain;
727
+ set viewportSize(viewportSize: RectangleSizePlain);
728
+ getViewportSize(): RectangleSize;
729
+ setViewportSize(viewportSize: RectangleSizePlain): Configuration;
696
730
  get visualGridOptions(): { [key: string]: any; };
697
731
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
698
732
  getVisualGridOptions(): { [key: string]: any; };
699
733
  setVisualGridOptions(visualGridOptions: { [key: string]: any; }): Configuration;
700
734
  setVisualGridOption(key: string, value: any): Configuration;
701
- get layoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
702
- set layoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; });
703
- getLayoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
704
- setLayoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; }): Configuration;
705
- get disableBrowserFetching(): boolean;
706
- set disableBrowserFetching(disableBrowserFetching: boolean);
707
- getDisableBrowserFetching(): boolean;
708
- setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
709
- get dontCloseBatches(): boolean;
710
- set dontCloseBatches(dontCloseBatches: boolean);
711
- getDontCloseBatches(): boolean;
712
- setDontCloseBatches(dontCloseBatches: boolean): Configuration;
713
- get disableNMLUrlCache(): boolean;
714
- set disableNMLUrlCache(disableNMLUrlCache: boolean);
715
- getDisableNMLUrlCache(): boolean;
716
- setDisableNMLUrlCache(disableNMLUrlCache: boolean): Configuration;
717
- get captureStatusBar(): boolean;
718
- set captureStatusBar(captureStatusBar: boolean);
719
- getCaptureStatusBar(): boolean;
720
- setCaptureStatusBar(captureStatusBar: boolean): Configuration;
735
+ get waitBeforeCapture(): number;
736
+ set waitBeforeCapture(waitBeforeCapture: number);
737
+ getWaitBeforeCapture(): number;
738
+ setWaitBeforeCapture(waitBeforeCapture: number): Configuration;
739
+ get waitBeforeScreenshots(): number;
740
+ set waitBeforeScreenshots(waitBeforeScreenshots: number);
741
+ getWaitBeforeScreenshots(): number;
742
+ setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration;
721
743
  }
722
744
  export class BatchClose {
723
745
  static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
@@ -916,7 +938,7 @@ export enum FailureReport {
916
938
  IMMEDIATE = 'IMMEDIATE',
917
939
  ON_CLOSE = 'ON_CLOSE'
918
940
  }
919
- export type IosDeviceNamePlain = "iPhone X" | "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";
941
+ export type IosDeviceNamePlain = "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone 15 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (3rd generation)" | "iPhone SE (2nd generation)" | "iPhone 13 mini" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 12" | "iPhone 12 Pro" | "iPhone 12 Pro Max" | "iPhone 13" | "iPhone 13 Pro" | "iPhone 13 Pro Max" | "iPhone 14" | "iPhone 14 Pro Max" | "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 15" | "iPhone 15 Pro Max" | "iPhone 15 Plus" | "iPhone 16" | "iPhone 16 Pro Max" | "iPhone 16 Pro" | "iPhone 16 Plus";
920
942
  export enum IosDeviceName {
921
943
  iPad_7 = 'iPad (7th generation)',
922
944
  iPad_9 = 'iPad (9th generation)',
@@ -957,49 +979,12 @@ export enum IosDeviceName {
957
979
  iPhone_16_Pro = 'iPhone 16 Pro',
958
980
  iPhone_16_Plus = 'iPhone 16 Plus'
959
981
  }
960
- export type IosVersionPlain = AndroidVersionPlain;
982
+ export type IosVersionPlain = "latest" | "latest-1";
961
983
  export enum IosVersion {
962
984
  LATEST = 'latest',
963
985
  ONE_VERSION_BACK = 'latest-1',
964
986
  LATEST_ONE_VERSION_BACK = 'latest-1'
965
987
  }
966
- export type AndroidDeviceNamePlain = "Galaxy S20" | "Galaxy S22" | "Galaxy S21" | "Galaxy S21 Ultra" | "Galaxy S10" | "Galaxy S9" | "Galaxy S10 Plus" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Tab S8" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Galaxy Tab S7" | "Sony Xperia 10 II" | "Galaxy S20 Plus" | "Galaxy S21 Plus" | "Xiaomi Redmi Note 11 Pro" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 10 JE" | "Pixel 6" | "Galaxy S22 Plus" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite";
967
- export enum AndroidDeviceName {
968
- Galaxy_S20 = 'Galaxy S20',
969
- Galaxy_S20_Plus = 'Galaxy S20 Plus',
970
- Galaxy_S20_PLUS = 'Galaxy S20 Plus',
971
- Galaxy_S21_Ultra = 'Galaxy S21 Ultra',
972
- Galaxy_S21_ULTRA = 'Galaxy S21 Ultra',
973
- Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus',
974
- Galaxy_S9 = 'Galaxy S9',
975
- Galaxy_S10 = 'Galaxy S10',
976
- Galaxy_S10_Plus = 'Galaxy S10 Plus',
977
- Pixel_4_XL = 'Pixel 4 XL',
978
- Pixel_3_XL = 'Pixel 3 XL',
979
- Galaxy_S21 = 'Galaxy S21',
980
- Galaxy_S21_Plus = 'Galaxy S21 Plus',
981
- Galaxy_S21_PLUS = 'Galaxy S21 Plus',
982
- Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro',
983
- Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
984
- Xiaomi_Redmi_Note_10_JE = 'Xiaomi Redmi Note 10 JE',
985
- Pixel_6 = 'Pixel 6',
986
- Galaxy_Note_10 = 'Galaxy Note 10',
987
- Pixel_4 = 'Pixel 4',
988
- Pixel_5 = 'Pixel 5',
989
- Galaxy_S22 = 'Galaxy S22',
990
- Galaxy_S22_Plus = 'Galaxy S22 Plus',
991
- Galaxy_Tab_S8 = 'Galaxy Tab S8',
992
- Galaxy_Tab_S7 = 'Galaxy Tab S7',
993
- Sony_Xperia_10_II = 'Sony Xperia 10 II',
994
- Sony_Xperia_1_II = 'Sony Xperia 1 II',
995
- Sony_Xperia_Ace_II = 'Sony Xperia Ace II',
996
- Huawei_P30_Lite = 'Huawei P30 Lite'
997
- }
998
- export type AndroidVersionPlain = "latest" | "latest-1";
999
- export enum AndroidVersion {
1000
- LATEST = 'latest',
1001
- ONE_VERSION_BACK = 'latest-1'
1002
- }
1003
988
  export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Dynamic" | "Exact";
1004
989
  export enum MatchLevel {
1005
990
  None = 'None',
@@ -1166,24 +1151,24 @@ export class CheckSettingsImage {
1166
1151
  withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
1167
1152
  region(region: RegionPlain | LegacyRegionPlain): CheckSettingsImage;
1168
1153
  withName(name: string): CheckSettingsImage;
1169
- ignoreRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1170
- ignoreRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1154
+ ignoreRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1155
+ ignoreRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1171
1156
  ignore(region: RegionPlain | LegacyRegionPlain): CheckSettingsImage;
1172
1157
  ignores(...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1173
- layoutRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1174
- layoutRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1175
- strictRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1176
- strictRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1177
- contentRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1178
- contentRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1158
+ layoutRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1159
+ layoutRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1160
+ strictRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1161
+ strictRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1162
+ contentRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1163
+ contentRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1179
1164
  floatingRegion(region: {
1180
- region: RegionPlain;
1165
+ region: RegionPlain | LegacyRegionPlain;
1181
1166
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1182
1167
  regionId?: undefined | string;
1183
1168
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1184
1169
  }): CheckSettingsImage;
1185
1170
  floatingRegion(region: {
1186
- region: RegionPlain;
1171
+ region: RegionPlain | LegacyRegionPlain;
1187
1172
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1188
1173
  regionId?: undefined | string;
1189
1174
  maxUpOffset?: undefined | number;
@@ -1193,42 +1178,42 @@ export class CheckSettingsImage {
1193
1178
  }): CheckSettingsImage;
1194
1179
  floatingRegion(region: RegionPlain | LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1195
1180
  floatingRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
1196
- region: RegionPlain;
1181
+ region: RegionPlain | LegacyRegionPlain;
1197
1182
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1198
1183
  regionId?: undefined | string;
1199
1184
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1200
1185
  }>): CheckSettingsImage;
1201
1186
  floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1202
1187
  floating(region: {
1203
- region: RegionPlain;
1188
+ region: RegionPlain | LegacyRegionPlain;
1204
1189
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1205
1190
  regionId?: undefined | string;
1206
1191
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1207
1192
  }): CheckSettingsImage;
1208
1193
  floating(region: RegionPlain | LegacyRegionPlain): CheckSettingsImage;
1209
1194
  floatings(...regions: Array<RegionPlain | LegacyRegionPlain | {
1210
- region: RegionPlain;
1195
+ region: RegionPlain | LegacyRegionPlain;
1211
1196
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1212
1197
  regionId?: undefined | string;
1213
1198
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1214
1199
  }>): CheckSettingsImage;
1215
1200
  floatings(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1216
1201
  accessibilityRegion(region: {
1217
- region: RegionPlain;
1202
+ region: RegionPlain | LegacyRegionPlain;
1218
1203
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1219
1204
  regionId?: undefined | string;
1220
1205
  type?: undefined | AccessibilityRegionTypePlain;
1221
1206
  }): CheckSettingsImage;
1222
1207
  accessibilityRegion(region: RegionPlain | LegacyRegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsImage;
1223
1208
  accessibilityRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
1224
- region: RegionPlain;
1209
+ region: RegionPlain | LegacyRegionPlain;
1225
1210
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1226
1211
  regionId?: undefined | string;
1227
1212
  type?: undefined | AccessibilityRegionTypePlain;
1228
1213
  }>): CheckSettingsImage;
1229
1214
  accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1230
1215
  dynamicRegion(region: {
1231
- region: RegionPlain;
1216
+ region: RegionPlain | LegacyRegionPlain;
1232
1217
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1233
1218
  regionId?: undefined | string;
1234
1219
  type?: undefined | string | Array<string>;
@@ -1236,7 +1221,7 @@ export class CheckSettingsImage {
1236
1221
  dynamicRegion(region: RegionPlain): CheckSettingsImage;
1237
1222
  dynamicRegion(region: RegionPlain, type?: undefined | string | Array<string>): CheckSettingsImage;
1238
1223
  dynamicRegions(...regions: Array<RegionPlain | {
1239
- region: RegionPlain;
1224
+ region: RegionPlain | LegacyRegionPlain;
1240
1225
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1241
1226
  regionId?: undefined | string;
1242
1227
  type?: undefined | string | Array<string>;
@@ -1575,8 +1560,7 @@ export class Region implements Required<RegionPlain> {
1575
1560
  }
1576
1561
  export type DesktopBrowserInfo = { name?: undefined | BrowserTypePlain; width: number; height: number; };
1577
1562
  export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1578
- export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | AndroidVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1579
- export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | AndroidVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1563
+ export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | IosVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1580
1564
  export type RunnerOptionsPlain = { testConcurrency?: undefined | number; fetchConcurrency?: undefined | number; removeDuplicateTests?: undefined | boolean; };
1581
1565
  export class RunnerOptionsFluent {
1582
1566
  testConcurrency(concurrency: number): RunnerOptionsFluent;
@@ -1807,14 +1791,14 @@ export class TestResults implements Required<TestResultsPlain> {
1807
1791
  delete(): Promise<void>;
1808
1792
  deleteSession(): Promise<void>;
1809
1793
  }
1810
- export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }); };
1794
+ export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }); };
1811
1795
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1812
1796
  get testResults(): TestResultsPlain;
1813
1797
  getTestResults(): TestResults;
1814
1798
  get exception(): Error;
1815
1799
  getException(): Error;
1816
- get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1817
- getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1800
+ get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1801
+ getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1818
1802
  }
1819
1803
  export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1820
1804
  export class TestResultsSummary implements Iterable<TestResultContainer> {