@applitools/eyes-webdriverio 5.39.0 → 5.40.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 (7) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist/legacy.js +4 -4
  3. package/dist/service.js +1 -1
  4. package/package.json +18 -16
  5. package/types/index.d.ts +343 -346
  6. package/types/service.d.ts +19 -33
  7. package/types/v8.d.ts +1 -0
package/types/index.d.ts CHANGED
@@ -13,13 +13,14 @@ export class By {
13
13
  readonly using: string;
14
14
  toString(): string;
15
15
  }
16
- export type Driver = Applitools.WebdriverIO.Browser & { __applitoolsBrand?: never; };
17
- export type Element = (Applitools.WebdriverIO.Element | { ELEMENT: string; } | { 'element-6066-11e4-a52e-4f735466cecf': string; }) & { __applitoolsBrand?: never; };
18
- export type Selector = (Applitools.WebdriverIO.Selector | { using: string; value: string; }) & { __applitoolsBrand?: never; };
16
+ export type Driver = Applitools.WebdriverIO.Browser & { __applitoolsBrand?: undefined; };
17
+ export type Element = (Applitools.WebdriverIO.Element | { ELEMENT: string; } | { 'element-6066-11e4-a52e-4f735466cecf': string; }) & { __applitoolsBrand?: undefined; };
18
+ export type Selector = (Applitools.WebdriverIO.Selector | { using: string; value: string; }) & { __applitoolsBrand?: undefined; };
19
19
  export class Eyes {
20
20
  static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
21
- constructor(runner?: EyesRunner, config?: ConfigurationPlain);
22
- constructor(config?: ConfigurationPlain);
21
+ static getExecutionCloudUrl(config?: undefined | ConfigurationPlain): Promise<string>;
22
+ constructor(runner?: undefined | EyesRunner, config?: undefined | ConfigurationPlain);
23
+ constructor(config?: undefined | ConfigurationPlain);
23
24
  get logger(): Logger;
24
25
  getLogger(): Logger;
25
26
  get runner(): EyesRunner;
@@ -32,44 +33,45 @@ export class Eyes {
32
33
  setConfiguration(config: ConfigurationPlain): void;
33
34
  get isOpen(): boolean;
34
35
  getIsOpen(): boolean;
35
- open(driver: Driver, config?: ConfigurationPlain): Promise<Driver>;
36
- open(driver: Driver, appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<Driver>;
37
- open(config?: ConfigurationPlain): Promise<void>;
38
- open(appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<void>;
36
+ getExecutionCloudUrl(): Promise<string>;
37
+ open(driver: Driver, config?: undefined | ConfigurationPlain): Promise<Driver>;
38
+ open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<Driver>;
39
+ open(config?: undefined | ConfigurationPlain): Promise<void>;
40
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
39
41
  check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
40
42
  check(target: {
41
43
  image: string | URL | Buffer;
42
- name?: string;
43
- dom?: string;
44
- locationInViewport?: LocationPlain;
45
- locationInView?: LocationPlain;
46
- fullViewSize?: RectangleSizePlain;
47
- }, checkSettings?: CheckSettingsImagePlain): Promise<MatchResult>;
48
- check(checkSettings?: CheckSettingsAutomationPlain): Promise<MatchResult>;
44
+ name?: undefined | string;
45
+ dom?: undefined | string;
46
+ locationInViewport?: undefined | LocationPlain;
47
+ locationInView?: undefined | LocationPlain;
48
+ fullViewSize?: undefined | RectangleSizePlain;
49
+ }, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
50
+ check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
49
51
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
50
52
  extractTextRegions<TPattern extends string>(target: {
51
53
  image: string | URL | Buffer;
52
- size?: { width: number; height: number; };
53
- name?: string;
54
- source?: string;
55
- dom?: string;
56
- locationInViewport?: { x: number; y: number; };
57
- locationInView?: { x: number; y: number; };
58
- fullViewSize?: { width: number; height: number; };
54
+ size?: undefined | { width: number; height: number; };
55
+ name?: undefined | string;
56
+ source?: undefined | string;
57
+ dom?: undefined | string;
58
+ locationInViewport?: undefined | { x: number; y: number; };
59
+ locationInView?: undefined | { x: number; y: number; };
60
+ fullViewSize?: undefined | { width: number; height: number; };
59
61
  }, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
60
62
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
61
63
  extractText(target: {
62
64
  image: string | URL | Buffer;
63
- size?: { width: number; height: number; };
64
- name?: string;
65
- source?: string;
66
- dom?: string;
67
- locationInViewport?: { x: number; y: number; };
68
- locationInView?: { x: number; y: number; };
69
- fullViewSize?: { width: number; height: number; };
65
+ size?: undefined | { width: number; height: number; };
66
+ name?: undefined | string;
67
+ source?: undefined | string;
68
+ dom?: undefined | string;
69
+ locationInViewport?: undefined | { x: number; y: number; };
70
+ locationInView?: undefined | { x: number; y: number; };
71
+ fullViewSize?: undefined | { width: number; height: number; };
70
72
  }, settings: Array<OCRRegion>): Promise<Array<string>>;
71
73
  extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
72
- close(throwErr?: boolean): Promise<TestResults>;
74
+ close(throwErr?: undefined | boolean): Promise<TestResults>;
73
75
  abort(): Promise<TestResults>;
74
76
  getViewportSize(): Promise<RectangleSize>;
75
77
  setViewportSize(size: RectangleSizePlain): Promise<void>;
@@ -94,7 +96,7 @@ export class Eyes {
94
96
  clearProperties(): Configuration;
95
97
  getBatch(): BatchInfo;
96
98
  setBatch(batch: BatchInfoPlain): void;
97
- setBatch(name: string, id?: string, startedAt?: string | Date): void;
99
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | string | Date): void;
98
100
  getApiKey(): string;
99
101
  setApiKey(apiKey: string): void;
100
102
  getTestName(): string;
@@ -128,7 +130,7 @@ export class Eyes {
128
130
  getParentBranchName(): string;
129
131
  setParentBranchName(parentBranchName: string): void;
130
132
  setProxy(proxy: ProxySettingsPlain): void;
131
- setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): void;
133
+ setProxy(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean): void;
132
134
  setProxy(isEnabled: false): void;
133
135
  getProxy(): ProxySettings;
134
136
  getSaveDiffs(): boolean;
@@ -153,56 +155,56 @@ export class Eyes {
153
155
  setStitchOverlap(stitchOverlap: number): void;
154
156
  }
155
157
  export type ConfigurationPlain = {
156
- agentId?: string;
157
- apiKey?: string;
158
- serverUrl?: string;
159
- proxy?: ProxySettingsPlain;
160
- autProxy?: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
161
- isDisabled?: boolean;
162
- appName?: string;
163
- testName?: string;
164
- displayName?: string;
165
- viewportSize?: RectangleSizePlain;
166
- sessionType?: SessionTypePlain;
167
- properties?: Array<PropertyDataPlain>;
168
- batch?: BatchInfoPlain;
169
- defaultMatchSettings?: ImageMatchSettingsPlain;
170
- hostApp?: string;
171
- hostOS?: string;
172
- hostAppInfo?: string;
173
- hostOSInfo?: string;
174
- deviceInfo?: string;
175
- baselineEnvName?: string;
176
- environmentName?: string;
177
- branchName?: string;
178
- parentBranchName?: string;
179
- baselineBranchName?: string;
180
- compareWithParentBranch?: boolean;
181
- ignoreBaseline?: boolean;
182
- ignoreGitMergeBase?: boolean;
183
- saveFailedTests?: boolean;
184
- saveNewTests?: boolean;
185
- saveDiffs?: boolean;
186
- sendDom?: boolean;
187
- matchTimeout?: number;
188
- forceFullPageScreenshot?: boolean;
189
- waitBeforeScreenshots?: number;
190
- stitchMode?: StitchModePlain;
191
- hideScrollbars?: boolean;
192
- hideCaret?: boolean;
193
- stitchOverlap?: number;
194
- scrollRootElement?: Element | EyesSelector<Selector>;
195
- cut?: CutProviderPlain;
196
- rotation?: ImageRotationPlain;
197
- scaleRatio?: number;
198
- waitBeforeCapture?: number;
199
- browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
200
- visualGridOptions?: Record<string, any>;
201
- layoutBreakpoints?: boolean | Array<number>;
202
- disableBrowserFetching?: boolean;
158
+ agentId?: undefined | string;
159
+ apiKey?: undefined | string;
160
+ serverUrl?: undefined | string;
161
+ proxy?: undefined | ProxySettingsPlain;
162
+ autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
163
+ isDisabled?: undefined | boolean;
164
+ appName?: undefined | string;
165
+ testName?: undefined | string;
166
+ displayName?: undefined | string;
167
+ viewportSize?: undefined | RectangleSizePlain;
168
+ sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION";
169
+ properties?: undefined | Array<PropertyDataPlain>;
170
+ batch?: undefined | BatchInfoPlain;
171
+ defaultMatchSettings?: undefined | ImageMatchSettingsPlain;
172
+ hostApp?: undefined | string;
173
+ hostOS?: undefined | string;
174
+ hostAppInfo?: undefined | string;
175
+ hostOSInfo?: undefined | string;
176
+ deviceInfo?: undefined | string;
177
+ baselineEnvName?: undefined | string;
178
+ environmentName?: undefined | string;
179
+ branchName?: undefined | string;
180
+ parentBranchName?: undefined | string;
181
+ baselineBranchName?: undefined | string;
182
+ compareWithParentBranch?: undefined | boolean;
183
+ ignoreBaseline?: undefined | boolean;
184
+ ignoreGitMergeBase?: undefined | boolean;
185
+ saveFailedTests?: undefined | boolean;
186
+ saveNewTests?: undefined | boolean;
187
+ saveDiffs?: undefined | boolean;
188
+ sendDom?: undefined | boolean;
189
+ matchTimeout?: undefined | number;
190
+ forceFullPageScreenshot?: undefined | boolean;
191
+ waitBeforeScreenshots?: undefined | number;
192
+ stitchMode?: undefined | "Scroll" | "CSS";
193
+ hideScrollbars?: undefined | boolean;
194
+ hideCaret?: undefined | boolean;
195
+ stitchOverlap?: undefined | number;
196
+ scrollRootElement?: undefined | Element | EyesSelector<Selector>;
197
+ cut?: undefined | CutProviderPlain;
198
+ rotation?: undefined | ImageRotationPlain;
199
+ scaleRatio?: undefined | number;
200
+ waitBeforeCapture?: undefined | number;
201
+ browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
202
+ visualGridOptions?: undefined | Record<string, any>;
203
+ layoutBreakpoints?: undefined | boolean | Array<number>;
204
+ disableBrowserFetching?: undefined | boolean;
203
205
  };
204
206
  export class Configuration implements Required<ConfigurationPlain> {
205
- constructor(config?: ConfigurationPlain, spec?: { isElement(element: any): element is Element; isSelector(selector: any): selector is Selector; });
207
+ constructor(config?: undefined | ConfigurationPlain, spec?: undefined | { isElement(element: any): element is Element; isSelector(selector: any): selector is Selector; });
206
208
  get appName(): string;
207
209
  set appName(appName: string);
208
210
  getAppName(): string;
@@ -247,12 +249,12 @@ export class Configuration implements Required<ConfigurationPlain> {
247
249
  set proxy(proxy: ProxySettingsPlain);
248
250
  getProxy(): ProxySettings;
249
251
  setProxy(proxy: ProxySettingsPlain): Configuration;
250
- setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
252
+ setProxy(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean): Configuration;
251
253
  setProxy(isEnabled: false): Configuration;
252
- get autProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
253
- set autProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; });
254
- getAutProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
255
- setAutProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; }): Configuration;
254
+ get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
255
+ set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
256
+ getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
257
+ setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
256
258
  get batch(): BatchInfoPlain;
257
259
  set batch(batch: BatchInfoPlain);
258
260
  getBatch(): BatchInfo;
@@ -394,14 +396,14 @@ export class Configuration implements Required<ConfigurationPlain> {
394
396
  setScaleRatio(scaleRatio: number): Configuration;
395
397
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
396
398
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
397
- getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>;
398
- setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
399
- addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
400
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
401
- addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
402
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
403
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
404
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
399
+ getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
400
+ setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
401
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
402
+ addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
403
+ 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;
404
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape" | "portrait"): Configuration;
405
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
406
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
405
407
  get visualGridOptions(): { [key: string]: any; };
406
408
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
407
409
  getVisualGridOptions(): { [key: string]: any; };
@@ -416,33 +418,33 @@ export class Configuration implements Required<ConfigurationPlain> {
416
418
  getDisableBrowserFetching(): boolean;
417
419
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
418
420
  }
419
- export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
421
+ export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
420
422
  export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
421
- frames?: Array<{ 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>; }); } | (number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>;
422
- webview?: string | boolean;
423
- scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; });
424
- fully?: boolean;
425
- disableBrowserFetching?: boolean;
426
- layoutBreakpoints?: boolean | Array<number>;
427
- visualGridOptions?: { [key: string]: any; };
428
- nmgOptions?: { [key: string]: any; };
429
- hooks?: { beforeCaptureScreenshot: string; };
430
- renderId?: string;
431
- timeout?: number;
432
- waitBeforeCapture?: number;
433
- lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
423
+ frames?: undefined | Array<{ frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); } | (number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>;
424
+ webview?: undefined | string | boolean;
425
+ scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
426
+ fully?: undefined | boolean;
427
+ disableBrowserFetching?: undefined | boolean;
428
+ layoutBreakpoints?: undefined | boolean | Array<number>;
429
+ visualGridOptions?: undefined | { [key: string]: any; };
430
+ nmgOptions?: undefined | { [key: string]: any; };
431
+ hooks?: undefined | { beforeCaptureScreenshot: string; };
432
+ renderId?: undefined | string;
433
+ timeout?: undefined | number;
434
+ waitBeforeCapture?: undefined | number;
435
+ lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
434
436
  };
435
437
  export class CheckSettingsAutomation {
436
- constructor(settings?: CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
437
- region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))): CheckSettingsAutomation;
438
- shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettingsAutomation;
439
- 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>; }); }): CheckSettingsAutomation;
440
- 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>; })): CheckSettingsAutomation;
441
- webview(webview?: string | boolean): CheckSettingsAutomation;
442
- scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettingsAutomation;
443
- fully(fully?: boolean): CheckSettingsAutomation;
438
+ constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: undefined | { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
439
+ region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
440
+ shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
441
+ frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
442
+ frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
443
+ webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
444
+ scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
445
+ fully(fully?: undefined | boolean): CheckSettingsAutomation;
444
446
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
445
- layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettingsAutomation;
447
+ layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
446
448
  hook(name: string, script: string): CheckSettingsAutomation;
447
449
  beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
448
450
  ufgOption(key: string, value: any): CheckSettingsAutomation;
@@ -452,64 +454,64 @@ export class CheckSettingsAutomation {
452
454
  renderId(renderId: string): CheckSettingsAutomation;
453
455
  timeout(timeout: number): CheckSettingsAutomation;
454
456
  waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
455
- lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettingsAutomation;
457
+ lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
456
458
  name(name: string): CheckSettingsAutomation;
457
459
  withName(name: string): CheckSettingsAutomation;
458
- 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; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
459
- 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; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
460
- 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; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
461
- 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; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
462
- 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; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
463
- 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; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
464
- 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; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
465
- 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; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
460
+ ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
461
+ ignoreRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
462
+ layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
463
+ layoutRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
464
+ strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
465
+ strictRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
466
+ contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
467
+ contentRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
466
468
  floatingRegion(region: {
467
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
468
- padding?: number | { top: number; bottom: number; let: number; right: number; };
469
- regionId?: string;
470
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
469
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
470
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
471
+ regionId?: undefined | string;
472
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
471
473
  }): CheckSettingsAutomation;
472
474
  floatingRegion(region: {
473
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
474
- padding?: number | { top: number; bottom: number; let: number; right: number; };
475
- regionId?: string;
476
- maxUpOffset?: number;
477
- maxDownOffset?: number;
478
- maxLeftOffset?: number;
479
- maxRightOffset?: number;
475
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
476
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
477
+ regionId?: undefined | string;
478
+ maxUpOffset?: undefined | number;
479
+ maxDownOffset?: undefined | number;
480
+ maxLeftOffset?: undefined | number;
481
+ maxRightOffset?: undefined | number;
480
482
  }): CheckSettingsAutomation;
481
- 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): CheckSettingsAutomation;
482
- floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
483
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
484
- padding?: number | { top: number; bottom: number; let: number; right: number; };
485
- regionId?: string;
486
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
483
+ floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
484
+ floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
485
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
486
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
487
+ regionId?: undefined | string;
488
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
487
489
  }>): CheckSettingsAutomation;
488
- floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
490
+ floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
489
491
  accessibilityRegion(region: {
490
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
491
- padding?: number | { top: number; bottom: number; let: number; right: number; };
492
- regionId?: string;
493
- type?: AccessibilityRegionTypePlain;
492
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
493
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
494
+ regionId?: undefined | string;
495
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
494
496
  }): CheckSettingsAutomation;
495
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettingsAutomation;
496
- accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
497
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
498
- padding?: number | { top: number; bottom: number; let: number; right: number; };
499
- regionId?: string;
500
- type?: AccessibilityRegionTypePlain;
497
+ accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
498
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
499
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
500
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
501
+ regionId?: undefined | string;
502
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
501
503
  }>): CheckSettingsAutomation;
502
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
504
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
503
505
  matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
504
506
  layout(): CheckSettingsAutomation;
505
507
  exact(): CheckSettingsAutomation;
506
508
  strict(): CheckSettingsAutomation;
507
509
  ignoreColors(): CheckSettingsAutomation;
508
- enablePatterns(enablePatterns?: boolean): CheckSettingsAutomation;
509
- ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsAutomation;
510
- ignoreCaret(ignoreCaret?: boolean): CheckSettingsAutomation;
511
- useDom(useDom?: boolean): CheckSettingsAutomation;
512
- sendDom(sendDom?: boolean): CheckSettingsAutomation;
510
+ enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsAutomation;
511
+ ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsAutomation;
512
+ ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsAutomation;
513
+ useDom(useDom?: undefined | boolean): CheckSettingsAutomation;
514
+ sendDom(sendDom?: undefined | boolean): CheckSettingsAutomation;
513
515
  pageId(pageId: string): CheckSettingsAutomation;
514
516
  variationGroupId(variationGroupId: string): CheckSettingsAutomation;
515
517
  }
@@ -517,15 +519,15 @@ export class CheckSettings extends CheckSettingsAutomation {
517
519
  }
518
520
  export const Target: TargetImage & TargetAutomation<Element, Selector>;
519
521
  export class BatchClose {
520
- static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }): Promise<void>;
521
- constructor(options?: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; });
522
+ static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
523
+ constructor(options?: undefined | { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; });
522
524
  close(): Promise<void>;
523
525
  setBatchIds(batchIds: Array<string>): BatchClose;
524
526
  setUrl(serverUrl: string): BatchClose;
525
527
  setApiKey(apiKey: string): BatchClose;
526
528
  setProxy(proxy: ProxySettingsPlain): BatchClose;
527
529
  }
528
- export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
530
+ export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }) => Promise<void>;
529
531
  export type AccessibilityGuidelinesVersionPlain = "WCAG_2_0" | "WCAG_2_1";
530
532
  export enum AccessibilityGuidelinesVersion {
531
533
  WCAG_2_0 = 'WCAG_2_0',
@@ -575,7 +577,7 @@ export enum CorsIframeHandle {
575
577
  KEEP = 'KEEP',
576
578
  SNAPSHOT = 'SNAPSHOT'
577
579
  }
578
- 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";
580
+ 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";
579
581
  export enum DeviceName {
580
582
  Blackberry_PlayBook = 'Blackberry PlayBook',
581
583
  BlackBerry_Z30 = 'BlackBerry Z30',
@@ -641,7 +643,9 @@ export enum DeviceName {
641
643
  Pixel_4 = 'Pixel 4',
642
644
  Pixel_4_XL = 'Pixel 4 XL',
643
645
  Pixel_5 = 'Pixel 5',
644
- Sony_Xperia_10_II = 'Sony Xperia 10 II'
646
+ Sony_Xperia_10_II = 'Sony Xperia 10 II',
647
+ Huawei_Mate_50_Pro = 'Huawei Mate 50 Pro',
648
+ Huawei_Matepad_11 = 'Huawei Matepad 11'
645
649
  }
646
650
  export type FailureReportPlain = "IMMEDIATE" | "ON_CLOSE";
647
651
  export enum FailureReport {
@@ -746,24 +750,24 @@ export enum TestResultsStatus {
746
750
  export class EyesError extends Error {
747
751
  }
748
752
  export class TestFailedError extends EyesError {
749
- constructor(message: string, results?: TestResultsPlain);
753
+ constructor(message: string, results?: undefined | TestResultsPlain);
750
754
  constructor(results: TestResultsPlain);
751
755
  get testResults(): TestResultsPlain;
752
756
  getTestResults(): TestResults;
753
757
  }
754
758
  export class DiffsFoundError extends TestFailedError {
755
- constructor(message: string, results?: TestResultsPlain);
759
+ constructor(message: string, results?: undefined | TestResultsPlain);
756
760
  constructor(results: TestResultsPlain);
757
761
  }
758
762
  export class NewTestError extends TestFailedError {
759
- constructor(message: string, results?: TestResultsPlain);
763
+ constructor(message: string, results?: undefined | TestResultsPlain);
760
764
  constructor(results: TestResultsPlain);
761
765
  }
762
- export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: AccessibilityRegionTypePlain; };
766
+ export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; };
763
767
  export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
764
768
  constructor(settings: AccessibilityMatchSettingsPlain);
765
769
  constructor(region: RegionPlain);
766
- constructor(x: number, y: number, width: number, height: number, type?: AccessibilityRegionTypePlain);
770
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject");
767
771
  get region(): RegionPlain;
768
772
  set region(region: RegionPlain);
769
773
  getRegion(): Region;
@@ -781,19 +785,19 @@ export class AccessibilityMatchSettings implements Required<AccessibilityMatchSe
781
785
  getType(): AccessibilityRegionType;
782
786
  setType(type: AccessibilityRegionTypePlain): void;
783
787
  }
784
- export type AccessibilitySettings = { level?: AccessibilityLevelPlain; guidelinesVersion?: AccessibilityGuidelinesVersionPlain; };
788
+ export type AccessibilitySettings = { level?: undefined | "AA" | "AAA"; guidelinesVersion?: undefined | "WCAG_2_0" | "WCAG_2_1"; };
785
789
  export type BatchInfoPlain = {
786
- id?: string;
787
- name?: string;
788
- sequenceName?: string;
789
- startedAt?: string | Date;
790
- notifyOnCompletion?: boolean;
791
- properties?: Array<PropertyDataPlain>;
790
+ id?: undefined | string;
791
+ name?: undefined | string;
792
+ sequenceName?: undefined | string;
793
+ startedAt?: undefined | string | Date;
794
+ notifyOnCompletion?: undefined | boolean;
795
+ properties?: undefined | Array<PropertyDataPlain>;
792
796
  };
793
797
  export class BatchInfo implements Required<BatchInfoPlain> {
794
798
  constructor();
795
- constructor(batch?: BatchInfoPlain);
796
- constructor(name?: string, startedAt?: string | Date, id?: string);
799
+ constructor(batch?: undefined | BatchInfoPlain);
800
+ constructor(name?: undefined | string, startedAt?: undefined | string | Date, id?: undefined | string);
797
801
  get id(): string;
798
802
  set id(id: string);
799
803
  getId(): string;
@@ -822,50 +826,50 @@ export class BatchInfo implements Required<BatchInfoPlain> {
822
826
  addProperty(prop: PropertyDataPlain): BatchInfo;
823
827
  }
824
828
  export type CheckSettingsImagePlain = {
825
- name?: string;
826
- region?: RegionPlain;
827
- matchLevel?: MatchLevelPlain;
828
- useDom?: boolean;
829
- sendDom?: boolean;
830
- enablePatterns?: boolean;
831
- ignoreDisplacements?: boolean;
832
- ignoreMismatch?: boolean;
833
- ignoreCaret?: boolean;
834
- ignoreRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
835
- layoutRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
836
- strictRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
837
- contentRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>;
838
- floatingRegions?: Array<RegionPlain | {
829
+ name?: undefined | string;
830
+ region?: undefined | RegionPlain;
831
+ matchLevel?: undefined | "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
832
+ useDom?: undefined | boolean;
833
+ sendDom?: undefined | boolean;
834
+ enablePatterns?: undefined | boolean;
835
+ ignoreDisplacements?: undefined | boolean;
836
+ ignoreMismatch?: undefined | boolean;
837
+ ignoreCaret?: undefined | boolean;
838
+ ignoreRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>;
839
+ layoutRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>;
840
+ strictRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>;
841
+ contentRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>;
842
+ floatingRegions?: undefined | Array<RegionPlain | {
839
843
  region: RegionPlain;
840
- padding?: number | { top: number; bottom: number; let: number; right: number; };
841
- regionId?: string;
842
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
844
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
845
+ regionId?: undefined | string;
846
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
843
847
  } | {
844
848
  region: RegionPlain;
845
- padding?: number | { top: number; bottom: number; let: number; right: number; };
846
- regionId?: string;
847
- maxUpOffset?: number;
848
- maxDownOffset?: number;
849
- maxLeftOffset?: number;
850
- maxRightOffset?: number;
849
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
850
+ regionId?: undefined | string;
851
+ maxUpOffset?: undefined | number;
852
+ maxDownOffset?: undefined | number;
853
+ maxLeftOffset?: undefined | number;
854
+ maxRightOffset?: undefined | number;
851
855
  }>;
852
- accessibilityRegions?: Array<RegionPlain | {
856
+ accessibilityRegions?: undefined | Array<RegionPlain | {
853
857
  region: RegionPlain;
854
- padding?: number | { top: number; bottom: number; let: number; right: number; };
855
- regionId?: string;
856
- type?: AccessibilityRegionTypePlain;
858
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
859
+ regionId?: undefined | string;
860
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
857
861
  }>;
858
- pageId?: string;
859
- variationGroupId?: string;
862
+ pageId?: undefined | string;
863
+ variationGroupId?: undefined | string;
860
864
  };
861
865
  export class CheckSettingsImage {
862
- constructor(settings?: CheckSettingsImagePlain | CheckSettingsImage, target?: {
866
+ constructor(settings?: undefined | CheckSettingsImagePlain | CheckSettingsImage, target?: undefined | {
863
867
  image: string | URL | Buffer;
864
- name?: string;
865
- dom?: string;
866
- locationInViewport?: LocationPlain;
867
- locationInView?: LocationPlain;
868
- fullViewSize?: RectangleSizePlain;
868
+ name?: undefined | string;
869
+ dom?: undefined | string;
870
+ locationInViewport?: undefined | LocationPlain;
871
+ locationInView?: undefined | LocationPlain;
872
+ fullViewSize?: undefined | RectangleSizePlain;
869
873
  });
870
874
  image(image: string | URL | Buffer): CheckSettingsImage;
871
875
  buffer(imageBuffer: Buffer): CheckSettingsImage;
@@ -877,49 +881,49 @@ export class CheckSettingsImage {
877
881
  withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
878
882
  region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
879
883
  withName(name: string): CheckSettingsImage;
880
- ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
881
- ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
882
- layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
883
- layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
884
- strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
885
- strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
886
- contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }): CheckSettingsImage;
887
- contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; let: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
884
+ ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
885
+ ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
886
+ layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
887
+ layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
888
+ strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
889
+ strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
890
+ contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
891
+ contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; let: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
888
892
  floatingRegion(region: {
889
893
  region: RegionPlain;
890
- padding?: number | { top: number; bottom: number; let: number; right: number; };
891
- regionId?: string;
892
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
894
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
895
+ regionId?: undefined | string;
896
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
893
897
  }): CheckSettingsImage;
894
898
  floatingRegion(region: {
895
899
  region: RegionPlain;
896
- padding?: number | { top: number; bottom: number; let: number; right: number; };
897
- regionId?: string;
898
- maxUpOffset?: number;
899
- maxDownOffset?: number;
900
- maxLeftOffset?: number;
901
- maxRightOffset?: number;
900
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
901
+ regionId?: undefined | string;
902
+ maxUpOffset?: undefined | number;
903
+ maxDownOffset?: undefined | number;
904
+ maxLeftOffset?: undefined | number;
905
+ maxRightOffset?: undefined | number;
902
906
  }): CheckSettingsImage;
903
- floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettingsImage;
907
+ floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
904
908
  floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
905
909
  region: RegionPlain;
906
- padding?: number | { top: number; bottom: number; let: number; right: number; };
907
- regionId?: string;
908
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
910
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
911
+ regionId?: undefined | string;
912
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
909
913
  }>): CheckSettingsImage;
910
914
  floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
911
915
  accessibilityRegion(region: {
912
916
  region: RegionPlain;
913
- padding?: number | { top: number; bottom: number; let: number; right: number; };
914
- regionId?: string;
915
- type?: AccessibilityRegionTypePlain;
917
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
918
+ regionId?: undefined | string;
919
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
916
920
  }): CheckSettingsImage;
917
- accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: AccessibilityRegionTypePlain): CheckSettingsImage;
921
+ accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
918
922
  accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
919
923
  region: RegionPlain;
920
- padding?: number | { top: number; bottom: number; let: number; right: number; };
921
- regionId?: string;
922
- type?: AccessibilityRegionTypePlain;
924
+ padding?: undefined | number | { top: number; bottom: number; let: number; right: number; };
925
+ regionId?: undefined | string;
926
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
923
927
  }>): CheckSettingsImage;
924
928
  accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
925
929
  matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
@@ -927,11 +931,11 @@ export class CheckSettingsImage {
927
931
  exact(): CheckSettingsImage;
928
932
  strict(): CheckSettingsImage;
929
933
  ignoreColors(): CheckSettingsImage;
930
- enablePatterns(enablePatterns?: boolean): CheckSettingsImage;
931
- ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsImage;
932
- ignoreCaret(ignoreCaret?: boolean): CheckSettingsImage;
933
- useDom(useDom?: boolean): CheckSettingsImage;
934
- sendDom(sendDom?: boolean): CheckSettingsImage;
934
+ enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsImage;
935
+ ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsImage;
936
+ ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsImage;
937
+ useDom(useDom?: undefined | boolean): CheckSettingsImage;
938
+ sendDom(sendDom?: undefined | boolean): CheckSettingsImage;
935
939
  pageId(pageId: string): CheckSettingsImage;
936
940
  variationGroupId(variationGroupId: string): CheckSettingsImage;
937
941
  }
@@ -944,11 +948,11 @@ export type TargetImage = {
944
948
  };
945
949
  export type TargetAutomation<TElement, TSelector> = {
946
950
  window(): CheckSettingsAutomation;
947
- region(region: LegacyRegionPlain | (RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })))): CheckSettingsAutomation;
948
- 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;
949
- 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;
950
- shadow(selector: string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }): CheckSettingsAutomation;
951
- webview(webview?: string | boolean): CheckSettingsAutomation;
951
+ region(region: LegacyRegionPlain | (RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })))): CheckSettingsAutomation;
952
+ frame(context: { frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })); scrollRootElement?: undefined | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })); }): CheckSettingsAutomation;
953
+ frame(frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })), scrollRootElement?: undefined | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; }))): CheckSettingsAutomation;
954
+ shadow(selector: string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; }): CheckSettingsAutomation;
955
+ webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
952
956
  };
953
957
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
954
958
  export class CutProvider implements Required<{
@@ -1000,15 +1004,15 @@ export class ExactMatchSettings implements Required<ExactMatchSettingsPlain> {
1000
1004
  }
1001
1005
  export type FloatingMatchSettingsPlain = {
1002
1006
  region: RegionPlain;
1003
- maxUpOffset?: number;
1004
- maxDownOffset?: number;
1005
- maxLeftOffset?: number;
1006
- maxRightOffset?: number;
1007
+ maxUpOffset?: undefined | number;
1008
+ maxDownOffset?: undefined | number;
1009
+ maxLeftOffset?: undefined | number;
1010
+ maxRightOffset?: undefined | number;
1007
1011
  };
1008
1012
  export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlain> {
1009
1013
  constructor(settings: FloatingMatchSettingsPlain);
1010
1014
  constructor(region: RegionPlain);
1011
- constructor(x: number, y: number, width: number, height: number, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number);
1015
+ constructor(x: number, y: number, width: number, height: number, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number);
1012
1016
  get region(): RegionPlain;
1013
1017
  set region(region: RegionPlain);
1014
1018
  getRegion(): Region;
@@ -1039,22 +1043,22 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
1039
1043
  setMaxRightOffset(maxRightOffset: number): void;
1040
1044
  }
1041
1045
  export type ImageMatchSettingsPlain = {
1042
- exact?: ExactMatchSettingsPlain;
1043
- matchLevel?: MatchLevelPlain;
1044
- ignoreCaret?: boolean;
1045
- useDom?: boolean;
1046
- enablePatterns?: boolean;
1047
- ignoreDisplacements?: boolean;
1048
- ignoreRegions?: Array<RegionPlain>;
1049
- layoutRegions?: Array<RegionPlain>;
1050
- strictRegions?: Array<RegionPlain>;
1051
- contentRegions?: Array<RegionPlain>;
1052
- floatingRegions?: Array<RegionPlain | FloatingMatchSettingsPlain>;
1053
- accessibilityRegions?: Array<RegionPlain | AccessibilityMatchSettingsPlain>;
1054
- accessibilitySettings?: AccessibilitySettings;
1046
+ exact?: undefined | ExactMatchSettingsPlain;
1047
+ matchLevel?: undefined | "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
1048
+ ignoreCaret?: undefined | boolean;
1049
+ useDom?: undefined | boolean;
1050
+ enablePatterns?: undefined | boolean;
1051
+ ignoreDisplacements?: undefined | boolean;
1052
+ ignoreRegions?: undefined | Array<RegionPlain>;
1053
+ layoutRegions?: undefined | Array<RegionPlain>;
1054
+ strictRegions?: undefined | Array<RegionPlain>;
1055
+ contentRegions?: undefined | Array<RegionPlain>;
1056
+ floatingRegions?: undefined | Array<RegionPlain | FloatingMatchSettingsPlain>;
1057
+ accessibilityRegions?: undefined | Array<RegionPlain | AccessibilityMatchSettingsPlain>;
1058
+ accessibilitySettings?: undefined | AccessibilitySettings;
1055
1059
  };
1056
1060
  export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
1057
- constructor(settings?: ImageMatchSettingsPlain);
1061
+ constructor(settings?: undefined | ImageMatchSettingsPlain);
1058
1062
  get exact(): ExactMatchSettingsPlain;
1059
1063
  set exact(exact: ExactMatchSettingsPlain);
1060
1064
  getExact(): ExactMatchSettings;
@@ -1140,18 +1144,11 @@ export class Location implements Required<LocationPlain> {
1140
1144
  setY(y: number): void;
1141
1145
  }
1142
1146
  export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1143
- export type CustomLogHandlerPlain = {
1144
- log(message: any): void;
1145
- warn?(message: any): void;
1146
- error?(message: any): void;
1147
- fatal?(message: any): void;
1148
- open?(): void;
1149
- close?(): void;
1150
- };
1151
- export type FileLogHandlerPlain = { type: "file"; filename?: string; append?: boolean; };
1147
+ export type CustomLogHandlerPlain = { log(message: any): void; };
1148
+ export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
1152
1149
  export type ConsoleLogHandlerPlain = { type: "console"; };
1153
1150
  export abstract class LogHandler implements CustomLogHandlerPlain {
1154
- constructor(verbose?: boolean);
1151
+ constructor(verbose?: undefined | boolean);
1155
1152
  get verbose(): boolean;
1156
1153
  set verbose(verbose: boolean);
1157
1154
  getIsVerbose(): boolean;
@@ -1162,7 +1159,7 @@ export abstract class LogHandler implements CustomLogHandlerPlain {
1162
1159
  abstract close(): void;
1163
1160
  }
1164
1161
  export class FileLogHandler extends LogHandler implements FileLogHandlerPlain {
1165
- constructor(verbose?: boolean, filename?: string, append?: boolean);
1162
+ constructor(verbose?: undefined | boolean, filename?: undefined | string, append?: undefined | boolean);
1166
1163
  readonly type: "file";
1167
1164
  readonly filename: string;
1168
1165
  readonly append: boolean;
@@ -1181,7 +1178,7 @@ export class NullLogHandler extends LogHandler {
1181
1178
  open(): void;
1182
1179
  close(): void;
1183
1180
  }
1184
- export type OCRSettings<TPattern extends string = string> = { patterns: Array<TPattern>; ignoreCase?: boolean; firstOnly?: boolean; language?: string; };
1181
+ export type OCRSettings<TPattern extends string = string> = { patterns: Array<TPattern>; ignoreCase?: undefined | boolean; firstOnly?: undefined | boolean; language?: undefined | string; };
1185
1182
  export type PropertyDataPlain = { name: string; value: string; };
1186
1183
  export class PropertyData implements Required<PropertyDataPlain> {
1187
1184
  constructor(property: PropertyDataPlain);
@@ -1195,10 +1192,10 @@ export class PropertyData implements Required<PropertyDataPlain> {
1195
1192
  getValue(): string;
1196
1193
  setValue(value: string): void;
1197
1194
  }
1198
- export type ProxySettingsPlain = { url: string; username?: string; password?: string; isHttpOnly?: boolean; };
1195
+ export type ProxySettingsPlain = { url: string; username?: undefined | string; password?: undefined | string; isHttpOnly?: undefined | boolean; };
1199
1196
  export class ProxySettings implements Required<ProxySettingsPlain> {
1200
1197
  constructor(proxy: ProxySettingsPlain);
1201
- constructor(url: string, username?: string, password?: string, isHttpOnly?: boolean);
1198
+ constructor(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean);
1202
1199
  get url(): string;
1203
1200
  getUri(): string;
1204
1201
  getUrl(): string;
@@ -1253,22 +1250,22 @@ export class Region implements Required<RegionPlain> {
1253
1250
  getHeight(): number;
1254
1251
  setHeight(height: number): void;
1255
1252
  }
1256
- export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; };
1257
- export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; };
1258
- export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1259
- export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1260
- export type RunnerOptionsPlain = { testConcurrency?: number; };
1253
+ 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; };
1254
+ export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1255
+ export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1256
+ export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1257
+ export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
1261
1258
  export class RunnerOptionsFluent {
1262
1259
  testConcurrency(concurrency: number): RunnerOptionsFluent;
1263
1260
  }
1264
1261
  export function RunnerOptions(): RunnerOptionsFluent;
1265
1262
  export type VisualLocatorSettings<TLocator extends string = string> = { locatorNames: Array<TLocator>; firstOnly: boolean; };
1266
1263
  export type ApiUrlsPlain = {
1267
- readonly baselineImage?: string;
1268
- readonly currentImage?: string;
1269
- readonly checkpointImage?: string;
1270
- readonly checkpointImageThumbnail?: string;
1271
- readonly diffImage?: string;
1264
+ readonly baselineImage?: undefined | string;
1265
+ readonly currentImage?: undefined | string;
1266
+ readonly checkpointImage?: undefined | string;
1267
+ readonly checkpointImageThumbnail?: undefined | string;
1268
+ readonly diffImage?: undefined | string;
1272
1269
  };
1273
1270
  export class ApiUrls implements Required<ApiUrlsPlain> {
1274
1271
  get baselineImage(): string;
@@ -1282,21 +1279,21 @@ export class ApiUrls implements Required<ApiUrlsPlain> {
1282
1279
  get diffImage(): string;
1283
1280
  getDiffImage(): string;
1284
1281
  }
1285
- export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; };
1282
+ export type AppUrlsPlain = { readonly step?: undefined | string; readonly stepEditor?: undefined | string; };
1286
1283
  export class AppUrls implements Required<AppUrlsPlain> {
1287
1284
  get step(): string;
1288
1285
  getStep(): string;
1289
1286
  get stepEditor(): string;
1290
1287
  getStepEditor(): string;
1291
1288
  }
1292
- export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; };
1289
+ export type MatchResultPlain = { readonly asExpected?: undefined | boolean; readonly windowId?: undefined | number; };
1293
1290
  export class MatchResult implements Required<MatchResultPlain> {
1294
1291
  get asExpected(): boolean;
1295
1292
  getAsExpected(): boolean;
1296
1293
  get windowId(): number;
1297
1294
  getWindowId(): number;
1298
1295
  }
1299
- export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; };
1296
+ export type SessionUrlsPlain = { readonly batch?: undefined | string; readonly session?: undefined | string; };
1300
1297
  export class SessionUrls implements Required<SessionUrlsPlain> {
1301
1298
  get batch(): string;
1302
1299
  getBatch(): string;
@@ -1304,13 +1301,13 @@ export class SessionUrls implements Required<SessionUrlsPlain> {
1304
1301
  getSession(): string;
1305
1302
  }
1306
1303
  export type StepInfoPlain = {
1307
- readonly name?: string;
1308
- readonly isDifferent?: boolean;
1309
- readonly hasBaselineImage?: boolean;
1310
- readonly hasCurrentImage?: boolean;
1311
- readonly appUrls?: AppUrlsPlain;
1312
- readonly apiUrls?: ApiUrlsPlain;
1313
- readonly renderId?: Array<string>;
1304
+ readonly name?: undefined | string;
1305
+ readonly isDifferent?: undefined | boolean;
1306
+ readonly hasBaselineImage?: undefined | boolean;
1307
+ readonly hasCurrentImage?: undefined | boolean;
1308
+ readonly appUrls?: undefined | AppUrlsPlain;
1309
+ readonly apiUrls?: undefined | ApiUrlsPlain;
1310
+ readonly renderId?: undefined | Array<string>;
1314
1311
  };
1315
1312
  export class StepInfo implements Required<StepInfoPlain> {
1316
1313
  get name(): string;
@@ -1330,36 +1327,36 @@ export class StepInfo implements Required<StepInfoPlain> {
1330
1327
  }
1331
1328
  export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
1332
1329
  export type TestResultsPlain = {
1333
- readonly id?: string;
1334
- readonly name?: string;
1335
- readonly secretToken?: string;
1336
- readonly status?: TestResultsStatusPlain;
1337
- readonly appName?: string;
1338
- readonly batchId?: string;
1339
- readonly batchName?: string;
1340
- readonly branchName?: string;
1341
- readonly hostOS?: string;
1342
- readonly hostApp?: string;
1343
- readonly hostDisplaySize?: RectangleSizePlain;
1344
- readonly accessibilityStatus?: TestAccessibilityStatus;
1345
- readonly startedAt?: string | Date;
1346
- readonly duration?: number;
1347
- readonly isNew?: boolean;
1348
- readonly isDifferent?: boolean;
1349
- readonly isAborted?: boolean;
1350
- readonly appUrls?: SessionUrlsPlain;
1351
- readonly apiUrls?: SessionUrlsPlain;
1352
- readonly stepsInfo?: Array<StepInfoPlain>;
1353
- readonly steps?: number;
1354
- readonly matches?: number;
1355
- readonly mismatches?: number;
1356
- readonly missing?: number;
1357
- readonly exactMatches?: number;
1358
- readonly strictMatches?: number;
1359
- readonly contentMatches?: number;
1360
- readonly layoutMatches?: number;
1361
- readonly noneMatches?: number;
1362
- readonly url?: string;
1330
+ readonly id?: undefined | string;
1331
+ readonly name?: undefined | string;
1332
+ readonly secretToken?: undefined | string;
1333
+ readonly status?: undefined | "Passed" | "Unresolved" | "Failed";
1334
+ readonly appName?: undefined | string;
1335
+ readonly batchId?: undefined | string;
1336
+ readonly batchName?: undefined | string;
1337
+ readonly branchName?: undefined | string;
1338
+ readonly hostOS?: undefined | string;
1339
+ readonly hostApp?: undefined | string;
1340
+ readonly hostDisplaySize?: undefined | RectangleSizePlain;
1341
+ readonly accessibilityStatus?: undefined | TestAccessibilityStatus;
1342
+ readonly startedAt?: undefined | string | Date;
1343
+ readonly duration?: undefined | number;
1344
+ readonly isNew?: undefined | boolean;
1345
+ readonly isDifferent?: undefined | boolean;
1346
+ readonly isAborted?: undefined | boolean;
1347
+ readonly appUrls?: undefined | SessionUrlsPlain;
1348
+ readonly apiUrls?: undefined | SessionUrlsPlain;
1349
+ readonly stepsInfo?: undefined | Array<StepInfoPlain>;
1350
+ readonly steps?: undefined | number;
1351
+ readonly matches?: undefined | number;
1352
+ readonly mismatches?: undefined | number;
1353
+ readonly missing?: undefined | number;
1354
+ readonly exactMatches?: undefined | number;
1355
+ readonly strictMatches?: undefined | number;
1356
+ readonly contentMatches?: undefined | number;
1357
+ readonly layoutMatches?: undefined | number;
1358
+ readonly noneMatches?: undefined | number;
1359
+ readonly url?: undefined | string;
1363
1360
  };
1364
1361
  export class TestResults implements Required<TestResultsPlain> {
1365
1362
  get id(): string;
@@ -1425,14 +1422,14 @@ export class TestResults implements Required<TestResultsPlain> {
1425
1422
  isPassed(): boolean;
1426
1423
  delete(): Promise<void>;
1427
1424
  }
1428
- export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo; };
1425
+ export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo; };
1429
1426
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1430
1427
  get testResults(): TestResultsPlain;
1431
1428
  getTestResults(): TestResults;
1432
1429
  get exception(): Error;
1433
1430
  getException(): Error;
1434
- get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
1435
- getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
1431
+ get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1432
+ getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1436
1433
  }
1437
1434
  export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1438
1435
  export class TestResultsSummary implements Iterable<TestResultContainer> {
@@ -1458,10 +1455,10 @@ export class ValidationResult implements Required<ValidationResultPlain> {
1458
1455
  get asExpected(): boolean;
1459
1456
  getAsExpected(): boolean;
1460
1457
  }
1461
- export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; };
1458
+ export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; };
1462
1459
  export class Logger {
1463
- constructor(options?: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
1464
- constructor(show?: boolean);
1460
+ constructor(options?: undefined | { show?: undefined | boolean; label?: undefined | string; handler?: undefined | LogHandlerPlain; });
1461
+ constructor(show?: undefined | boolean);
1465
1462
  getLogHandler(): LogHandler | FileLogHandler | ConsoleLogHandler;
1466
1463
  setLogHandler(handler: LogHandlerPlain): void;
1467
1464
  verbose(...messages: Array<any>): void;
@@ -1472,15 +1469,15 @@ export class Logger {
1472
1469
  open(): void;
1473
1470
  close(): void;
1474
1471
  tag(name: string, value: any): void;
1475
- extend(label?: string): Logger;
1472
+ extend(label?: undefined | string): Logger;
1476
1473
  }
1477
1474
  export abstract class EyesRunner {
1478
- getAllTestResults(throwErr?: boolean): Promise<TestResultsSummary>;
1475
+ getAllTestResults(throwErr?: undefined | boolean): Promise<TestResultsSummary>;
1479
1476
  }
1480
1477
  export class ClassicRunner extends EyesRunner {
1481
1478
  }
1482
1479
  export class VisualGridRunner extends EyesRunner {
1483
- constructor(options?: RunnerOptionsPlain);
1480
+ constructor(options?: undefined | RunnerOptionsPlain);
1484
1481
  get testConcurrency(): number;
1485
1482
  }
1486
1483
  export abstract class SessionEventHandler {
@@ -1507,8 +1504,8 @@ export class SessionEventHandlers extends SessionEventHandler {
1507
1504
  validationEnded(sessionId: string, validationId: number, validationResult: ValidationResult): void;
1508
1505
  }
1509
1506
  export class RemoteSessionEventHandler extends SessionEventHandler {
1510
- constructor(options: { serverUrl: string; accessKey?: string; timeout?: number; });
1511
- constructor(serverUrl: string, accessKey?: string, timeout?: number);
1507
+ constructor(options: { serverUrl: string; accessKey?: undefined | string; timeout?: undefined | number; });
1508
+ constructor(serverUrl: string, accessKey?: undefined | string, timeout?: undefined | number);
1512
1509
  get serverUrl(): string;
1513
1510
  set serverUrl(serverUrl: string);
1514
1511
  getServerUrl(): string;