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