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