@applitools/eyes-webdriverio 5.35.3 → 5.35.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/package.json +7 -7
  3. package/types/index.d.ts +58 -168
package/CHANGELOG.md CHANGED
@@ -10,6 +10,27 @@
10
10
 
11
11
 
12
12
 
13
+ ## 5.35.6 - 2022/6/27
14
+
15
+ ### Features
16
+ - Add support for dynamic coded regions
17
+ ### Bug fixes
18
+ - Improve the logic that detects the side of native Android navigation bar
19
+
20
+ ## 5.35.5 - 2022/6/22
21
+
22
+ ### Features
23
+ - Support `addMobileDevice` in user API for NMG
24
+ ### Bug fixes
25
+ - Improved handling of touch padding related issues in native apps
26
+ - Prevented navbar from appearing on Android 12 screenshots
27
+
28
+ ## 5.35.4 - 2022/6/17
29
+
30
+ ### Features
31
+ ### Bug fixes
32
+ - Fixed scrolling on some android devices
33
+
13
34
  ## 5.35.3 - 2022/6/14
14
35
 
15
36
  ### Features
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-webdriverio",
3
- "version": "5.35.3",
3
+ "version": "5.35.6",
4
4
  "description": "Applitools Eyes SDK for WebdriverIO",
5
5
  "keywords": [
6
6
  "eyes-webdriverio",
@@ -115,17 +115,17 @@
115
115
  }
116
116
  },
117
117
  "dependencies": {
118
- "@applitools/eyes-api": "1.6.1",
119
- "@applitools/eyes-sdk-core": "13.8.1",
120
- "@applitools/spec-driver-webdriverio": "1.2.11",
121
- "@applitools/visual-grid-client": "15.12.44"
118
+ "@applitools/eyes-api": "1.7.2",
119
+ "@applitools/eyes-sdk-core": "13.8.6",
120
+ "@applitools/spec-driver-webdriverio": "1.2.15",
121
+ "@applitools/visual-grid-client": "15.13.1"
122
122
  },
123
123
  "devDependencies": {
124
- "@applitools/api-extractor": "1.2.8",
124
+ "@applitools/api-extractor": "1.2.9",
125
125
  "@applitools/bongo": "^2.1.5",
126
126
  "@applitools/scripts": "1.1.0",
127
127
  "@applitools/sdk-coverage-tests": "^2.3.18",
128
- "@applitools/sdk-shared": "0.9.11",
128
+ "@applitools/sdk-shared": "0.9.12",
129
129
  "@applitools/test-utils": "1.3.3",
130
130
  "@types/mocha": "^9.1.1",
131
131
  "@types/node": "12",
package/types/index.d.ts CHANGED
@@ -32,37 +32,15 @@ export class Eyes {
32
32
  setConfiguration(config: ConfigurationPlain): void;
33
33
  get isOpen(): boolean;
34
34
  getIsOpen(): boolean;
35
- on(handler: (event: string, data?: Record<string, any>) => any): () => void;
36
- on(event: "setSizeWillStart", handler: (data: { viewportSize: RectangleSizePlain; }) => any): () => void;
37
- on(event: "setSizeEnded", handler: () => any): () => void;
38
- on(event: "initStarted", handler: () => any): () => void;
39
- on(event: "initEnded", handler: () => any): () => void;
40
- on(event: "testStarted", handler: (data: { sessionId: string; }) => any): () => void;
41
- on(event: "validationWillStart", handler: (data: { sessionId: string; validationInfo: ValidationInfoPlain; }) => any): () => void;
42
- on(event: "validationEnded", handler: (data: { sessionId: string; validationId: number; validationResult: ValidationResultPlain; }) => any): () => void;
43
- on(event: "testEnded", handler: (data: { sessionId: string; testResults: TestResultsPlain; }) => any): () => void;
44
- off(event: string): void;
45
- off(handler: (...args: Array<any>) => any): void;
46
35
  open(driver: Driver, config?: ConfigurationPlain): Promise<Driver>;
47
36
  open(driver: Driver, appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<Driver>;
48
- checkWindow(name?: string, timeout?: number, fully?: boolean): Promise<MatchResult>;
49
- checkFrame(element: number | Element | EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
50
- checkElement(element: Element, timeout?: number, name?: string): Promise<MatchResult>;
51
- checkElementBy(selector: EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
52
- checkRegion(region?: RegionPlain, name?: string, timeout?: number): Promise<MatchResult>;
53
- checkRegionByElement(element: Element, name?: string, timeout?: number): Promise<MatchResult>;
54
- checkRegionBy(selector: EyesSelector<Selector>, name?: string, timeout?: number, fully?: boolean): Promise<MatchResult>;
55
- checkRegionInFrame(frame: number | Element | EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: number, name?: string, fully?: boolean): Promise<MatchResult>;
56
37
  check(name: string, checkSettings: CheckSettings): Promise<MatchResult>;
57
38
  check(checkSettings?: CheckSettingsPlain): Promise<MatchResult>;
58
39
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
59
40
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
60
41
  extractText(regions: Array<OCRRegion>): Promise<Array<string>>;
61
42
  close(throwErr?: boolean): Promise<TestResults>;
62
- closeAsync(): Promise<void>;
63
43
  abort(): Promise<TestResults>;
64
- abortAsync(): Promise<void>;
65
- abortIfNotClosed(): Promise<TestResultsPlain>;
66
44
  getViewportSize(): Promise<RectangleSize>;
67
45
  setViewportSize(size: RectangleSizePlain): Promise<void>;
68
46
  getScrollRootElement(): Element | EyesSelector<Selector>;
@@ -95,8 +73,6 @@ export class Eyes {
95
73
  setAppName(appName: string): void;
96
74
  getBaselineBranchName(): string;
97
75
  setBaselineBranchName(baselineBranchName: string): void;
98
- getBaselineName(): string;
99
- setBaselineName(baselineName: string): void;
100
76
  getBaselineEnvName(): string;
101
77
  setBaselineEnvName(baselineEnvName: string): void;
102
78
  getBranchName(): string;
@@ -145,23 +121,14 @@ export class Eyes {
145
121
  setStitchMode(stitchMode: StitchModePlain): void;
146
122
  getStitchOverlap(): number;
147
123
  setStitchOverlap(stitchOverlap: number): void;
148
- getSessionEventHandlers(): SessionEventHandlers;
149
- addSessionEventHandler(handler: SessionEventHandler): void;
150
- removeSessionEventHandler(handler: SessionEventHandler): void;
151
- clearSessionEventHandlers(): void;
152
124
  }
153
125
  export type ConfigurationPlain = {
154
- logs?: LogHandlerPlain;
155
- debugScreenshots?: { save: boolean; path?: string; prefix?: string; };
156
126
  agentId?: string;
157
127
  apiKey?: string;
158
128
  serverUrl?: string;
159
129
  proxy?: ProxySettingsPlain;
160
130
  autProxy?: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
161
131
  isDisabled?: boolean;
162
- connectionTimeout?: number;
163
- removeSession?: boolean;
164
- remoteEvents?: { serverUrl: string; accessKey?: string; timeout?: number; };
165
132
  appName?: string;
166
133
  testName?: string;
167
134
  displayName?: string;
@@ -186,7 +153,6 @@ export type ConfigurationPlain = {
186
153
  saveFailedTests?: boolean;
187
154
  saveNewTests?: boolean;
188
155
  saveDiffs?: boolean;
189
- dontCloseBatches?: boolean;
190
156
  sendDom?: boolean;
191
157
  matchTimeout?: number;
192
158
  forceFullPageScreenshot?: boolean;
@@ -200,28 +166,13 @@ export type ConfigurationPlain = {
200
166
  rotation?: ImageRotationPlain;
201
167
  scaleRatio?: number;
202
168
  waitBeforeCapture?: number;
203
- concurrentSessions?: number;
204
- browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>;
169
+ browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
205
170
  visualGridOptions?: Record<string, any>;
206
171
  layoutBreakpoints?: boolean | Array<number>;
207
172
  disableBrowserFetching?: boolean;
208
173
  };
209
174
  export class Configuration implements Required<ConfigurationPlain> {
210
175
  constructor(config?: ConfigurationPlain);
211
- get logs(): LogHandlerPlain;
212
- set logs(logs: LogHandlerPlain);
213
- getShowLogs(): boolean;
214
- setShowLogs(show: boolean): Configuration;
215
- getLogHandler(): LogHandlerPlain;
216
- setLogHandler(handler: LogHandlerPlain): Configuration;
217
- get debugScreenshots(): { save: boolean; path?: string; prefix?: string; };
218
- set debugScreenshots(debugScreenshots: { save: boolean; path?: string; prefix?: string; });
219
- getSaveDebugScreenshots(): boolean;
220
- setSaveDebugScreenshots(save: boolean): Configuration;
221
- getDebugScreenshotsPath(): string;
222
- setDebugScreenshotsPath(path: string): Configuration;
223
- getDebugScreenshotsPrefix(): string;
224
- setDebugScreenshotsPrefix(prefix: string): Configuration;
225
176
  get appName(): string;
226
177
  set appName(appName: string);
227
178
  getAppName(): string;
@@ -272,18 +223,6 @@ export class Configuration implements Required<ConfigurationPlain> {
272
223
  set autProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; });
273
224
  getAutProxy(): { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
274
225
  setAutProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; }): Configuration;
275
- get connectionTimeout(): number;
276
- set connectionTimeout(connectionTimeout: number);
277
- getConnectionTimeout(): number;
278
- setConnectionTimeout(connectionTimeout: number): Configuration;
279
- get removeSession(): boolean;
280
- set removeSession(removeSession: boolean);
281
- getRemoveSession(): boolean;
282
- setRemoveSession(removeSession: boolean): Configuration;
283
- get remoteEvents(): { serverUrl: string; accessKey?: string; timeout?: number; };
284
- set remoteEvents(remoteEvents: { serverUrl: string; accessKey?: string; timeout?: number; });
285
- getRemoteEvents(): { serverUrl: string; accessKey?: string; timeout?: number; };
286
- setRemoteEvents(remoteEvents: { serverUrl: string; accessKey?: string; timeout?: number; }): Configuration;
287
226
  get batch(): BatchInfoPlain;
288
227
  set batch(batch: BatchInfoPlain);
289
228
  getBatch(): BatchInfo;
@@ -423,18 +362,16 @@ export class Configuration implements Required<ConfigurationPlain> {
423
362
  set scaleRatio(scaleRatio: number);
424
363
  getScaleRatio(): number;
425
364
  setScaleRatio(scaleRatio: number): Configuration;
426
- get concurrentSessions(): number;
427
- set concurrentSessions(concurrentSessions: number);
428
- getConcurrentSessions(): number;
429
- setConcurrentSessions(concurrentSessions: number): Configuration;
430
- get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>;
431
- set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>);
432
- getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>;
433
- setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>): Configuration;
434
- addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>): Configuration;
435
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo): Configuration;
365
+ get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
366
+ set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
367
+ getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>;
368
+ setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
369
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
370
+ addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
436
371
  addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
437
372
  addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
373
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
374
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: IosVersionPlain): Configuration;
438
375
  get visualGridOptions(): { [key: string]: any; };
439
376
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
440
377
  getVisualGridOptions(): { [key: string]: any; };
@@ -448,10 +385,6 @@ export class Configuration implements Required<ConfigurationPlain> {
448
385
  set disableBrowserFetching(disableBrowserFetching: boolean);
449
386
  getDisableBrowserFetching(): boolean;
450
387
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
451
- get dontCloseBatches(): boolean;
452
- set dontCloseBatches(dontCloseBatches: boolean);
453
- getDontCloseBatches(): boolean;
454
- setDontCloseBatches(dontCloseBatches: boolean): Configuration;
455
388
  }
456
389
  export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
457
390
  export type CheckSettingsPlain = {
@@ -466,18 +399,19 @@ export type CheckSettingsPlain = {
466
399
  enablePatterns?: boolean;
467
400
  ignoreDisplacements?: boolean;
468
401
  ignoreCaret?: boolean;
469
- ignoreRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
470
- layoutRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
471
- strictRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
472
- contentRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
402
+ ignoreRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
403
+ layoutRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
404
+ strictRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
405
+ contentRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>;
473
406
  floatingRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
474
407
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
475
408
  maxUpOffset?: number;
476
409
  maxDownOffset?: number;
477
410
  maxLeftOffset?: number;
478
411
  maxRightOffset?: number;
412
+ regionId?: string;
479
413
  }>;
480
- accessibilityRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }>;
414
+ accessibilityRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; regionId?: string; }>;
481
415
  disableBrowserFetching?: boolean;
482
416
  layoutBreakpoints?: boolean | Array<number>;
483
417
  visualGridOptions?: { [key: string]: any; };
@@ -491,28 +425,26 @@ export type CheckSettingsPlain = {
491
425
  };
492
426
  export class CheckSettings {
493
427
  constructor(settings?: CheckSettingsPlain);
494
- name(name: string): CheckSettings;
495
428
  withName(name: string): CheckSettings;
496
429
  region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
497
430
  shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
498
431
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); }): CheckSettings;
499
432
  frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
500
- ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
501
- ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
502
- ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
503
- ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
504
- layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
505
- layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
506
- strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
507
- strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
508
- contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
509
- contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
433
+ ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }): CheckSettings;
434
+ ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>): CheckSettings;
435
+ layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }): CheckSettings;
436
+ layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>): CheckSettings;
437
+ strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }): CheckSettings;
438
+ strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>): CheckSettings;
439
+ contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }): CheckSettings;
440
+ contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); padding?: number | { top?: number; right?: number; bottom?: number; left?: number; }; regionId?: string; }>): CheckSettings;
510
441
  floatingRegion(region: {
511
442
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
512
443
  maxUpOffset?: number;
513
444
  maxDownOffset?: number;
514
445
  maxLeftOffset?: number;
515
446
  maxRightOffset?: number;
447
+ regionId?: string;
516
448
  }): CheckSettings;
517
449
  floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettings;
518
450
  floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
@@ -521,31 +453,15 @@ export class CheckSettings {
521
453
  maxDownOffset?: number;
522
454
  maxLeftOffset?: number;
523
455
  maxRightOffset?: number;
456
+ regionId?: string;
524
457
  }>): CheckSettings;
525
458
  floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
526
- floating(region: {
527
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
528
- maxUpOffset?: number;
529
- maxDownOffset?: number;
530
- maxLeftOffset?: number;
531
- maxRightOffset?: number;
532
- }): CheckSettings;
533
- floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
534
- floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
535
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
536
- maxUpOffset?: number;
537
- maxDownOffset?: number;
538
- maxLeftOffset?: number;
539
- maxRightOffset?: number;
540
- }>): CheckSettings;
541
- floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
542
- accessibilityRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }): CheckSettings;
459
+ accessibilityRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; regionId?: string; }): CheckSettings;
543
460
  accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettings;
544
- accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }>): CheckSettings;
461
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; regionId?: string; }>): CheckSettings;
545
462
  accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
546
463
  scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
547
464
  fully(fully?: boolean): CheckSettings;
548
- stitchContent(stitchContent?: boolean): CheckSettings;
549
465
  matchLevel(matchLevel: MatchLevelPlain): CheckSettings;
550
466
  layout(): CheckSettings;
551
467
  exact(): CheckSettings;
@@ -560,7 +476,6 @@ export class CheckSettings {
560
476
  layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettings;
561
477
  hook(name: string, script: string): CheckSettings;
562
478
  beforeRenderScreenshotHook(script: string): CheckSettings;
563
- webHook(script: string): CheckSettings;
564
479
  visualGridOption(key: string, value: any): CheckSettings;
565
480
  visualGridOptions(options: { [key: string]: any; }): CheckSettings;
566
481
  renderId(renderId: string): CheckSettings;
@@ -738,6 +653,33 @@ export enum IosVersion {
738
653
  ONE_VERSION_BACK = 'latest-1',
739
654
  LATEST_ONE_VERSION_BACK = 'latest-1'
740
655
  }
656
+ export type AndroidDeviceNamePlain = "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra";
657
+ export enum AndroidDeviceName {
658
+ Pixel_3_XL = 'Pixel 3 XL',
659
+ Pixel_4 = 'Pixel 4',
660
+ Pixel_4_XL = 'Pixel 4 XL',
661
+ Galaxy_Note_8 = 'Galaxy Note 8',
662
+ Galaxy_Note_9 = 'Galaxy Note 9',
663
+ Galaxy_S8 = 'Galaxy S8',
664
+ Galaxy_S8_Plus = 'Galaxy S8 Plus',
665
+ Galaxy_S9 = 'Galaxy S9',
666
+ Galaxy_S9_Plus = 'Galaxy S9 Plus',
667
+ Galaxy_S10 = 'Galaxy S10',
668
+ Galaxy_S10_Plus = 'Galaxy S10 Plus',
669
+ Galaxy_Note_10 = 'Galaxy Note 10',
670
+ Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus',
671
+ Galaxy_S20 = 'Galaxy S20',
672
+ Galaxy_S20_Plus = 'Galaxy S20 Plus',
673
+ Galaxy_S21 = 'Galaxy S21',
674
+ Galaxy_S21_Plus = 'Galaxy S21 Plus',
675
+ Galaxy_S21_Ultra = 'Galaxy S21 Ultra'
676
+ }
677
+ export type AndroidVersionPlain = "latest" | "latest-1" | "latest-2";
678
+ export enum AndroidVersion {
679
+ LATEST = 'latest',
680
+ ONE_VERSION_BACK = 'latest-1',
681
+ TWO_VERSIONS_BACK = 'latest-2'
682
+ }
741
683
  export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "Strict" | "Exact";
742
684
  export enum MatchLevel {
743
685
  None = 'None',
@@ -1153,6 +1095,7 @@ export class Region implements Required<RegionPlain> {
1153
1095
  export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; };
1154
1096
  export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; };
1155
1097
  export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: IosVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1098
+ export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1156
1099
  export type RunnerOptionsPlain = { testConcurrency?: number; };
1157
1100
  export class RunnerOptionsFluent {
1158
1101
  testConcurrency(concurrency: number): RunnerOptionsFluent;
@@ -1169,46 +1112,35 @@ export type ApiUrlsPlain = {
1169
1112
  export class ApiUrls implements Required<ApiUrlsPlain> {
1170
1113
  get baselineImage(): string;
1171
1114
  getBaselineImage(): string;
1172
- setBaselineImage(setBaselineImage: string): void;
1173
1115
  get currentImage(): string;
1174
1116
  getCurrentImage(): string;
1175
- setCurrentImage(currentImage: string): void;
1176
1117
  get checkpointImage(): string;
1177
1118
  getCheckpointImage(): string;
1178
- setCheckpointImage(checkpointImage: string): void;
1179
1119
  get checkpointImageThumbnail(): string;
1180
1120
  getCheckpointImageThumbnail(): string;
1181
- setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
1182
1121
  get diffImage(): string;
1183
1122
  getDiffImage(): string;
1184
- setDiffImage(diffImage: string): void;
1185
1123
  }
1186
1124
  export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; };
1187
1125
  export class AppUrls implements Required<AppUrlsPlain> {
1188
1126
  get step(): string;
1189
1127
  getStep(): string;
1190
- setStep(step: string): void;
1191
1128
  get stepEditor(): string;
1192
1129
  getStepEditor(): string;
1193
- setStepEditor(stepEditor: string): void;
1194
1130
  }
1195
1131
  export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; };
1196
1132
  export class MatchResult implements Required<MatchResultPlain> {
1197
1133
  get asExpected(): boolean;
1198
1134
  getAsExpected(): boolean;
1199
- setAsExpected(asExpected: boolean): void;
1200
1135
  get windowId(): number;
1201
1136
  getWindowId(): number;
1202
- setWindowId(windowId: number): void;
1203
1137
  }
1204
1138
  export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; };
1205
1139
  export class SessionUrls implements Required<SessionUrlsPlain> {
1206
1140
  get batch(): string;
1207
1141
  getBatch(): string;
1208
- setBatch(batch: string): void;
1209
1142
  get session(): string;
1210
1143
  getSession(): string;
1211
- setSession(session: string): void;
1212
1144
  }
1213
1145
  export type StepInfoPlain = {
1214
1146
  readonly name?: string;
@@ -1222,25 +1154,18 @@ export type StepInfoPlain = {
1222
1154
  export class StepInfo implements Required<StepInfoPlain> {
1223
1155
  get name(): string;
1224
1156
  getName(): string;
1225
- setName(value: string): void;
1226
1157
  get isDifferent(): boolean;
1227
1158
  getIsDifferent(): boolean;
1228
- setIsDifferent(value: boolean): void;
1229
1159
  get hasBaselineImage(): boolean;
1230
1160
  getHasBaselineImage(): boolean;
1231
- setHasBaselineImage(value: boolean): void;
1232
1161
  get hasCurrentImage(): boolean;
1233
1162
  getHasCurrentImage(): boolean;
1234
- setHasCurrentImage(hasCurrentImage: boolean): void;
1235
1163
  get appUrls(): AppUrlsPlain;
1236
1164
  getAppUrls(): AppUrls;
1237
- setAppUrls(appUrls: AppUrlsPlain): void;
1238
1165
  get apiUrls(): ApiUrlsPlain;
1239
1166
  getApiUrls(): ApiUrls;
1240
- setApiUrls(apiUrls: ApiUrlsPlain): void;
1241
1167
  get renderId(): Array<string>;
1242
1168
  getRenderId(): Array<string>;
1243
- setRenderId(renderId: Array<string>): void;
1244
1169
  }
1245
1170
  export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
1246
1171
  export type TestResultsPlain = {
@@ -1278,97 +1203,66 @@ export type TestResultsPlain = {
1278
1203
  export class TestResults implements Required<TestResultsPlain> {
1279
1204
  get id(): string;
1280
1205
  getId(): string;
1281
- setId(id: string): void;
1282
1206
  get name(): string;
1283
1207
  getName(): string;
1284
- setName(name: string): void;
1285
1208
  get secretToken(): string;
1286
1209
  getSecretToken(): string;
1287
- setSecretToken(secretToken: string): void;
1288
1210
  get status(): TestResultsStatusPlain;
1289
1211
  getStatus(): TestResultsStatus;
1290
- setStatus(status: TestResultsStatus): void;
1291
1212
  get appName(): string;
1292
1213
  getAppName(): string;
1293
- setAppName(appName: string): void;
1294
1214
  get batchName(): string;
1295
1215
  getBatchName(): string;
1296
- setBatchName(batchName: string): void;
1297
1216
  get batchId(): string;
1298
1217
  getBatchId(): string;
1299
- setBatchId(batchId: string): void;
1300
1218
  get branchName(): string;
1301
1219
  getBranchName(): string;
1302
- setBranchName(branchName: string): void;
1303
1220
  get hostOS(): string;
1304
1221
  getHostOS(): string;
1305
- setHostOS(hostOS: string): void;
1306
1222
  get hostApp(): string;
1307
1223
  getHostApp(): string;
1308
- setHostApp(hostApp: string): void;
1309
1224
  get hostDisplaySize(): RectangleSizePlain;
1310
1225
  getHostDisplaySize(): RectangleSize;
1311
- setHostDisplaySize(hostDisplaySize: RectangleSizePlain): void;
1312
1226
  get accessibilityStatus(): TestAccessibilityStatus;
1313
1227
  getAccessibilityStatus(): TestAccessibilityStatus;
1314
- setAccessibilityStatus(accessibilityStatus: TestAccessibilityStatus): void;
1315
1228
  get startedAt(): string | Date;
1316
1229
  getStartedAt(): Date;
1317
- setStartedAt(startedAt: string | Date): void;
1318
1230
  get duration(): number;
1319
1231
  getDuration(): number;
1320
- setDuration(duration: number): void;
1321
1232
  get isNew(): boolean;
1322
1233
  getIsNew(): boolean;
1323
- setIsNew(isNew: boolean): void;
1324
1234
  get isDifferent(): boolean;
1325
1235
  getIsDifferent(): boolean;
1326
- setIsDifferent(isDifferent: boolean): void;
1327
1236
  get isAborted(): boolean;
1328
1237
  getIsAborted(): boolean;
1329
- setIsAborted(isAborted: boolean): void;
1330
1238
  get appUrls(): SessionUrlsPlain;
1331
1239
  getAppUrls(): SessionUrls;
1332
- setAppUrls(appUrls: SessionUrlsPlain): void;
1333
1240
  get apiUrls(): SessionUrlsPlain;
1334
1241
  getApiUrls(): SessionUrls;
1335
- setApiUrls(apiUrls: SessionUrlsPlain): void;
1336
1242
  get stepsInfo(): Array<StepInfoPlain>;
1337
1243
  getStepsInfo(): Array<StepInfo>;
1338
- setStepsInfo(stepInfo: Array<StepInfoPlain>): void;
1339
1244
  get steps(): number;
1340
1245
  getSteps(): number;
1341
- setSteps(steps: number): void;
1342
1246
  get matches(): number;
1343
1247
  getMatches(): number;
1344
- setMatches(matches: number): void;
1345
1248
  get mismatches(): number;
1346
1249
  getMismatches(): number;
1347
- setMismatches(mismatches: number): void;
1348
1250
  get missing(): number;
1349
1251
  getMissing(): number;
1350
- setMissing(missing: number): void;
1351
1252
  get exactMatches(): number;
1352
1253
  getExactMatches(): number;
1353
- setExactMatches(exactMatches: number): void;
1354
1254
  get strictMatches(): number;
1355
1255
  getStrictMatches(): number;
1356
- setStrictMatches(strictMatches: number): void;
1357
1256
  get contentMatches(): number;
1358
1257
  getContentMatches(): number;
1359
- setContentMatches(contentMatches: number): void;
1360
1258
  get layoutMatches(): number;
1361
1259
  getLayoutMatches(): number;
1362
- setLayoutMatches(layoutMatches: number): void;
1363
1260
  get noneMatches(): number;
1364
1261
  getNoneMatches(): number;
1365
- setNoneMatches(noneMatches: number): void;
1366
1262
  get url(): string;
1367
1263
  getUrl(): string;
1368
- setUrl(url: string): void;
1369
1264
  isPassed(): boolean;
1370
1265
  delete(): Promise<void>;
1371
- deleteSession(): Promise<void>;
1372
1266
  }
1373
1267
  export type TestResultContainerPlain = { readonly exception?: Error; readonly testResults?: {
1374
1268
  readonly id?: string;
@@ -1415,14 +1309,14 @@ export type TestResultContainerPlain = { readonly exception?: Error; readonly te
1415
1309
  readonly layoutMatches?: number;
1416
1310
  readonly noneMatches?: number;
1417
1311
  readonly url?: string;
1418
- }; readonly browserInfo?: { name?: "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "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"; screenOrientation?: "landscape" | "portrait"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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 (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "landscape" | "portrait"; }; }; };
1312
+ }; readonly browserInfo?: { name?: "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "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"; screenOrientation?: "landscape" | "portrait"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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 (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "landscape" | "portrait"; }; } | { androidDeviceInfo: { deviceName: "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra"; version?: "latest" | "latest-1" | "latest-2"; screenOrientation?: "landscape" | "portrait"; }; }; };
1419
1313
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1420
1314
  get testResults(): TestResultsPlain;
1421
1315
  getTestResults(): TestResults;
1422
1316
  get exception(): Error;
1423
1317
  getException(): Error;
1424
- get browserInfo(): { name?: "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "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"; screenOrientation?: "landscape" | "portrait"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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 (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "landscape" | "portrait"; }; };
1425
- getBrowserInfo(): { name?: "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "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"; screenOrientation?: "landscape" | "portrait"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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 (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "landscape" | "portrait"; }; };
1318
+ get browserInfo(): { name?: "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "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"; screenOrientation?: "landscape" | "portrait"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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 (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "landscape" | "portrait"; }; } | { androidDeviceInfo: { deviceName: "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra"; version?: "latest" | "latest-1" | "latest-2"; screenOrientation?: "landscape" | "portrait"; }; };
1319
+ getBrowserInfo(): { name?: "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "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"; screenOrientation?: "landscape" | "portrait"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "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 (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "landscape" | "portrait"; }; } | { androidDeviceInfo: { deviceName: "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra"; version?: "latest" | "latest-1" | "latest-2"; screenOrientation?: "landscape" | "portrait"; }; };
1426
1320
  }
1427
1321
  export type TestResultsSummaryPlain = {
1428
1322
  results: Array<TestResultContainerPlain>;
@@ -1481,11 +1375,7 @@ export class ClassicRunner extends EyesRunner {
1481
1375
  }
1482
1376
  export class VisualGridRunner extends EyesRunner {
1483
1377
  constructor(options?: RunnerOptionsPlain);
1484
- constructor(options?: RunnerOptionsFluent);
1485
- constructor(legacyConcurrency?: number);
1486
1378
  get testConcurrency(): number;
1487
- get legacyConcurrency(): number;
1488
- getConcurrentSessions(): number;
1489
1379
  }
1490
1380
  export abstract class SessionEventHandler {
1491
1381
  abstract initStarted(): any;