@applitools/eyes-images 4.22.0 → 4.23.0

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 (4) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/dist/api.js +20 -15
  3. package/package.json +24 -44
  4. package/types/index.d.ts +445 -423
package/types/index.d.ts CHANGED
@@ -1,7 +1,8 @@
1
1
  export class Eyes {
2
+ static getExecutionCloudUrl(config?: undefined | ConfigurationPlain): Promise<string>;
2
3
  static setViewportSize(driver: unknown, size: RectangleSizePlain): Promise<void>;
3
- constructor(runner?: EyesRunner, config?: ConfigurationPlain);
4
- constructor(config?: ConfigurationPlain);
4
+ constructor(runner?: undefined | EyesRunner, config?: undefined | ConfigurationPlain);
5
+ constructor(config?: undefined | ConfigurationPlain);
5
6
  get logger(): Logger;
6
7
  getLogger(): Logger;
7
8
  get runner(): EyesRunner;
@@ -14,45 +15,48 @@ export class Eyes {
14
15
  setConfiguration(config: ConfigurationPlain): void;
15
16
  get isOpen(): boolean;
16
17
  getIsOpen(): boolean;
17
- open(driver: never, config?: ConfigurationPlain): Promise<never>;
18
- open(driver: never, appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<never>;
19
- open(config?: ConfigurationPlain): Promise<void>;
20
- open(appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<void>;
21
- check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation<never, never>): Promise<MatchResult>;
18
+ getExecutionCloudUrl(): Promise<string>;
19
+ open(driver: never, config?: undefined | ConfigurationPlain): Promise<never>;
20
+ open(driver: never, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<never>;
21
+ open(config?: undefined | ConfigurationPlain): Promise<void>;
22
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
23
+ check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
22
24
  check(target: {
23
- image: string | Buffer | URL;
24
- name?: string;
25
- dom?: string;
26
- locationInViewport?: LocationPlain;
27
- locationInView?: LocationPlain;
28
- fullViewSize?: RectangleSizePlain;
29
- }, checkSettings?: CheckSettingsImagePlain): Promise<MatchResult>;
30
- check(checkSettings?: CheckSettingsAutomationPlain<never, never>): Promise<MatchResult>;
25
+ image: string | URL | Buffer;
26
+ name?: undefined | string;
27
+ dom?: undefined | string;
28
+ locationInViewport?: undefined | LocationPlain;
29
+ locationInView?: undefined | LocationPlain;
30
+ fullViewSize?: undefined | RectangleSizePlain;
31
+ }, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
32
+ check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
31
33
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
32
34
  extractTextRegions<TPattern extends string>(target: {
33
- image: string | Buffer | URL;
34
- size?: { width: number; height: number; };
35
- name?: string;
36
- source?: string;
37
- dom?: string;
38
- locationInViewport?: { x: number; y: number; };
39
- locationInView?: { x: number; y: number; };
40
- fullViewSize?: { width: number; height: number; };
35
+ image: string | URL | Buffer;
36
+ size?: undefined | { width: number; height: number; };
37
+ name?: undefined | string;
38
+ source?: undefined | string;
39
+ dom?: undefined | string;
40
+ locationInViewport?: undefined | { x: number; y: number; };
41
+ locationInView?: undefined | { x: number; y: number; };
42
+ fullViewSize?: undefined | { width: number; height: number; };
41
43
  }, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
42
44
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
43
45
  extractText(target: {
44
- image: string | Buffer | URL;
45
- size?: { width: number; height: number; };
46
- name?: string;
47
- source?: string;
48
- dom?: string;
49
- locationInViewport?: { x: number; y: number; };
50
- locationInView?: { x: number; y: number; };
51
- fullViewSize?: { width: number; height: number; };
46
+ image: string | URL | Buffer;
47
+ size?: undefined | { width: number; height: number; };
48
+ name?: undefined | string;
49
+ source?: undefined | string;
50
+ dom?: undefined | string;
51
+ locationInViewport?: undefined | { x: number; y: number; };
52
+ locationInView?: undefined | { x: number; y: number; };
53
+ fullViewSize?: undefined | { width: number; height: number; };
52
54
  }, settings: Array<OCRRegion>): Promise<Array<string>>;
53
55
  extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
54
- close(throwErr?: boolean): Promise<TestResults>;
56
+ close(throwErr?: undefined | boolean): Promise<TestResults>;
57
+ closeAsync(): Promise<void>;
55
58
  abort(): Promise<TestResults>;
59
+ abortAsync(): Promise<void>;
56
60
  getViewportSize(): Promise<RectangleSize>;
57
61
  setViewportSize(size: RectangleSizePlain): Promise<void>;
58
62
  getScrollRootElement(): EyesSelector<never>;
@@ -76,7 +80,7 @@ export class Eyes {
76
80
  clearProperties(): Configuration;
77
81
  getBatch(): BatchInfo;
78
82
  setBatch(batch: BatchInfoPlain): void;
79
- setBatch(name: string, id?: string, startedAt?: string | Date): void;
83
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | string | Date): void;
80
84
  getApiKey(): string;
81
85
  setApiKey(apiKey: string): void;
82
86
  getTestName(): string;
@@ -110,7 +114,7 @@ export class Eyes {
110
114
  getParentBranchName(): string;
111
115
  setParentBranchName(parentBranchName: string): void;
112
116
  setProxy(proxy: ProxySettingsPlain): void;
113
- setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): void;
117
+ setProxy(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean): void;
114
118
  setProxy(isEnabled: false): void;
115
119
  getProxy(): ProxySettings;
116
120
  getSaveDiffs(): boolean;
@@ -135,56 +139,56 @@ export class Eyes {
135
139
  setStitchOverlap(stitchOverlap: number): void;
136
140
  }
137
141
  export type ConfigurationPlain = {
138
- agentId?: string;
139
- apiKey?: string;
140
- serverUrl?: string;
141
- proxy?: ProxySettingsPlain;
142
- autProxy?: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
143
- isDisabled?: boolean;
144
- appName?: string;
145
- testName?: string;
146
- displayName?: string;
147
- viewportSize?: RectangleSizePlain;
148
- sessionType?: SessionTypePlain;
149
- properties?: Array<PropertyDataPlain>;
150
- batch?: BatchInfoPlain;
151
- defaultMatchSettings?: ImageMatchSettingsPlain;
152
- hostApp?: string;
153
- hostOS?: string;
154
- hostAppInfo?: string;
155
- hostOSInfo?: string;
156
- deviceInfo?: string;
157
- baselineEnvName?: string;
158
- environmentName?: string;
159
- branchName?: string;
160
- parentBranchName?: string;
161
- baselineBranchName?: string;
162
- compareWithParentBranch?: boolean;
163
- ignoreBaseline?: boolean;
164
- ignoreGitMergeBase?: boolean;
165
- saveFailedTests?: boolean;
166
- saveNewTests?: boolean;
167
- saveDiffs?: boolean;
168
- sendDom?: boolean;
169
- matchTimeout?: number;
170
- forceFullPageScreenshot?: boolean;
171
- waitBeforeScreenshots?: number;
172
- stitchMode?: StitchModePlain;
173
- hideScrollbars?: boolean;
174
- hideCaret?: boolean;
175
- stitchOverlap?: number;
176
- scrollRootElement?: EyesSelector<never>;
177
- cut?: CutProviderPlain;
178
- rotation?: ImageRotationPlain;
179
- scaleRatio?: number;
180
- waitBeforeCapture?: number;
181
- browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
182
- visualGridOptions?: Record<string, any>;
183
- layoutBreakpoints?: boolean | Array<number>;
184
- disableBrowserFetching?: boolean;
142
+ agentId?: undefined | string;
143
+ apiKey?: undefined | string;
144
+ serverUrl?: undefined | string;
145
+ proxy?: undefined | ProxySettingsPlain;
146
+ autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
147
+ isDisabled?: undefined | boolean;
148
+ appName?: undefined | string;
149
+ testName?: undefined | string;
150
+ displayName?: undefined | string;
151
+ viewportSize?: undefined | RectangleSizePlain;
152
+ sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION";
153
+ properties?: undefined | Array<PropertyDataPlain>;
154
+ batch?: undefined | BatchInfoPlain;
155
+ defaultMatchSettings?: undefined | ImageMatchSettingsPlain;
156
+ hostApp?: undefined | string;
157
+ hostOS?: undefined | string;
158
+ hostAppInfo?: undefined | string;
159
+ hostOSInfo?: undefined | string;
160
+ deviceInfo?: undefined | string;
161
+ baselineEnvName?: undefined | string;
162
+ environmentName?: undefined | string;
163
+ branchName?: undefined | string;
164
+ parentBranchName?: undefined | string;
165
+ baselineBranchName?: undefined | string;
166
+ compareWithParentBranch?: undefined | boolean;
167
+ ignoreBaseline?: undefined | boolean;
168
+ ignoreGitMergeBase?: undefined | boolean;
169
+ saveFailedTests?: undefined | boolean;
170
+ saveNewTests?: undefined | boolean;
171
+ saveDiffs?: undefined | boolean;
172
+ sendDom?: undefined | boolean;
173
+ matchTimeout?: undefined | number;
174
+ forceFullPageScreenshot?: undefined | boolean;
175
+ waitBeforeScreenshots?: undefined | number;
176
+ stitchMode?: undefined | "Scroll" | "CSS" | "Resize";
177
+ hideScrollbars?: undefined | boolean;
178
+ hideCaret?: undefined | boolean;
179
+ stitchOverlap?: undefined | number;
180
+ scrollRootElement?: undefined | EyesSelector<never>;
181
+ cut?: undefined | CutProviderPlain;
182
+ rotation?: undefined | ImageRotationPlain;
183
+ scaleRatio?: undefined | number;
184
+ browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
185
+ visualGridOptions?: undefined | Record<string, any>;
186
+ layoutBreakpoints?: undefined | boolean | Array<number>;
187
+ disableBrowserFetching?: undefined | boolean;
188
+ waitBeforeCapture?: undefined | number;
185
189
  };
186
190
  export class Configuration implements Required<ConfigurationPlain> {
187
- constructor(config?: ConfigurationPlain, spec?: { isElement(element: any): element is never; isSelector(selector: any): selector is never; });
191
+ constructor(config?: undefined | ConfigurationPlain);
188
192
  get appName(): string;
189
193
  set appName(appName: string);
190
194
  getAppName(): string;
@@ -229,12 +233,12 @@ export class Configuration implements Required<ConfigurationPlain> {
229
233
  set proxy(proxy: ProxySettingsPlain);
230
234
  getProxy(): ProxySettings;
231
235
  setProxy(proxy: ProxySettingsPlain): Configuration;
232
- setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
236
+ setProxy(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean): Configuration;
233
237
  setProxy(isEnabled: false): Configuration;
234
- get autProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
235
- set autProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; });
236
- getAutProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
237
- setAutProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; }): Configuration;
238
+ get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
239
+ set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
240
+ getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
241
+ setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
238
242
  get batch(): BatchInfoPlain;
239
243
  set batch(batch: BatchInfoPlain);
240
244
  getBatch(): BatchInfo;
@@ -376,14 +380,14 @@ export class Configuration implements Required<ConfigurationPlain> {
376
380
  setScaleRatio(scaleRatio: number): Configuration;
377
381
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
378
382
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
379
- getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>;
380
- setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
381
- addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
382
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
383
- addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
384
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
385
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
386
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
383
+ getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
384
+ setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
385
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
386
+ addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
387
+ addBrowser(width: number, height: number, name?: undefined | "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"): Configuration;
388
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape" | "portrait"): Configuration;
389
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
390
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
387
391
  get visualGridOptions(): { [key: string]: any; };
388
392
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
389
393
  getVisualGridOptions(): { [key: string]: any; };
@@ -398,25 +402,208 @@ export class Configuration implements Required<ConfigurationPlain> {
398
402
  getDisableBrowserFetching(): boolean;
399
403
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
400
404
  }
401
- export type OCRRegion = { target: RegionPlain | EyesSelector<never>; hint?: string; minMatch?: number; language?: string; };
402
- export const CheckSettings: CheckSettingsImage;
405
+ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
406
+ frames?: undefined | Array<{ frame: number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); } | (number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))>;
407
+ webview?: undefined | string | boolean;
408
+ scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
409
+ fully?: undefined | boolean;
410
+ disableBrowserFetching?: undefined | boolean;
411
+ layoutBreakpoints?: undefined | boolean | Array<number>;
412
+ visualGridOptions?: undefined | { [key: string]: any; };
413
+ nmgOptions?: undefined | { [key: string]: any; };
414
+ hooks?: undefined | { beforeCaptureScreenshot: string; };
415
+ renderId?: undefined | string;
416
+ timeout?: undefined | number;
417
+ waitBeforeCapture?: undefined | number;
418
+ lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
419
+ };
420
+ export class CheckSettingsAutomation {
421
+ constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain);
422
+ region(region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))): CheckSettingsAutomation;
423
+ shadow(selector: string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }): CheckSettingsAutomation;
424
+ frame(context: { frame: number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); }): CheckSettingsAutomation;
425
+ frame(frame: number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })), scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))): CheckSettingsAutomation;
426
+ webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
427
+ scrollRootElement(scrollRootElement: (string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })): CheckSettingsAutomation;
428
+ fully(fully?: undefined | boolean): CheckSettingsAutomation;
429
+ disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
430
+ layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
431
+ hook(name: string, script: string): CheckSettingsAutomation;
432
+ beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
433
+ ufgOption(key: string, value: any): CheckSettingsAutomation;
434
+ ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
435
+ nmgOption(key: string, value: any): CheckSettingsAutomation;
436
+ nmgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
437
+ renderId(renderId: string): CheckSettingsAutomation;
438
+ timeout(timeout: number): CheckSettingsAutomation;
439
+ waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
440
+ lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
441
+ densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
442
+ name(name: string): CheckSettingsAutomation;
443
+ withName(name: string): CheckSettingsAutomation;
444
+ ignoreRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
445
+ ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
446
+ layoutRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
447
+ layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
448
+ strictRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
449
+ strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
450
+ contentRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
451
+ contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | { region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
452
+ floatingRegion(region: {
453
+ region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
454
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
455
+ regionId?: undefined | string;
456
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
457
+ }): CheckSettingsAutomation;
458
+ floatingRegion(region: {
459
+ region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
460
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
461
+ regionId?: undefined | string;
462
+ maxUpOffset?: undefined | number;
463
+ maxDownOffset?: undefined | number;
464
+ maxLeftOffset?: undefined | number;
465
+ maxRightOffset?: undefined | number;
466
+ }): CheckSettingsAutomation;
467
+ floatingRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
468
+ floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | {
469
+ region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
470
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
471
+ regionId?: undefined | string;
472
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
473
+ }>): CheckSettingsAutomation;
474
+ floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))>): CheckSettingsAutomation;
475
+ accessibilityRegion(region: {
476
+ region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
477
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
478
+ regionId?: undefined | string;
479
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
480
+ }): CheckSettingsAutomation;
481
+ accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))), type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
482
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))) | {
483
+ region: RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }));
484
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
485
+ regionId?: undefined | string;
486
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
487
+ }>): CheckSettingsAutomation;
488
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))>): CheckSettingsAutomation;
489
+ matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
490
+ layout(): CheckSettingsAutomation;
491
+ exact(): CheckSettingsAutomation;
492
+ strict(): CheckSettingsAutomation;
493
+ ignoreColors(): CheckSettingsAutomation;
494
+ enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsAutomation;
495
+ ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsAutomation;
496
+ ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsAutomation;
497
+ useDom(useDom?: undefined | boolean): CheckSettingsAutomation;
498
+ sendDom(sendDom?: undefined | boolean): CheckSettingsAutomation;
499
+ pageId(pageId: string): CheckSettingsAutomation;
500
+ variationGroupId(variationGroupId: string): CheckSettingsAutomation;
501
+ }
502
+ export class CheckSettingsImage {
503
+ constructor(settings?: undefined | CheckSettingsImagePlain | CheckSettingsImage, target?: undefined | {
504
+ image: string | URL | Buffer;
505
+ name?: undefined | string;
506
+ dom?: undefined | string;
507
+ locationInViewport?: undefined | LocationPlain;
508
+ locationInView?: undefined | LocationPlain;
509
+ fullViewSize?: undefined | RectangleSizePlain;
510
+ });
511
+ image(image: string | URL | Buffer): CheckSettingsImage;
512
+ buffer(imageBuffer: Buffer): CheckSettingsImage;
513
+ base64(imageBase64: Buffer): CheckSettingsImage;
514
+ path(imagePath: string): CheckSettingsImage;
515
+ url(imageUrl: string | URL): CheckSettingsImage;
516
+ name(name: string): CheckSettingsImage;
517
+ withDom(dom: string): CheckSettingsImage;
518
+ withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
519
+ region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
520
+ withName(name: string): CheckSettingsImage;
521
+ ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
522
+ ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
523
+ layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
524
+ layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
525
+ strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
526
+ strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
527
+ contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
528
+ contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
529
+ floatingRegion(region: {
530
+ region: RegionPlain;
531
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
532
+ regionId?: undefined | string;
533
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
534
+ }): CheckSettingsImage;
535
+ floatingRegion(region: {
536
+ region: RegionPlain;
537
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
538
+ regionId?: undefined | string;
539
+ maxUpOffset?: undefined | number;
540
+ maxDownOffset?: undefined | number;
541
+ maxLeftOffset?: undefined | number;
542
+ maxRightOffset?: undefined | number;
543
+ }): CheckSettingsImage;
544
+ floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
545
+ floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
546
+ region: RegionPlain;
547
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
548
+ regionId?: undefined | string;
549
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
550
+ }>): CheckSettingsImage;
551
+ floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
552
+ accessibilityRegion(region: {
553
+ region: RegionPlain;
554
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
555
+ regionId?: undefined | string;
556
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
557
+ }): CheckSettingsImage;
558
+ accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
559
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
560
+ region: RegionPlain;
561
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
562
+ regionId?: undefined | string;
563
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
564
+ }>): CheckSettingsImage;
565
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
566
+ matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
567
+ layout(): CheckSettingsImage;
568
+ exact(): CheckSettingsImage;
569
+ strict(): CheckSettingsImage;
570
+ ignoreColors(): CheckSettingsImage;
571
+ enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsImage;
572
+ ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsImage;
573
+ ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsImage;
574
+ useDom(useDom?: undefined | boolean): CheckSettingsImage;
575
+ sendDom(sendDom?: undefined | boolean): CheckSettingsImage;
576
+ pageId(pageId: string): CheckSettingsImage;
577
+ variationGroupId(variationGroupId: string): CheckSettingsImage;
578
+ }
579
+ export class CheckSettings extends CheckSettingsImage {
580
+ }
581
+ export type TargetAutomation = {
582
+ window(): CheckSettingsAutomation;
583
+ region(region: LegacyRegionPlain | (RegionPlain | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })))): CheckSettingsAutomation;
584
+ frame(context: { frame: number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })); }): CheckSettingsAutomation;
585
+ frame(frame: number | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; })), scrollRootElement?: undefined | ((string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }))): CheckSettingsAutomation;
586
+ shadow(selector: string | { selector: string; type?: undefined | string; shadow?: undefined | EyesSelector<never>; frame?: undefined | EyesSelector<never>; }): CheckSettingsAutomation;
587
+ webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
588
+ };
403
589
  export const Target: {
404
- image(image: string | Buffer | URL): CheckSettingsImage;
590
+ image(image: string | URL | Buffer): CheckSettingsImage;
405
591
  buffer(imageBuffer: Buffer): CheckSettingsImage;
406
592
  base64(imageBase64: string): CheckSettingsImage;
407
593
  path(imagePath: string): CheckSettingsImage;
408
594
  url(imageUrl: string | URL): CheckSettingsImage;
409
595
  };
596
+ export type OCRRegion = { target: RegionPlain | EyesSelector<never>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
410
597
  export class BatchClose {
411
- static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }): Promise<void>;
412
- constructor(options?: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; });
598
+ static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
599
+ constructor(options?: undefined | { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; });
413
600
  close(): Promise<void>;
414
601
  setBatchIds(batchIds: Array<string>): BatchClose;
415
602
  setUrl(serverUrl: string): BatchClose;
416
603
  setApiKey(apiKey: string): BatchClose;
417
604
  setProxy(proxy: ProxySettingsPlain): BatchClose;
418
605
  }
419
- export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
606
+ export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }) => Promise<void>;
420
607
  export type AccessibilityGuidelinesVersionPlain = "WCAG_2_0" | "WCAG_2_1";
421
608
  export enum AccessibilityGuidelinesVersion {
422
609
  WCAG_2_0 = 'WCAG_2_0',
@@ -466,7 +653,7 @@ export enum CorsIframeHandle {
466
653
  KEEP = 'KEEP',
467
654
  SNAPSHOT = 'SNAPSHOT'
468
655
  }
469
- export type DeviceNamePlain = "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II";
656
+ export type DeviceNamePlain = "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Huawei Mate 50 Pro" | "Huawei Matepad 11";
470
657
  export enum DeviceName {
471
658
  Blackberry_PlayBook = 'Blackberry PlayBook',
472
659
  BlackBerry_Z30 = 'BlackBerry Z30',
@@ -532,7 +719,9 @@ export enum DeviceName {
532
719
  Pixel_4 = 'Pixel 4',
533
720
  Pixel_4_XL = 'Pixel 4 XL',
534
721
  Pixel_5 = 'Pixel 5',
535
- Sony_Xperia_10_II = 'Sony Xperia 10 II'
722
+ Sony_Xperia_10_II = 'Sony Xperia 10 II',
723
+ Huawei_Mate_50_Pro = 'Huawei Mate 50 Pro',
724
+ Huawei_Matepad_11 = 'Huawei Matepad 11'
536
725
  }
537
726
  export type FailureReportPlain = "IMMEDIATE" | "ON_CLOSE";
538
727
  export enum FailureReport {
@@ -573,7 +762,7 @@ export enum IosVersion {
573
762
  ONE_VERSION_BACK = 'latest-1',
574
763
  LATEST_ONE_VERSION_BACK = 'latest-1'
575
764
  }
576
- export type AndroidDeviceNamePlain = "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro";
765
+ export type AndroidDeviceNamePlain = "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Sony Xperia 10 II" | "Pixel 6" | "Galaxy S20 Plus" | "Galaxy S21" | "Galaxy S21 Plus" | "Galaxy S21 Ultra" | "Galaxy S22 Plus" | "Galaxy Tab S8" | "Xiaomi Redmi Note 10 JE" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 11 Pro" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite";
577
766
  export enum AndroidDeviceName {
578
767
  Pixel_3_XL = 'Pixel 3 XL',
579
768
  Pixel_4 = 'Pixel 4',
@@ -593,16 +782,20 @@ export enum AndroidDeviceName {
593
782
  Galaxy_S22_Plus = 'Galaxy S22 Plus',
594
783
  Galaxy_Tab_S7 = 'Galaxy Tab S7',
595
784
  Galaxy_Tab_S8 = 'Galaxy Tab S8',
785
+ Xiaomi_Redmi_Note_10_JE = 'Xiaomi Redmi Note 10 JE',
596
786
  Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
597
787
  Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro',
598
- Sony_Xperia_10_II = 'Sony Xperia 10 II'
788
+ Sony_Xperia_1_II = 'Sony Xperia 1 II',
789
+ Sony_Xperia_10_II = 'Sony Xperia 10 II',
790
+ Sony_Xperia_Ace_II = 'Sony Xperia Ace II',
791
+ Huawei_P30_Lite = 'Huawei P30 Lite'
599
792
  }
600
793
  export type AndroidVersionPlain = "latest" | "latest-1";
601
794
  export enum AndroidVersion {
602
795
  LATEST = 'latest',
603
796
  ONE_VERSION_BACK = 'latest-1'
604
797
  }
605
- export type MatchLevelPlain = "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
798
+ export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
606
799
  export enum MatchLevel {
607
800
  None = 'None',
608
801
  LegacyLayout = 'Layout1',
@@ -613,7 +806,7 @@ export enum MatchLevel {
613
806
  Strict = 'Strict',
614
807
  Exact = 'Exact'
615
808
  }
616
- export type ScreenOrientationPlain = "portrait" | "landscape";
809
+ export type ScreenOrientationPlain = "landscape" | "portrait";
617
810
  export enum ScreenOrientation {
618
811
  PORTRAIT = 'portrait',
619
812
  LANDSCAPE = 'landscape'
@@ -623,12 +816,15 @@ export enum SessionType {
623
816
  SEQUENTIAL = 'SEQUENTIAL',
624
817
  PROGRESSION = 'PROGRESSION'
625
818
  }
626
- export type StitchModePlain = "Scroll" | "CSS";
819
+ export type StitchModePlain = "Scroll" | "CSS" | "Resize";
627
820
  export enum StitchMode {
628
821
  SCROLL = 'Scroll',
629
- CSS = 'CSS'
822
+ Scroll = 'Scroll',
823
+ CSS = 'CSS',
824
+ RESIZE = 'Resize',
825
+ Resize = 'Resize'
630
826
  }
631
- export type TestResultsStatusPlain = "Passed" | "Unresolved" | "Failed";
827
+ export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
632
828
  export enum TestResultsStatus {
633
829
  Passed = 'Passed',
634
830
  Unresolved = 'Unresolved',
@@ -637,24 +833,24 @@ export enum TestResultsStatus {
637
833
  export class EyesError extends Error {
638
834
  }
639
835
  export class TestFailedError extends EyesError {
640
- constructor(message: string, results?: TestResultsPlain);
836
+ constructor(message: string, results: TestResultsPlain);
641
837
  constructor(results: TestResultsPlain);
642
838
  get testResults(): TestResultsPlain;
643
839
  getTestResults(): TestResults;
644
840
  }
645
841
  export class DiffsFoundError extends TestFailedError {
646
- constructor(message: string, results?: TestResultsPlain);
842
+ constructor(message: string, results?: undefined | TestResultsPlain);
647
843
  constructor(results: TestResultsPlain);
648
844
  }
649
845
  export class NewTestError extends TestFailedError {
650
- constructor(message: string, results?: TestResultsPlain);
846
+ constructor(message: string, results?: undefined | TestResultsPlain);
651
847
  constructor(results: TestResultsPlain);
652
848
  }
653
- export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: AccessibilityRegionTypePlain; };
849
+ export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; };
654
850
  export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
655
851
  constructor(settings: AccessibilityMatchSettingsPlain);
656
852
  constructor(region: RegionPlain);
657
- constructor(x: number, y: number, width: number, height: number, type?: AccessibilityRegionTypePlain);
853
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject");
658
854
  get region(): RegionPlain;
659
855
  set region(region: RegionPlain);
660
856
  getRegion(): Region;
@@ -672,19 +868,19 @@ export class AccessibilityMatchSettings implements Required<AccessibilityMatchSe
672
868
  getType(): AccessibilityRegionType;
673
869
  setType(type: AccessibilityRegionTypePlain): void;
674
870
  }
675
- export type AccessibilitySettings = { level?: AccessibilityLevelPlain; guidelinesVersion?: AccessibilityGuidelinesVersionPlain; };
871
+ export type AccessibilitySettings = { level?: undefined | "AA" | "AAA"; guidelinesVersion?: undefined | "WCAG_2_0" | "WCAG_2_1"; };
676
872
  export type BatchInfoPlain = {
677
- id?: string;
678
- name?: string;
679
- sequenceName?: string;
680
- startedAt?: string | Date;
681
- notifyOnCompletion?: boolean;
682
- properties?: Array<PropertyDataPlain>;
873
+ id?: undefined | string;
874
+ name?: undefined | string;
875
+ sequenceName?: undefined | string;
876
+ startedAt?: undefined | string | Date;
877
+ notifyOnCompletion?: undefined | boolean;
878
+ properties?: undefined | Array<PropertyDataPlain>;
683
879
  };
684
880
  export class BatchInfo implements Required<BatchInfoPlain> {
685
881
  constructor();
686
- constructor(batch?: BatchInfoPlain);
687
- constructor(name?: string, startedAt?: string | Date, id?: string);
882
+ constructor(batch?: undefined | BatchInfoPlain);
883
+ constructor(name?: undefined | string, startedAt?: undefined | string | Date, id?: undefined | string);
688
884
  get id(): string;
689
885
  set id(id: string);
690
886
  getId(): string;
@@ -713,217 +909,50 @@ export class BatchInfo implements Required<BatchInfoPlain> {
713
909
  addProperty(prop: PropertyDataPlain): BatchInfo;
714
910
  }
715
911
  export type CheckSettingsImagePlain = {
716
- name?: string;
717
- region?: RegionPlain;
718
- matchLevel?: MatchLevelPlain;
719
- useDom?: boolean;
720
- sendDom?: boolean;
721
- enablePatterns?: boolean;
722
- ignoreDisplacements?: boolean;
723
- ignoreMismatch?: boolean;
724
- ignoreCaret?: boolean;
725
- ignoreRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
726
- layoutRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
727
- strictRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
728
- contentRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
729
- floatingRegions?: Array<RegionPlain | {
912
+ name?: undefined | string;
913
+ region?: undefined | RegionPlain;
914
+ matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
915
+ useDom?: undefined | boolean;
916
+ sendDom?: undefined | boolean;
917
+ enablePatterns?: undefined | boolean;
918
+ ignoreDisplacements?: undefined | boolean;
919
+ ignoreMismatch?: undefined | boolean;
920
+ ignoreCaret?: undefined | boolean;
921
+ ignoreRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
922
+ layoutRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
923
+ strictRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
924
+ contentRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
925
+ floatingRegions?: undefined | Array<RegionPlain | {
730
926
  region: RegionPlain;
731
- padding?: number | { top: number; bottom: number; let: number; right: number; };
732
- regionId?: string;
733
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
927
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
928
+ regionId?: undefined | string;
929
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
734
930
  } | {
735
931
  region: RegionPlain;
736
- padding?: number | { top: number; bottom: number; let: number; right: number; };
737
- regionId?: string;
738
- maxUpOffset?: number;
739
- maxDownOffset?: number;
740
- maxLeftOffset?: number;
741
- maxRightOffset?: number;
932
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
933
+ regionId?: undefined | string;
934
+ maxUpOffset?: undefined | number;
935
+ maxDownOffset?: undefined | number;
936
+ maxLeftOffset?: undefined | number;
937
+ maxRightOffset?: undefined | number;
742
938
  }>;
743
- accessibilityRegions?: Array<RegionPlain | {
939
+ accessibilityRegions?: undefined | Array<RegionPlain | {
744
940
  region: RegionPlain;
745
- padding?: number | { top: number; bottom: number; let: number; right: number; };
746
- regionId?: string;
747
- type?: AccessibilityRegionTypePlain;
941
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
942
+ regionId?: undefined | string;
943
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
748
944
  }>;
749
- pageId?: string;
750
- variationGroupId?: string;
945
+ pageId?: undefined | string;
946
+ variationGroupId?: undefined | string;
947
+ densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
751
948
  };
752
- export class CheckSettingsImage {
753
- constructor(settings?: CheckSettingsImagePlain | CheckSettingsImage, target?: {
754
- image: string | Buffer | URL;
755
- name?: string;
756
- dom?: string;
757
- locationInViewport?: LocationPlain;
758
- locationInView?: LocationPlain;
759
- fullViewSize?: RectangleSizePlain;
760
- });
761
- image(image: string | Buffer | URL): CheckSettingsImage;
762
- buffer(imageBuffer: Buffer): CheckSettingsImage;
763
- base64(imageBase64: Buffer): CheckSettingsImage;
764
- path(imagePath: string): CheckSettingsImage;
765
- url(imageUrl: string | URL): CheckSettingsImage;
766
- name(name: string): CheckSettingsImage;
767
- withDom(dom: string): CheckSettingsImage;
768
- withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
769
- region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
770
- withName(name: string): CheckSettingsImage;
771
- ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
772
- ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
773
- layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
774
- layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
775
- strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
776
- strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
777
- contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
778
- contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
779
- floatingRegion(region: {
780
- region: RegionPlain;
781
- padding?: number | { top: number; bottom: number; let: number; right: number; };
782
- regionId?: string;
783
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
784
- }): CheckSettingsImage;
785
- floatingRegion(region: {
786
- region: RegionPlain;
787
- padding?: number | { top: number; bottom: number; let: number; right: number; };
788
- regionId?: string;
789
- maxUpOffset?: number;
790
- maxDownOffset?: number;
791
- maxLeftOffset?: number;
792
- maxRightOffset?: number;
793
- }): CheckSettingsImage;
794
- floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettingsImage;
795
- floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
796
- region: RegionPlain;
797
- padding?: number | { top: number; bottom: number; let: number; right: number; };
798
- regionId?: string;
799
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
800
- }>): CheckSettingsImage;
801
- floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
802
- accessibilityRegion(region: {
803
- region: RegionPlain;
804
- padding?: number | { top: number; bottom: number; let: number; right: number; };
805
- regionId?: string;
806
- type?: AccessibilityRegionTypePlain;
807
- }): CheckSettingsImage;
808
- accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: AccessibilityRegionTypePlain): CheckSettingsImage;
809
- accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
810
- region: RegionPlain;
811
- padding?: number | { top: number; bottom: number; let: number; right: number; };
812
- regionId?: string;
813
- type?: AccessibilityRegionTypePlain;
814
- }>): CheckSettingsImage;
815
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
816
- matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
817
- layout(): CheckSettingsImage;
818
- exact(): CheckSettingsImage;
819
- strict(): CheckSettingsImage;
820
- content(): CheckSettingsImage;
821
- enablePatterns(enablePatterns?: boolean): CheckSettingsImage;
822
- ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsImage;
823
- ignoreCaret(ignoreCaret?: boolean): CheckSettingsImage;
824
- useDom(useDom?: boolean): CheckSettingsImage;
825
- sendDom(sendDom?: boolean): CheckSettingsImage;
826
- pageId(pageId: string): CheckSettingsImage;
827
- variationGroupId(variationGroupId: string): CheckSettingsImage;
828
- }
829
- export type CheckSettingsAutomationPlain<TElement, TSelector> = CheckSettingsImagePlain & {
830
- frames?: Array<{ frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })); scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }); } | (number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })))>;
831
- webview?: string | boolean;
832
- scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; });
833
- fully?: boolean;
834
- disableBrowserFetching?: boolean;
835
- layoutBreakpoints?: boolean | Array<number>;
836
- visualGridOptions?: { [key: string]: any; };
837
- hooks?: { beforeCaptureScreenshot: string; };
838
- renderId?: string;
839
- timeout?: number;
840
- waitBeforeCapture?: number;
841
- lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
842
- };
843
- export class CheckSettingsAutomation<TElement = unknown, TSelector = unknown> {
844
- constructor(settings?: CheckSettingsAutomation<TElement, TSelector> | CheckSettingsAutomationPlain<TElement, TSelector>, spec?: { isElement(value: any): value is TElement; isSelector(value: any): value is TSelector; });
845
- region(region: RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }))): CheckSettingsAutomation<any, any>;
846
- shadow(selector: string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }): CheckSettingsAutomation<any, any>;
847
- frame(context: { frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })); scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }); }): CheckSettingsAutomation<any, any>;
848
- frame(frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })), scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })): CheckSettingsAutomation<any, any>;
849
- webview(webview?: string | boolean): CheckSettingsAutomation<any, any>;
850
- scrollRootElement(scrollRootElement: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })): CheckSettingsAutomation<any, any>;
851
- fully(fully?: boolean): CheckSettingsAutomation<any, any>;
852
- disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation<any, any>;
853
- layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettingsAutomation<any, any>;
854
- hook(name: string, script: string): CheckSettingsAutomation<any, any>;
855
- beforeRenderScreenshotHook(script: string): CheckSettingsAutomation<any, any>;
856
- ufgOption(key: string, value: any): CheckSettingsAutomation<any, any>;
857
- ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation<any, any>;
858
- renderId(renderId: string): CheckSettingsAutomation<any, any>;
859
- timeout(timeout: number): CheckSettingsAutomation<any, any>;
860
- waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation<any, any>;
861
- lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettingsAutomation<any, any>;
862
- name(name: string): CheckSettingsAutomation<any, any>;
863
- withName(name: string): CheckSettingsAutomation<any, any>;
864
- ignoreRegion(region: any): CheckSettingsAutomation<any, any>;
865
- ignoreRegions(...regions: Array<any>): CheckSettingsAutomation<any, any>;
866
- layoutRegion(region: any): CheckSettingsAutomation<any, any>;
867
- layoutRegions(...regions: Array<any>): CheckSettingsAutomation<any, any>;
868
- strictRegion(region: any): CheckSettingsAutomation<any, any>;
869
- strictRegions(...regions: Array<any>): CheckSettingsAutomation<any, any>;
870
- contentRegion(region: any): CheckSettingsAutomation<any, any>;
871
- contentRegions(...regions: Array<any>): CheckSettingsAutomation<any, any>;
872
- floatingRegion(region: {
873
- region: any;
874
- padding?: number | { top: number; bottom: number; let: number; right: number; };
875
- regionId?: string;
876
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
877
- }): CheckSettingsAutomation<any, any>;
878
- floatingRegion(region: {
879
- region: any;
880
- padding?: number | { top: number; bottom: number; let: number; right: number; };
881
- regionId?: string;
882
- maxUpOffset?: number;
883
- maxDownOffset?: number;
884
- maxLeftOffset?: number;
885
- maxRightOffset?: number;
886
- }): CheckSettingsAutomation<any, any>;
887
- floatingRegion(region: any, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettingsAutomation<any, any>;
888
- floatingRegions(...regions: Array<any>): CheckSettingsAutomation<any, any>;
889
- floatingRegions(maxOffset: number, ...regions: Array<any>): CheckSettingsAutomation<any, any>;
890
- accessibilityRegion(region: {
891
- region: any;
892
- padding?: number | { top: number; bottom: number; let: number; right: number; };
893
- regionId?: string;
894
- type?: AccessibilityRegionTypePlain;
895
- }): CheckSettingsAutomation<any, any>;
896
- accessibilityRegion(region: any, type?: AccessibilityRegionTypePlain): CheckSettingsAutomation<any, any>;
897
- accessibilityRegions(...regions: Array<any>): CheckSettingsAutomation<any, any>;
898
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<any>): CheckSettingsAutomation<any, any>;
899
- matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation<any, any>;
900
- layout(): CheckSettingsAutomation<any, any>;
901
- exact(): CheckSettingsAutomation<any, any>;
902
- strict(): CheckSettingsAutomation<any, any>;
903
- content(): CheckSettingsAutomation<any, any>;
904
- enablePatterns(enablePatterns?: boolean): CheckSettingsAutomation<any, any>;
905
- ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsAutomation<any, any>;
906
- ignoreCaret(ignoreCaret?: boolean): CheckSettingsAutomation<any, any>;
907
- useDom(useDom?: boolean): CheckSettingsAutomation<any, any>;
908
- sendDom(sendDom?: boolean): CheckSettingsAutomation<any, any>;
909
- pageId(pageId: string): CheckSettingsAutomation<any, any>;
910
- variationGroupId(variationGroupId: string): CheckSettingsAutomation<any, any>;
911
- }
912
949
  export type TargetImage = {
913
- image(image: string | Buffer | URL): CheckSettingsImage;
950
+ image(image: string | URL | Buffer): CheckSettingsImage;
914
951
  buffer(imageBuffer: Buffer): CheckSettingsImage;
915
952
  base64(imageBase64: string): CheckSettingsImage;
916
953
  path(imagePath: string): CheckSettingsImage;
917
954
  url(imageUrl: string | URL): CheckSettingsImage;
918
955
  };
919
- export type TargetAutomation<TElement, TSelector> = {
920
- window(): CheckSettingsAutomation<TElement, TSelector>;
921
- region(region: LegacyRegionPlain | (RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })))): CheckSettingsAutomation<TElement, TSelector>;
922
- frame(context: { frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })); scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }); }): CheckSettingsAutomation<TElement, TSelector>;
923
- frame(frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })), scrollRootElement?: TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })): CheckSettingsAutomation<TElement, TSelector>;
924
- shadow(selector: string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }): CheckSettingsAutomation<TSelector, unknown>;
925
- webview(webview?: string | boolean): CheckSettingsAutomation<TElement, TSelector>;
926
- };
927
956
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
928
957
  export class CutProvider implements Required<{
929
958
  x: number;
@@ -974,15 +1003,15 @@ export class ExactMatchSettings implements Required<ExactMatchSettingsPlain> {
974
1003
  }
975
1004
  export type FloatingMatchSettingsPlain = {
976
1005
  region: RegionPlain;
977
- maxUpOffset?: number;
978
- maxDownOffset?: number;
979
- maxLeftOffset?: number;
980
- maxRightOffset?: number;
1006
+ maxUpOffset?: undefined | number;
1007
+ maxDownOffset?: undefined | number;
1008
+ maxLeftOffset?: undefined | number;
1009
+ maxRightOffset?: undefined | number;
981
1010
  };
982
1011
  export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlain> {
983
1012
  constructor(settings: FloatingMatchSettingsPlain);
984
1013
  constructor(region: RegionPlain);
985
- constructor(x: number, y: number, width: number, height: number, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number);
1014
+ constructor(x: number, y: number, width: number, height: number, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number);
986
1015
  get region(): RegionPlain;
987
1016
  set region(region: RegionPlain);
988
1017
  getRegion(): Region;
@@ -1013,22 +1042,22 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
1013
1042
  setMaxRightOffset(maxRightOffset: number): void;
1014
1043
  }
1015
1044
  export type ImageMatchSettingsPlain = {
1016
- exact?: ExactMatchSettingsPlain;
1017
- matchLevel?: MatchLevelPlain;
1018
- ignoreCaret?: boolean;
1019
- useDom?: boolean;
1020
- enablePatterns?: boolean;
1021
- ignoreDisplacements?: boolean;
1022
- ignoreRegions?: Array<RegionPlain>;
1023
- layoutRegions?: Array<RegionPlain>;
1024
- strictRegions?: Array<RegionPlain>;
1025
- contentRegions?: Array<RegionPlain>;
1026
- floatingRegions?: Array<RegionPlain | FloatingMatchSettingsPlain>;
1027
- accessibilityRegions?: Array<RegionPlain | AccessibilityMatchSettingsPlain>;
1028
- accessibilitySettings?: AccessibilitySettings;
1045
+ exact?: undefined | ExactMatchSettingsPlain;
1046
+ matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
1047
+ ignoreCaret?: undefined | boolean;
1048
+ useDom?: undefined | boolean;
1049
+ enablePatterns?: undefined | boolean;
1050
+ ignoreDisplacements?: undefined | boolean;
1051
+ ignoreRegions?: undefined | Array<RegionPlain>;
1052
+ layoutRegions?: undefined | Array<RegionPlain>;
1053
+ strictRegions?: undefined | Array<RegionPlain>;
1054
+ contentRegions?: undefined | Array<RegionPlain>;
1055
+ floatingRegions?: undefined | Array<RegionPlain | FloatingMatchSettingsPlain>;
1056
+ accessibilityRegions?: undefined | Array<RegionPlain | AccessibilityMatchSettingsPlain>;
1057
+ accessibilitySettings?: undefined | AccessibilitySettings;
1029
1058
  };
1030
1059
  export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
1031
- constructor(settings?: ImageMatchSettingsPlain);
1060
+ constructor(settings?: undefined | ImageMatchSettingsPlain);
1032
1061
  get exact(): ExactMatchSettingsPlain;
1033
1062
  set exact(exact: ExactMatchSettingsPlain);
1034
1063
  getExact(): ExactMatchSettings;
@@ -1114,18 +1143,11 @@ export class Location implements Required<LocationPlain> {
1114
1143
  setY(y: number): void;
1115
1144
  }
1116
1145
  export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1117
- export type CustomLogHandlerPlain = {
1118
- log(message: any): void;
1119
- warn?(message: any): void;
1120
- error?(message: any): void;
1121
- fatal?(message: any): void;
1122
- open?(): void;
1123
- close?(): void;
1124
- };
1125
- export type FileLogHandlerPlain = { type: "file"; filename?: string; append?: boolean; };
1146
+ export type CustomLogHandlerPlain = { log(message: any): void; };
1147
+ export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
1126
1148
  export type ConsoleLogHandlerPlain = { type: "console"; };
1127
1149
  export abstract class LogHandler implements CustomLogHandlerPlain {
1128
- constructor(verbose?: boolean);
1150
+ constructor(verbose?: undefined | boolean);
1129
1151
  get verbose(): boolean;
1130
1152
  set verbose(verbose: boolean);
1131
1153
  getIsVerbose(): boolean;
@@ -1136,7 +1158,7 @@ export abstract class LogHandler implements CustomLogHandlerPlain {
1136
1158
  abstract close(): void;
1137
1159
  }
1138
1160
  export class FileLogHandler extends LogHandler implements FileLogHandlerPlain {
1139
- constructor(verbose?: boolean, filename?: string, append?: boolean);
1161
+ constructor(verbose?: undefined | boolean, filename?: undefined | string, append?: undefined | boolean);
1140
1162
  readonly type: "file";
1141
1163
  readonly filename: string;
1142
1164
  readonly append: boolean;
@@ -1155,7 +1177,7 @@ export class NullLogHandler extends LogHandler {
1155
1177
  open(): void;
1156
1178
  close(): void;
1157
1179
  }
1158
- export type OCRSettings<TPattern extends string = string> = { patterns: Array<TPattern>; ignoreCase?: boolean; firstOnly?: boolean; language?: string; };
1180
+ export type OCRSettings<TPattern extends string = string> = { patterns: Array<TPattern>; ignoreCase?: undefined | boolean; firstOnly?: undefined | boolean; language?: undefined | string; };
1159
1181
  export type PropertyDataPlain = { name: string; value: string; };
1160
1182
  export class PropertyData implements Required<PropertyDataPlain> {
1161
1183
  constructor(property: PropertyDataPlain);
@@ -1169,10 +1191,10 @@ export class PropertyData implements Required<PropertyDataPlain> {
1169
1191
  getValue(): string;
1170
1192
  setValue(value: string): void;
1171
1193
  }
1172
- export type ProxySettingsPlain = { url: string; username?: string; password?: string; isHttpOnly?: boolean; };
1194
+ export type ProxySettingsPlain = { url: string; username?: undefined | string; password?: undefined | string; };
1173
1195
  export class ProxySettings implements Required<ProxySettingsPlain> {
1174
1196
  constructor(proxy: ProxySettingsPlain);
1175
- constructor(url: string, username?: string, password?: string, isHttpOnly?: boolean);
1197
+ constructor(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean);
1176
1198
  get url(): string;
1177
1199
  getUri(): string;
1178
1200
  getUrl(): string;
@@ -1227,22 +1249,22 @@ export class Region implements Required<RegionPlain> {
1227
1249
  getHeight(): number;
1228
1250
  setHeight(height: number): void;
1229
1251
  }
1230
- export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; };
1231
- export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; };
1232
- export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1233
- export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1234
- export type RunnerOptionsPlain = { testConcurrency?: number; };
1252
+ export type DesktopBrowserInfo = { name?: undefined | "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; };
1253
+ export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1254
+ export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1255
+ export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1256
+ export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
1235
1257
  export class RunnerOptionsFluent {
1236
1258
  testConcurrency(concurrency: number): RunnerOptionsFluent;
1237
1259
  }
1238
1260
  export function RunnerOptions(): RunnerOptionsFluent;
1239
1261
  export type VisualLocatorSettings<TLocator extends string = string> = { locatorNames: Array<TLocator>; firstOnly: boolean; };
1240
1262
  export type ApiUrlsPlain = {
1241
- readonly baselineImage?: string;
1242
- readonly currentImage?: string;
1243
- readonly checkpointImage?: string;
1244
- readonly checkpointImageThumbnail?: string;
1245
- readonly diffImage?: string;
1263
+ readonly baselineImage?: undefined | string;
1264
+ readonly currentImage?: undefined | string;
1265
+ readonly checkpointImage?: undefined | string;
1266
+ readonly checkpointImageThumbnail?: undefined | string;
1267
+ readonly diffImage?: undefined | string;
1246
1268
  };
1247
1269
  export class ApiUrls implements Required<ApiUrlsPlain> {
1248
1270
  get baselineImage(): string;
@@ -1256,21 +1278,21 @@ export class ApiUrls implements Required<ApiUrlsPlain> {
1256
1278
  get diffImage(): string;
1257
1279
  getDiffImage(): string;
1258
1280
  }
1259
- export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; };
1281
+ export type AppUrlsPlain = { readonly step?: undefined | string; readonly stepEditor?: undefined | string; };
1260
1282
  export class AppUrls implements Required<AppUrlsPlain> {
1261
1283
  get step(): string;
1262
1284
  getStep(): string;
1263
1285
  get stepEditor(): string;
1264
1286
  getStepEditor(): string;
1265
1287
  }
1266
- export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; };
1288
+ export type MatchResultPlain = { readonly asExpected?: undefined | boolean; readonly windowId?: undefined | number; };
1267
1289
  export class MatchResult implements Required<MatchResultPlain> {
1268
1290
  get asExpected(): boolean;
1269
1291
  getAsExpected(): boolean;
1270
1292
  get windowId(): number;
1271
1293
  getWindowId(): number;
1272
1294
  }
1273
- export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; };
1295
+ export type SessionUrlsPlain = { readonly batch?: undefined | string; readonly session?: undefined | string; };
1274
1296
  export class SessionUrls implements Required<SessionUrlsPlain> {
1275
1297
  get batch(): string;
1276
1298
  getBatch(): string;
@@ -1278,13 +1300,13 @@ export class SessionUrls implements Required<SessionUrlsPlain> {
1278
1300
  getSession(): string;
1279
1301
  }
1280
1302
  export type StepInfoPlain = {
1281
- readonly name?: string;
1282
- readonly isDifferent?: boolean;
1283
- readonly hasBaselineImage?: boolean;
1284
- readonly hasCurrentImage?: boolean;
1285
- readonly appUrls?: AppUrlsPlain;
1286
- readonly apiUrls?: ApiUrlsPlain;
1287
- readonly renderId?: Array<string>;
1303
+ readonly name?: undefined | string;
1304
+ readonly isDifferent?: undefined | boolean;
1305
+ readonly hasBaselineImage?: undefined | boolean;
1306
+ readonly hasCurrentImage?: undefined | boolean;
1307
+ readonly appUrls?: undefined | AppUrlsPlain;
1308
+ readonly apiUrls?: undefined | ApiUrlsPlain;
1309
+ readonly renderId?: undefined | Array<string>;
1288
1310
  };
1289
1311
  export class StepInfo implements Required<StepInfoPlain> {
1290
1312
  get name(): string;
@@ -1304,36 +1326,36 @@ export class StepInfo implements Required<StepInfoPlain> {
1304
1326
  }
1305
1327
  export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
1306
1328
  export type TestResultsPlain = {
1307
- readonly id?: string;
1308
- readonly name?: string;
1309
- readonly secretToken?: string;
1310
- readonly status?: TestResultsStatusPlain;
1311
- readonly appName?: string;
1312
- readonly batchId?: string;
1313
- readonly batchName?: string;
1314
- readonly branchName?: string;
1315
- readonly hostOS?: string;
1316
- readonly hostApp?: string;
1317
- readonly hostDisplaySize?: RectangleSizePlain;
1318
- readonly accessibilityStatus?: TestAccessibilityStatus;
1319
- readonly startedAt?: string | Date;
1320
- readonly duration?: number;
1321
- readonly isNew?: boolean;
1322
- readonly isDifferent?: boolean;
1323
- readonly isAborted?: boolean;
1324
- readonly appUrls?: SessionUrlsPlain;
1325
- readonly apiUrls?: SessionUrlsPlain;
1326
- readonly stepsInfo?: Array<StepInfoPlain>;
1327
- readonly steps?: number;
1328
- readonly matches?: number;
1329
- readonly mismatches?: number;
1330
- readonly missing?: number;
1331
- readonly exactMatches?: number;
1332
- readonly strictMatches?: number;
1333
- readonly contentMatches?: number;
1334
- readonly layoutMatches?: number;
1335
- readonly noneMatches?: number;
1336
- readonly url?: string;
1329
+ readonly id?: undefined | string;
1330
+ readonly name?: undefined | string;
1331
+ readonly secretToken?: undefined | string;
1332
+ readonly status?: undefined | "Passed" | "Failed" | "Unresolved";
1333
+ readonly appName?: undefined | string;
1334
+ readonly batchId?: undefined | string;
1335
+ readonly batchName?: undefined | string;
1336
+ readonly branchName?: undefined | string;
1337
+ readonly hostOS?: undefined | string;
1338
+ readonly hostApp?: undefined | string;
1339
+ readonly hostDisplaySize?: undefined | RectangleSizePlain;
1340
+ readonly accessibilityStatus?: undefined | TestAccessibilityStatus;
1341
+ readonly startedAt?: undefined | string | Date;
1342
+ readonly duration?: undefined | number;
1343
+ readonly isNew?: undefined | boolean;
1344
+ readonly isDifferent?: undefined | boolean;
1345
+ readonly isAborted?: undefined | boolean;
1346
+ readonly appUrls?: undefined | SessionUrlsPlain;
1347
+ readonly apiUrls?: undefined | SessionUrlsPlain;
1348
+ readonly stepsInfo?: undefined | Array<StepInfoPlain>;
1349
+ readonly steps?: undefined | number;
1350
+ readonly matches?: undefined | number;
1351
+ readonly mismatches?: undefined | number;
1352
+ readonly missing?: undefined | number;
1353
+ readonly exactMatches?: undefined | number;
1354
+ readonly strictMatches?: undefined | number;
1355
+ readonly contentMatches?: undefined | number;
1356
+ readonly layoutMatches?: undefined | number;
1357
+ readonly noneMatches?: undefined | number;
1358
+ readonly url?: undefined | string;
1337
1359
  };
1338
1360
  export class TestResults implements Required<TestResultsPlain> {
1339
1361
  get id(): string;
@@ -1399,14 +1421,14 @@ export class TestResults implements Required<TestResultsPlain> {
1399
1421
  isPassed(): boolean;
1400
1422
  delete(): Promise<void>;
1401
1423
  }
1402
- export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo; };
1424
+ export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo); };
1403
1425
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1404
1426
  get testResults(): TestResultsPlain;
1405
1427
  getTestResults(): TestResults;
1406
1428
  get exception(): Error;
1407
1429
  getException(): Error;
1408
- get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
1409
- getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
1430
+ get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1431
+ getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1410
1432
  }
1411
1433
  export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1412
1434
  export class TestResultsSummary implements Iterable<TestResultContainer> {
@@ -1432,10 +1454,10 @@ export class ValidationResult implements Required<ValidationResultPlain> {
1432
1454
  get asExpected(): boolean;
1433
1455
  getAsExpected(): boolean;
1434
1456
  }
1435
- export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; };
1457
+ export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; };
1436
1458
  export class Logger {
1437
- constructor(options?: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
1438
- constructor(show?: boolean);
1459
+ constructor(options?: undefined | { show?: undefined | boolean; label?: undefined | string; handler?: undefined | LogHandlerPlain; });
1460
+ constructor(show?: undefined | boolean);
1439
1461
  getLogHandler(): LogHandler | FileLogHandler | ConsoleLogHandler;
1440
1462
  setLogHandler(handler: LogHandlerPlain): void;
1441
1463
  verbose(...messages: Array<any>): void;
@@ -1446,16 +1468,16 @@ export class Logger {
1446
1468
  open(): void;
1447
1469
  close(): void;
1448
1470
  tag(name: string, value: any): void;
1449
- extend(label?: string): Logger;
1471
+ extend(label?: undefined | string): Logger;
1450
1472
  }
1451
1473
  export abstract class EyesRunner {
1452
- getAllTestResults(throwErr?: boolean): Promise<TestResultsSummary>;
1474
+ getAllTestResults(throwErr?: undefined | boolean): Promise<TestResultsSummary>;
1453
1475
  }
1454
1476
  export class ClassicRunner extends EyesRunner {
1455
1477
  }
1456
1478
  export class VisualGridRunner extends EyesRunner {
1457
- constructor(options?: RunnerOptionsPlain);
1458
- get testConcurrency(): number;
1479
+ constructor(options?: undefined | RunnerOptionsPlain);
1480
+ get testConcurrency(): undefined | number;
1459
1481
  }
1460
1482
  export abstract class SessionEventHandler {
1461
1483
  abstract initStarted(): any;
@@ -1481,20 +1503,20 @@ export class SessionEventHandlers extends SessionEventHandler {
1481
1503
  validationEnded(sessionId: string, validationId: number, validationResult: ValidationResult): void;
1482
1504
  }
1483
1505
  export class RemoteSessionEventHandler extends SessionEventHandler {
1484
- constructor(options: { serverUrl: string; accessKey?: string; timeout?: number; });
1485
- constructor(serverUrl: string, accessKey?: string, timeout?: number);
1506
+ constructor(options: { serverUrl: string; accessKey?: undefined | string; timeout?: undefined | number; });
1507
+ constructor(serverUrl: string, accessKey?: undefined | string, timeout?: undefined | number);
1486
1508
  get serverUrl(): string;
1487
1509
  set serverUrl(serverUrl: string);
1488
1510
  getServerUrl(): string;
1489
1511
  setServerUrl(serverUrl: string): void;
1490
- get accessKey(): string;
1491
- set accessKey(accessKey: string);
1492
- getAccessKey(): string;
1512
+ get accessKey(): undefined | string;
1513
+ set accessKey(accessKey: undefined | string);
1514
+ getAccessKey(): undefined | string;
1493
1515
  setAccessKey(accessKey: string): void;
1494
- get timeout(): number;
1495
- set timeout(timeout: number);
1516
+ get timeout(): undefined | number;
1517
+ set timeout(timeout: undefined | number);
1496
1518
  setTimeout(timeout: number): void;
1497
- getTimeout(): number;
1519
+ getTimeout(): undefined | number;
1498
1520
  initStarted(): void;
1499
1521
  initEnded(): void;
1500
1522
  setSizeWillStart(): void;