@applitools/eyes-cypress 3.30.2 → 3.31.1
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 +13 -0
- package/dist/browser/mergeCypressConfigs.js +11 -0
- package/dist/browser/transformCypressCheckSettings.js +281 -0
- package/dist/browser/transformCypressConfig.js +58 -0
- package/dist/browser/utils.js +55 -0
- package/dist/plugin/config.js +10 -1
- package/dist/plugin/configParams.js +1 -0
- package/dist/plugin/index.js +1 -1
- package/dist/plugin/server.js +5 -2
- package/package.json +8 -10
- package/src/browser/commands.js +20 -26
- package/src/browser/mergeCypressConfigs.ts +15 -0
- package/src/browser/transformCypressCheckSettings.ts +263 -0
- package/src/browser/transformCypressConfig.ts +56 -0
- package/src/browser/utils.ts +33 -0
- package/src/expose.ts +60 -31
- package/src/plugin/config.ts +10 -1
- package/src/plugin/configParams.ts +1 -0
- package/src/plugin/index.ts +2 -1
- package/src/plugin/server.ts +6 -2
- package/types/expose.d.ts +256 -208
- package/src/browser/eyesCheckMapping.js +0 -281
- package/src/browser/eyesOpenMapping.js +0 -95
package/types/expose.d.ts
CHANGED
|
@@ -1,17 +1,91 @@
|
|
|
1
|
+
export type MaybeArray<T> = T | Array<T>;
|
|
1
2
|
export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; };
|
|
2
3
|
export enum TestResultsStatus {
|
|
3
4
|
Passed = 'Passed',
|
|
4
5
|
Unresolved = 'Unresolved',
|
|
5
6
|
Failed = 'Failed'
|
|
6
7
|
}
|
|
8
|
+
export enum DeviceName {
|
|
9
|
+
Blackberry_PlayBook = 'Blackberry PlayBook',
|
|
10
|
+
BlackBerry_Z30 = 'BlackBerry Z30',
|
|
11
|
+
Galaxy_A5 = 'Galaxy A5',
|
|
12
|
+
Galaxy_Note_10 = 'Galaxy Note 10',
|
|
13
|
+
Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus',
|
|
14
|
+
Galaxy_Note_2 = 'Galaxy Note 2',
|
|
15
|
+
Galaxy_Note_3 = 'Galaxy Note 3',
|
|
16
|
+
Galaxy_Note_4 = 'Galaxy Note 4',
|
|
17
|
+
Galaxy_Note_8 = 'Galaxy Note 8',
|
|
18
|
+
Galaxy_Note_9 = 'Galaxy Note 9',
|
|
19
|
+
Galaxy_S3 = 'Galaxy S3',
|
|
20
|
+
Galaxy_S5 = 'Galaxy S5',
|
|
21
|
+
Galaxy_S8 = 'Galaxy S8',
|
|
22
|
+
Galaxy_S8_Plus = 'Galaxy S8 Plus',
|
|
23
|
+
Galaxy_S9 = 'Galaxy S9',
|
|
24
|
+
Galaxy_S9_Plus = 'Galaxy S9 Plus',
|
|
25
|
+
Galaxy_S10 = 'Galaxy S10',
|
|
26
|
+
Galaxy_S10_Plus = 'Galaxy S10 Plus',
|
|
27
|
+
Galaxy_S20 = 'Galaxy S20',
|
|
28
|
+
Galaxy_S22 = 'Galaxy S22',
|
|
29
|
+
Galaxy_Tab_S7 = 'Galaxy Tab S7',
|
|
30
|
+
iPad = 'iPad',
|
|
31
|
+
iPad_6th_Gen = 'iPad 6th Gen',
|
|
32
|
+
iPad_7th_Gen = 'iPad 7th Gen',
|
|
33
|
+
iPad_Air_2 = 'iPad Air 2',
|
|
34
|
+
iPad_Mini = 'iPad Mini',
|
|
35
|
+
iPad_Pro = 'iPad Pro',
|
|
36
|
+
iPhone_11 = 'iPhone 11',
|
|
37
|
+
iPhone_11_Pro = 'iPhone 11 Pro',
|
|
38
|
+
iPhone_11_Pro_Max = 'iPhone 11 Pro Max',
|
|
39
|
+
iPhone_4 = 'iPhone 4',
|
|
40
|
+
iPhone_5SE = 'iPhone 5/SE',
|
|
41
|
+
iPhone_6_7_8 = 'iPhone 6/7/8',
|
|
42
|
+
iPhone_6_7_8_Plus = 'iPhone 6/7/8 Plus',
|
|
43
|
+
iPhone_X = 'iPhone X',
|
|
44
|
+
iPhone_XR = 'iPhone XR',
|
|
45
|
+
iPhone_XS = 'iPhone XS',
|
|
46
|
+
iPhone_XS_Max = 'iPhone XS Max',
|
|
47
|
+
Kindle_Fire_HDX = 'Kindle Fire HDX',
|
|
48
|
+
Laptop_with_HiDPI_screen = 'Laptop with HiDPI screen',
|
|
49
|
+
Laptop_with_MDPI_screen = 'Laptop with MDPI screen',
|
|
50
|
+
Laptop_with_touch = 'Laptop with touch',
|
|
51
|
+
LG_G6 = 'LG G6',
|
|
52
|
+
LG_Optimus_L70 = 'LG Optimus L70',
|
|
53
|
+
Microsoft_Lumia_550 = 'Microsoft Lumia 550',
|
|
54
|
+
Microsoft_Lumia_950 = 'Microsoft Lumia 950',
|
|
55
|
+
Nexus_10 = 'Nexus 10',
|
|
56
|
+
Nexus_4 = 'Nexus 4',
|
|
57
|
+
Nexus_5 = 'Nexus 5',
|
|
58
|
+
Nexus_5X = 'Nexus 5X',
|
|
59
|
+
Nexus_6 = 'Nexus 6',
|
|
60
|
+
Nexus_6P = 'Nexus 6P',
|
|
61
|
+
Nexus_7 = 'Nexus 7',
|
|
62
|
+
Nokia_Lumia_520 = 'Nokia Lumia 520',
|
|
63
|
+
Nokia_N9 = 'Nokia N9',
|
|
64
|
+
OnePlus_7T = 'OnePlus 7T',
|
|
65
|
+
OnePlus_7T_Pro = 'OnePlus 7T Pro',
|
|
66
|
+
Pixel_2 = 'Pixel 2',
|
|
67
|
+
Pixel_2_XL = 'Pixel 2 XL',
|
|
68
|
+
Pixel_3 = 'Pixel 3',
|
|
69
|
+
Pixel_3_XL = 'Pixel 3 XL',
|
|
70
|
+
Pixel_4 = 'Pixel 4',
|
|
71
|
+
Pixel_4_XL = 'Pixel 4 XL',
|
|
72
|
+
Pixel_5 = 'Pixel 5',
|
|
73
|
+
Sony_Xperia_10_II = 'Sony Xperia 10 II',
|
|
74
|
+
Huawei_Mate_50_Pro = 'Huawei Mate 50 Pro',
|
|
75
|
+
Huawei_Matepad_11 = 'Huawei Matepad 11'
|
|
76
|
+
}
|
|
77
|
+
export type ScreenOrientationPlain = "landscape" | "portrait";
|
|
78
|
+
export type LegacyRegion = { left: number; top: number; width: number; height: number; };
|
|
79
|
+
export type Selector = string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; };
|
|
80
|
+
export type Element = HTMLElement | JQuery;
|
|
81
|
+
export type ElementWithOptions = { element: Element; regionId?: string; padding?: any; };
|
|
82
|
+
export type SelectorWithOptions = { region: Selector; regionId?: string; padding?: number | LegacyRegion; };
|
|
83
|
+
export type AccessibilityValidation = { level?: "AA" | "AAA"; guidelinesVersion?: "WCAG_2_0" | "WCAG_2_1"; };
|
|
84
|
+
export type FloatingRegion = ((LegacyRegion | Selector | ElementWithOptions | SelectorWithOptions) & { maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }) | Array<(LegacyRegion | Selector | ElementWithOptions | SelectorWithOptions) & { maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }>;
|
|
85
|
+
export type accessibilityRegion = ((LegacyRegion | Selector | ElementWithOptions) & { accessibilityType?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }) | { region: { selector: Selector; accessibilityType: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }; regionId?: string; padding?: number | LegacyRegion; } | Array<((LegacyRegion | Selector | ElementWithOptions) & { accessibilityType?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }) | { region: { selector: Selector; accessibilityType: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }; regionId?: string; padding?: number | LegacyRegion; }>;
|
|
7
86
|
export type CypressCheckSettings = {
|
|
8
87
|
name?: string;
|
|
9
|
-
region?:
|
|
10
|
-
x: number;
|
|
11
|
-
y: number;
|
|
12
|
-
width: number;
|
|
13
|
-
height: number;
|
|
14
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }));
|
|
88
|
+
region?: LegacyRegion;
|
|
15
89
|
matchLevel?: "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
16
90
|
useDom?: boolean;
|
|
17
91
|
sendDom?: boolean;
|
|
@@ -24,57 +98,57 @@ export type CypressCheckSettings = {
|
|
|
24
98
|
y: number;
|
|
25
99
|
width: number;
|
|
26
100
|
height: number;
|
|
27
|
-
} | (
|
|
101
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: {
|
|
28
102
|
x: number;
|
|
29
103
|
y: number;
|
|
30
104
|
width: number;
|
|
31
105
|
height: number;
|
|
32
|
-
} | (
|
|
106
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
|
|
33
107
|
layoutRegions?: Array<({
|
|
34
108
|
x: number;
|
|
35
109
|
y: number;
|
|
36
110
|
width: number;
|
|
37
111
|
height: number;
|
|
38
|
-
} | (
|
|
112
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: {
|
|
39
113
|
x: number;
|
|
40
114
|
y: number;
|
|
41
115
|
width: number;
|
|
42
116
|
height: number;
|
|
43
|
-
} | (
|
|
117
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
|
|
44
118
|
strictRegions?: Array<({
|
|
45
119
|
x: number;
|
|
46
120
|
y: number;
|
|
47
121
|
width: number;
|
|
48
122
|
height: number;
|
|
49
|
-
} | (
|
|
123
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: {
|
|
50
124
|
x: number;
|
|
51
125
|
y: number;
|
|
52
126
|
width: number;
|
|
53
127
|
height: number;
|
|
54
|
-
} | (
|
|
128
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
|
|
55
129
|
contentRegions?: Array<({
|
|
56
130
|
x: number;
|
|
57
131
|
y: number;
|
|
58
132
|
width: number;
|
|
59
133
|
height: number;
|
|
60
|
-
} | (
|
|
134
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: {
|
|
61
135
|
x: number;
|
|
62
136
|
y: number;
|
|
63
137
|
width: number;
|
|
64
138
|
height: number;
|
|
65
|
-
} | (
|
|
139
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
|
|
66
140
|
floatingRegions?: Array<({
|
|
67
141
|
x: number;
|
|
68
142
|
y: number;
|
|
69
143
|
width: number;
|
|
70
144
|
height: number;
|
|
71
|
-
} | (
|
|
145
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
72
146
|
region: {
|
|
73
147
|
x: number;
|
|
74
148
|
y: number;
|
|
75
149
|
width: number;
|
|
76
150
|
height: number;
|
|
77
|
-
} | (
|
|
151
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
78
152
|
padding?: number | { top: number; bottom: number; left: number; right: number; };
|
|
79
153
|
regionId?: string;
|
|
80
154
|
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
@@ -84,7 +158,7 @@ export type CypressCheckSettings = {
|
|
|
84
158
|
y: number;
|
|
85
159
|
width: number;
|
|
86
160
|
height: number;
|
|
87
|
-
} | (
|
|
161
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
88
162
|
padding?: number | { top: number; bottom: number; left: number; right: number; };
|
|
89
163
|
regionId?: string;
|
|
90
164
|
maxUpOffset?: number;
|
|
@@ -97,13 +171,13 @@ export type CypressCheckSettings = {
|
|
|
97
171
|
y: number;
|
|
98
172
|
width: number;
|
|
99
173
|
height: number;
|
|
100
|
-
} | (
|
|
174
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
|
|
101
175
|
region: {
|
|
102
176
|
x: number;
|
|
103
177
|
y: number;
|
|
104
178
|
width: number;
|
|
105
179
|
height: number;
|
|
106
|
-
} | (
|
|
180
|
+
} | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
|
|
107
181
|
padding?: number | { top: number; bottom: number; left: number; right: number; };
|
|
108
182
|
regionId?: string;
|
|
109
183
|
type?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
@@ -111,9 +185,9 @@ export type CypressCheckSettings = {
|
|
|
111
185
|
pageId?: string;
|
|
112
186
|
variationGroupId?: string;
|
|
113
187
|
densityMetrics?: { scaleRatio?: number; xdpi?: number; ydpi?: number; };
|
|
114
|
-
frames?: Array<{ frame: number | (
|
|
188
|
+
frames?: Array<{ frame: number | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); } | (number | (Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>;
|
|
115
189
|
webview?: string | boolean;
|
|
116
|
-
scrollRootElement?:
|
|
190
|
+
scrollRootElement?: Element | (Selector | { selector: Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; });
|
|
117
191
|
fully?: boolean;
|
|
118
192
|
disableBrowserFetching?: boolean;
|
|
119
193
|
layoutBreakpoints?: boolean | Array<number>;
|
|
@@ -126,183 +200,19 @@ export type CypressCheckSettings = {
|
|
|
126
200
|
lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
|
|
127
201
|
tag?: string;
|
|
128
202
|
target?: "window" | "region";
|
|
129
|
-
selector?:
|
|
130
|
-
element?:
|
|
131
|
-
ignore?:
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
x: number;
|
|
138
|
-
y: number;
|
|
139
|
-
width: number;
|
|
140
|
-
height: number;
|
|
141
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; } | Array<{ left: number; top: number; width: number; height: number; } | { element: HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }; regionId?: string; padding?: any; } | ({
|
|
142
|
-
x: number;
|
|
143
|
-
y: number;
|
|
144
|
-
width: number;
|
|
145
|
-
height: number;
|
|
146
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }))) | { region: {
|
|
147
|
-
x: number;
|
|
148
|
-
y: number;
|
|
149
|
-
width: number;
|
|
150
|
-
height: number;
|
|
151
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
|
|
152
|
-
layout?: { left: number; top: number; width: number; height: number; } | { element: HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }; regionId?: string; padding?: any; } | ({
|
|
153
|
-
x: number;
|
|
154
|
-
y: number;
|
|
155
|
-
width: number;
|
|
156
|
-
height: number;
|
|
157
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }))) | { region: {
|
|
158
|
-
x: number;
|
|
159
|
-
y: number;
|
|
160
|
-
width: number;
|
|
161
|
-
height: number;
|
|
162
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; } | Array<{ left: number; top: number; width: number; height: number; } | { element: HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }; regionId?: string; padding?: any; } | ({
|
|
163
|
-
x: number;
|
|
164
|
-
y: number;
|
|
165
|
-
width: number;
|
|
166
|
-
height: number;
|
|
167
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }))) | { region: {
|
|
168
|
-
x: number;
|
|
169
|
-
y: number;
|
|
170
|
-
width: number;
|
|
171
|
-
height: number;
|
|
172
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
|
|
173
|
-
content?: { left: number; top: number; width: number; height: number; } | { element: HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }; regionId?: string; padding?: any; } | ({
|
|
174
|
-
x: number;
|
|
175
|
-
y: number;
|
|
176
|
-
width: number;
|
|
177
|
-
height: number;
|
|
178
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }))) | { region: {
|
|
179
|
-
x: number;
|
|
180
|
-
y: number;
|
|
181
|
-
width: number;
|
|
182
|
-
height: number;
|
|
183
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; } | Array<{ left: number; top: number; width: number; height: number; } | { element: HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }; regionId?: string; padding?: any; } | ({
|
|
184
|
-
x: number;
|
|
185
|
-
y: number;
|
|
186
|
-
width: number;
|
|
187
|
-
height: number;
|
|
188
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }))) | { region: {
|
|
189
|
-
x: number;
|
|
190
|
-
y: number;
|
|
191
|
-
width: number;
|
|
192
|
-
height: number;
|
|
193
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
|
|
194
|
-
strict?: { left: number; top: number; width: number; height: number; } | { element: HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }; regionId?: string; padding?: any; } | ({
|
|
195
|
-
x: number;
|
|
196
|
-
y: number;
|
|
197
|
-
width: number;
|
|
198
|
-
height: number;
|
|
199
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }))) | { region: {
|
|
200
|
-
x: number;
|
|
201
|
-
y: number;
|
|
202
|
-
width: number;
|
|
203
|
-
height: number;
|
|
204
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; } | Array<{ left: number; top: number; width: number; height: number; } | { element: HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }; regionId?: string; padding?: any; } | ({
|
|
205
|
-
x: number;
|
|
206
|
-
y: number;
|
|
207
|
-
width: number;
|
|
208
|
-
height: number;
|
|
209
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }))) | { region: {
|
|
210
|
-
x: number;
|
|
211
|
-
y: number;
|
|
212
|
-
width: number;
|
|
213
|
-
height: number;
|
|
214
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; })); padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
|
|
215
|
-
floating?: ({
|
|
216
|
-
x: number;
|
|
217
|
-
y: number;
|
|
218
|
-
width: number;
|
|
219
|
-
height: number;
|
|
220
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }))) | {
|
|
221
|
-
region: {
|
|
222
|
-
x: number;
|
|
223
|
-
y: number;
|
|
224
|
-
width: number;
|
|
225
|
-
height: number;
|
|
226
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }));
|
|
227
|
-
padding?: number | { top: number; bottom: number; left: number; right: number; };
|
|
228
|
-
regionId?: string;
|
|
229
|
-
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
230
|
-
} | {
|
|
231
|
-
region: {
|
|
232
|
-
x: number;
|
|
233
|
-
y: number;
|
|
234
|
-
width: number;
|
|
235
|
-
height: number;
|
|
236
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }));
|
|
237
|
-
padding?: number | { top: number; bottom: number; left: number; right: number; };
|
|
238
|
-
regionId?: string;
|
|
239
|
-
maxUpOffset?: number;
|
|
240
|
-
maxDownOffset?: number;
|
|
241
|
-
maxLeftOffset?: number;
|
|
242
|
-
maxRightOffset?: number;
|
|
243
|
-
} | (({ left: number; top: number; width: number; height: number; } | (string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { element: HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }; regionId?: string; padding?: any; }) & { maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; }) | Array<({
|
|
244
|
-
x: number;
|
|
245
|
-
y: number;
|
|
246
|
-
width: number;
|
|
247
|
-
height: number;
|
|
248
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }))) | {
|
|
249
|
-
region: {
|
|
250
|
-
x: number;
|
|
251
|
-
y: number;
|
|
252
|
-
width: number;
|
|
253
|
-
height: number;
|
|
254
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }));
|
|
255
|
-
padding?: number | { top: number; bottom: number; left: number; right: number; };
|
|
256
|
-
regionId?: string;
|
|
257
|
-
offset?: { top?: number; bottom?: number; left?: number; right?: number; };
|
|
258
|
-
} | {
|
|
259
|
-
region: {
|
|
260
|
-
x: number;
|
|
261
|
-
y: number;
|
|
262
|
-
width: number;
|
|
263
|
-
height: number;
|
|
264
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }));
|
|
265
|
-
padding?: number | { top: number; bottom: number; left: number; right: number; };
|
|
266
|
-
regionId?: string;
|
|
267
|
-
maxUpOffset?: number;
|
|
268
|
-
maxDownOffset?: number;
|
|
269
|
-
maxLeftOffset?: number;
|
|
270
|
-
maxRightOffset?: number;
|
|
271
|
-
} | (({ left: number; top: number; width: number; height: number; } | (string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { element: HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }; regionId?: string; padding?: any; }) & { maxUpOffset?: number; maxDownOffset?: number; maxLeftOffset?: number; maxRightOffset?: number; })>;
|
|
272
|
-
accessibility?: ({
|
|
273
|
-
x: number;
|
|
274
|
-
y: number;
|
|
275
|
-
width: number;
|
|
276
|
-
height: number;
|
|
277
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }))) | {
|
|
278
|
-
region: {
|
|
279
|
-
x: number;
|
|
280
|
-
y: number;
|
|
281
|
-
width: number;
|
|
282
|
-
height: number;
|
|
283
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }));
|
|
284
|
-
padding?: number | { top: number; bottom: number; left: number; right: number; };
|
|
285
|
-
regionId?: string;
|
|
286
|
-
type?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
287
|
-
} | (({ left: number; top: number; width: number; height: number; } | (string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { element: HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }; regionId?: string; padding?: any; }) & { accessibilityType?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }) | Array<({
|
|
288
|
-
x: number;
|
|
289
|
-
y: number;
|
|
290
|
-
width: number;
|
|
291
|
-
height: number;
|
|
292
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }))) | {
|
|
293
|
-
region: {
|
|
294
|
-
x: number;
|
|
295
|
-
y: number;
|
|
296
|
-
width: number;
|
|
297
|
-
height: number;
|
|
298
|
-
} | ((HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }) | ((string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { selector: string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }; type?: string; shadow?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; frame?: EyesSelector<string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }>; }));
|
|
299
|
-
padding?: number | { top: number; bottom: number; left: number; right: number; };
|
|
300
|
-
regionId?: string;
|
|
301
|
-
type?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
|
|
302
|
-
} | (({ left: number; top: number; width: number; height: number; } | (string | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; }) | { element: HTMLElement | { [n: number]: HTMLElement; [Symbol.iterator](): Iterator<HTMLElement, any, undefined>; }; regionId?: string; padding?: any; }) & { accessibilityType?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; })>;
|
|
203
|
+
selector?: Selector;
|
|
204
|
+
element?: Element;
|
|
205
|
+
ignore?: MaybeArray<string | HTMLElement | JQuery | LegacyRegion | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | ElementWithOptions | SelectorWithOptions>;
|
|
206
|
+
layout?: MaybeArray<string | HTMLElement | JQuery | LegacyRegion | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | ElementWithOptions | SelectorWithOptions>;
|
|
207
|
+
content?: MaybeArray<string | HTMLElement | JQuery | LegacyRegion | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | ElementWithOptions | SelectorWithOptions>;
|
|
208
|
+
strict?: MaybeArray<string | HTMLElement | JQuery | LegacyRegion | { selector: string; type?: "css" | "xpath"; nodeType?: "element" | "shadow-root"; } | ElementWithOptions | SelectorWithOptions>;
|
|
209
|
+
floating?: FloatingRegion;
|
|
210
|
+
accessibility?: accessibilityRegion;
|
|
303
211
|
scriptHooks?: { beforeCaptureScreenshot: string; };
|
|
212
|
+
browser?: MaybeArray<{ name?: "chrome" | "firefox" | "edge" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11"; screenOrientation?: ScreenOrientationPlain; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 14 Pro Max" | "iPhone 14" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { androidDeviceInfo: { deviceName: "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 10 JE" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite"; version?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { deviceName: DeviceName; screenOrientation?: ScreenOrientationPlain; name?: string; }>;
|
|
304
213
|
};
|
|
305
214
|
export type CypressEyesConfig = {
|
|
215
|
+
debugScreenshots?: { save: boolean; path?: string; prefix?: string; };
|
|
306
216
|
agentId?: string;
|
|
307
217
|
apiKey?: string;
|
|
308
218
|
serverUrl?: string;
|
|
@@ -315,6 +225,8 @@ export type CypressEyesConfig = {
|
|
|
315
225
|
domains?: Array<string>;
|
|
316
226
|
};
|
|
317
227
|
isDisabled?: boolean;
|
|
228
|
+
connectionTimeout?: number;
|
|
229
|
+
removeSession?: boolean;
|
|
318
230
|
appName?: string;
|
|
319
231
|
testName?: string;
|
|
320
232
|
displayName?: string;
|
|
@@ -388,7 +300,7 @@ export type CypressEyesConfig = {
|
|
|
388
300
|
width: number;
|
|
389
301
|
height: number;
|
|
390
302
|
}; type?: "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; }>;
|
|
391
|
-
accessibilitySettings?:
|
|
303
|
+
accessibilitySettings?: AccessibilityValidation;
|
|
392
304
|
};
|
|
393
305
|
hostApp?: string;
|
|
394
306
|
hostOS?: string;
|
|
@@ -406,6 +318,7 @@ export type CypressEyesConfig = {
|
|
|
406
318
|
saveFailedTests?: boolean;
|
|
407
319
|
saveNewTests?: boolean;
|
|
408
320
|
saveDiffs?: boolean;
|
|
321
|
+
dontCloseBatches?: boolean;
|
|
409
322
|
sendDom?: boolean;
|
|
410
323
|
matchTimeout?: number;
|
|
411
324
|
forceFullPageScreenshot?: boolean;
|
|
@@ -414,118 +327,252 @@ export type CypressEyesConfig = {
|
|
|
414
327
|
hideScrollbars?: boolean;
|
|
415
328
|
hideCaret?: boolean;
|
|
416
329
|
stitchOverlap?: number;
|
|
417
|
-
scrollRootElement?:
|
|
330
|
+
scrollRootElement?: Element | EyesSelector<Selector>;
|
|
418
331
|
cut?: { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
|
|
419
332
|
rotation?: 0 | 270 | -270 | 180 | -180 | 90 | -90;
|
|
420
333
|
scaleRatio?: number;
|
|
421
334
|
waitBeforeCapture?: number;
|
|
422
|
-
|
|
335
|
+
concurrentSessions?: number;
|
|
336
|
+
browsersInfo?: Array<{ name?: "chrome" | "firefox" | "edge" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11"; screenOrientation?: ScreenOrientationPlain; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 14 Pro Max" | "iPhone 14" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { androidDeviceInfo: { deviceName: "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 10 JE" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite"; version?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; }>;
|
|
423
337
|
visualGridOptions?: Record<string, any>;
|
|
424
338
|
layoutBreakpoints?: boolean | Array<number>;
|
|
425
339
|
disableBrowserFetching?: boolean;
|
|
426
|
-
browser?:
|
|
340
|
+
browser?: MaybeArray<{ name?: "chrome" | "firefox" | "edge" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11"; screenOrientation?: ScreenOrientationPlain; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 14 Pro Max" | "iPhone 14" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { androidDeviceInfo: { deviceName: "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 10 JE" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite"; version?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { deviceName: DeviceName; screenOrientation?: ScreenOrientationPlain; name?: string; }>;
|
|
427
341
|
batchId?: string;
|
|
428
342
|
batchName?: string;
|
|
429
343
|
batchSequence?: string;
|
|
430
344
|
notifyOnCompletion?: boolean;
|
|
345
|
+
batchSequenceName?: string;
|
|
431
346
|
envName?: string;
|
|
432
|
-
|
|
347
|
+
accessibilityValidation?: AccessibilityValidation;
|
|
348
|
+
matchLevel?: "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
|
|
349
|
+
ignoreCaret?: boolean;
|
|
350
|
+
ignoreDisplacements?: boolean;
|
|
351
|
+
useDom?: boolean;
|
|
352
|
+
enablePatterns?: boolean;
|
|
353
|
+
scriptHooks?: { beforeCaptureScreenshot: string; };
|
|
433
354
|
};
|
|
434
355
|
export type CypressTestResultsSummary = { getAllResults(): Array<{ getTestResults(): {
|
|
435
356
|
getId(): string;
|
|
357
|
+
setId(_id: string): void;
|
|
436
358
|
getName(): string;
|
|
359
|
+
setName(_name: string): void;
|
|
437
360
|
getSecretToken(): string;
|
|
361
|
+
setSecretToken(_secretToken: string): void;
|
|
438
362
|
getStatus(): TestResultsStatus;
|
|
363
|
+
setStatus(_status: TestResultsStatus): void;
|
|
439
364
|
getAppName(): string;
|
|
365
|
+
setAppName(_appName: string): void;
|
|
440
366
|
getBatchName(): string;
|
|
367
|
+
setBatchName(_batchName: string): void;
|
|
441
368
|
getBatchId(): string;
|
|
369
|
+
setBatchId(_batchId: string): void;
|
|
442
370
|
getBranchName(): string;
|
|
371
|
+
setBranchName(_branchName: string): void;
|
|
443
372
|
getHostOS(): string;
|
|
373
|
+
setHostOS(_hostOS: string): void;
|
|
444
374
|
getHostApp(): string;
|
|
375
|
+
setHostApp(_hostApp: string): void;
|
|
445
376
|
getHostDisplaySize(): { getWidth(): number; setWidth(width: number): void; getHeight(): number; setHeight(height: number): void; };
|
|
377
|
+
setHostDisplaySize(_hostDisplaySize: { width: number; height: number; }): void;
|
|
446
378
|
getAccessibilityStatus(): { readonly status: "Passed" | "Failed"; readonly level: "AA" | "AAA"; readonly version: "WCAG_2_0" | "WCAG_2_1"; };
|
|
379
|
+
setAccessibilityStatus(_accessibilityStatus: { readonly status: "Passed" | "Failed"; readonly level: "AA" | "AAA"; readonly version: "WCAG_2_0" | "WCAG_2_1"; }): void;
|
|
447
380
|
getStartedAt(): Date;
|
|
381
|
+
setStartedAt(_startedAt: string | Date): void;
|
|
448
382
|
getDuration(): number;
|
|
383
|
+
setDuration(_duration: number): void;
|
|
449
384
|
getIsNew(): boolean;
|
|
385
|
+
setIsNew(_isNew: boolean): void;
|
|
450
386
|
getIsDifferent(): boolean;
|
|
387
|
+
setIsDifferent(_isDifferent: boolean): void;
|
|
451
388
|
getIsAborted(): boolean;
|
|
452
|
-
|
|
453
|
-
|
|
389
|
+
setIsAborted(_isAborted: boolean): void;
|
|
390
|
+
getAppUrls(): { getBatch(): string; setBatch(batch: string): void; getSession(): string; setSession(session: string): void; };
|
|
391
|
+
setAppUrls(_appUrls: { readonly batch?: string; readonly session?: string; }): void;
|
|
392
|
+
getApiUrls(): { getBatch(): string; setBatch(batch: string): void; getSession(): string; setSession(session: string): void; };
|
|
393
|
+
setApiUrls(_apiUrls: { readonly batch?: string; readonly session?: string; }): void;
|
|
454
394
|
getStepsInfo(): Array<{
|
|
455
395
|
getName(): string;
|
|
396
|
+
setName(value: string): void;
|
|
456
397
|
getIsDifferent(): boolean;
|
|
398
|
+
setIsDifferent(value: boolean): void;
|
|
457
399
|
getHasBaselineImage(): boolean;
|
|
400
|
+
setHasBaselineImage(value: boolean): void;
|
|
458
401
|
getHasCurrentImage(): boolean;
|
|
459
|
-
|
|
402
|
+
setHasCurrentImage(hasCurrentImage: boolean): void;
|
|
403
|
+
getAppUrls(): { getStep(): string; setStep(step: string): void; getStepEditor(): string; setStepEditor(stepEditor: string): void; };
|
|
404
|
+
setAppUrls(appUrls: { readonly step?: string; readonly stepEditor?: string; }): void;
|
|
460
405
|
getApiUrls(): {
|
|
461
406
|
getBaselineImage(): string;
|
|
407
|
+
setBaselineImage(setBaselineImage: string): void;
|
|
462
408
|
getCurrentImage(): string;
|
|
409
|
+
setCurrentImage(currentImage: string): void;
|
|
463
410
|
getCheckpointImage(): string;
|
|
411
|
+
setCheckpointImage(checkpointImage: string): void;
|
|
464
412
|
getCheckpointImageThumbnail(): string;
|
|
413
|
+
setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
|
|
465
414
|
getDiffImage(): string;
|
|
415
|
+
setDiffImage(diffImage: string): void;
|
|
466
416
|
};
|
|
417
|
+
setApiUrls(apiUrls: {
|
|
418
|
+
readonly baselineImage?: string;
|
|
419
|
+
readonly currentImage?: string;
|
|
420
|
+
readonly checkpointImage?: string;
|
|
421
|
+
readonly checkpointImageThumbnail?: string;
|
|
422
|
+
readonly diffImage?: string;
|
|
423
|
+
}): void;
|
|
467
424
|
getRenderId(): Array<string>;
|
|
425
|
+
setRenderId(renderId: Array<string>): void;
|
|
468
426
|
}>;
|
|
427
|
+
setStepsInfo(_stepInfo: Array<{
|
|
428
|
+
readonly name?: string;
|
|
429
|
+
readonly isDifferent?: boolean;
|
|
430
|
+
readonly hasBaselineImage?: boolean;
|
|
431
|
+
readonly hasCurrentImage?: boolean;
|
|
432
|
+
readonly appUrls?: { readonly step?: string; readonly stepEditor?: string; };
|
|
433
|
+
readonly apiUrls?: {
|
|
434
|
+
readonly baselineImage?: string;
|
|
435
|
+
readonly currentImage?: string;
|
|
436
|
+
readonly checkpointImage?: string;
|
|
437
|
+
readonly checkpointImageThumbnail?: string;
|
|
438
|
+
readonly diffImage?: string;
|
|
439
|
+
};
|
|
440
|
+
readonly renderId?: Array<string>;
|
|
441
|
+
}>): void;
|
|
469
442
|
getSteps(): number;
|
|
443
|
+
setSteps(_steps: number): void;
|
|
470
444
|
getMatches(): number;
|
|
445
|
+
setMatches(_matches: number): void;
|
|
471
446
|
getMismatches(): number;
|
|
447
|
+
setMismatches(_mismatches: number): void;
|
|
472
448
|
getMissing(): number;
|
|
449
|
+
setMissing(_missing: number): void;
|
|
473
450
|
getExactMatches(): number;
|
|
451
|
+
setExactMatches(_exactMatches: number): void;
|
|
474
452
|
getStrictMatches(): number;
|
|
453
|
+
setStrictMatches(_strictMatches: number): void;
|
|
475
454
|
getContentMatches(): number;
|
|
455
|
+
setContentMatches(_contentMatches: number): void;
|
|
476
456
|
getLayoutMatches(): number;
|
|
457
|
+
setLayoutMatches(_layoutMatches: number): void;
|
|
477
458
|
getNoneMatches(): number;
|
|
459
|
+
setNoneMatches(_noneMatches: number): void;
|
|
478
460
|
getUrl(): string;
|
|
461
|
+
setUrl(_url: string): void;
|
|
479
462
|
isPassed(): boolean;
|
|
480
463
|
delete(): Promise<void>;
|
|
481
|
-
|
|
464
|
+
deleteSession(): Promise<void>;
|
|
465
|
+
}; getException(): Error; getBrowserInfo(): { name?: "chrome" | "firefox" | "edge" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11"; screenOrientation?: ScreenOrientationPlain; }; } | { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11"; screenOrientation?: ScreenOrientationPlain; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 14 Pro Max" | "iPhone 14" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { androidDeviceInfo: { deviceName: "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 10 JE" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite"; version?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; }; }>; [Symbol.iterator](): Iterator<{ getTestResults(): {
|
|
482
466
|
getId(): string;
|
|
467
|
+
setId(_id: string): void;
|
|
483
468
|
getName(): string;
|
|
469
|
+
setName(_name: string): void;
|
|
484
470
|
getSecretToken(): string;
|
|
471
|
+
setSecretToken(_secretToken: string): void;
|
|
485
472
|
getStatus(): TestResultsStatus;
|
|
473
|
+
setStatus(_status: TestResultsStatus): void;
|
|
486
474
|
getAppName(): string;
|
|
475
|
+
setAppName(_appName: string): void;
|
|
487
476
|
getBatchName(): string;
|
|
477
|
+
setBatchName(_batchName: string): void;
|
|
488
478
|
getBatchId(): string;
|
|
479
|
+
setBatchId(_batchId: string): void;
|
|
489
480
|
getBranchName(): string;
|
|
481
|
+
setBranchName(_branchName: string): void;
|
|
490
482
|
getHostOS(): string;
|
|
483
|
+
setHostOS(_hostOS: string): void;
|
|
491
484
|
getHostApp(): string;
|
|
485
|
+
setHostApp(_hostApp: string): void;
|
|
492
486
|
getHostDisplaySize(): { getWidth(): number; setWidth(width: number): void; getHeight(): number; setHeight(height: number): void; };
|
|
487
|
+
setHostDisplaySize(_hostDisplaySize: { width: number; height: number; }): void;
|
|
493
488
|
getAccessibilityStatus(): { readonly status: "Passed" | "Failed"; readonly level: "AA" | "AAA"; readonly version: "WCAG_2_0" | "WCAG_2_1"; };
|
|
489
|
+
setAccessibilityStatus(_accessibilityStatus: { readonly status: "Passed" | "Failed"; readonly level: "AA" | "AAA"; readonly version: "WCAG_2_0" | "WCAG_2_1"; }): void;
|
|
494
490
|
getStartedAt(): Date;
|
|
491
|
+
setStartedAt(_startedAt: string | Date): void;
|
|
495
492
|
getDuration(): number;
|
|
493
|
+
setDuration(_duration: number): void;
|
|
496
494
|
getIsNew(): boolean;
|
|
495
|
+
setIsNew(_isNew: boolean): void;
|
|
497
496
|
getIsDifferent(): boolean;
|
|
497
|
+
setIsDifferent(_isDifferent: boolean): void;
|
|
498
498
|
getIsAborted(): boolean;
|
|
499
|
-
|
|
500
|
-
|
|
499
|
+
setIsAborted(_isAborted: boolean): void;
|
|
500
|
+
getAppUrls(): { getBatch(): string; setBatch(batch: string): void; getSession(): string; setSession(session: string): void; };
|
|
501
|
+
setAppUrls(_appUrls: { readonly batch?: string; readonly session?: string; }): void;
|
|
502
|
+
getApiUrls(): { getBatch(): string; setBatch(batch: string): void; getSession(): string; setSession(session: string): void; };
|
|
503
|
+
setApiUrls(_apiUrls: { readonly batch?: string; readonly session?: string; }): void;
|
|
501
504
|
getStepsInfo(): Array<{
|
|
502
505
|
getName(): string;
|
|
506
|
+
setName(value: string): void;
|
|
503
507
|
getIsDifferent(): boolean;
|
|
508
|
+
setIsDifferent(value: boolean): void;
|
|
504
509
|
getHasBaselineImage(): boolean;
|
|
510
|
+
setHasBaselineImage(value: boolean): void;
|
|
505
511
|
getHasCurrentImage(): boolean;
|
|
506
|
-
|
|
512
|
+
setHasCurrentImage(hasCurrentImage: boolean): void;
|
|
513
|
+
getAppUrls(): { getStep(): string; setStep(step: string): void; getStepEditor(): string; setStepEditor(stepEditor: string): void; };
|
|
514
|
+
setAppUrls(appUrls: { readonly step?: string; readonly stepEditor?: string; }): void;
|
|
507
515
|
getApiUrls(): {
|
|
508
516
|
getBaselineImage(): string;
|
|
517
|
+
setBaselineImage(setBaselineImage: string): void;
|
|
509
518
|
getCurrentImage(): string;
|
|
519
|
+
setCurrentImage(currentImage: string): void;
|
|
510
520
|
getCheckpointImage(): string;
|
|
521
|
+
setCheckpointImage(checkpointImage: string): void;
|
|
511
522
|
getCheckpointImageThumbnail(): string;
|
|
523
|
+
setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
|
|
512
524
|
getDiffImage(): string;
|
|
525
|
+
setDiffImage(diffImage: string): void;
|
|
513
526
|
};
|
|
527
|
+
setApiUrls(apiUrls: {
|
|
528
|
+
readonly baselineImage?: string;
|
|
529
|
+
readonly currentImage?: string;
|
|
530
|
+
readonly checkpointImage?: string;
|
|
531
|
+
readonly checkpointImageThumbnail?: string;
|
|
532
|
+
readonly diffImage?: string;
|
|
533
|
+
}): void;
|
|
514
534
|
getRenderId(): Array<string>;
|
|
535
|
+
setRenderId(renderId: Array<string>): void;
|
|
515
536
|
}>;
|
|
537
|
+
setStepsInfo(_stepInfo: Array<{
|
|
538
|
+
readonly name?: string;
|
|
539
|
+
readonly isDifferent?: boolean;
|
|
540
|
+
readonly hasBaselineImage?: boolean;
|
|
541
|
+
readonly hasCurrentImage?: boolean;
|
|
542
|
+
readonly appUrls?: { readonly step?: string; readonly stepEditor?: string; };
|
|
543
|
+
readonly apiUrls?: {
|
|
544
|
+
readonly baselineImage?: string;
|
|
545
|
+
readonly currentImage?: string;
|
|
546
|
+
readonly checkpointImage?: string;
|
|
547
|
+
readonly checkpointImageThumbnail?: string;
|
|
548
|
+
readonly diffImage?: string;
|
|
549
|
+
};
|
|
550
|
+
readonly renderId?: Array<string>;
|
|
551
|
+
}>): void;
|
|
516
552
|
getSteps(): number;
|
|
553
|
+
setSteps(_steps: number): void;
|
|
517
554
|
getMatches(): number;
|
|
555
|
+
setMatches(_matches: number): void;
|
|
518
556
|
getMismatches(): number;
|
|
557
|
+
setMismatches(_mismatches: number): void;
|
|
519
558
|
getMissing(): number;
|
|
559
|
+
setMissing(_missing: number): void;
|
|
520
560
|
getExactMatches(): number;
|
|
561
|
+
setExactMatches(_exactMatches: number): void;
|
|
521
562
|
getStrictMatches(): number;
|
|
563
|
+
setStrictMatches(_strictMatches: number): void;
|
|
522
564
|
getContentMatches(): number;
|
|
565
|
+
setContentMatches(_contentMatches: number): void;
|
|
523
566
|
getLayoutMatches(): number;
|
|
567
|
+
setLayoutMatches(_layoutMatches: number): void;
|
|
524
568
|
getNoneMatches(): number;
|
|
569
|
+
setNoneMatches(_noneMatches: number): void;
|
|
525
570
|
getUrl(): string;
|
|
571
|
+
setUrl(_url: string): void;
|
|
526
572
|
isPassed(): boolean;
|
|
527
573
|
delete(): Promise<void>;
|
|
528
|
-
|
|
574
|
+
deleteSession(): Promise<void>;
|
|
575
|
+
}; getException(): Error; getBrowserInfo(): { name?: "chrome" | "firefox" | "edge" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back"; width: number; height: number; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11"; screenOrientation?: ScreenOrientationPlain; }; } | { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11"; screenOrientation?: ScreenOrientationPlain; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 14 Pro Max" | "iPhone 14" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; } | { androidDeviceInfo: { deviceName: "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 10 JE" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite"; version?: "latest" | "latest-1"; screenOrientation?: ScreenOrientationPlain; }; }; }, any, undefined>; };
|
|
529
576
|
export type EyesPluginConfig = {
|
|
530
577
|
tapDirPath: string;
|
|
531
578
|
tapFileName: string;
|
|
@@ -538,6 +585,7 @@ export type EyesPluginConfig = {
|
|
|
538
585
|
eyesWaitBeforeCapture: number;
|
|
539
586
|
eyesPort?: number;
|
|
540
587
|
eyesIsGlobalHooksSupported?: boolean;
|
|
588
|
+
eyesRemoveDuplicateTests?: boolean;
|
|
541
589
|
};
|
|
542
590
|
declare const _default: (pluginInitArgs: Cypress.ConfigOptions | NodeJS.Module) => Cypress.ConfigOptions | NodeJS.Module | (() => Promise<void>);
|
|
543
591
|
export default _default;
|