@applitools/eyes-webdriverio 5.35.5 → 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 +7 -0
  2. package/package.json +7 -7
  3. package/types/index.d.ts +19 -159
package/CHANGELOG.md CHANGED
@@ -10,6 +10,13 @@
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
+
13
20
  ## 5.35.5 - 2022/6/22
14
21
 
15
22
  ### Features
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-webdriverio",
3
- "version": "5.35.5",
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.7.1",
119
- "@applitools/eyes-sdk-core": "13.8.4",
120
- "@applitools/spec-driver-webdriverio": "1.2.13",
121
- "@applitools/visual-grid-client": "15.12.47"
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,7 +166,6 @@ export type ConfigurationPlain = {
200
166
  rotation?: ImageRotationPlain;
201
167
  scaleRatio?: number;
202
168
  waitBeforeCapture?: number;
203
- concurrentSessions?: number;
204
169
  browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
205
170
  visualGridOptions?: Record<string, any>;
206
171
  layoutBreakpoints?: boolean | Array<number>;
@@ -208,20 +173,6 @@ export type ConfigurationPlain = {
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,10 +362,6 @@ 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
365
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
431
366
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
432
367
  getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>;
@@ -450,10 +385,6 @@ export class Configuration implements Required<ConfigurationPlain> {
450
385
  set disableBrowserFetching(disableBrowserFetching: boolean);
451
386
  getDisableBrowserFetching(): boolean;
452
387
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
453
- get dontCloseBatches(): boolean;
454
- set dontCloseBatches(dontCloseBatches: boolean);
455
- getDontCloseBatches(): boolean;
456
- setDontCloseBatches(dontCloseBatches: boolean): Configuration;
457
388
  }
458
389
  export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
459
390
  export type CheckSettingsPlain = {
@@ -468,18 +399,19 @@ export type CheckSettingsPlain = {
468
399
  enablePatterns?: boolean;
469
400
  ignoreDisplacements?: boolean;
470
401
  ignoreCaret?: boolean;
471
- 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; }; }>;
472
- 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; }; }>;
473
- 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; }; }>;
474
- 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; }; }>;
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; }>;
475
406
  floatingRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
476
407
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
477
408
  maxUpOffset?: number;
478
409
  maxDownOffset?: number;
479
410
  maxLeftOffset?: number;
480
411
  maxRightOffset?: number;
412
+ regionId?: string;
481
413
  }>;
482
- 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; }>;
483
415
  disableBrowserFetching?: boolean;
484
416
  layoutBreakpoints?: boolean | Array<number>;
485
417
  visualGridOptions?: { [key: string]: any; };
@@ -493,28 +425,26 @@ export type CheckSettingsPlain = {
493
425
  };
494
426
  export class CheckSettings {
495
427
  constructor(settings?: CheckSettingsPlain);
496
- name(name: string): CheckSettings;
497
428
  withName(name: string): CheckSettings;
498
429
  region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
499
430
  shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
500
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;
501
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;
502
- 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; }; }): CheckSettings;
503
- 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; }; }>): CheckSettings;
504
- ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
505
- ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
506
- 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; }; }): CheckSettings;
507
- 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; }; }>): CheckSettings;
508
- 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; }; }): CheckSettings;
509
- 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; }; }>): CheckSettings;
510
- 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; }; }): CheckSettings;
511
- 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; }; }>): 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;
512
441
  floatingRegion(region: {
513
442
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
514
443
  maxUpOffset?: number;
515
444
  maxDownOffset?: number;
516
445
  maxLeftOffset?: number;
517
446
  maxRightOffset?: number;
447
+ regionId?: string;
518
448
  }): CheckSettings;
519
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;
520
450
  floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
@@ -523,31 +453,15 @@ export class CheckSettings {
523
453
  maxDownOffset?: number;
524
454
  maxLeftOffset?: number;
525
455
  maxRightOffset?: number;
456
+ regionId?: string;
526
457
  }>): CheckSettings;
527
458
  floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
528
- floating(region: {
529
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
530
- maxUpOffset?: number;
531
- maxDownOffset?: number;
532
- maxLeftOffset?: number;
533
- maxRightOffset?: number;
534
- }): CheckSettings;
535
- floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
536
- floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
537
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
538
- maxUpOffset?: number;
539
- maxDownOffset?: number;
540
- maxLeftOffset?: number;
541
- maxRightOffset?: number;
542
- }>): CheckSettings;
543
- floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
544
- 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;
545
460
  accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettings;
546
- 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;
547
462
  accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
548
463
  scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
549
464
  fully(fully?: boolean): CheckSettings;
550
- stitchContent(stitchContent?: boolean): CheckSettings;
551
465
  matchLevel(matchLevel: MatchLevelPlain): CheckSettings;
552
466
  layout(): CheckSettings;
553
467
  exact(): CheckSettings;
@@ -562,7 +476,6 @@ export class CheckSettings {
562
476
  layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettings;
563
477
  hook(name: string, script: string): CheckSettings;
564
478
  beforeRenderScreenshotHook(script: string): CheckSettings;
565
- webHook(script: string): CheckSettings;
566
479
  visualGridOption(key: string, value: any): CheckSettings;
567
480
  visualGridOptions(options: { [key: string]: any; }): CheckSettings;
568
481
  renderId(renderId: string): CheckSettings;
@@ -765,7 +678,7 @@ export type AndroidVersionPlain = "latest" | "latest-1" | "latest-2";
765
678
  export enum AndroidVersion {
766
679
  LATEST = 'latest',
767
680
  ONE_VERSION_BACK = 'latest-1',
768
- TWO_VERSION_BACK = 'latest-2'
681
+ TWO_VERSIONS_BACK = 'latest-2'
769
682
  }
770
683
  export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "Strict" | "Exact";
771
684
  export enum MatchLevel {
@@ -1199,46 +1112,35 @@ export type ApiUrlsPlain = {
1199
1112
  export class ApiUrls implements Required<ApiUrlsPlain> {
1200
1113
  get baselineImage(): string;
1201
1114
  getBaselineImage(): string;
1202
- setBaselineImage(setBaselineImage: string): void;
1203
1115
  get currentImage(): string;
1204
1116
  getCurrentImage(): string;
1205
- setCurrentImage(currentImage: string): void;
1206
1117
  get checkpointImage(): string;
1207
1118
  getCheckpointImage(): string;
1208
- setCheckpointImage(checkpointImage: string): void;
1209
1119
  get checkpointImageThumbnail(): string;
1210
1120
  getCheckpointImageThumbnail(): string;
1211
- setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
1212
1121
  get diffImage(): string;
1213
1122
  getDiffImage(): string;
1214
- setDiffImage(diffImage: string): void;
1215
1123
  }
1216
1124
  export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; };
1217
1125
  export class AppUrls implements Required<AppUrlsPlain> {
1218
1126
  get step(): string;
1219
1127
  getStep(): string;
1220
- setStep(step: string): void;
1221
1128
  get stepEditor(): string;
1222
1129
  getStepEditor(): string;
1223
- setStepEditor(stepEditor: string): void;
1224
1130
  }
1225
1131
  export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; };
1226
1132
  export class MatchResult implements Required<MatchResultPlain> {
1227
1133
  get asExpected(): boolean;
1228
1134
  getAsExpected(): boolean;
1229
- setAsExpected(asExpected: boolean): void;
1230
1135
  get windowId(): number;
1231
1136
  getWindowId(): number;
1232
- setWindowId(windowId: number): void;
1233
1137
  }
1234
1138
  export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; };
1235
1139
  export class SessionUrls implements Required<SessionUrlsPlain> {
1236
1140
  get batch(): string;
1237
1141
  getBatch(): string;
1238
- setBatch(batch: string): void;
1239
1142
  get session(): string;
1240
1143
  getSession(): string;
1241
- setSession(session: string): void;
1242
1144
  }
1243
1145
  export type StepInfoPlain = {
1244
1146
  readonly name?: string;
@@ -1252,25 +1154,18 @@ export type StepInfoPlain = {
1252
1154
  export class StepInfo implements Required<StepInfoPlain> {
1253
1155
  get name(): string;
1254
1156
  getName(): string;
1255
- setName(value: string): void;
1256
1157
  get isDifferent(): boolean;
1257
1158
  getIsDifferent(): boolean;
1258
- setIsDifferent(value: boolean): void;
1259
1159
  get hasBaselineImage(): boolean;
1260
1160
  getHasBaselineImage(): boolean;
1261
- setHasBaselineImage(value: boolean): void;
1262
1161
  get hasCurrentImage(): boolean;
1263
1162
  getHasCurrentImage(): boolean;
1264
- setHasCurrentImage(hasCurrentImage: boolean): void;
1265
1163
  get appUrls(): AppUrlsPlain;
1266
1164
  getAppUrls(): AppUrls;
1267
- setAppUrls(appUrls: AppUrlsPlain): void;
1268
1165
  get apiUrls(): ApiUrlsPlain;
1269
1166
  getApiUrls(): ApiUrls;
1270
- setApiUrls(apiUrls: ApiUrlsPlain): void;
1271
1167
  get renderId(): Array<string>;
1272
1168
  getRenderId(): Array<string>;
1273
- setRenderId(renderId: Array<string>): void;
1274
1169
  }
1275
1170
  export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
1276
1171
  export type TestResultsPlain = {
@@ -1308,97 +1203,66 @@ export type TestResultsPlain = {
1308
1203
  export class TestResults implements Required<TestResultsPlain> {
1309
1204
  get id(): string;
1310
1205
  getId(): string;
1311
- setId(id: string): void;
1312
1206
  get name(): string;
1313
1207
  getName(): string;
1314
- setName(name: string): void;
1315
1208
  get secretToken(): string;
1316
1209
  getSecretToken(): string;
1317
- setSecretToken(secretToken: string): void;
1318
1210
  get status(): TestResultsStatusPlain;
1319
1211
  getStatus(): TestResultsStatus;
1320
- setStatus(status: TestResultsStatus): void;
1321
1212
  get appName(): string;
1322
1213
  getAppName(): string;
1323
- setAppName(appName: string): void;
1324
1214
  get batchName(): string;
1325
1215
  getBatchName(): string;
1326
- setBatchName(batchName: string): void;
1327
1216
  get batchId(): string;
1328
1217
  getBatchId(): string;
1329
- setBatchId(batchId: string): void;
1330
1218
  get branchName(): string;
1331
1219
  getBranchName(): string;
1332
- setBranchName(branchName: string): void;
1333
1220
  get hostOS(): string;
1334
1221
  getHostOS(): string;
1335
- setHostOS(hostOS: string): void;
1336
1222
  get hostApp(): string;
1337
1223
  getHostApp(): string;
1338
- setHostApp(hostApp: string): void;
1339
1224
  get hostDisplaySize(): RectangleSizePlain;
1340
1225
  getHostDisplaySize(): RectangleSize;
1341
- setHostDisplaySize(hostDisplaySize: RectangleSizePlain): void;
1342
1226
  get accessibilityStatus(): TestAccessibilityStatus;
1343
1227
  getAccessibilityStatus(): TestAccessibilityStatus;
1344
- setAccessibilityStatus(accessibilityStatus: TestAccessibilityStatus): void;
1345
1228
  get startedAt(): string | Date;
1346
1229
  getStartedAt(): Date;
1347
- setStartedAt(startedAt: string | Date): void;
1348
1230
  get duration(): number;
1349
1231
  getDuration(): number;
1350
- setDuration(duration: number): void;
1351
1232
  get isNew(): boolean;
1352
1233
  getIsNew(): boolean;
1353
- setIsNew(isNew: boolean): void;
1354
1234
  get isDifferent(): boolean;
1355
1235
  getIsDifferent(): boolean;
1356
- setIsDifferent(isDifferent: boolean): void;
1357
1236
  get isAborted(): boolean;
1358
1237
  getIsAborted(): boolean;
1359
- setIsAborted(isAborted: boolean): void;
1360
1238
  get appUrls(): SessionUrlsPlain;
1361
1239
  getAppUrls(): SessionUrls;
1362
- setAppUrls(appUrls: SessionUrlsPlain): void;
1363
1240
  get apiUrls(): SessionUrlsPlain;
1364
1241
  getApiUrls(): SessionUrls;
1365
- setApiUrls(apiUrls: SessionUrlsPlain): void;
1366
1242
  get stepsInfo(): Array<StepInfoPlain>;
1367
1243
  getStepsInfo(): Array<StepInfo>;
1368
- setStepsInfo(stepInfo: Array<StepInfoPlain>): void;
1369
1244
  get steps(): number;
1370
1245
  getSteps(): number;
1371
- setSteps(steps: number): void;
1372
1246
  get matches(): number;
1373
1247
  getMatches(): number;
1374
- setMatches(matches: number): void;
1375
1248
  get mismatches(): number;
1376
1249
  getMismatches(): number;
1377
- setMismatches(mismatches: number): void;
1378
1250
  get missing(): number;
1379
1251
  getMissing(): number;
1380
- setMissing(missing: number): void;
1381
1252
  get exactMatches(): number;
1382
1253
  getExactMatches(): number;
1383
- setExactMatches(exactMatches: number): void;
1384
1254
  get strictMatches(): number;
1385
1255
  getStrictMatches(): number;
1386
- setStrictMatches(strictMatches: number): void;
1387
1256
  get contentMatches(): number;
1388
1257
  getContentMatches(): number;
1389
- setContentMatches(contentMatches: number): void;
1390
1258
  get layoutMatches(): number;
1391
1259
  getLayoutMatches(): number;
1392
- setLayoutMatches(layoutMatches: number): void;
1393
1260
  get noneMatches(): number;
1394
1261
  getNoneMatches(): number;
1395
- setNoneMatches(noneMatches: number): void;
1396
1262
  get url(): string;
1397
1263
  getUrl(): string;
1398
- setUrl(url: string): void;
1399
1264
  isPassed(): boolean;
1400
1265
  delete(): Promise<void>;
1401
- deleteSession(): Promise<void>;
1402
1266
  }
1403
1267
  export type TestResultContainerPlain = { readonly exception?: Error; readonly testResults?: {
1404
1268
  readonly id?: string;
@@ -1511,11 +1375,7 @@ export class ClassicRunner extends EyesRunner {
1511
1375
  }
1512
1376
  export class VisualGridRunner extends EyesRunner {
1513
1377
  constructor(options?: RunnerOptionsPlain);
1514
- constructor(options?: RunnerOptionsFluent);
1515
- constructor(legacyConcurrency?: number);
1516
1378
  get testConcurrency(): number;
1517
- get legacyConcurrency(): number;
1518
- getConcurrentSessions(): number;
1519
1379
  }
1520
1380
  export abstract class SessionEventHandler {
1521
1381
  abstract initStarted(): any;