@applitools/eyes-webdriverio 5.38.2 → 5.39.1

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