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