@applitools/eyes-puppeteer 1.27.11 → 1.27.12
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.
- package/CHANGELOG.md +48 -0
- package/package.json +4 -4
- package/types/index.d.ts +370 -380
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,53 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.27.12](https://github.com/Applitools-Dev/sdk/compare/js/eyes-puppeteer@1.27.11...js/eyes-puppeteer@1.27.12) (2024-11-27)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Dependencies
|
|
7
|
+
|
|
8
|
+
* @applitools/dom-shared bumped to 1.0.16
|
|
9
|
+
#### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* 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))
|
|
12
|
+
* @applitools/dom-snapshot bumped to 4.11.11
|
|
13
|
+
|
|
14
|
+
* @applitools/req bumped to 1.7.4
|
|
15
|
+
#### Bug Fixes
|
|
16
|
+
|
|
17
|
+
* 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))
|
|
18
|
+
* @applitools/core bumped to 4.24.2
|
|
19
|
+
#### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* 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))
|
|
22
|
+
* 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))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
* @applitools/dom-capture bumped to 11.5.2
|
|
27
|
+
|
|
28
|
+
* @applitools/nml-client bumped to 1.8.19
|
|
29
|
+
|
|
30
|
+
* @applitools/tunnel-client bumped to 1.5.10
|
|
31
|
+
|
|
32
|
+
* @applitools/ufg-client bumped to 1.14.1
|
|
33
|
+
|
|
34
|
+
* @applitools/core-base bumped to 1.19.3
|
|
35
|
+
#### Bug Fixes
|
|
36
|
+
|
|
37
|
+
* 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))
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
* @applitools/ec-client bumped to 1.9.15
|
|
42
|
+
|
|
43
|
+
* @applitools/eyes bumped to 1.28.0
|
|
44
|
+
#### Features
|
|
45
|
+
|
|
46
|
+
* remove Android NMG API ([#2566](https://github.com/Applitools-Dev/sdk/issues/2566)) ([750c0f0](https://github.com/Applitools-Dev/sdk/commit/750c0f0263e5ff06f86055e7ba0c3fb47cadb620))
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
3
51
|
## [1.27.11](https://github.com/Applitools-Dev/sdk/compare/js/eyes-puppeteer@1.27.10...js/eyes-puppeteer@1.27.11) (2024-10-29)
|
|
4
52
|
|
|
5
53
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applitools/eyes-puppeteer",
|
|
3
|
-
"version": "1.27.
|
|
3
|
+
"version": "1.27.12",
|
|
4
4
|
"description": "Applitools Eyes SDK for Puppeteer",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eyes-puppeteer",
|
|
@@ -36,13 +36,13 @@
|
|
|
36
36
|
"up:framework": "echo \"$(jq '.devDependencies.puppeteer = $ENV.APPLITOOLS_FRAMEWORK_VERSION' ./package.json)\" > ./package.json"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@applitools/eyes": "1.
|
|
40
|
-
"@applitools/spec-driver-puppeteer": "1.4.
|
|
39
|
+
"@applitools/eyes": "1.28.0",
|
|
40
|
+
"@applitools/spec-driver-puppeteer": "1.4.20"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"@applitools/api-extractor": "^1.2.22",
|
|
44
44
|
"@applitools/bongo": "^5.10.0",
|
|
45
|
-
"@applitools/generic": "^3.9.
|
|
45
|
+
"@applitools/generic": "^3.9.2",
|
|
46
46
|
"@applitools/test-utils": "^1.5.17",
|
|
47
47
|
"@types/node": "^12.20.55",
|
|
48
48
|
"puppeteer": "^22.0.0"
|
package/types/index.d.ts
CHANGED
|
@@ -174,7 +174,7 @@ export class Eyes {
|
|
|
174
174
|
}
|
|
175
175
|
export type CheckSettingsImagePlain = {
|
|
176
176
|
name?: undefined | string;
|
|
177
|
-
region?: undefined | RegionPlain;
|
|
177
|
+
region?: undefined | RegionPlain | LegacyRegionPlain;
|
|
178
178
|
matchLevel?: undefined | MatchLevelPlain;
|
|
179
179
|
useDom?: undefined | boolean;
|
|
180
180
|
sendDom?: undefined | boolean;
|
|
@@ -182,17 +182,17 @@ export type CheckSettingsImagePlain = {
|
|
|
182
182
|
ignoreDisplacements?: undefined | boolean;
|
|
183
183
|
ignoreMismatch?: undefined | boolean;
|
|
184
184
|
ignoreCaret?: undefined | boolean;
|
|
185
|
-
ignoreRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
186
|
-
layoutRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
187
|
-
strictRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
188
|
-
contentRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
189
|
-
floatingRegions?: undefined | Array<RegionPlain | {
|
|
190
|
-
region: RegionPlain;
|
|
185
|
+
ignoreRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
186
|
+
layoutRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
187
|
+
strictRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
188
|
+
contentRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
|
|
189
|
+
floatingRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | {
|
|
190
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
191
191
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
192
192
|
regionId?: undefined | string;
|
|
193
193
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
194
194
|
} | {
|
|
195
|
-
region: RegionPlain;
|
|
195
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
196
196
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
197
197
|
regionId?: undefined | string;
|
|
198
198
|
maxUpOffset?: undefined | number;
|
|
@@ -200,14 +200,14 @@ export type CheckSettingsImagePlain = {
|
|
|
200
200
|
maxLeftOffset?: undefined | number;
|
|
201
201
|
maxRightOffset?: undefined | number;
|
|
202
202
|
}>;
|
|
203
|
-
accessibilityRegions?: undefined | Array<RegionPlain | {
|
|
204
|
-
region: RegionPlain;
|
|
203
|
+
accessibilityRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | {
|
|
204
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
205
205
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
206
206
|
regionId?: undefined | string;
|
|
207
207
|
type?: undefined | AccessibilityRegionTypePlain;
|
|
208
208
|
}>;
|
|
209
209
|
dynamicRegions?: undefined | Array<RegionPlain | {
|
|
210
|
-
region: RegionPlain;
|
|
210
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
211
211
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
212
212
|
regionId?: undefined | string;
|
|
213
213
|
type?: undefined | string | Array<string>;
|
|
@@ -218,7 +218,7 @@ export type CheckSettingsImagePlain = {
|
|
|
218
218
|
};
|
|
219
219
|
export type CheckSettingsAutomationPlain = {
|
|
220
220
|
name?: undefined | string;
|
|
221
|
-
region?: undefined | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })));
|
|
221
|
+
region?: undefined | (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })));
|
|
222
222
|
matchLevel?: undefined | MatchLevelPlain;
|
|
223
223
|
useDom?: undefined | boolean;
|
|
224
224
|
sendDom?: undefined | boolean;
|
|
@@ -226,17 +226,17 @@ export type CheckSettingsAutomationPlain = {
|
|
|
226
226
|
ignoreDisplacements?: undefined | boolean;
|
|
227
227
|
ignoreMismatch?: undefined | boolean;
|
|
228
228
|
ignoreCaret?: undefined | boolean;
|
|
229
|
-
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; }>;
|
|
230
|
-
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; }>;
|
|
231
|
-
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; }>;
|
|
232
|
-
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; }>;
|
|
233
|
-
floatingRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
234
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
229
|
+
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; }>;
|
|
230
|
+
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; }>;
|
|
231
|
+
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; }>;
|
|
232
|
+
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; }>;
|
|
233
|
+
floatingRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
234
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
235
235
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
236
236
|
regionId?: undefined | string;
|
|
237
237
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
238
238
|
} | {
|
|
239
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
239
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
240
240
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
241
241
|
regionId?: undefined | string;
|
|
242
242
|
maxUpOffset?: undefined | number;
|
|
@@ -244,14 +244,14 @@ export type CheckSettingsAutomationPlain = {
|
|
|
244
244
|
maxLeftOffset?: undefined | number;
|
|
245
245
|
maxRightOffset?: undefined | number;
|
|
246
246
|
}>;
|
|
247
|
-
accessibilityRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
248
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
247
|
+
accessibilityRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
248
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
249
249
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
250
250
|
regionId?: undefined | string;
|
|
251
251
|
type?: undefined | AccessibilityRegionTypePlain;
|
|
252
252
|
}>;
|
|
253
|
-
dynamicRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
254
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
253
|
+
dynamicRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
254
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
255
255
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
256
256
|
regionId?: undefined | string;
|
|
257
257
|
type?: undefined | string | Array<string>;
|
|
@@ -266,6 +266,7 @@ export type CheckSettingsAutomationPlain = {
|
|
|
266
266
|
disableBrowserFetching?: undefined | boolean;
|
|
267
267
|
layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
|
|
268
268
|
visualGridOptions?: undefined | { [key: string]: any; };
|
|
269
|
+
ufgOptions?: undefined | { [key: string]: any; };
|
|
269
270
|
nmgOptions?: undefined | { [key: string]: any; };
|
|
270
271
|
useSystemScreenshot?: undefined | boolean;
|
|
271
272
|
hooks?: undefined | { beforeCaptureScreenshot: string; };
|
|
@@ -277,6 +278,7 @@ export class CheckSettingsAutomation {
|
|
|
277
278
|
constructor(settings?: undefined | CheckSettingsAutomation);
|
|
278
279
|
constructor(settings?: undefined | CheckSettingsAutomationPlain);
|
|
279
280
|
region(region: RegionPlain): CheckSettingsAutomation;
|
|
281
|
+
region(region: LegacyRegionPlain): CheckSettingsAutomation;
|
|
280
282
|
region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
281
283
|
shadow(selector: string): CheckSettingsAutomation;
|
|
282
284
|
shadow(selector: Selector): CheckSettingsAutomation;
|
|
@@ -310,33 +312,30 @@ export class CheckSettingsAutomation {
|
|
|
310
312
|
densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
|
|
311
313
|
name(name: string): CheckSettingsAutomation;
|
|
312
314
|
withName(name: string): CheckSettingsAutomation;
|
|
313
|
-
ignoreRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
|
|
314
|
-
ignoreRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
ignore(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
|
|
315
|
+
ignoreRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
|
|
316
|
+
ignoreRegion(region: { 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;
|
|
317
|
+
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;
|
|
318
|
+
ignore(region: RegionPlain): CheckSettingsAutomation;
|
|
318
319
|
ignore(region: LegacyRegionPlain): CheckSettingsAutomation;
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
layoutRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
|
|
322
|
-
layoutRegion(region: { 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;
|
|
323
|
-
layoutRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) |
|
|
324
|
-
strictRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
|
|
325
|
-
strictRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
contentRegion(region:
|
|
329
|
-
|
|
330
|
-
contentRegion(region: { 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;
|
|
331
|
-
contentRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { 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;
|
|
320
|
+
ignore(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
321
|
+
ignores(...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
|
|
322
|
+
layoutRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
|
|
323
|
+
layoutRegion(region: { 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;
|
|
324
|
+
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;
|
|
325
|
+
strictRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
|
|
326
|
+
strictRegion(region: { 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;
|
|
327
|
+
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;
|
|
328
|
+
contentRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
|
|
329
|
+
contentRegion(region: { 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;
|
|
330
|
+
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;
|
|
332
331
|
floatingRegion(region: {
|
|
333
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
332
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
334
333
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
335
334
|
regionId?: undefined | string;
|
|
336
335
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
337
336
|
}): CheckSettingsAutomation;
|
|
338
337
|
floatingRegion(region: {
|
|
339
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
338
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
340
339
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
341
340
|
regionId?: undefined | string;
|
|
342
341
|
maxUpOffset?: undefined | number;
|
|
@@ -344,59 +343,65 @@ export class CheckSettingsAutomation {
|
|
|
344
343
|
maxLeftOffset?: undefined | number;
|
|
345
344
|
maxRightOffset?: undefined | number;
|
|
346
345
|
}): CheckSettingsAutomation;
|
|
347
|
-
floatingRegion(region:
|
|
346
|
+
floatingRegion(region: RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
|
|
348
347
|
floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
|
|
349
|
-
|
|
350
|
-
|
|
348
|
+
floatingRegion(region: (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;
|
|
349
|
+
floatingRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
350
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
351
351
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
352
352
|
regionId?: undefined | string;
|
|
353
353
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
354
354
|
}>): CheckSettingsAutomation;
|
|
355
|
-
floatingRegions(maxOffset: number, ...regions: Array<
|
|
355
|
+
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;
|
|
356
356
|
floating(region: {
|
|
357
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
357
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
358
358
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
359
359
|
regionId?: undefined | string;
|
|
360
360
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
361
361
|
}): CheckSettingsAutomation;
|
|
362
|
-
floating(region:
|
|
362
|
+
floating(region: RegionPlain): CheckSettingsAutomation;
|
|
363
363
|
floating(region: LegacyRegionPlain): CheckSettingsAutomation;
|
|
364
|
-
|
|
365
|
-
|
|
364
|
+
floating(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
365
|
+
floatings(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
366
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
366
367
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
367
368
|
regionId?: undefined | string;
|
|
368
369
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
369
370
|
}>): CheckSettingsAutomation;
|
|
370
|
-
floatings(maxOffset: number, ...regions: Array<
|
|
371
|
+
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;
|
|
371
372
|
accessibilityRegion(region: {
|
|
372
|
-
region: RegionPlain | (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 | AccessibilityRegionTypePlain;
|
|
376
377
|
}): CheckSettingsAutomation;
|
|
377
|
-
accessibilityRegion(region:
|
|
378
|
+
accessibilityRegion(region: RegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
|
|
378
379
|
accessibilityRegion(region: LegacyRegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
|
|
379
|
-
|
|
380
|
-
|
|
380
|
+
accessibilityRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
|
|
381
|
+
accessibilityRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
382
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
381
383
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
382
384
|
regionId?: undefined | string;
|
|
383
385
|
type?: undefined | AccessibilityRegionTypePlain;
|
|
384
386
|
}>): CheckSettingsAutomation;
|
|
385
|
-
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<
|
|
387
|
+
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;
|
|
386
388
|
dynamicRegion(region: {
|
|
387
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
389
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
388
390
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
389
391
|
regionId?: undefined | string;
|
|
390
392
|
type?: undefined | string | Array<string>;
|
|
391
393
|
}): CheckSettingsAutomation;
|
|
392
394
|
dynamicRegion(region: RegionPlain): CheckSettingsAutomation;
|
|
395
|
+
dynamicRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
|
|
393
396
|
dynamicRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
394
397
|
dynamicRegion(region: RegionPlain, type?: undefined | string): CheckSettingsAutomation;
|
|
398
|
+
dynamicRegion(region: LegacyRegionPlain, type?: undefined | string): CheckSettingsAutomation;
|
|
395
399
|
dynamicRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | string): CheckSettingsAutomation;
|
|
396
400
|
dynamicRegion(region: RegionPlain, type?: undefined | Array<string>): CheckSettingsAutomation;
|
|
401
|
+
dynamicRegion(region: LegacyRegionPlain, type?: undefined | Array<string>): CheckSettingsAutomation;
|
|
397
402
|
dynamicRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | Array<string>): CheckSettingsAutomation;
|
|
398
|
-
dynamicRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
399
|
-
region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
403
|
+
dynamicRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
|
|
404
|
+
region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
|
|
400
405
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
401
406
|
regionId?: undefined | string;
|
|
402
407
|
type?: undefined | string | Array<string>;
|
|
@@ -420,8 +425,9 @@ export class CheckSettings extends CheckSettingsAutomation {
|
|
|
420
425
|
}
|
|
421
426
|
export type TargetAutomation = {
|
|
422
427
|
window(): CheckSettingsAutomation;
|
|
423
|
-
region(region:
|
|
428
|
+
region(region: RegionPlain): CheckSettingsAutomation;
|
|
424
429
|
region(region: LegacyRegionPlain): CheckSettingsAutomation;
|
|
430
|
+
region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
425
431
|
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;
|
|
426
432
|
frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
427
433
|
frame(frame: (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;
|
|
@@ -433,8 +439,9 @@ export type TargetAutomation = {
|
|
|
433
439
|
};
|
|
434
440
|
export const TargetAutomation: {
|
|
435
441
|
window(): CheckSettingsAutomation;
|
|
436
|
-
region(region:
|
|
442
|
+
region(region: RegionPlain): CheckSettingsAutomation;
|
|
437
443
|
region(region: LegacyRegionPlain): CheckSettingsAutomation;
|
|
444
|
+
region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
438
445
|
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;
|
|
439
446
|
frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
|
|
440
447
|
frame(frame: (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;
|
|
@@ -448,64 +455,158 @@ export type Target = TargetImage & TargetAutomation;
|
|
|
448
455
|
export const Target: TargetImage & TargetAutomation;
|
|
449
456
|
export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
|
|
450
457
|
export type ConfigurationPlain = {
|
|
451
|
-
|
|
458
|
+
accessibilityValidation?: undefined | AccessibilitySettings;
|
|
452
459
|
agentId?: undefined | string;
|
|
453
460
|
apiKey?: undefined | string;
|
|
454
|
-
serverUrl?: undefined | string;
|
|
455
|
-
proxy?: undefined | ProxySettingsPlain;
|
|
456
|
-
autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
|
|
457
|
-
isDisabled?: undefined | boolean;
|
|
458
|
-
connectionTimeout?: undefined | number;
|
|
459
|
-
removeSession?: undefined | boolean;
|
|
460
461
|
appName?: undefined | string;
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
sessionType?: undefined | SessionTypePlain;
|
|
465
|
-
properties?: undefined | Array<PropertyDataPlain>;
|
|
462
|
+
autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
|
|
463
|
+
baselineBranchName?: undefined | string;
|
|
464
|
+
baselineEnvName?: undefined | string;
|
|
466
465
|
batch?: undefined | BatchInfoPlain;
|
|
466
|
+
branchName?: undefined | string;
|
|
467
|
+
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 (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"; }; })>;
|
|
468
|
+
captureStatusBar?: undefined | boolean;
|
|
469
|
+
compareWithParentBranch?: undefined | boolean;
|
|
470
|
+
concurrentSessions?: undefined | number;
|
|
471
|
+
connectionTimeout?: undefined | number;
|
|
472
|
+
cut?: undefined | CutProviderPlain;
|
|
473
|
+
debugScreenshots?: undefined | { save: boolean; path?: undefined | string; prefix?: undefined | string; };
|
|
467
474
|
defaultMatchSettings?: undefined | ImageMatchSettingsPlain;
|
|
468
|
-
hostApp?: undefined | string;
|
|
469
|
-
hostOS?: undefined | string;
|
|
470
|
-
hostAppInfo?: undefined | string;
|
|
471
|
-
hostOSInfo?: undefined | string;
|
|
472
475
|
deviceInfo?: undefined | string;
|
|
473
|
-
|
|
476
|
+
disableBrowserFetching?: undefined | boolean;
|
|
477
|
+
disableNMLUrlCache?: undefined | boolean;
|
|
478
|
+
displayName?: undefined | string;
|
|
479
|
+
dontCloseBatches?: undefined | boolean;
|
|
480
|
+
enablePatterns?: undefined | boolean;
|
|
474
481
|
environmentName?: undefined | string;
|
|
475
|
-
|
|
476
|
-
parentBranchName?: undefined | string;
|
|
482
|
+
forceFullPageScreenshot?: undefined | boolean;
|
|
477
483
|
gitMergeBaseTimestamp?: undefined | string;
|
|
478
|
-
|
|
479
|
-
|
|
484
|
+
hideCaret?: undefined | boolean;
|
|
485
|
+
hideScrollbars?: undefined | boolean;
|
|
486
|
+
hostApp?: undefined | string;
|
|
487
|
+
hostAppInfo?: undefined | string;
|
|
488
|
+
hostOS?: undefined | string;
|
|
489
|
+
hostOSInfo?: undefined | string;
|
|
480
490
|
ignoreBaseline?: undefined | boolean;
|
|
491
|
+
ignoreCaret?: undefined | boolean;
|
|
492
|
+
ignoreDisplacements?: undefined | boolean;
|
|
481
493
|
ignoreGitMergeBase?: undefined | boolean;
|
|
494
|
+
isDisabled?: undefined | boolean;
|
|
495
|
+
layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
|
|
496
|
+
matchLevel?: undefined | MatchLevelPlain;
|
|
497
|
+
matchTimeout?: undefined | number;
|
|
498
|
+
mobileOptions?: undefined | { keepNavigationBar?: undefined | boolean; };
|
|
499
|
+
parentBranchName?: undefined | string;
|
|
500
|
+
properties?: undefined | Array<PropertyDataPlain>;
|
|
501
|
+
proxy?: undefined | ProxySettingsPlain;
|
|
502
|
+
removeSession?: undefined | boolean;
|
|
503
|
+
rotation?: undefined | ImageRotationPlain;
|
|
504
|
+
saveDiffs?: undefined | boolean;
|
|
482
505
|
saveFailedTests?: undefined | boolean;
|
|
483
506
|
saveNewTests?: undefined | boolean;
|
|
484
|
-
|
|
485
|
-
|
|
507
|
+
scaleRatio?: undefined | number;
|
|
508
|
+
scrollRootElement?: undefined | Element | EyesSelector<Selector>;
|
|
486
509
|
sendDom?: undefined | boolean;
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
waitBeforeScreenshots?: undefined | number;
|
|
510
|
+
serverUrl?: undefined | string;
|
|
511
|
+
sessionType?: undefined | SessionTypePlain;
|
|
490
512
|
stitchMode?: undefined | StitchModePlain;
|
|
491
|
-
hideScrollbars?: undefined | boolean;
|
|
492
|
-
hideCaret?: undefined | boolean;
|
|
493
513
|
stitchOverlap?: undefined | number;
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
scaleRatio?: undefined | number;
|
|
498
|
-
concurrentSessions?: undefined | number;
|
|
499
|
-
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"; }; })>;
|
|
514
|
+
testName?: undefined | string;
|
|
515
|
+
useDom?: undefined | boolean;
|
|
516
|
+
viewportSize?: undefined | RectangleSizePlain;
|
|
500
517
|
visualGridOptions?: undefined | Record<string, any>;
|
|
501
|
-
layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
|
|
502
|
-
disableBrowserFetching?: undefined | boolean;
|
|
503
518
|
waitBeforeCapture?: undefined | number;
|
|
504
|
-
|
|
505
|
-
captureStatusBar?: undefined | boolean;
|
|
519
|
+
waitBeforeScreenshots?: undefined | number;
|
|
506
520
|
};
|
|
507
521
|
export class Configuration implements Required<ConfigurationPlain> {
|
|
508
522
|
constructor(config?: undefined | ConfigurationPlain);
|
|
523
|
+
get accessibilityValidation(): AccessibilitySettings;
|
|
524
|
+
set accessibilityValidation(accessibilityValidation: AccessibilitySettings);
|
|
525
|
+
getAccessibilityValidation(): AccessibilitySettings;
|
|
526
|
+
setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): Configuration;
|
|
527
|
+
get agentId(): string;
|
|
528
|
+
set agentId(agentId: string);
|
|
529
|
+
getAgentId(): string;
|
|
530
|
+
setAgentId(agentId: string): Configuration;
|
|
531
|
+
get apiKey(): string;
|
|
532
|
+
set apiKey(apiKey: string);
|
|
533
|
+
getApiKey(): string;
|
|
534
|
+
setApiKey(apiKey: string): Configuration;
|
|
535
|
+
get appName(): string;
|
|
536
|
+
set appName(appName: string);
|
|
537
|
+
getAppName(): string;
|
|
538
|
+
setAppName(appName: string): Configuration;
|
|
539
|
+
get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
|
|
540
|
+
set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
|
|
541
|
+
getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
|
|
542
|
+
setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
|
|
543
|
+
get baselineBranchName(): string;
|
|
544
|
+
set baselineBranchName(baselineBranchName: string);
|
|
545
|
+
getBaselineBranchName(): string;
|
|
546
|
+
setBaselineBranchName(baselineBranchName: string): Configuration;
|
|
547
|
+
get baselineEnvName(): string;
|
|
548
|
+
set baselineEnvName(baselineEnvName: string);
|
|
549
|
+
getBaselineEnvName(): string;
|
|
550
|
+
setBaselineEnvName(baselineEnvName: string): Configuration;
|
|
551
|
+
get batch(): BatchInfoPlain;
|
|
552
|
+
set batch(batch: BatchInfoPlain);
|
|
553
|
+
getBatch(): BatchInfo;
|
|
554
|
+
setBatch(batch: BatchInfoPlain): Configuration;
|
|
555
|
+
get branchName(): string;
|
|
556
|
+
set branchName(branchName: string);
|
|
557
|
+
getBranchName(): string;
|
|
558
|
+
setBranchName(branchName: string): Configuration;
|
|
559
|
+
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 (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"; }; })>;
|
|
560
|
+
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 (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"; }; })>);
|
|
561
|
+
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 (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"; }; })>;
|
|
562
|
+
setBrowsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
|
|
563
|
+
addBrowsers(...browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
|
|
564
|
+
addBrowser(browserInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })): Configuration;
|
|
565
|
+
addBrowser(width: number, height: number, name?: undefined | BrowserTypePlain): Configuration;
|
|
566
|
+
addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | ScreenOrientationPlain): Configuration;
|
|
567
|
+
addMultiDeviceTarget(deviceName: "iPhone X"): Configuration;
|
|
568
|
+
addMultiDeviceTarget(deviceName: "iPhone 14 Plus"): Configuration;
|
|
569
|
+
addMultiDeviceTarget(deviceName: "iPhone 14 Pro"): Configuration;
|
|
570
|
+
addMultiDeviceTarget(deviceName: "iPhone XR"): Configuration;
|
|
571
|
+
addMultiDeviceTarget(deviceName: "iPhone 11"): Configuration;
|
|
572
|
+
addMultiDeviceTarget(deviceName: "iPhone 11 Pro Max"): Configuration;
|
|
573
|
+
addMultiDeviceTarget(deviceName: "iPhone 11 Pro"): Configuration;
|
|
574
|
+
addMultiDeviceTarget(deviceName: "iPhone SE (2nd generation)"): Configuration;
|
|
575
|
+
addMultiDeviceTarget(deviceName: "iPhone SE (3rd generation)"): Configuration;
|
|
576
|
+
addMultiDeviceTarget(deviceName: "iPhone Xs"): Configuration;
|
|
577
|
+
addMultiDeviceTarget(deviceName: "iPhone 12"): Configuration;
|
|
578
|
+
addMultiDeviceTarget(deviceName: "iPhone 12 mini"): Configuration;
|
|
579
|
+
addMultiDeviceTarget(deviceName: "iPhone 12 Pro Max"): Configuration;
|
|
580
|
+
addMultiDeviceTarget(deviceName: "iPhone 12 Pro"): Configuration;
|
|
581
|
+
addMultiDeviceTarget(deviceName: "iPhone 13"): Configuration;
|
|
582
|
+
addMultiDeviceTarget(deviceName: "iPhone 13 mini"): Configuration;
|
|
583
|
+
addMultiDeviceTarget(deviceName: "iPhone 13 Pro Max"): Configuration;
|
|
584
|
+
addMultiDeviceTarget(deviceName: "iPhone 13 Pro"): Configuration;
|
|
585
|
+
addMultiDeviceTarget(deviceName: "iPhone 14"): Configuration;
|
|
586
|
+
addMultiDeviceTarget(deviceName: "iPhone 14 Pro Max"): Configuration;
|
|
587
|
+
addMultiDeviceTarget(deviceName: "iPhone 8"): Configuration;
|
|
588
|
+
addMultiDeviceTarget(deviceName: "iPhone 8 Plus"): Configuration;
|
|
589
|
+
addMultiDeviceTarget(deviceName: "iPhone Xs Max"): Configuration;
|
|
590
|
+
get captureStatusBar(): boolean;
|
|
591
|
+
set captureStatusBar(captureStatusBar: boolean);
|
|
592
|
+
getCaptureStatusBar(): boolean;
|
|
593
|
+
setCaptureStatusBar(captureStatusBar: boolean): Configuration;
|
|
594
|
+
get compareWithParentBranch(): boolean;
|
|
595
|
+
set compareWithParentBranch(compareWithParentBranch: boolean);
|
|
596
|
+
getCompareWithParentBranch(): boolean;
|
|
597
|
+
setCompareWithParentBranch(compareWithParentBranch: boolean): Configuration;
|
|
598
|
+
get concurrentSessions(): number;
|
|
599
|
+
set concurrentSessions(concurrentSessions: number);
|
|
600
|
+
getConcurrentSessions(): number;
|
|
601
|
+
setConcurrentSessions(concurrentSessions: number): Configuration;
|
|
602
|
+
get connectionTimeout(): number;
|
|
603
|
+
set connectionTimeout(connectionTimeout: number);
|
|
604
|
+
getConnectionTimeout(): number;
|
|
605
|
+
setConnectionTimeout(connectionTimeout: number): Configuration;
|
|
606
|
+
get cut(): CutProviderPlain;
|
|
607
|
+
set cut(cut: CutProviderPlain);
|
|
608
|
+
getCut(): CutProviderPlain;
|
|
609
|
+
setCut(cut: CutProviderPlain): Configuration;
|
|
509
610
|
get debugScreenshots(): { save: boolean; path?: undefined | string; prefix?: undefined | string; };
|
|
510
611
|
set debugScreenshots(debugScreenshots: { save: boolean; path?: undefined | string; prefix?: undefined | string; });
|
|
511
612
|
getSaveDebugScreenshots(): boolean;
|
|
@@ -514,111 +615,138 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
514
615
|
setDebugScreenshotsPath(path: string): Configuration;
|
|
515
616
|
getDebugScreenshotsPrefix(): string;
|
|
516
617
|
setDebugScreenshotsPrefix(prefix: string): Configuration;
|
|
517
|
-
get
|
|
518
|
-
set
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
get
|
|
522
|
-
set
|
|
523
|
-
|
|
524
|
-
|
|
618
|
+
get defaultMatchSettings(): ImageMatchSettingsPlain;
|
|
619
|
+
set defaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain);
|
|
620
|
+
getDefaultMatchSettings(): ImageMatchSettingsPlain;
|
|
621
|
+
setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain): Configuration;
|
|
622
|
+
get deviceInfo(): string;
|
|
623
|
+
set deviceInfo(deviceInfo: string);
|
|
624
|
+
getDeviceInfo(): string;
|
|
625
|
+
setDeviceInfo(deviceInfo: string): Configuration;
|
|
626
|
+
get disableBrowserFetching(): boolean;
|
|
627
|
+
set disableBrowserFetching(disableBrowserFetching: boolean);
|
|
628
|
+
getDisableBrowserFetching(): boolean;
|
|
629
|
+
setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
|
|
630
|
+
get disableNMLUrlCache(): boolean;
|
|
631
|
+
set disableNMLUrlCache(disableNMLUrlCache: boolean);
|
|
632
|
+
getDisableNMLUrlCache(): boolean;
|
|
633
|
+
setDisableNMLUrlCache(disableNMLUrlCache: boolean): Configuration;
|
|
525
634
|
get displayName(): string;
|
|
526
635
|
set displayName(displayName: string);
|
|
527
636
|
getDisplayName(): string;
|
|
528
637
|
setDisplayName(displayName: string): Configuration;
|
|
638
|
+
get dontCloseBatches(): boolean;
|
|
639
|
+
set dontCloseBatches(dontCloseBatches: boolean);
|
|
640
|
+
getDontCloseBatches(): boolean;
|
|
641
|
+
setDontCloseBatches(dontCloseBatches: boolean): Configuration;
|
|
642
|
+
get enablePatterns(): boolean;
|
|
643
|
+
set enablePatterns(enablePatterns: boolean);
|
|
644
|
+
getEnablePatterns(): boolean;
|
|
645
|
+
setEnablePatterns(enablePatterns: boolean): Configuration;
|
|
646
|
+
get environmentName(): string;
|
|
647
|
+
set environmentName(environmentName: string);
|
|
648
|
+
getEnvironmentName(): string;
|
|
649
|
+
setEnvironmentName(environmentName: string): Configuration;
|
|
650
|
+
get forceFullPageScreenshot(): boolean;
|
|
651
|
+
set forceFullPageScreenshot(forceFullPageScreenshot: boolean);
|
|
652
|
+
getForceFullPageScreenshot(): boolean;
|
|
653
|
+
setForceFullPageScreenshot(forceFullPageScreenshot: boolean): Configuration;
|
|
654
|
+
get gitMergeBaseTimestamp(): string;
|
|
655
|
+
set gitMergeBaseTimestamp(gitMergeBaseTimestamp: string);
|
|
656
|
+
getGitMergeBaseTimestamp(): string;
|
|
657
|
+
setGitMergeBaseTimestamp(gitMergeBaseTimestamp: string): Configuration;
|
|
658
|
+
get hideCaret(): boolean;
|
|
659
|
+
set hideCaret(hideCaret: boolean);
|
|
660
|
+
getHideCaret(): boolean;
|
|
661
|
+
setHideCaret(hideCaret: boolean): Configuration;
|
|
662
|
+
get hideScrollbars(): boolean;
|
|
663
|
+
set hideScrollbars(hideScrollbars: boolean);
|
|
664
|
+
getHideScrollbars(): boolean;
|
|
665
|
+
setHideScrollbars(hideScrollbars: boolean): Configuration;
|
|
666
|
+
get hostApp(): string;
|
|
667
|
+
set hostApp(hostApp: string);
|
|
668
|
+
getHostApp(): string;
|
|
669
|
+
setHostApp(hostApp: string): Configuration;
|
|
670
|
+
get hostAppInfo(): string;
|
|
671
|
+
set hostAppInfo(hostAppInfo: string);
|
|
672
|
+
getHostAppInfo(): string;
|
|
673
|
+
setHostAppInfo(hostAppInfo: string): Configuration;
|
|
674
|
+
get hostOS(): string;
|
|
675
|
+
set hostOS(hostOS: string);
|
|
676
|
+
getHostOS(): string;
|
|
677
|
+
setHostOS(hostOS: string): Configuration;
|
|
678
|
+
get hostOSInfo(): string;
|
|
679
|
+
set hostOSInfo(hostOSInfo: string);
|
|
680
|
+
getHostOSInfo(): string;
|
|
681
|
+
setHostOSInfo(hostOSInfo: string): Configuration;
|
|
682
|
+
get ignoreBaseline(): boolean;
|
|
683
|
+
set ignoreBaseline(ignoreBaseline: boolean);
|
|
684
|
+
getIgnoreBaseline(): boolean;
|
|
685
|
+
setIgnoreBaseline(ignoreBaseline: boolean): Configuration;
|
|
686
|
+
get ignoreCaret(): boolean;
|
|
687
|
+
set ignoreCaret(ignoreCaret: boolean);
|
|
688
|
+
getIgnoreCaret(): boolean;
|
|
689
|
+
setIgnoreCaret(ignoreCaret: boolean): Configuration;
|
|
690
|
+
get ignoreDisplacements(): boolean;
|
|
691
|
+
set ignoreDisplacements(ignoreDisplacements: boolean);
|
|
692
|
+
getIgnoreDisplacements(): boolean;
|
|
693
|
+
setIgnoreDisplacements(ignoreDisplacements: boolean): Configuration;
|
|
694
|
+
get ignoreGitMergeBase(): boolean;
|
|
695
|
+
set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
|
|
696
|
+
getIgnoreGitMergeBase(): boolean;
|
|
697
|
+
setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): Configuration;
|
|
529
698
|
get isDisabled(): boolean;
|
|
530
699
|
set isDisabled(isDisabled: boolean);
|
|
531
700
|
getIsDisabled(): boolean;
|
|
532
701
|
setIsDisabled(isDisabled: boolean): Configuration;
|
|
702
|
+
get layoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
|
|
703
|
+
set layoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; });
|
|
704
|
+
getLayoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
|
|
705
|
+
setLayoutBreakpoints(layoutBreakpoints: boolean): Configuration;
|
|
706
|
+
setLayoutBreakpoints(layoutBreakpoints: Array<number>): Configuration;
|
|
707
|
+
setLayoutBreakpoints(layoutBreakpoints: { breakpoints: boolean | Array<number>; reload?: undefined | boolean; }): Configuration;
|
|
708
|
+
get matchLevel(): MatchLevelPlain;
|
|
709
|
+
set matchLevel(matchLevel: MatchLevelPlain);
|
|
710
|
+
getMatchLevel(): MatchLevel;
|
|
711
|
+
setMatchLevel(matchLevel: MatchLevelPlain): Configuration;
|
|
533
712
|
get matchTimeout(): number;
|
|
534
713
|
set matchTimeout(matchTimeout: number);
|
|
535
714
|
getMatchTimeout(): number;
|
|
536
715
|
setMatchTimeout(matchTimeout: number): Configuration;
|
|
537
|
-
get
|
|
538
|
-
set
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
get
|
|
542
|
-
set
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
get
|
|
546
|
-
set
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
setApiKey(apiKey: string): Configuration;
|
|
553
|
-
get serverUrl(): string;
|
|
554
|
-
set serverUrl(serverUrl: string);
|
|
555
|
-
getServerUrl(): string;
|
|
556
|
-
setServerUrl(serverUrl: string): Configuration;
|
|
716
|
+
get mobileOptions(): { keepNavigationBar?: undefined | boolean; };
|
|
717
|
+
set mobileOptions(mobileOptions: { keepNavigationBar?: undefined | boolean; });
|
|
718
|
+
getMobileOptions(): { keepNavigationBar?: undefined | boolean; };
|
|
719
|
+
setMobileOptions(mobileOptions: { keepNavigationBar?: undefined | boolean; }): Configuration;
|
|
720
|
+
get parentBranchName(): string;
|
|
721
|
+
set parentBranchName(parentBranchName: string);
|
|
722
|
+
getParentBranchName(): string;
|
|
723
|
+
setParentBranchName(parentBranchName: string): Configuration;
|
|
724
|
+
get properties(): Array<PropertyDataPlain>;
|
|
725
|
+
set properties(properties: Array<PropertyDataPlain>);
|
|
726
|
+
getProperties(): Array<PropertyData>;
|
|
727
|
+
setProperties(properties: Array<PropertyDataPlain>): Configuration;
|
|
728
|
+
addProperty(name: string, value: string): Configuration;
|
|
729
|
+
addProperty(prop: PropertyDataPlain): Configuration;
|
|
730
|
+
clearProperties(): Configuration;
|
|
557
731
|
get proxy(): ProxySettingsPlain;
|
|
558
732
|
set proxy(proxy: ProxySettingsPlain);
|
|
559
733
|
getProxy(): ProxySettings;
|
|
560
734
|
setProxy(proxy: ProxySettingsPlain): Configuration;
|
|
561
735
|
setProxy(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean): Configuration;
|
|
562
736
|
setProxy(isEnabled: false): Configuration;
|
|
563
|
-
get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
|
|
564
|
-
set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
|
|
565
|
-
getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
|
|
566
|
-
setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
|
|
567
|
-
get connectionTimeout(): number;
|
|
568
|
-
set connectionTimeout(connectionTimeout: number);
|
|
569
|
-
getConnectionTimeout(): number;
|
|
570
|
-
setConnectionTimeout(connectionTimeout: number): Configuration;
|
|
571
737
|
get removeSession(): boolean;
|
|
572
738
|
set removeSession(removeSession: boolean);
|
|
573
739
|
getRemoveSession(): boolean;
|
|
574
740
|
setRemoveSession(removeSession: boolean): Configuration;
|
|
575
|
-
get
|
|
576
|
-
set
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
addProperty(prop: PropertyDataPlain): Configuration;
|
|
585
|
-
clearProperties(): Configuration;
|
|
586
|
-
get baselineEnvName(): string;
|
|
587
|
-
set baselineEnvName(baselineEnvName: string);
|
|
588
|
-
getBaselineEnvName(): string;
|
|
589
|
-
setBaselineEnvName(baselineEnvName: string): Configuration;
|
|
590
|
-
get environmentName(): string;
|
|
591
|
-
set environmentName(environmentName: string);
|
|
592
|
-
getEnvironmentName(): string;
|
|
593
|
-
setEnvironmentName(environmentName: string): Configuration;
|
|
594
|
-
get branchName(): string;
|
|
595
|
-
set branchName(branchName: string);
|
|
596
|
-
getBranchName(): string;
|
|
597
|
-
setBranchName(branchName: string): Configuration;
|
|
598
|
-
get parentBranchName(): string;
|
|
599
|
-
set parentBranchName(parentBranchName: string);
|
|
600
|
-
getParentBranchName(): string;
|
|
601
|
-
setParentBranchName(parentBranchName: string): Configuration;
|
|
602
|
-
get baselineBranchName(): string;
|
|
603
|
-
set baselineBranchName(baselineBranchName: string);
|
|
604
|
-
getBaselineBranchName(): string;
|
|
605
|
-
setBaselineBranchName(baselineBranchName: string): Configuration;
|
|
606
|
-
get gitMergeBaseTimestamp(): string;
|
|
607
|
-
set gitMergeBaseTimestamp(gitMergeBaseTimestamp: string);
|
|
608
|
-
getGitMergeBaseTimestamp(): string;
|
|
609
|
-
setGitMergeBaseTimestamp(gitMergeBaseTimestamp: string): Configuration;
|
|
610
|
-
get compareWithParentBranch(): boolean;
|
|
611
|
-
set compareWithParentBranch(compareWithParentBranch: boolean);
|
|
612
|
-
getCompareWithParentBranch(): boolean;
|
|
613
|
-
setCompareWithParentBranch(compareWithParentBranch: boolean): Configuration;
|
|
614
|
-
get ignoreGitMergeBase(): boolean;
|
|
615
|
-
set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
|
|
616
|
-
getIgnoreGitMergeBase(): boolean;
|
|
617
|
-
setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): Configuration;
|
|
618
|
-
get ignoreBaseline(): boolean;
|
|
619
|
-
set ignoreBaseline(ignoreBaseline: boolean);
|
|
620
|
-
getIgnoreBaseline(): boolean;
|
|
621
|
-
setIgnoreBaseline(ignoreBaseline: boolean): Configuration;
|
|
741
|
+
get rotation(): ImageRotationPlain;
|
|
742
|
+
set rotation(rotation: ImageRotationPlain);
|
|
743
|
+
getRotation(): ImageRotation;
|
|
744
|
+
setRotation(rotation: ImageRotationPlain): Configuration;
|
|
745
|
+
setRotation(rotation: ImageRotation): Configuration;
|
|
746
|
+
get saveDiffs(): boolean;
|
|
747
|
+
set saveDiffs(saveDiffs: boolean);
|
|
748
|
+
getSaveDiffs(): boolean;
|
|
749
|
+
setSaveDiffs(saveDiffs: boolean): Configuration;
|
|
622
750
|
get saveFailedTests(): boolean;
|
|
623
751
|
set saveFailedTests(saveFailedTests: boolean);
|
|
624
752
|
getSaveFailedTests(): boolean;
|
|
@@ -627,160 +755,60 @@ export class Configuration implements Required<ConfigurationPlain> {
|
|
|
627
755
|
set saveNewTests(saveNewTests: boolean);
|
|
628
756
|
getSaveNewTests(): boolean;
|
|
629
757
|
setSaveNewTests(saveNewTests: boolean): Configuration;
|
|
630
|
-
get
|
|
631
|
-
set
|
|
632
|
-
|
|
633
|
-
|
|
758
|
+
get scaleRatio(): number;
|
|
759
|
+
set scaleRatio(scaleRatio: number);
|
|
760
|
+
getScaleRatio(): number;
|
|
761
|
+
setScaleRatio(scaleRatio: number): Configuration;
|
|
762
|
+
get scrollRootElement(): Element | EyesSelector<Selector>;
|
|
763
|
+
set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
|
|
764
|
+
getScrollRootElement(): Element | EyesSelector<Selector>;
|
|
765
|
+
setScrollRootElement(scrollRootElement: Element): Configuration;
|
|
766
|
+
setScrollRootElement(scrollRootElement: EyesSelector<Selector>): Configuration;
|
|
634
767
|
get sendDom(): boolean;
|
|
635
768
|
set sendDom(sendDom: boolean);
|
|
636
769
|
getSendDom(): boolean;
|
|
637
770
|
setSendDom(sendDom: boolean): Configuration;
|
|
638
|
-
get
|
|
639
|
-
set
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
get
|
|
643
|
-
set
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
get hostAppInfo(): string;
|
|
647
|
-
set hostAppInfo(hostAppInfo: string);
|
|
648
|
-
getHostAppInfo(): string;
|
|
649
|
-
setHostAppInfo(hostAppInfo: string): Configuration;
|
|
650
|
-
get hostOSInfo(): string;
|
|
651
|
-
set hostOSInfo(hostOSInfo: string);
|
|
652
|
-
getHostOSInfo(): string;
|
|
653
|
-
setHostOSInfo(hostOSInfo: string): Configuration;
|
|
654
|
-
get deviceInfo(): string;
|
|
655
|
-
set deviceInfo(deviceInfo: string);
|
|
656
|
-
getDeviceInfo(): string;
|
|
657
|
-
setDeviceInfo(deviceInfo: string): Configuration;
|
|
658
|
-
get defaultMatchSettings(): ImageMatchSettingsPlain;
|
|
659
|
-
set defaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain);
|
|
660
|
-
getDefaultMatchSettings(): ImageMatchSettingsPlain;
|
|
661
|
-
setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain): Configuration;
|
|
662
|
-
getMatchLevel(): MatchLevel;
|
|
663
|
-
setMatchLevel(matchLevel: MatchLevelPlain): Configuration;
|
|
664
|
-
getAccessibilityValidation(): AccessibilitySettings;
|
|
665
|
-
setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): Configuration;
|
|
666
|
-
getUseDom(): boolean;
|
|
667
|
-
setUseDom(useDom: boolean): Configuration;
|
|
668
|
-
getEnablePatterns(): boolean;
|
|
669
|
-
setEnablePatterns(enablePatterns: boolean): Configuration;
|
|
670
|
-
getIgnoreDisplacements(): boolean;
|
|
671
|
-
setIgnoreDisplacements(ignoreDisplacements: boolean): Configuration;
|
|
672
|
-
getIgnoreCaret(): boolean;
|
|
673
|
-
setIgnoreCaret(ignoreCaret: boolean): Configuration;
|
|
674
|
-
get forceFullPageScreenshot(): boolean;
|
|
675
|
-
set forceFullPageScreenshot(forceFullPageScreenshot: boolean);
|
|
676
|
-
getForceFullPageScreenshot(): boolean;
|
|
677
|
-
setForceFullPageScreenshot(forceFullPageScreenshot: boolean): Configuration;
|
|
678
|
-
get waitBeforeScreenshots(): number;
|
|
679
|
-
set waitBeforeScreenshots(waitBeforeScreenshots: number);
|
|
680
|
-
getWaitBeforeScreenshots(): number;
|
|
681
|
-
setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration;
|
|
682
|
-
get waitBeforeCapture(): number;
|
|
683
|
-
set waitBeforeCapture(waitBeforeCapture: number);
|
|
684
|
-
getWaitBeforeCapture(): number;
|
|
685
|
-
setWaitBeforeCapture(waitBeforeCapture: number): Configuration;
|
|
771
|
+
get serverUrl(): string;
|
|
772
|
+
set serverUrl(serverUrl: string);
|
|
773
|
+
getServerUrl(): string;
|
|
774
|
+
setServerUrl(serverUrl: string): Configuration;
|
|
775
|
+
get sessionType(): SessionTypePlain;
|
|
776
|
+
set sessionType(sessionType: SessionTypePlain);
|
|
777
|
+
getSessionType(): SessionType;
|
|
778
|
+
setSessionType(sessionType: SessionTypePlain): Configuration;
|
|
686
779
|
get stitchMode(): StitchModePlain;
|
|
687
780
|
set stitchMode(stitchMode: StitchModePlain);
|
|
688
781
|
getStitchMode(): StitchMode;
|
|
689
782
|
setStitchMode(stitchMode: StitchModePlain): Configuration;
|
|
690
|
-
get hideScrollbars(): boolean;
|
|
691
|
-
set hideScrollbars(hideScrollbars: boolean);
|
|
692
|
-
getHideScrollbars(): boolean;
|
|
693
|
-
setHideScrollbars(hideScrollbars: boolean): Configuration;
|
|
694
|
-
get hideCaret(): boolean;
|
|
695
|
-
set hideCaret(hideCaret: boolean);
|
|
696
|
-
getHideCaret(): boolean;
|
|
697
|
-
setHideCaret(hideCaret: boolean): Configuration;
|
|
698
783
|
get stitchOverlap(): number;
|
|
699
784
|
set stitchOverlap(stitchOverlap: number);
|
|
700
785
|
getStitchOverlap(): number;
|
|
701
786
|
setStitchOverlap(stitchOverlap: number): Configuration;
|
|
702
|
-
get
|
|
703
|
-
set
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
setRotation(rotation: ImageRotationPlain): Configuration;
|
|
715
|
-
setRotation(rotation: ImageRotation): Configuration;
|
|
716
|
-
get scaleRatio(): number;
|
|
717
|
-
set scaleRatio(scaleRatio: number);
|
|
718
|
-
getScaleRatio(): number;
|
|
719
|
-
setScaleRatio(scaleRatio: number): Configuration;
|
|
720
|
-
get concurrentSessions(): number;
|
|
721
|
-
set concurrentSessions(concurrentSessions: number);
|
|
722
|
-
getConcurrentSessions(): number;
|
|
723
|
-
setConcurrentSessions(concurrentSessions: number): Configuration;
|
|
724
|
-
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"; }; })>;
|
|
725
|
-
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"; }; })>);
|
|
726
|
-
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"; }; })>;
|
|
727
|
-
setBrowsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
|
|
728
|
-
addBrowsers(...browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
|
|
729
|
-
addBrowser(browserInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })): Configuration;
|
|
730
|
-
addBrowser(width: number, height: number, name?: undefined | BrowserTypePlain): Configuration;
|
|
731
|
-
addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | ScreenOrientationPlain): Configuration;
|
|
732
|
-
addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
|
|
733
|
-
addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
|
|
734
|
-
addMultiDeviceTarget(deviceName: "iPhone X"): Configuration;
|
|
735
|
-
addMultiDeviceTarget(deviceName: "iPhone 14 Plus"): Configuration;
|
|
736
|
-
addMultiDeviceTarget(deviceName: "iPhone 14 Pro"): Configuration;
|
|
737
|
-
addMultiDeviceTarget(deviceName: "iPhone XR"): Configuration;
|
|
738
|
-
addMultiDeviceTarget(deviceName: "iPhone 11"): Configuration;
|
|
739
|
-
addMultiDeviceTarget(deviceName: "iPhone 11 Pro Max"): Configuration;
|
|
740
|
-
addMultiDeviceTarget(deviceName: "iPhone 11 Pro"): Configuration;
|
|
741
|
-
addMultiDeviceTarget(deviceName: "iPhone SE (2nd generation)"): Configuration;
|
|
742
|
-
addMultiDeviceTarget(deviceName: "iPhone SE (3rd generation)"): Configuration;
|
|
743
|
-
addMultiDeviceTarget(deviceName: "iPhone Xs"): Configuration;
|
|
744
|
-
addMultiDeviceTarget(deviceName: "iPhone 12"): Configuration;
|
|
745
|
-
addMultiDeviceTarget(deviceName: "iPhone 12 mini"): Configuration;
|
|
746
|
-
addMultiDeviceTarget(deviceName: "iPhone 12 Pro Max"): Configuration;
|
|
747
|
-
addMultiDeviceTarget(deviceName: "iPhone 12 Pro"): Configuration;
|
|
748
|
-
addMultiDeviceTarget(deviceName: "iPhone 13"): Configuration;
|
|
749
|
-
addMultiDeviceTarget(deviceName: "iPhone 13 mini"): Configuration;
|
|
750
|
-
addMultiDeviceTarget(deviceName: "iPhone 13 Pro Max"): Configuration;
|
|
751
|
-
addMultiDeviceTarget(deviceName: "iPhone 13 Pro"): Configuration;
|
|
752
|
-
addMultiDeviceTarget(deviceName: "iPhone 14"): Configuration;
|
|
753
|
-
addMultiDeviceTarget(deviceName: "iPhone 14 Pro Max"): Configuration;
|
|
754
|
-
addMultiDeviceTarget(deviceName: "iPhone 8"): Configuration;
|
|
755
|
-
addMultiDeviceTarget(deviceName: "iPhone 8 Plus"): Configuration;
|
|
756
|
-
addMultiDeviceTarget(deviceName: "iPhone Xs Max"): Configuration;
|
|
787
|
+
get testName(): string;
|
|
788
|
+
set testName(testName: string);
|
|
789
|
+
getTestName(): string;
|
|
790
|
+
setTestName(testName: string): Configuration;
|
|
791
|
+
get useDom(): boolean;
|
|
792
|
+
set useDom(useDom: boolean);
|
|
793
|
+
getUseDom(): boolean;
|
|
794
|
+
setUseDom(useDom: boolean): Configuration;
|
|
795
|
+
get viewportSize(): RectangleSizePlain;
|
|
796
|
+
set viewportSize(viewportSize: RectangleSizePlain);
|
|
797
|
+
getViewportSize(): RectangleSize;
|
|
798
|
+
setViewportSize(viewportSize: RectangleSizePlain): Configuration;
|
|
757
799
|
get visualGridOptions(): { [key: string]: any; };
|
|
758
800
|
set visualGridOptions(visualGridOptions: { [key: string]: any; });
|
|
759
801
|
getVisualGridOptions(): { [key: string]: any; };
|
|
760
802
|
setVisualGridOptions(visualGridOptions: { [key: string]: any; }): Configuration;
|
|
761
803
|
setVisualGridOption(key: string, value: any): Configuration;
|
|
762
|
-
get
|
|
763
|
-
set
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
getDisableBrowserFetching(): boolean;
|
|
771
|
-
setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
|
|
772
|
-
get dontCloseBatches(): boolean;
|
|
773
|
-
set dontCloseBatches(dontCloseBatches: boolean);
|
|
774
|
-
getDontCloseBatches(): boolean;
|
|
775
|
-
setDontCloseBatches(dontCloseBatches: boolean): Configuration;
|
|
776
|
-
get disableNMLUrlCache(): boolean;
|
|
777
|
-
set disableNMLUrlCache(disableNMLUrlCache: boolean);
|
|
778
|
-
getDisableNMLUrlCache(): boolean;
|
|
779
|
-
setDisableNMLUrlCache(disableNMLUrlCache: boolean): Configuration;
|
|
780
|
-
get captureStatusBar(): boolean;
|
|
781
|
-
set captureStatusBar(captureStatusBar: boolean);
|
|
782
|
-
getCaptureStatusBar(): boolean;
|
|
783
|
-
setCaptureStatusBar(captureStatusBar: boolean): Configuration;
|
|
804
|
+
get waitBeforeCapture(): number;
|
|
805
|
+
set waitBeforeCapture(waitBeforeCapture: number);
|
|
806
|
+
getWaitBeforeCapture(): number;
|
|
807
|
+
setWaitBeforeCapture(waitBeforeCapture: number): Configuration;
|
|
808
|
+
get waitBeforeScreenshots(): number;
|
|
809
|
+
set waitBeforeScreenshots(waitBeforeScreenshots: number);
|
|
810
|
+
getWaitBeforeScreenshots(): number;
|
|
811
|
+
setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration;
|
|
784
812
|
}
|
|
785
813
|
export class BatchClose {
|
|
786
814
|
static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
|
|
@@ -964,49 +992,12 @@ export enum IosDeviceName {
|
|
|
964
992
|
iPhone_16_Pro = 'iPhone 16 Pro',
|
|
965
993
|
iPhone_16_Plus = 'iPhone 16 Plus'
|
|
966
994
|
}
|
|
967
|
-
export type IosVersionPlain =
|
|
995
|
+
export type IosVersionPlain = "latest" | "latest-1";
|
|
968
996
|
export enum IosVersion {
|
|
969
997
|
LATEST = 'latest',
|
|
970
998
|
ONE_VERSION_BACK = 'latest-1',
|
|
971
999
|
LATEST_ONE_VERSION_BACK = 'latest-1'
|
|
972
1000
|
}
|
|
973
|
-
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";
|
|
974
|
-
export enum AndroidDeviceName {
|
|
975
|
-
Galaxy_S20 = 'Galaxy S20',
|
|
976
|
-
Galaxy_S20_Plus = 'Galaxy S20 Plus',
|
|
977
|
-
Galaxy_S20_PLUS = 'Galaxy S20 Plus',
|
|
978
|
-
Galaxy_S21_Ultra = 'Galaxy S21 Ultra',
|
|
979
|
-
Galaxy_S21_ULTRA = 'Galaxy S21 Ultra',
|
|
980
|
-
Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus',
|
|
981
|
-
Galaxy_S9 = 'Galaxy S9',
|
|
982
|
-
Galaxy_S10 = 'Galaxy S10',
|
|
983
|
-
Galaxy_S10_Plus = 'Galaxy S10 Plus',
|
|
984
|
-
Pixel_4_XL = 'Pixel 4 XL',
|
|
985
|
-
Pixel_3_XL = 'Pixel 3 XL',
|
|
986
|
-
Galaxy_S21 = 'Galaxy S21',
|
|
987
|
-
Galaxy_S21_Plus = 'Galaxy S21 Plus',
|
|
988
|
-
Galaxy_S21_PLUS = 'Galaxy S21 Plus',
|
|
989
|
-
Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro',
|
|
990
|
-
Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
|
|
991
|
-
Xiaomi_Redmi_Note_10_JE = 'Xiaomi Redmi Note 10 JE',
|
|
992
|
-
Pixel_6 = 'Pixel 6',
|
|
993
|
-
Galaxy_Note_10 = 'Galaxy Note 10',
|
|
994
|
-
Pixel_4 = 'Pixel 4',
|
|
995
|
-
Pixel_5 = 'Pixel 5',
|
|
996
|
-
Galaxy_S22 = 'Galaxy S22',
|
|
997
|
-
Galaxy_S22_Plus = 'Galaxy S22 Plus',
|
|
998
|
-
Galaxy_Tab_S8 = 'Galaxy Tab S8',
|
|
999
|
-
Galaxy_Tab_S7 = 'Galaxy Tab S7',
|
|
1000
|
-
Sony_Xperia_10_II = 'Sony Xperia 10 II',
|
|
1001
|
-
Sony_Xperia_1_II = 'Sony Xperia 1 II',
|
|
1002
|
-
Sony_Xperia_Ace_II = 'Sony Xperia Ace II',
|
|
1003
|
-
Huawei_P30_Lite = 'Huawei P30 Lite'
|
|
1004
|
-
}
|
|
1005
|
-
export type AndroidVersionPlain = "latest" | "latest-1";
|
|
1006
|
-
export enum AndroidVersion {
|
|
1007
|
-
LATEST = 'latest',
|
|
1008
|
-
ONE_VERSION_BACK = 'latest-1'
|
|
1009
|
-
}
|
|
1010
1001
|
export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Dynamic" | "Exact";
|
|
1011
1002
|
export enum MatchLevel {
|
|
1012
1003
|
None = 'None',
|
|
@@ -1182,31 +1173,31 @@ export class CheckSettingsImage {
|
|
|
1182
1173
|
withName(name: string): CheckSettingsImage;
|
|
1183
1174
|
ignoreRegion(region: RegionPlain): CheckSettingsImage;
|
|
1184
1175
|
ignoreRegion(region: LegacyRegionPlain): CheckSettingsImage;
|
|
1185
|
-
ignoreRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
1186
|
-
ignoreRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
1176
|
+
ignoreRegion(region: { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
1177
|
+
ignoreRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
1187
1178
|
ignore(region: RegionPlain): CheckSettingsImage;
|
|
1188
1179
|
ignore(region: LegacyRegionPlain): CheckSettingsImage;
|
|
1189
1180
|
ignores(...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
|
|
1190
1181
|
layoutRegion(region: RegionPlain): CheckSettingsImage;
|
|
1191
1182
|
layoutRegion(region: LegacyRegionPlain): CheckSettingsImage;
|
|
1192
|
-
layoutRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
1193
|
-
layoutRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
1183
|
+
layoutRegion(region: { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
1184
|
+
layoutRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
1194
1185
|
strictRegion(region: RegionPlain): CheckSettingsImage;
|
|
1195
1186
|
strictRegion(region: LegacyRegionPlain): CheckSettingsImage;
|
|
1196
|
-
strictRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
1197
|
-
strictRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
1187
|
+
strictRegion(region: { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
1188
|
+
strictRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
1198
1189
|
contentRegion(region: RegionPlain): CheckSettingsImage;
|
|
1199
1190
|
contentRegion(region: LegacyRegionPlain): CheckSettingsImage;
|
|
1200
|
-
contentRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
1201
|
-
contentRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
1191
|
+
contentRegion(region: { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
|
|
1192
|
+
contentRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
|
|
1202
1193
|
floatingRegion(region: {
|
|
1203
|
-
region: RegionPlain;
|
|
1194
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
1204
1195
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
1205
1196
|
regionId?: undefined | string;
|
|
1206
1197
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
1207
1198
|
}): CheckSettingsImage;
|
|
1208
1199
|
floatingRegion(region: {
|
|
1209
|
-
region: RegionPlain;
|
|
1200
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
1210
1201
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
1211
1202
|
regionId?: undefined | string;
|
|
1212
1203
|
maxUpOffset?: undefined | number;
|
|
@@ -1217,14 +1208,14 @@ export class CheckSettingsImage {
|
|
|
1217
1208
|
floatingRegion(region: RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
|
|
1218
1209
|
floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
|
|
1219
1210
|
floatingRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
|
|
1220
|
-
region: RegionPlain;
|
|
1211
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
1221
1212
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
1222
1213
|
regionId?: undefined | string;
|
|
1223
1214
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
1224
1215
|
}>): CheckSettingsImage;
|
|
1225
1216
|
floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
|
|
1226
1217
|
floating(region: {
|
|
1227
|
-
region: RegionPlain;
|
|
1218
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
1228
1219
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
1229
1220
|
regionId?: undefined | string;
|
|
1230
1221
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
@@ -1232,14 +1223,14 @@ export class CheckSettingsImage {
|
|
|
1232
1223
|
floating(region: RegionPlain): CheckSettingsImage;
|
|
1233
1224
|
floating(region: LegacyRegionPlain): CheckSettingsImage;
|
|
1234
1225
|
floatings(...regions: Array<RegionPlain | LegacyRegionPlain | {
|
|
1235
|
-
region: RegionPlain;
|
|
1226
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
1236
1227
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
1237
1228
|
regionId?: undefined | string;
|
|
1238
1229
|
offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
|
|
1239
1230
|
}>): CheckSettingsImage;
|
|
1240
1231
|
floatings(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
|
|
1241
1232
|
accessibilityRegion(region: {
|
|
1242
|
-
region: RegionPlain;
|
|
1233
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
1243
1234
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
1244
1235
|
regionId?: undefined | string;
|
|
1245
1236
|
type?: undefined | AccessibilityRegionTypePlain;
|
|
@@ -1247,14 +1238,14 @@ export class CheckSettingsImage {
|
|
|
1247
1238
|
accessibilityRegion(region: RegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsImage;
|
|
1248
1239
|
accessibilityRegion(region: LegacyRegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsImage;
|
|
1249
1240
|
accessibilityRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
|
|
1250
|
-
region: RegionPlain;
|
|
1241
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
1251
1242
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
1252
1243
|
regionId?: undefined | string;
|
|
1253
1244
|
type?: undefined | AccessibilityRegionTypePlain;
|
|
1254
1245
|
}>): CheckSettingsImage;
|
|
1255
1246
|
accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
|
|
1256
1247
|
dynamicRegion(region: {
|
|
1257
|
-
region: RegionPlain;
|
|
1248
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
1258
1249
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
1259
1250
|
regionId?: undefined | string;
|
|
1260
1251
|
type?: undefined | string | Array<string>;
|
|
@@ -1263,7 +1254,7 @@ export class CheckSettingsImage {
|
|
|
1263
1254
|
dynamicRegion(region: RegionPlain, type?: undefined | string): CheckSettingsImage;
|
|
1264
1255
|
dynamicRegion(region: RegionPlain, type?: undefined | Array<string>): CheckSettingsImage;
|
|
1265
1256
|
dynamicRegions(...regions: Array<RegionPlain | {
|
|
1266
|
-
region: RegionPlain;
|
|
1257
|
+
region: RegionPlain | LegacyRegionPlain;
|
|
1267
1258
|
padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
|
|
1268
1259
|
regionId?: undefined | string;
|
|
1269
1260
|
type?: undefined | string | Array<string>;
|
|
@@ -1608,8 +1599,7 @@ export class Region implements Required<RegionPlain> {
|
|
|
1608
1599
|
}
|
|
1609
1600
|
export type DesktopBrowserInfo = { name?: undefined | BrowserTypePlain; width: number; height: number; };
|
|
1610
1601
|
export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
|
|
1611
|
-
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined |
|
|
1612
|
-
export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | AndroidVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
|
|
1602
|
+
export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | IosVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
|
|
1613
1603
|
export type RunnerOptionsPlain = { testConcurrency?: undefined | number; fetchConcurrency?: undefined | number; removeDuplicateTests?: undefined | boolean; };
|
|
1614
1604
|
export class RunnerOptionsFluent {
|
|
1615
1605
|
testConcurrency(concurrency: number): RunnerOptionsFluent;
|
|
@@ -1841,14 +1831,14 @@ export class TestResults implements Required<TestResultsPlain> {
|
|
|
1841
1831
|
delete(): Promise<void>;
|
|
1842
1832
|
deleteSession(): Promise<void>;
|
|
1843
1833
|
}
|
|
1844
|
-
export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo |
|
|
1834
|
+
export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }); };
|
|
1845
1835
|
export class TestResultContainer implements Required<TestResultContainerPlain> {
|
|
1846
1836
|
get testResults(): TestResultsPlain;
|
|
1847
1837
|
getTestResults(): TestResults;
|
|
1848
1838
|
get exception(): Error;
|
|
1849
1839
|
getException(): Error;
|
|
1850
|
-
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo |
|
|
1851
|
-
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo |
|
|
1840
|
+
get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
|
|
1841
|
+
getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
|
|
1852
1842
|
}
|
|
1853
1843
|
export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
|
|
1854
1844
|
export class TestResultsSummary implements Iterable<TestResultContainer> {
|