@applitools/eyes-selenium 4.63.0 → 4.64.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 +14 -0
  2. package/README.md +18 -0
  3. package/package.json +14 -32
  4. package/types/index.d.ts +366 -364
package/types/index.d.ts CHANGED
@@ -1,11 +1,12 @@
1
- export type Driver = import('selenium-webdriver').WebDriver & { __applitoolsBrand?: never; };
2
- export type Element = import('selenium-webdriver').WebElement & { __applitoolsBrand?: never; };
3
- export type Selector = (import('selenium-webdriver').By | import('selenium-webdriver').RelativeBy | import('selenium-webdriver').ByHash | { using: string; value: string; } | ((webdriver: import('selenium-webdriver').WebDriver) => Promise<any>)) & { __applitoolsBrand?: never; };
1
+ export type Driver = import('selenium-webdriver').WebDriver & { __applitoolsBrand?: undefined; };
2
+ export type Element = import('selenium-webdriver').WebElement & { __applitoolsBrand?: undefined; };
3
+ export type Selector = (import('selenium-webdriver').By | import('selenium-webdriver').RelativeBy | import('selenium-webdriver').ByHash | { using: string; value: string; } | ((webdriver: import('selenium-webdriver').WebDriver) => Promise<any>)) & { __applitoolsBrand?: undefined; };
4
+ export type SpecType = { driver: Driver; context: Driver; element: Element; selector: Selector; };
4
5
  export class Eyes {
5
6
  static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
6
- static getExecutionCloudUrl(config?: ConfigurationPlain): Promise<string>;
7
- constructor(runner?: EyesRunner, config?: ConfigurationPlain);
8
- constructor(config?: ConfigurationPlain);
7
+ static getExecutionCloudUrl(config?: undefined | ConfigurationPlain): Promise<string>;
8
+ constructor(runner?: undefined | EyesRunner, config?: undefined | ConfigurationPlain);
9
+ constructor(config?: undefined | ConfigurationPlain);
9
10
  get logger(): Logger;
10
11
  getLogger(): Logger;
11
12
  get runner(): EyesRunner;
@@ -19,45 +20,47 @@ export class Eyes {
19
20
  get isOpen(): boolean;
20
21
  getIsOpen(): boolean;
21
22
  getExecutionCloudUrl(): Promise<string>;
22
- open(driver: Driver, config?: ConfigurationPlain): Promise<Driver>;
23
- open(driver: Driver, appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<Driver>;
24
- open(config?: ConfigurationPlain): Promise<void>;
25
- open(appName?: string, testName?: string, viewportSize?: RectangleSizePlain, sessionType?: SessionTypePlain): Promise<void>;
23
+ open(driver: Driver, config?: undefined | ConfigurationPlain): Promise<Driver>;
24
+ open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<Driver>;
25
+ open(config?: undefined | ConfigurationPlain): Promise<void>;
26
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
26
27
  check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
27
28
  check(target: {
28
- image: string | Buffer | URL;
29
- name?: string;
30
- dom?: string;
31
- locationInViewport?: LocationPlain;
32
- locationInView?: LocationPlain;
33
- fullViewSize?: RectangleSizePlain;
34
- }, checkSettings?: CheckSettingsImagePlain): Promise<MatchResult>;
35
- check(checkSettings?: CheckSettingsAutomationPlain): Promise<MatchResult>;
29
+ image: string | URL | Buffer;
30
+ name?: undefined | string;
31
+ dom?: undefined | string;
32
+ locationInViewport?: undefined | LocationPlain;
33
+ locationInView?: undefined | LocationPlain;
34
+ fullViewSize?: undefined | RectangleSizePlain;
35
+ }, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
36
+ check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
36
37
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
37
38
  extractTextRegions<TPattern extends string>(target: {
38
- image: string | Buffer | URL;
39
- size?: { width: number; height: number; };
40
- name?: string;
41
- source?: string;
42
- dom?: string;
43
- locationInViewport?: { x: number; y: number; };
44
- locationInView?: { x: number; y: number; };
45
- fullViewSize?: { width: number; height: number; };
39
+ image: string | URL | Buffer;
40
+ size?: undefined | { width: number; height: number; };
41
+ name?: undefined | string;
42
+ source?: undefined | string;
43
+ dom?: undefined | string;
44
+ locationInViewport?: undefined | { x: number; y: number; };
45
+ locationInView?: undefined | { x: number; y: number; };
46
+ fullViewSize?: undefined | { width: number; height: number; };
46
47
  }, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
47
48
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
48
49
  extractText(target: {
49
- image: string | Buffer | URL;
50
- size?: { width: number; height: number; };
51
- name?: string;
52
- source?: string;
53
- dom?: string;
54
- locationInViewport?: { x: number; y: number; };
55
- locationInView?: { x: number; y: number; };
56
- fullViewSize?: { width: number; height: number; };
50
+ image: string | URL | Buffer;
51
+ size?: undefined | { width: number; height: number; };
52
+ name?: undefined | string;
53
+ source?: undefined | string;
54
+ dom?: undefined | string;
55
+ locationInViewport?: undefined | { x: number; y: number; };
56
+ locationInView?: undefined | { x: number; y: number; };
57
+ fullViewSize?: undefined | { width: number; height: number; };
57
58
  }, settings: Array<OCRRegion>): Promise<Array<string>>;
58
59
  extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
59
- close(throwErr?: boolean): Promise<TestResults>;
60
+ close(throwErr?: undefined | boolean): Promise<TestResults>;
61
+ closeAsync(): Promise<void>;
60
62
  abort(): Promise<TestResults>;
63
+ abortAsync(): Promise<void>;
61
64
  getViewportSize(): Promise<RectangleSize>;
62
65
  setViewportSize(size: RectangleSizePlain): Promise<void>;
63
66
  getScrollRootElement(): Element | EyesSelector<Selector>;
@@ -81,7 +84,7 @@ export class Eyes {
81
84
  clearProperties(): Configuration;
82
85
  getBatch(): BatchInfo;
83
86
  setBatch(batch: BatchInfoPlain): void;
84
- setBatch(name: string, id?: string, startedAt?: string | Date): void;
87
+ setBatch(name: string, id?: undefined | string, startedAt?: undefined | string | Date): void;
85
88
  getApiKey(): string;
86
89
  setApiKey(apiKey: string): void;
87
90
  getTestName(): string;
@@ -115,7 +118,7 @@ export class Eyes {
115
118
  getParentBranchName(): string;
116
119
  setParentBranchName(parentBranchName: string): void;
117
120
  setProxy(proxy: ProxySettingsPlain): void;
118
- setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): void;
121
+ setProxy(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean): void;
119
122
  setProxy(isEnabled: false): void;
120
123
  getProxy(): ProxySettings;
121
124
  getSaveDiffs(): boolean;
@@ -140,56 +143,56 @@ export class Eyes {
140
143
  setStitchOverlap(stitchOverlap: number): void;
141
144
  }
142
145
  export type ConfigurationPlain = {
143
- agentId?: string;
144
- apiKey?: string;
145
- serverUrl?: string;
146
- proxy?: ProxySettingsPlain;
147
- autProxy?: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
148
- isDisabled?: boolean;
149
- appName?: string;
150
- testName?: string;
151
- displayName?: string;
152
- viewportSize?: RectangleSizePlain;
153
- sessionType?: SessionTypePlain;
154
- properties?: Array<PropertyDataPlain>;
155
- batch?: BatchInfoPlain;
156
- defaultMatchSettings?: ImageMatchSettingsPlain;
157
- hostApp?: string;
158
- hostOS?: string;
159
- hostAppInfo?: string;
160
- hostOSInfo?: string;
161
- deviceInfo?: string;
162
- baselineEnvName?: string;
163
- environmentName?: string;
164
- branchName?: string;
165
- parentBranchName?: string;
166
- baselineBranchName?: string;
167
- compareWithParentBranch?: boolean;
168
- ignoreBaseline?: boolean;
169
- ignoreGitMergeBase?: boolean;
170
- saveFailedTests?: boolean;
171
- saveNewTests?: boolean;
172
- saveDiffs?: boolean;
173
- sendDom?: boolean;
174
- matchTimeout?: number;
175
- forceFullPageScreenshot?: boolean;
176
- waitBeforeScreenshots?: number;
177
- stitchMode?: StitchModePlain;
178
- hideScrollbars?: boolean;
179
- hideCaret?: boolean;
180
- stitchOverlap?: number;
181
- scrollRootElement?: Element | EyesSelector<Selector>;
182
- cut?: CutProviderPlain;
183
- rotation?: ImageRotationPlain;
184
- scaleRatio?: number;
185
- waitBeforeCapture?: number;
186
- browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
187
- visualGridOptions?: Record<string, any>;
188
- layoutBreakpoints?: boolean | Array<number>;
189
- disableBrowserFetching?: boolean;
146
+ agentId?: undefined | string;
147
+ apiKey?: undefined | string;
148
+ serverUrl?: undefined | string;
149
+ proxy?: undefined | ProxySettingsPlain;
150
+ autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
151
+ isDisabled?: undefined | boolean;
152
+ appName?: undefined | string;
153
+ testName?: undefined | string;
154
+ displayName?: undefined | string;
155
+ viewportSize?: undefined | RectangleSizePlain;
156
+ sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION";
157
+ properties?: undefined | Array<PropertyDataPlain>;
158
+ batch?: undefined | BatchInfoPlain;
159
+ defaultMatchSettings?: undefined | ImageMatchSettingsPlain;
160
+ hostApp?: undefined | string;
161
+ hostOS?: undefined | string;
162
+ hostAppInfo?: undefined | string;
163
+ hostOSInfo?: undefined | string;
164
+ deviceInfo?: undefined | string;
165
+ baselineEnvName?: undefined | string;
166
+ environmentName?: undefined | string;
167
+ branchName?: undefined | string;
168
+ parentBranchName?: undefined | string;
169
+ baselineBranchName?: undefined | string;
170
+ compareWithParentBranch?: undefined | boolean;
171
+ ignoreBaseline?: undefined | boolean;
172
+ ignoreGitMergeBase?: undefined | boolean;
173
+ saveFailedTests?: undefined | boolean;
174
+ saveNewTests?: undefined | boolean;
175
+ saveDiffs?: undefined | boolean;
176
+ sendDom?: undefined | boolean;
177
+ matchTimeout?: undefined | number;
178
+ forceFullPageScreenshot?: undefined | boolean;
179
+ waitBeforeScreenshots?: undefined | number;
180
+ stitchMode?: undefined | "Scroll" | "CSS";
181
+ hideScrollbars?: undefined | boolean;
182
+ hideCaret?: undefined | boolean;
183
+ stitchOverlap?: undefined | number;
184
+ scrollRootElement?: undefined | Element | EyesSelector<Selector>;
185
+ cut?: undefined | CutProviderPlain;
186
+ rotation?: undefined | ImageRotationPlain;
187
+ scaleRatio?: undefined | number;
188
+ waitBeforeCapture?: undefined | number;
189
+ browsersInfo?: undefined | Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
190
+ visualGridOptions?: undefined | Record<string, any>;
191
+ layoutBreakpoints?: undefined | boolean | Array<number>;
192
+ disableBrowserFetching?: undefined | boolean;
190
193
  };
191
194
  export class Configuration implements Required<ConfigurationPlain> {
192
- constructor(config?: ConfigurationPlain, spec?: { isElement(element: any): element is Element; isSelector(selector: any): selector is Selector; });
195
+ constructor(config?: undefined | ConfigurationPlain, spec?: undefined | {});
193
196
  get appName(): string;
194
197
  set appName(appName: string);
195
198
  getAppName(): string;
@@ -234,12 +237,12 @@ export class Configuration implements Required<ConfigurationPlain> {
234
237
  set proxy(proxy: ProxySettingsPlain);
235
238
  getProxy(): ProxySettings;
236
239
  setProxy(proxy: ProxySettingsPlain): Configuration;
237
- setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
240
+ setProxy(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean): Configuration;
238
241
  setProxy(isEnabled: false): Configuration;
239
- get autProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
240
- set autProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; });
241
- getAutProxy(): ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; };
242
- setAutProxy(autProxy: ProxySettingsPlain & { mode?: "Allow" | "Block"; domains?: Array<string>; }): Configuration;
242
+ get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
243
+ set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
244
+ getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
245
+ setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
243
246
  get batch(): BatchInfoPlain;
244
247
  set batch(batch: BatchInfoPlain);
245
248
  getBatch(): BatchInfo;
@@ -381,14 +384,14 @@ export class Configuration implements Required<ConfigurationPlain> {
381
384
  setScaleRatio(scaleRatio: number): Configuration;
382
385
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
383
386
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
384
- getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>;
385
- setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
386
- addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
387
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
388
- addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
389
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
390
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
391
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: AndroidVersionPlain): Configuration;
387
+ getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
388
+ setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
389
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
390
+ addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
391
+ 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;
392
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape" | "portrait"): Configuration;
393
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
394
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
392
395
  get visualGridOptions(): { [key: string]: any; };
393
396
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
394
397
  getVisualGridOptions(): { [key: string]: any; };
@@ -403,33 +406,33 @@ export class Configuration implements Required<ConfigurationPlain> {
403
406
  getDisableBrowserFetching(): boolean;
404
407
  setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
405
408
  }
406
- export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
409
+ export type OCRRegion = { target: RegionPlain | Element | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
407
410
  export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
408
- 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>; })))>;
409
- webview?: string | boolean;
410
- scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; });
411
- fully?: boolean;
412
- disableBrowserFetching?: boolean;
413
- layoutBreakpoints?: boolean | Array<number>;
414
- visualGridOptions?: { [key: string]: any; };
415
- nmgOptions?: { [key: string]: any; };
416
- hooks?: { beforeCaptureScreenshot: string; };
417
- renderId?: string;
418
- timeout?: number;
419
- waitBeforeCapture?: number;
420
- lazyLoad?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; };
411
+ 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>; })))>;
412
+ webview?: undefined | string | boolean;
413
+ scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
414
+ fully?: undefined | boolean;
415
+ disableBrowserFetching?: undefined | boolean;
416
+ layoutBreakpoints?: undefined | boolean | Array<number>;
417
+ visualGridOptions?: undefined | { [key: string]: any; };
418
+ nmgOptions?: undefined | { [key: string]: any; };
419
+ hooks?: undefined | { beforeCaptureScreenshot: string; };
420
+ renderId?: undefined | string;
421
+ timeout?: undefined | number;
422
+ waitBeforeCapture?: undefined | number;
423
+ lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
421
424
  };
422
425
  export class CheckSettingsAutomation {
423
- constructor(settings?: CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
424
- region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))): CheckSettingsAutomation;
425
- shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettingsAutomation;
426
- 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;
427
- 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;
428
- webview(webview?: string | boolean): CheckSettingsAutomation;
429
- scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettingsAutomation;
430
- fully(fully?: boolean): CheckSettingsAutomation;
426
+ constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: undefined | {});
427
+ region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
428
+ shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
429
+ 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;
430
+ 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;
431
+ webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
432
+ scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })): CheckSettingsAutomation;
433
+ fully(fully?: undefined | boolean): CheckSettingsAutomation;
431
434
  disableBrowserFetching(disableBrowserFetching: boolean): CheckSettingsAutomation;
432
- layoutBreakpoints(layoutBreakpoints?: boolean | Array<number>): CheckSettingsAutomation;
435
+ layoutBreakpoints(layoutBreakpoints?: undefined | boolean | Array<number>): CheckSettingsAutomation;
433
436
  hook(name: string, script: string): CheckSettingsAutomation;
434
437
  beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
435
438
  ufgOption(key: string, value: any): CheckSettingsAutomation;
@@ -439,80 +442,81 @@ export class CheckSettingsAutomation {
439
442
  renderId(renderId: string): CheckSettingsAutomation;
440
443
  timeout(timeout: number): CheckSettingsAutomation;
441
444
  waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
442
- lazyLoad(options?: boolean | { scrollLength?: number; waitingTime?: number; maxAmountToScroll?: number; }): CheckSettingsAutomation;
445
+ lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
446
+ densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
443
447
  name(name: string): CheckSettingsAutomation;
444
448
  withName(name: string): CheckSettingsAutomation;
445
- 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; left: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
446
- 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; left: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
447
- 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; left: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
448
- 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; left: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
449
- 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; left: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
450
- 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; left: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
451
- 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; left: number; right: number; }; regionId?: string; }): CheckSettingsAutomation;
452
- 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; left: number; right: number; }; regionId?: string; }>): CheckSettingsAutomation;
449
+ 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; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
450
+ 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; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
451
+ 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; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
452
+ 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; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
453
+ 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; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
454
+ 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; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
455
+ 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; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
456
+ 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; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
453
457
  floatingRegion(region: {
454
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
455
- padding?: number | { top: number; bottom: number; left: number; right: number; };
456
- regionId?: string;
457
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
458
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
459
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
460
+ regionId?: undefined | string;
461
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
458
462
  }): CheckSettingsAutomation;
459
463
  floatingRegion(region: {
460
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
461
- padding?: number | { top: number; bottom: number; left: number; right: number; };
462
- regionId?: string;
463
- maxUpOffset?: number;
464
- maxDownOffset?: number;
465
- maxLeftOffset?: number;
466
- maxRightOffset?: number;
464
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
465
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
466
+ regionId?: undefined | string;
467
+ maxUpOffset?: undefined | number;
468
+ maxDownOffset?: undefined | number;
469
+ maxLeftOffset?: undefined | number;
470
+ maxRightOffset?: undefined | number;
467
471
  }): CheckSettingsAutomation;
468
- 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;
469
- floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
470
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
471
- padding?: number | { top: number; bottom: number; left: number; right: number; };
472
- regionId?: string;
473
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
472
+ 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;
473
+ floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
474
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
475
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
476
+ regionId?: undefined | string;
477
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
474
478
  }>): CheckSettingsAutomation;
475
- floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
479
+ 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;
476
480
  accessibilityRegion(region: {
477
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
478
- padding?: number | { top: number; bottom: number; left: number; right: number; };
479
- regionId?: string;
480
- type?: AccessibilityRegionTypePlain;
481
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
482
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
483
+ regionId?: undefined | string;
484
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
481
485
  }): CheckSettingsAutomation;
482
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type?: AccessibilityRegionTypePlain): CheckSettingsAutomation;
483
- accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
484
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
485
- padding?: number | { top: number; bottom: number; left: number; right: number; };
486
- regionId?: string;
487
- type?: AccessibilityRegionTypePlain;
486
+ 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;
487
+ accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
488
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
489
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
490
+ regionId?: undefined | string;
491
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
488
492
  }>): CheckSettingsAutomation;
489
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettingsAutomation;
493
+ 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;
490
494
  matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
491
495
  layout(): CheckSettingsAutomation;
492
496
  exact(): CheckSettingsAutomation;
493
497
  strict(): CheckSettingsAutomation;
494
498
  ignoreColors(): CheckSettingsAutomation;
495
- enablePatterns(enablePatterns?: boolean): CheckSettingsAutomation;
496
- ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsAutomation;
497
- ignoreCaret(ignoreCaret?: boolean): CheckSettingsAutomation;
498
- useDom(useDom?: boolean): CheckSettingsAutomation;
499
- sendDom(sendDom?: boolean): CheckSettingsAutomation;
499
+ enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsAutomation;
500
+ ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsAutomation;
501
+ ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsAutomation;
502
+ useDom(useDom?: undefined | boolean): CheckSettingsAutomation;
503
+ sendDom(sendDom?: undefined | boolean): CheckSettingsAutomation;
500
504
  pageId(pageId: string): CheckSettingsAutomation;
501
505
  variationGroupId(variationGroupId: string): CheckSettingsAutomation;
502
506
  }
503
507
  export class CheckSettings extends CheckSettingsAutomation {
504
508
  }
505
- export const Target: TargetImage & TargetAutomation<Element, Selector>;
509
+ export const Target: TargetImage & TargetAutomation<SpecType>;
506
510
  export class BatchClose {
507
- static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }): Promise<void>;
508
- constructor(options?: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; });
511
+ static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
512
+ constructor(options?: undefined | { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; });
509
513
  close(): Promise<void>;
510
514
  setBatchIds(batchIds: Array<string>): BatchClose;
511
515
  setUrl(serverUrl: string): BatchClose;
512
516
  setApiKey(apiKey: string): BatchClose;
513
517
  setProxy(proxy: ProxySettingsPlain): BatchClose;
514
518
  }
515
- export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
519
+ export const closeBatch: (options: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }) => Promise<void>;
516
520
  export type AccessibilityGuidelinesVersionPlain = "WCAG_2_0" | "WCAG_2_1";
517
521
  export enum AccessibilityGuidelinesVersion {
518
522
  WCAG_2_0 = 'WCAG_2_0',
@@ -671,7 +675,7 @@ export enum IosVersion {
671
675
  ONE_VERSION_BACK = 'latest-1',
672
676
  LATEST_ONE_VERSION_BACK = 'latest-1'
673
677
  }
674
- 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";
678
+ 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";
675
679
  export enum AndroidDeviceName {
676
680
  Pixel_3_XL = 'Pixel 3 XL',
677
681
  Pixel_4 = 'Pixel 4',
@@ -691,16 +695,20 @@ export enum AndroidDeviceName {
691
695
  Galaxy_S22_Plus = 'Galaxy S22 Plus',
692
696
  Galaxy_Tab_S7 = 'Galaxy Tab S7',
693
697
  Galaxy_Tab_S8 = 'Galaxy Tab S8',
698
+ Xiaomi_Redmi_Note_10_JE = 'Xiaomi Redmi Note 10 JE',
694
699
  Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
695
700
  Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro',
696
- Sony_Xperia_10_II = 'Sony Xperia 10 II'
701
+ Sony_Xperia_1_II = 'Sony Xperia 1 II',
702
+ Sony_Xperia_10_II = 'Sony Xperia 10 II',
703
+ Sony_Xperia_Ace_II = 'Sony Xperia Ace II',
704
+ Huawei_P30_Lite = 'Huawei P30 Lite'
697
705
  }
698
706
  export type AndroidVersionPlain = "latest" | "latest-1";
699
707
  export enum AndroidVersion {
700
708
  LATEST = 'latest',
701
709
  ONE_VERSION_BACK = 'latest-1'
702
710
  }
703
- export type MatchLevelPlain = "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
711
+ export type MatchLevelPlain = "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
704
712
  export enum MatchLevel {
705
713
  None = 'None',
706
714
  LegacyLayout = 'Layout1',
@@ -711,7 +719,7 @@ export enum MatchLevel {
711
719
  Strict = 'Strict',
712
720
  Exact = 'Exact'
713
721
  }
714
- export type ScreenOrientationPlain = "portrait" | "landscape";
722
+ export type ScreenOrientationPlain = "landscape" | "portrait";
715
723
  export enum ScreenOrientation {
716
724
  PORTRAIT = 'portrait',
717
725
  LANDSCAPE = 'landscape'
@@ -735,24 +743,24 @@ export enum TestResultsStatus {
735
743
  export class EyesError extends Error {
736
744
  }
737
745
  export class TestFailedError extends EyesError {
738
- constructor(message: string, results?: TestResultsPlain);
746
+ constructor(message: string, results: TestResultsPlain);
739
747
  constructor(results: TestResultsPlain);
740
748
  get testResults(): TestResultsPlain;
741
749
  getTestResults(): TestResults;
742
750
  }
743
751
  export class DiffsFoundError extends TestFailedError {
744
- constructor(message: string, results?: TestResultsPlain);
752
+ constructor(message: string, results?: undefined | TestResultsPlain);
745
753
  constructor(results: TestResultsPlain);
746
754
  }
747
755
  export class NewTestError extends TestFailedError {
748
- constructor(message: string, results?: TestResultsPlain);
756
+ constructor(message: string, results?: undefined | TestResultsPlain);
749
757
  constructor(results: TestResultsPlain);
750
758
  }
751
- export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: AccessibilityRegionTypePlain; };
759
+ export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; };
752
760
  export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
753
761
  constructor(settings: AccessibilityMatchSettingsPlain);
754
762
  constructor(region: RegionPlain);
755
- constructor(x: number, y: number, width: number, height: number, type?: AccessibilityRegionTypePlain);
763
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject");
756
764
  get region(): RegionPlain;
757
765
  set region(region: RegionPlain);
758
766
  getRegion(): Region;
@@ -770,19 +778,19 @@ export class AccessibilityMatchSettings implements Required<AccessibilityMatchSe
770
778
  getType(): AccessibilityRegionType;
771
779
  setType(type: AccessibilityRegionTypePlain): void;
772
780
  }
773
- export type AccessibilitySettings = { level?: AccessibilityLevelPlain; guidelinesVersion?: AccessibilityGuidelinesVersionPlain; };
781
+ export type AccessibilitySettings = { level?: undefined | "AA" | "AAA"; guidelinesVersion?: undefined | "WCAG_2_0" | "WCAG_2_1"; };
774
782
  export type BatchInfoPlain = {
775
- id?: string;
776
- name?: string;
777
- sequenceName?: string;
778
- startedAt?: string | Date;
779
- notifyOnCompletion?: boolean;
780
- properties?: Array<PropertyDataPlain>;
783
+ id?: undefined | string;
784
+ name?: undefined | string;
785
+ sequenceName?: undefined | string;
786
+ startedAt?: undefined | string | Date;
787
+ notifyOnCompletion?: undefined | boolean;
788
+ properties?: undefined | Array<PropertyDataPlain>;
781
789
  };
782
790
  export class BatchInfo implements Required<BatchInfoPlain> {
783
791
  constructor();
784
- constructor(batch?: BatchInfoPlain);
785
- constructor(name?: string, startedAt?: string | Date, id?: string);
792
+ constructor(batch?: undefined | BatchInfoPlain);
793
+ constructor(name?: undefined | string, startedAt?: undefined | string | Date, id?: undefined | string);
786
794
  get id(): string;
787
795
  set id(id: string);
788
796
  getId(): string;
@@ -811,52 +819,53 @@ export class BatchInfo implements Required<BatchInfoPlain> {
811
819
  addProperty(prop: PropertyDataPlain): BatchInfo;
812
820
  }
813
821
  export type CheckSettingsImagePlain = {
814
- name?: string;
815
- region?: RegionPlain;
816
- matchLevel?: MatchLevelPlain;
817
- useDom?: boolean;
818
- sendDom?: boolean;
819
- enablePatterns?: boolean;
820
- ignoreDisplacements?: boolean;
821
- ignoreMismatch?: boolean;
822
- ignoreCaret?: boolean;
823
- ignoreRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
824
- layoutRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
825
- strictRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
826
- contentRegions?: Array<RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>;
827
- floatingRegions?: Array<RegionPlain | {
822
+ name?: undefined | string;
823
+ region?: undefined | RegionPlain;
824
+ matchLevel?: undefined | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
825
+ useDom?: undefined | boolean;
826
+ sendDom?: undefined | boolean;
827
+ enablePatterns?: undefined | boolean;
828
+ ignoreDisplacements?: undefined | boolean;
829
+ ignoreMismatch?: undefined | boolean;
830
+ ignoreCaret?: undefined | boolean;
831
+ ignoreRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
832
+ layoutRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
833
+ strictRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
834
+ contentRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
835
+ floatingRegions?: undefined | Array<RegionPlain | {
828
836
  region: RegionPlain;
829
- padding?: number | { top: number; bottom: number; left: number; right: number; };
830
- regionId?: string;
831
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
837
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
838
+ regionId?: undefined | string;
839
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
832
840
  } | {
833
841
  region: RegionPlain;
834
- padding?: number | { top: number; bottom: number; left: number; right: number; };
835
- regionId?: string;
836
- maxUpOffset?: number;
837
- maxDownOffset?: number;
838
- maxLeftOffset?: number;
839
- maxRightOffset?: number;
842
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
843
+ regionId?: undefined | string;
844
+ maxUpOffset?: undefined | number;
845
+ maxDownOffset?: undefined | number;
846
+ maxLeftOffset?: undefined | number;
847
+ maxRightOffset?: undefined | number;
840
848
  }>;
841
- accessibilityRegions?: Array<RegionPlain | {
849
+ accessibilityRegions?: undefined | Array<RegionPlain | {
842
850
  region: RegionPlain;
843
- padding?: number | { top: number; bottom: number; left: number; right: number; };
844
- regionId?: string;
845
- type?: AccessibilityRegionTypePlain;
851
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
852
+ regionId?: undefined | string;
853
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
846
854
  }>;
847
- pageId?: string;
848
- variationGroupId?: string;
855
+ pageId?: undefined | string;
856
+ variationGroupId?: undefined | string;
857
+ densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
849
858
  };
850
859
  export class CheckSettingsImage {
851
- constructor(settings?: CheckSettingsImagePlain | CheckSettingsImage, target?: {
852
- image: string | Buffer | URL;
853
- name?: string;
854
- dom?: string;
855
- locationInViewport?: LocationPlain;
856
- locationInView?: LocationPlain;
857
- fullViewSize?: RectangleSizePlain;
860
+ constructor(settings?: undefined | CheckSettingsImagePlain | CheckSettingsImage, target?: undefined | {
861
+ image: string | URL | Buffer;
862
+ name?: undefined | string;
863
+ dom?: undefined | string;
864
+ locationInViewport?: undefined | LocationPlain;
865
+ locationInView?: undefined | LocationPlain;
866
+ fullViewSize?: undefined | RectangleSizePlain;
858
867
  });
859
- image(image: string | Buffer | URL): CheckSettingsImage;
868
+ image(image: string | URL | Buffer): CheckSettingsImage;
860
869
  buffer(imageBuffer: Buffer): CheckSettingsImage;
861
870
  base64(imageBase64: Buffer): CheckSettingsImage;
862
871
  path(imagePath: string): CheckSettingsImage;
@@ -866,49 +875,49 @@ export class CheckSettingsImage {
866
875
  withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
867
876
  region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
868
877
  withName(name: string): CheckSettingsImage;
869
- ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }): CheckSettingsImage;
870
- ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
871
- layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }): CheckSettingsImage;
872
- layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
873
- strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }): CheckSettingsImage;
874
- strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
875
- contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }): CheckSettingsImage;
876
- contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: number | { top: number; bottom: number; left: number; right: number; }; regionId?: string; }>): CheckSettingsImage;
878
+ ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
879
+ ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
880
+ layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
881
+ layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
882
+ strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
883
+ strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
884
+ contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
885
+ contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
877
886
  floatingRegion(region: {
878
887
  region: RegionPlain;
879
- padding?: number | { top: number; bottom: number; left: number; right: number; };
880
- regionId?: string;
881
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
888
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
889
+ regionId?: undefined | string;
890
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
882
891
  }): CheckSettingsImage;
883
892
  floatingRegion(region: {
884
893
  region: RegionPlain;
885
- padding?: number | { top: number; bottom: number; left: number; right: number; };
886
- regionId?: string;
887
- maxUpOffset?: number;
888
- maxDownOffset?: number;
889
- maxLeftOffset?: number;
890
- maxRightOffset?: number;
894
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
895
+ regionId?: undefined | string;
896
+ maxUpOffset?: undefined | number;
897
+ maxDownOffset?: undefined | number;
898
+ maxLeftOffset?: undefined | number;
899
+ maxRightOffset?: undefined | number;
891
900
  }): CheckSettingsImage;
892
- floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number): CheckSettingsImage;
901
+ floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
893
902
  floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
894
903
  region: RegionPlain;
895
- padding?: number | { top: number; bottom: number; left: number; right: number; };
896
- regionId?: string;
897
- offset?: { top?: number; bottom?: number; left?: number; right?: number; };
904
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
905
+ regionId?: undefined | string;
906
+ offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
898
907
  }>): CheckSettingsImage;
899
908
  floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
900
909
  accessibilityRegion(region: {
901
910
  region: RegionPlain;
902
- padding?: number | { top: number; bottom: number; left: number; right: number; };
903
- regionId?: string;
904
- type?: AccessibilityRegionTypePlain;
911
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
912
+ regionId?: undefined | string;
913
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
905
914
  }): CheckSettingsImage;
906
- accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: AccessibilityRegionTypePlain): CheckSettingsImage;
915
+ accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
907
916
  accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
908
917
  region: RegionPlain;
909
- padding?: number | { top: number; bottom: number; left: number; right: number; };
910
- regionId?: string;
911
- type?: AccessibilityRegionTypePlain;
918
+ padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
919
+ regionId?: undefined | string;
920
+ type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
912
921
  }>): CheckSettingsImage;
913
922
  accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
914
923
  matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
@@ -916,28 +925,28 @@ export class CheckSettingsImage {
916
925
  exact(): CheckSettingsImage;
917
926
  strict(): CheckSettingsImage;
918
927
  ignoreColors(): CheckSettingsImage;
919
- enablePatterns(enablePatterns?: boolean): CheckSettingsImage;
920
- ignoreDisplacements(ignoreDisplacements?: boolean): CheckSettingsImage;
921
- ignoreCaret(ignoreCaret?: boolean): CheckSettingsImage;
922
- useDom(useDom?: boolean): CheckSettingsImage;
923
- sendDom(sendDom?: boolean): CheckSettingsImage;
928
+ enablePatterns(enablePatterns?: undefined | boolean): CheckSettingsImage;
929
+ ignoreDisplacements(ignoreDisplacements?: undefined | boolean): CheckSettingsImage;
930
+ ignoreCaret(ignoreCaret?: undefined | boolean): CheckSettingsImage;
931
+ useDom(useDom?: undefined | boolean): CheckSettingsImage;
932
+ sendDom(sendDom?: undefined | boolean): CheckSettingsImage;
924
933
  pageId(pageId: string): CheckSettingsImage;
925
934
  variationGroupId(variationGroupId: string): CheckSettingsImage;
926
935
  }
927
936
  export type TargetImage = {
928
- image(image: string | Buffer | URL): CheckSettingsImage;
937
+ image(image: string | URL | Buffer): CheckSettingsImage;
929
938
  buffer(imageBuffer: Buffer): CheckSettingsImage;
930
939
  base64(imageBase64: string): CheckSettingsImage;
931
940
  path(imagePath: string): CheckSettingsImage;
932
941
  url(imageUrl: string | URL): CheckSettingsImage;
933
942
  };
934
- export type TargetAutomation<TElement, TSelector> = {
943
+ export type TargetAutomation<TSpec extends SpecType = SpecType> = {
935
944
  window(): CheckSettingsAutomation;
936
- region(region: LegacyRegionPlain | (RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; })))): CheckSettingsAutomation;
937
- 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;
938
- 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;
939
- shadow(selector: string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; }): CheckSettingsAutomation;
940
- webview(webview?: string | boolean): CheckSettingsAutomation;
945
+ region(region: LegacyRegionPlain | (RegionPlain | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })))): CheckSettingsAutomation;
946
+ frame(context: { frame: number | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })); scrollRootElement?: undefined | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })); }): CheckSettingsAutomation;
947
+ frame(frame: number | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })), scrollRootElement?: undefined | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))): CheckSettingsAutomation;
948
+ shadow(selector: string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }): CheckSettingsAutomation;
949
+ webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
941
950
  };
942
951
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
943
952
  export class CutProvider implements Required<{
@@ -989,15 +998,15 @@ export class ExactMatchSettings implements Required<ExactMatchSettingsPlain> {
989
998
  }
990
999
  export type FloatingMatchSettingsPlain = {
991
1000
  region: RegionPlain;
992
- maxUpOffset?: number;
993
- maxDownOffset?: number;
994
- maxLeftOffset?: number;
995
- maxRightOffset?: number;
1001
+ maxUpOffset?: undefined | number;
1002
+ maxDownOffset?: undefined | number;
1003
+ maxLeftOffset?: undefined | number;
1004
+ maxRightOffset?: undefined | number;
996
1005
  };
997
1006
  export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlain> {
998
1007
  constructor(settings: FloatingMatchSettingsPlain);
999
1008
  constructor(region: RegionPlain);
1000
- constructor(x: number, y: number, width: number, height: number, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number);
1009
+ constructor(x: number, y: number, width: number, height: number, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number);
1001
1010
  get region(): RegionPlain;
1002
1011
  set region(region: RegionPlain);
1003
1012
  getRegion(): Region;
@@ -1028,22 +1037,22 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
1028
1037
  setMaxRightOffset(maxRightOffset: number): void;
1029
1038
  }
1030
1039
  export type ImageMatchSettingsPlain = {
1031
- exact?: ExactMatchSettingsPlain;
1032
- matchLevel?: MatchLevelPlain;
1033
- ignoreCaret?: boolean;
1034
- useDom?: boolean;
1035
- enablePatterns?: boolean;
1036
- ignoreDisplacements?: boolean;
1037
- ignoreRegions?: Array<RegionPlain>;
1038
- layoutRegions?: Array<RegionPlain>;
1039
- strictRegions?: Array<RegionPlain>;
1040
- contentRegions?: Array<RegionPlain>;
1041
- floatingRegions?: Array<RegionPlain | FloatingMatchSettingsPlain>;
1042
- accessibilityRegions?: Array<RegionPlain | AccessibilityMatchSettingsPlain>;
1043
- accessibilitySettings?: AccessibilitySettings;
1040
+ exact?: undefined | ExactMatchSettingsPlain;
1041
+ matchLevel?: undefined | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
1042
+ ignoreCaret?: undefined | boolean;
1043
+ useDom?: undefined | boolean;
1044
+ enablePatterns?: undefined | boolean;
1045
+ ignoreDisplacements?: undefined | boolean;
1046
+ ignoreRegions?: undefined | Array<RegionPlain>;
1047
+ layoutRegions?: undefined | Array<RegionPlain>;
1048
+ strictRegions?: undefined | Array<RegionPlain>;
1049
+ contentRegions?: undefined | Array<RegionPlain>;
1050
+ floatingRegions?: undefined | Array<RegionPlain | FloatingMatchSettingsPlain>;
1051
+ accessibilityRegions?: undefined | Array<RegionPlain | AccessibilityMatchSettingsPlain>;
1052
+ accessibilitySettings?: undefined | AccessibilitySettings;
1044
1053
  };
1045
1054
  export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
1046
- constructor(settings?: ImageMatchSettingsPlain);
1055
+ constructor(settings?: undefined | ImageMatchSettingsPlain);
1047
1056
  get exact(): ExactMatchSettingsPlain;
1048
1057
  set exact(exact: ExactMatchSettingsPlain);
1049
1058
  getExact(): ExactMatchSettings;
@@ -1129,18 +1138,11 @@ export class Location implements Required<LocationPlain> {
1129
1138
  setY(y: number): void;
1130
1139
  }
1131
1140
  export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1132
- export type CustomLogHandlerPlain = {
1133
- log(message: any): void;
1134
- warn?(message: any): void;
1135
- error?(message: any): void;
1136
- fatal?(message: any): void;
1137
- open?(): void;
1138
- close?(): void;
1139
- };
1140
- export type FileLogHandlerPlain = { type: "file"; filename?: string; append?: boolean; };
1141
+ export type CustomLogHandlerPlain = { log(message: any): void; };
1142
+ export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
1141
1143
  export type ConsoleLogHandlerPlain = { type: "console"; };
1142
1144
  export abstract class LogHandler implements CustomLogHandlerPlain {
1143
- constructor(verbose?: boolean);
1145
+ constructor(verbose?: undefined | boolean);
1144
1146
  get verbose(): boolean;
1145
1147
  set verbose(verbose: boolean);
1146
1148
  getIsVerbose(): boolean;
@@ -1151,7 +1153,7 @@ export abstract class LogHandler implements CustomLogHandlerPlain {
1151
1153
  abstract close(): void;
1152
1154
  }
1153
1155
  export class FileLogHandler extends LogHandler implements FileLogHandlerPlain {
1154
- constructor(verbose?: boolean, filename?: string, append?: boolean);
1156
+ constructor(verbose?: undefined | boolean, filename?: undefined | string, append?: undefined | boolean);
1155
1157
  readonly type: "file";
1156
1158
  readonly filename: string;
1157
1159
  readonly append: boolean;
@@ -1170,7 +1172,7 @@ export class NullLogHandler extends LogHandler {
1170
1172
  open(): void;
1171
1173
  close(): void;
1172
1174
  }
1173
- export type OCRSettings<TPattern extends string = string> = { patterns: Array<TPattern>; ignoreCase?: boolean; firstOnly?: boolean; language?: string; };
1175
+ export type OCRSettings<TPattern extends string = string> = { patterns: Array<TPattern>; ignoreCase?: undefined | boolean; firstOnly?: undefined | boolean; language?: undefined | string; };
1174
1176
  export type PropertyDataPlain = { name: string; value: string; };
1175
1177
  export class PropertyData implements Required<PropertyDataPlain> {
1176
1178
  constructor(property: PropertyDataPlain);
@@ -1184,10 +1186,10 @@ export class PropertyData implements Required<PropertyDataPlain> {
1184
1186
  getValue(): string;
1185
1187
  setValue(value: string): void;
1186
1188
  }
1187
- export type ProxySettingsPlain = { url: string; username?: string; password?: string; isHttpOnly?: boolean; };
1189
+ export type ProxySettingsPlain = { url: string; username?: undefined | string; password?: undefined | string; };
1188
1190
  export class ProxySettings implements Required<ProxySettingsPlain> {
1189
1191
  constructor(proxy: ProxySettingsPlain);
1190
- constructor(url: string, username?: string, password?: string, isHttpOnly?: boolean);
1192
+ constructor(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean);
1191
1193
  get url(): string;
1192
1194
  getUri(): string;
1193
1195
  getUrl(): string;
@@ -1242,22 +1244,22 @@ export class Region implements Required<RegionPlain> {
1242
1244
  getHeight(): number;
1243
1245
  setHeight(height: number): void;
1244
1246
  }
1245
- export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; };
1246
- export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; };
1247
- export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1248
- export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: AndroidVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1249
- export type RunnerOptionsPlain = { testConcurrency?: number; };
1247
+ 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; };
1248
+ export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1249
+ export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1250
+ export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1251
+ export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
1250
1252
  export class RunnerOptionsFluent {
1251
1253
  testConcurrency(concurrency: number): RunnerOptionsFluent;
1252
1254
  }
1253
1255
  export function RunnerOptions(): RunnerOptionsFluent;
1254
1256
  export type VisualLocatorSettings<TLocator extends string = string> = { locatorNames: Array<TLocator>; firstOnly: boolean; };
1255
1257
  export type ApiUrlsPlain = {
1256
- readonly baselineImage?: string;
1257
- readonly currentImage?: string;
1258
- readonly checkpointImage?: string;
1259
- readonly checkpointImageThumbnail?: string;
1260
- readonly diffImage?: string;
1258
+ readonly baselineImage?: undefined | string;
1259
+ readonly currentImage?: undefined | string;
1260
+ readonly checkpointImage?: undefined | string;
1261
+ readonly checkpointImageThumbnail?: undefined | string;
1262
+ readonly diffImage?: undefined | string;
1261
1263
  };
1262
1264
  export class ApiUrls implements Required<ApiUrlsPlain> {
1263
1265
  get baselineImage(): string;
@@ -1271,21 +1273,21 @@ export class ApiUrls implements Required<ApiUrlsPlain> {
1271
1273
  get diffImage(): string;
1272
1274
  getDiffImage(): string;
1273
1275
  }
1274
- export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; };
1276
+ export type AppUrlsPlain = { readonly step?: undefined | string; readonly stepEditor?: undefined | string; };
1275
1277
  export class AppUrls implements Required<AppUrlsPlain> {
1276
1278
  get step(): string;
1277
1279
  getStep(): string;
1278
1280
  get stepEditor(): string;
1279
1281
  getStepEditor(): string;
1280
1282
  }
1281
- export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; };
1283
+ export type MatchResultPlain = { readonly asExpected?: undefined | boolean; readonly windowId?: undefined | number; };
1282
1284
  export class MatchResult implements Required<MatchResultPlain> {
1283
1285
  get asExpected(): boolean;
1284
1286
  getAsExpected(): boolean;
1285
1287
  get windowId(): number;
1286
1288
  getWindowId(): number;
1287
1289
  }
1288
- export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; };
1290
+ export type SessionUrlsPlain = { readonly batch?: undefined | string; readonly session?: undefined | string; };
1289
1291
  export class SessionUrls implements Required<SessionUrlsPlain> {
1290
1292
  get batch(): string;
1291
1293
  getBatch(): string;
@@ -1293,13 +1295,13 @@ export class SessionUrls implements Required<SessionUrlsPlain> {
1293
1295
  getSession(): string;
1294
1296
  }
1295
1297
  export type StepInfoPlain = {
1296
- readonly name?: string;
1297
- readonly isDifferent?: boolean;
1298
- readonly hasBaselineImage?: boolean;
1299
- readonly hasCurrentImage?: boolean;
1300
- readonly appUrls?: AppUrlsPlain;
1301
- readonly apiUrls?: ApiUrlsPlain;
1302
- readonly renderId?: Array<string>;
1298
+ readonly name?: undefined | string;
1299
+ readonly isDifferent?: undefined | boolean;
1300
+ readonly hasBaselineImage?: undefined | boolean;
1301
+ readonly hasCurrentImage?: undefined | boolean;
1302
+ readonly appUrls?: undefined | AppUrlsPlain;
1303
+ readonly apiUrls?: undefined | ApiUrlsPlain;
1304
+ readonly renderId?: undefined | Array<string>;
1303
1305
  };
1304
1306
  export class StepInfo implements Required<StepInfoPlain> {
1305
1307
  get name(): string;
@@ -1319,36 +1321,36 @@ export class StepInfo implements Required<StepInfoPlain> {
1319
1321
  }
1320
1322
  export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
1321
1323
  export type TestResultsPlain = {
1322
- readonly id?: string;
1323
- readonly name?: string;
1324
- readonly secretToken?: string;
1325
- readonly status?: TestResultsStatusPlain;
1326
- readonly appName?: string;
1327
- readonly batchId?: string;
1328
- readonly batchName?: string;
1329
- readonly branchName?: string;
1330
- readonly hostOS?: string;
1331
- readonly hostApp?: string;
1332
- readonly hostDisplaySize?: RectangleSizePlain;
1333
- readonly accessibilityStatus?: TestAccessibilityStatus;
1334
- readonly startedAt?: string | Date;
1335
- readonly duration?: number;
1336
- readonly isNew?: boolean;
1337
- readonly isDifferent?: boolean;
1338
- readonly isAborted?: boolean;
1339
- readonly appUrls?: SessionUrlsPlain;
1340
- readonly apiUrls?: SessionUrlsPlain;
1341
- readonly stepsInfo?: Array<StepInfoPlain>;
1342
- readonly steps?: number;
1343
- readonly matches?: number;
1344
- readonly mismatches?: number;
1345
- readonly missing?: number;
1346
- readonly exactMatches?: number;
1347
- readonly strictMatches?: number;
1348
- readonly contentMatches?: number;
1349
- readonly layoutMatches?: number;
1350
- readonly noneMatches?: number;
1351
- readonly url?: string;
1324
+ readonly id?: undefined | string;
1325
+ readonly name?: undefined | string;
1326
+ readonly secretToken?: undefined | string;
1327
+ readonly status?: undefined | "Passed" | "Unresolved" | "Failed";
1328
+ readonly appName?: undefined | string;
1329
+ readonly batchId?: undefined | string;
1330
+ readonly batchName?: undefined | string;
1331
+ readonly branchName?: undefined | string;
1332
+ readonly hostOS?: undefined | string;
1333
+ readonly hostApp?: undefined | string;
1334
+ readonly hostDisplaySize?: undefined | RectangleSizePlain;
1335
+ readonly accessibilityStatus?: undefined | TestAccessibilityStatus;
1336
+ readonly startedAt?: undefined | string | Date;
1337
+ readonly duration?: undefined | number;
1338
+ readonly isNew?: undefined | boolean;
1339
+ readonly isDifferent?: undefined | boolean;
1340
+ readonly isAborted?: undefined | boolean;
1341
+ readonly appUrls?: undefined | SessionUrlsPlain;
1342
+ readonly apiUrls?: undefined | SessionUrlsPlain;
1343
+ readonly stepsInfo?: undefined | Array<StepInfoPlain>;
1344
+ readonly steps?: undefined | number;
1345
+ readonly matches?: undefined | number;
1346
+ readonly mismatches?: undefined | number;
1347
+ readonly missing?: undefined | number;
1348
+ readonly exactMatches?: undefined | number;
1349
+ readonly strictMatches?: undefined | number;
1350
+ readonly contentMatches?: undefined | number;
1351
+ readonly layoutMatches?: undefined | number;
1352
+ readonly noneMatches?: undefined | number;
1353
+ readonly url?: undefined | string;
1352
1354
  };
1353
1355
  export class TestResults implements Required<TestResultsPlain> {
1354
1356
  get id(): string;
@@ -1414,14 +1416,14 @@ export class TestResults implements Required<TestResultsPlain> {
1414
1416
  isPassed(): boolean;
1415
1417
  delete(): Promise<void>;
1416
1418
  }
1417
- export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo; };
1419
+ export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo); };
1418
1420
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1419
1421
  get testResults(): TestResultsPlain;
1420
1422
  getTestResults(): TestResults;
1421
1423
  get exception(): Error;
1422
1424
  getException(): Error;
1423
- get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
1424
- getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo | AndroidDeviceInfo;
1425
+ get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1426
+ getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1425
1427
  }
1426
1428
  export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1427
1429
  export class TestResultsSummary implements Iterable<TestResultContainer> {
@@ -1447,10 +1449,10 @@ export class ValidationResult implements Required<ValidationResultPlain> {
1447
1449
  get asExpected(): boolean;
1448
1450
  getAsExpected(): boolean;
1449
1451
  }
1450
- export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; };
1452
+ export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; };
1451
1453
  export class Logger {
1452
- constructor(options?: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
1453
- constructor(show?: boolean);
1454
+ constructor(options?: undefined | { show?: undefined | boolean; label?: undefined | string; handler?: undefined | LogHandlerPlain; });
1455
+ constructor(show?: undefined | boolean);
1454
1456
  getLogHandler(): LogHandler | FileLogHandler | ConsoleLogHandler;
1455
1457
  setLogHandler(handler: LogHandlerPlain): void;
1456
1458
  verbose(...messages: Array<any>): void;
@@ -1461,16 +1463,16 @@ export class Logger {
1461
1463
  open(): void;
1462
1464
  close(): void;
1463
1465
  tag(name: string, value: any): void;
1464
- extend(label?: string): Logger;
1466
+ extend(label?: undefined | string): Logger;
1465
1467
  }
1466
1468
  export abstract class EyesRunner {
1467
- getAllTestResults(throwErr?: boolean): Promise<TestResultsSummary>;
1469
+ getAllTestResults(throwErr?: undefined | boolean): Promise<TestResultsSummary>;
1468
1470
  }
1469
1471
  export class ClassicRunner extends EyesRunner {
1470
1472
  }
1471
1473
  export class VisualGridRunner extends EyesRunner {
1472
- constructor(options?: RunnerOptionsPlain);
1473
- get testConcurrency(): number;
1474
+ constructor(options?: undefined | RunnerOptionsPlain);
1475
+ get testConcurrency(): undefined | number;
1474
1476
  }
1475
1477
  export abstract class SessionEventHandler {
1476
1478
  abstract initStarted(): any;
@@ -1496,20 +1498,20 @@ export class SessionEventHandlers extends SessionEventHandler {
1496
1498
  validationEnded(sessionId: string, validationId: number, validationResult: ValidationResult): void;
1497
1499
  }
1498
1500
  export class RemoteSessionEventHandler extends SessionEventHandler {
1499
- constructor(options: { serverUrl: string; accessKey?: string; timeout?: number; });
1500
- constructor(serverUrl: string, accessKey?: string, timeout?: number);
1501
+ constructor(options: { serverUrl: string; accessKey?: undefined | string; timeout?: undefined | number; });
1502
+ constructor(serverUrl: string, accessKey?: undefined | string, timeout?: undefined | number);
1501
1503
  get serverUrl(): string;
1502
1504
  set serverUrl(serverUrl: string);
1503
1505
  getServerUrl(): string;
1504
1506
  setServerUrl(serverUrl: string): void;
1505
- get accessKey(): string;
1506
- set accessKey(accessKey: string);
1507
- getAccessKey(): string;
1507
+ get accessKey(): undefined | string;
1508
+ set accessKey(accessKey: undefined | string);
1509
+ getAccessKey(): undefined | string;
1508
1510
  setAccessKey(accessKey: string): void;
1509
- get timeout(): number;
1510
- set timeout(timeout: number);
1511
+ get timeout(): undefined | number;
1512
+ set timeout(timeout: undefined | number);
1511
1513
  setTimeout(timeout: number): void;
1512
- getTimeout(): number;
1514
+ getTimeout(): undefined | number;
1513
1515
  initStarted(): void;
1514
1516
  initEnded(): void;
1515
1517
  setSizeWillStart(): void;