@applitools/eyes-selenium 4.56.3 → 4.58.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/dist/api.js +1 -1
  3. package/dist/index.js +0 -5
  4. package/dist/spec-driver.js +3 -342
  5. package/package.json +20 -23
  6. package/types/index.d.ts +1362 -1997
  7. package/dist/legacy.js +0 -78
package/types/index.d.ts CHANGED
@@ -1,2079 +1,1444 @@
1
+ export type Driver = import('selenium-webdriver').WebDriver & { __applitoolsBrand?: never; };
2
+ export type Element = import('selenium-webdriver').WebElement & { __applitoolsBrand?: never; };
3
+ export type Selector = (import('selenium-webdriver').Locator | { using: string; value: string; }) & { __applitoolsBrand?: never; };
4
+ export class Eyes {
5
+ static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
6
+ constructor(runner: EyesRunner, config: ConfigurationPlain);
7
+ constructor(config: ConfigurationPlain);
8
+ get logger(): Logger;
9
+ getLogger(): Logger;
10
+ get runner(): EyesRunner;
11
+ getRunner(): EyesRunner;
12
+ get driver(): Driver;
13
+ getDriver(): Driver;
14
+ get configuration(): ConfigurationPlain;
15
+ set configuration(configuration: ConfigurationPlain);
16
+ getConfiguration(): Configuration;
17
+ setConfiguration(config: ConfigurationPlain): void;
18
+ get isOpen(): boolean;
19
+ getIsOpen(): boolean;
20
+ on(handler: (event: string, data: Record<string, any>) => any): () => void;
21
+ on(event: "setSizeWillStart", handler: (data: { viewportSize: RectangleSizePlain; }) => any): () => void;
22
+ on(event: "setSizeEnded", handler: () => any): () => void;
23
+ on(event: "initStarted", handler: () => any): () => void;
24
+ on(event: "initEnded", handler: () => any): () => void;
25
+ on(event: "testStarted", handler: (data: { sessionId: string; }) => any): () => void;
26
+ on(event: "validationWillStart", handler: (data: { sessionId: string; validationInfo: ValidationInfoPlain; }) => any): () => void;
27
+ on(event: "validationEnded", handler: (data: { sessionId: string; validationId: number; validationResult: ValidationResultPlain; }) => any): () => void;
28
+ on(event: "testEnded", handler: (data: { sessionId: string; testResults: TestResultsPlain; }) => any): () => void;
29
+ off(event: string): void;
30
+ off(handler: (args: Array<any>) => any): void;
31
+ open(driver: Driver, config: ConfigurationPlain): Promise<Driver>;
32
+ open(driver: Driver, appName: string, testName: string, viewportSize: RectangleSizePlain, sessionType: SessionTypePlain): Promise<Driver>;
33
+ checkWindow(name: string, timeout: number, fully: boolean): Promise<MatchResult>;
34
+ checkFrame(element: number | Element | EyesSelector<Selector>, timeout: number, name: string): Promise<MatchResult>;
35
+ checkElement(element: Element, timeout: number, name: string): Promise<MatchResult>;
36
+ checkElementBy(selector: EyesSelector<Selector>, timeout: number, name: string): Promise<MatchResult>;
37
+ checkRegion(region: RegionPlain, name: string, timeout: number): Promise<MatchResult>;
38
+ checkRegionByElement(element: Element, name: string, timeout: number): Promise<MatchResult>;
39
+ checkRegionBy(selector: EyesSelector<Selector>, name: string, timeout: number, fully: boolean): Promise<MatchResult>;
40
+ checkRegionInFrame(frame: number | Element | EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout: number, name: string, fully: boolean): Promise<MatchResult>;
41
+ check(name: string, checkSettings: CheckSettings): Promise<MatchResult>;
42
+ check(checkSettings: CheckSettingsPlain): Promise<MatchResult>;
43
+ locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
44
+ extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
45
+ extractText(regions: Array<OCRRegion>): Promise<Array<string>>;
46
+ close(throwErr: boolean): Promise<TestResults>;
47
+ closeAsync(): Promise<void>;
48
+ abort(): Promise<TestResults>;
49
+ abortAsync(): Promise<void>;
50
+ abortIfNotClosed(): Promise<TestResultsPlain>;
51
+ getViewportSize(): Promise<RectangleSize>;
52
+ setViewportSize(size: RectangleSizePlain): Promise<void>;
53
+ getScrollRootElement(): Element | EyesSelector<Selector>;
54
+ setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): void;
55
+ setLogHandler(handler: LogHandler): void;
56
+ getLogHandler(): LogHandler;
57
+ setCutProvider(cutProvider: CutProvider): void;
58
+ setImageCut(cutProvider: CutProvider): void;
59
+ getIsCutProviderExplicitlySet(): boolean;
60
+ getRotation(): ImageRotation;
61
+ setRotation(rotation: ImageRotationPlain | ImageRotation): void;
62
+ getScaleRatio(): number;
63
+ setScaleRatio(scaleRatio: number): void;
64
+ getSaveDebugScreenshots(): boolean;
65
+ setSaveDebugScreenshots(save: boolean): void;
66
+ getDebugScreenshotsPath(): string;
67
+ setDebugScreenshotsPath(path: string): void;
68
+ getDebugScreenshotsPrefix(): string;
69
+ setDebugScreenshotsPrefix(prefix: string): void;
70
+ addProperty(name: string, value: string): Configuration;
71
+ clearProperties(): Configuration;
72
+ getBatch(): BatchInfo;
73
+ setBatch(batch: BatchInfoPlain): void;
74
+ setBatch(name: string, id: string, startedAt: string | Date): void;
75
+ getApiKey(): string;
76
+ setApiKey(apiKey: string): void;
77
+ getTestName(): string;
78
+ setTestName(testName: string): void;
79
+ getAppName(): string;
80
+ setAppName(appName: string): void;
81
+ getBaselineBranchName(): string;
82
+ setBaselineBranchName(baselineBranchName: string): void;
83
+ getBaselineName(): string;
84
+ setBaselineName(baselineName: string): void;
85
+ getBaselineEnvName(): string;
86
+ setBaselineEnvName(baselineEnvName: string): void;
87
+ getBranchName(): string;
88
+ setBranchName(branchName: string): void;
89
+ getHostApp(): string;
90
+ setHostApp(hostApp: string): void;
91
+ getHostOS(): string;
92
+ setHostOS(hostOS: string): void;
93
+ getHostAppInfo(): string;
94
+ setHostAppInfo(hostAppInfo: string): void;
95
+ getHostOSInfo(): string;
96
+ setHostOSInfo(hostOSInfo: string): void;
97
+ getDeviceInfo(): string;
98
+ setDeviceInfo(deviceInfo: string): void;
99
+ setIgnoreCaret(ignoreCaret: boolean): void;
100
+ getIgnoreCaret(): boolean;
101
+ getIsDisabled(): boolean;
102
+ setIsDisabled(isDisabled: boolean): void;
103
+ getMatchLevel(): MatchLevel;
104
+ setMatchLevel(matchLevel: MatchLevelPlain): void;
105
+ getMatchTimeout(): number;
106
+ setMatchTimeout(matchTimeout: number): void;
107
+ getParentBranchName(): string;
108
+ setParentBranchName(parentBranchName: string): void;
109
+ setProxy(proxy: ProxySettingsPlain): void;
110
+ setProxy(url: string, username: string, password: string, isHttpOnly: boolean): void;
111
+ setProxy(isEnabled: false): void;
112
+ getProxy(): ProxySettings;
113
+ getSaveDiffs(): boolean;
114
+ setSaveDiffs(saveDiffs: boolean): void;
115
+ getSaveNewTests(): boolean;
116
+ setSaveNewTests(saveNewTests: boolean): void;
117
+ getServerUrl(): string;
118
+ setServerUrl(serverUrl: string): void;
119
+ getSendDom(): boolean;
120
+ setSendDom(sendDom: boolean): void;
121
+ getHideCaret(): boolean;
122
+ setHideCaret(hideCaret: boolean): void;
123
+ getHideScrollbars(): boolean;
124
+ setHideScrollbars(hideScrollbars: boolean): void;
125
+ getForceFullPageScreenshot(): boolean;
126
+ setForceFullPageScreenshot(forceFullPageScreenshot: boolean): void;
127
+ getWaitBeforeScreenshots(): number;
128
+ setWaitBeforeScreenshots(waitBeforeScreenshots: number): void;
129
+ getStitchMode(): StitchMode;
130
+ setStitchMode(stitchMode: StitchModePlain): void;
131
+ getStitchOverlap(): number;
132
+ setStitchOverlap(stitchOverlap: number): void;
133
+ getSessionEventHandlers(): SessionEventHandlers;
134
+ addSessionEventHandler(handler: SessionEventHandler): void;
135
+ removeSessionEventHandler(handler: SessionEventHandler): void;
136
+ clearSessionEventHandlers(): void;
137
+ }
138
+ export type ConfigurationPlain = {
139
+ logs?: LogHandlerPlain;
140
+ debugScreenshots?: { save: boolean; path?: string; prefix?: string; };
141
+ agentId?: string;
142
+ apiKey?: string;
143
+ serverUrl?: string;
144
+ proxy?: ProxySettingsPlain;
145
+ isDisabled?: boolean;
146
+ connectionTimeout?: number;
147
+ removeSession?: boolean;
148
+ remoteEvents?: { serverUrl: string; accessKey?: string; timeout?: number; };
149
+ appName?: string;
150
+ testName?: string;
151
+ displayName?: string;
152
+ viewportSize?: RectangleSizePlain;
153
+ sessionType?: SessionTypePlain;
154
+ properties?: Array<PropertyDataPlain>;
155
+ batch?: BatchInfoPlain;
156
+ defaultMatchSettings?: ImageMatchSettingsPlain;
157
+ hostApp?: string;
158
+ hostOS?: string;
159
+ hostAppInfo?: string;
160
+ hostOSInfo?: string;
161
+ deviceInfo?: string;
162
+ baselineEnvName?: string;
163
+ environmentName?: string;
164
+ branchName?: string;
165
+ parentBranchName?: string;
166
+ baselineBranchName?: string;
167
+ compareWithParentBranch?: boolean;
168
+ ignoreBaseline?: boolean;
169
+ saveFailedTests?: boolean;
170
+ saveNewTests?: boolean;
171
+ saveDiffs?: boolean;
172
+ dontCloseBatches?: boolean;
173
+ sendDom?: boolean;
174
+ matchTimeout?: number;
175
+ forceFullPageScreenshot?: boolean;
176
+ waitBeforeScreenshots?: number;
177
+ stitchMode?: StitchModePlain;
178
+ hideScrollbars?: boolean;
179
+ hideCaret?: boolean;
180
+ stitchOverlap?: number;
181
+ scrollRootElement?: Element | EyesSelector<Selector>;
182
+ cut?: CutProviderPlain;
183
+ rotation?: ImageRotationPlain;
184
+ scaleRatio?: number;
185
+ waitBeforeCapture?: number;
186
+ concurrentSessions?: number;
187
+ browsersInfo?: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>;
188
+ visualGridOptions?: Record<string, any>;
189
+ layoutBreakpoints?: boolean | Array<number>;
190
+ disableBrowserFetching?: boolean;
191
+ };
192
+ export class Configuration implements Required<ConfigurationPlain> {
193
+ constructor(config: ConfigurationPlain);
194
+ get logs(): LogHandlerPlain;
195
+ set logs(logs: LogHandlerPlain);
196
+ getShowLogs(): boolean;
197
+ setShowLogs(show: boolean): Configuration;
198
+ getLogHandler(): LogHandlerPlain;
199
+ setLogHandler(handler: LogHandlerPlain): Configuration;
200
+ get debugScreenshots(): { save: boolean; path?: string; prefix?: string; };
201
+ set debugScreenshots(debugScreenshots: { save: boolean; path?: string; prefix?: string; });
202
+ getSaveDebugScreenshots(): boolean;
203
+ setSaveDebugScreenshots(save: boolean): Configuration;
204
+ getDebugScreenshotsPath(): string;
205
+ setDebugScreenshotsPath(path: string): Configuration;
206
+ getDebugScreenshotsPrefix(): string;
207
+ setDebugScreenshotsPrefix(prefix: string): Configuration;
208
+ get appName(): string;
209
+ set appName(appName: string);
210
+ getAppName(): string;
211
+ setAppName(appName: string): Configuration;
212
+ get testName(): string;
213
+ set testName(testName: string);
214
+ getTestName(): string;
215
+ setTestName(testName: string): Configuration;
216
+ get displayName(): string;
217
+ set displayName(displayName: string);
218
+ getDisplayName(): string;
219
+ setDisplayName(displayName: string): Configuration;
220
+ get isDisabled(): boolean;
221
+ set isDisabled(isDisabled: boolean);
222
+ getIsDisabled(): boolean;
223
+ setIsDisabled(isDisabled: boolean): Configuration;
224
+ get matchTimeout(): number;
225
+ set matchTimeout(matchTimeout: number);
226
+ getMatchTimeout(): number;
227
+ setMatchTimeout(matchTimeout: number): Configuration;
228
+ get sessionType(): SessionTypePlain;
229
+ set sessionType(sessionType: SessionTypePlain);
230
+ getSessionType(): SessionType;
231
+ setSessionType(sessionType: SessionTypePlain): Configuration;
232
+ get viewportSize(): RectangleSizePlain;
233
+ set viewportSize(viewportSize: RectangleSizePlain);
234
+ getViewportSize(): RectangleSize;
235
+ setViewportSize(viewportSize: RectangleSizePlain): Configuration;
236
+ get agentId(): string;
237
+ set agentId(agentId: string);
238
+ getAgentId(): string;
239
+ setAgentId(agentId: string): Configuration;
240
+ get apiKey(): string;
241
+ set apiKey(apiKey: string);
242
+ getApiKey(): string;
243
+ setApiKey(apiKey: string): Configuration;
244
+ get serverUrl(): string;
245
+ set serverUrl(serverUrl: string);
246
+ getServerUrl(): string;
247
+ setServerUrl(serverUrl: string): Configuration;
248
+ get proxy(): ProxySettingsPlain;
249
+ set proxy(proxy: ProxySettingsPlain);
250
+ getProxy(): ProxySettings;
251
+ setProxy(proxy: ProxySettingsPlain): Configuration;
252
+ setProxy(url: string, username: string, password: string, isHttpOnly: boolean): Configuration;
253
+ setProxy(isEnabled: false): Configuration;
254
+ get connectionTimeout(): number;
255
+ set connectionTimeout(connectionTimeout: number);
256
+ getConnectionTimeout(): number;
257
+ setConnectionTimeout(connectionTimeout: number): Configuration;
258
+ get removeSession(): boolean;
259
+ set removeSession(removeSession: boolean);
260
+ getRemoveSession(): boolean;
261
+ setRemoveSession(removeSession: boolean): Configuration;
262
+ get remoteEvents(): { serverUrl: string; accessKey?: string; timeout?: number; };
263
+ set remoteEvents(remoteEvents: { serverUrl: string; accessKey?: string; timeout?: number; });
264
+ getRemoteEvents(): { serverUrl: string; accessKey?: string; timeout?: number; };
265
+ setRemoteEvents(remoteEvents: { serverUrl: string; accessKey?: string; timeout?: number; }): Configuration;
266
+ get batch(): BatchInfoPlain;
267
+ set batch(batch: BatchInfoPlain);
268
+ getBatch(): BatchInfo;
269
+ setBatch(batch: BatchInfoPlain): Configuration;
270
+ get properties(): Array<PropertyDataPlain>;
271
+ set properties(properties: Array<PropertyDataPlain>);
272
+ getProperties(): Array<PropertyData>;
273
+ setProperties(properties: Array<PropertyDataPlain>): Configuration;
274
+ addProperty(name: string, value: string): Configuration;
275
+ addProperty(prop: PropertyDataPlain): Configuration;
276
+ clearProperties(): Configuration;
277
+ get baselineEnvName(): string;
278
+ set baselineEnvName(baselineEnvName: string);
279
+ getBaselineEnvName(): string;
280
+ setBaselineEnvName(baselineEnvName: string): Configuration;
281
+ get environmentName(): string;
282
+ set environmentName(environmentName: string);
283
+ getEnvironmentName(): string;
284
+ setEnvironmentName(environmentName: string): Configuration;
285
+ get branchName(): string;
286
+ set branchName(branchName: string);
287
+ getBranchName(): string;
288
+ setBranchName(branchName: string): Configuration;
289
+ get parentBranchName(): string;
290
+ set parentBranchName(parentBranchName: string);
291
+ getParentBranchName(): string;
292
+ setParentBranchName(parentBranchName: string): Configuration;
293
+ get baselineBranchName(): string;
294
+ set baselineBranchName(baselineBranchName: string);
295
+ getBaselineBranchName(): string;
296
+ setBaselineBranchName(baselineBranchName: string): Configuration;
297
+ get compareWithParentBranch(): boolean;
298
+ set compareWithParentBranch(compareWithParentBranch: boolean);
299
+ getCompareWithParentBranch(): boolean;
300
+ setCompareWithParentBranch(compareWithParentBranch: boolean): Configuration;
301
+ get ignoreBaseline(): boolean;
302
+ set ignoreBaseline(ignoreBaseline: boolean);
303
+ getIgnoreBaseline(): boolean;
304
+ setIgnoreBaseline(ignoreBaseline: boolean): Configuration;
305
+ get saveFailedTests(): boolean;
306
+ set saveFailedTests(saveFailedTests: boolean);
307
+ getSaveFailedTests(): boolean;
308
+ setSaveFailedTests(saveFailedTests: boolean): Configuration;
309
+ get saveNewTests(): boolean;
310
+ set saveNewTests(saveNewTests: boolean);
311
+ getSaveNewTests(): boolean;
312
+ setSaveNewTests(saveNewTests: boolean): Configuration;
313
+ get saveDiffs(): boolean;
314
+ set saveDiffs(saveDiffs: boolean);
315
+ getSaveDiffs(): boolean;
316
+ setSaveDiffs(saveDiffs: boolean): Configuration;
317
+ get sendDom(): boolean;
318
+ set sendDom(sendDom: boolean);
319
+ getSendDom(): boolean;
320
+ setSendDom(sendDom: boolean): Configuration;
321
+ get hostApp(): string;
322
+ set hostApp(hostApp: string);
323
+ getHostApp(): string;
324
+ setHostApp(hostApp: string): Configuration;
325
+ get hostOS(): string;
326
+ set hostOS(hostOS: string);
327
+ getHostOS(): string;
328
+ setHostOS(hostOS: string): Configuration;
329
+ get hostAppInfo(): string;
330
+ set hostAppInfo(hostAppInfo: string);
331
+ getHostAppInfo(): string;
332
+ setHostAppInfo(hostAppInfo: string): Configuration;
333
+ get hostOSInfo(): string;
334
+ set hostOSInfo(hostOSInfo: string);
335
+ getHostOSInfo(): string;
336
+ setHostOSInfo(hostOSInfo: string): Configuration;
337
+ get deviceInfo(): string;
338
+ set deviceInfo(deviceInfo: string);
339
+ getDeviceInfo(): string;
340
+ setDeviceInfo(deviceInfo: string): Configuration;
341
+ get defaultMatchSettings(): ImageMatchSettingsPlain;
342
+ set defaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain);
343
+ getDefaultMatchSettings(): ImageMatchSettingsPlain;
344
+ setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain): Configuration;
345
+ getMatchLevel(): MatchLevel;
346
+ setMatchLevel(matchLevel: MatchLevelPlain): Configuration;
347
+ getAccessibilityValidation(): AccessibilitySettings;
348
+ setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): Configuration;
349
+ getUseDom(): boolean;
350
+ setUseDom(useDom: boolean): Configuration;
351
+ getEnablePatterns(): boolean;
352
+ setEnablePatterns(enablePatterns: boolean): Configuration;
353
+ getIgnoreDisplacements(): boolean;
354
+ setIgnoreDisplacements(ignoreDisplacements: boolean): Configuration;
355
+ getIgnoreCaret(): boolean;
356
+ setIgnoreCaret(ignoreCaret: boolean): Configuration;
357
+ get forceFullPageScreenshot(): boolean;
358
+ set forceFullPageScreenshot(forceFullPageScreenshot: boolean);
359
+ getForceFullPageScreenshot(): boolean;
360
+ setForceFullPageScreenshot(forceFullPageScreenshot: boolean): Configuration;
361
+ get waitBeforeScreenshots(): number;
362
+ set waitBeforeScreenshots(waitBeforeScreenshots: number);
363
+ getWaitBeforeScreenshots(): number;
364
+ setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration;
365
+ get waitBeforeCapture(): number;
366
+ set waitBeforeCapture(waitBeforeCapture: number);
367
+ getWaitBeforeCapture(): number;
368
+ setWaitBeforeCapture(waitBeforeCapture: number): Configuration;
369
+ get stitchMode(): StitchModePlain;
370
+ set stitchMode(stitchMode: StitchModePlain);
371
+ getStitchMode(): StitchMode;
372
+ setStitchMode(stitchMode: StitchModePlain): Configuration;
373
+ get hideScrollbars(): boolean;
374
+ set hideScrollbars(hideScrollbars: boolean);
375
+ getHideScrollbars(): boolean;
376
+ setHideScrollbars(hideScrollbars: boolean): Configuration;
377
+ get hideCaret(): boolean;
378
+ set hideCaret(hideCaret: boolean);
379
+ getHideCaret(): boolean;
380
+ setHideCaret(hideCaret: boolean): Configuration;
381
+ get stitchOverlap(): number;
382
+ set stitchOverlap(stitchOverlap: number);
383
+ getStitchOverlap(): number;
384
+ setStitchOverlap(stitchOverlap: number): Configuration;
385
+ get scrollRootElement(): Element | EyesSelector<Selector>;
386
+ set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
387
+ getScrollRootElement(): Element | EyesSelector<Selector>;
388
+ setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): Configuration;
389
+ get cut(): CutProviderPlain;
390
+ set cut(cut: CutProviderPlain);
391
+ getCut(): CutProviderPlain;
392
+ setCut(cut: CutProviderPlain): Configuration;
393
+ get rotation(): ImageRotationPlain;
394
+ set rotation(rotation: ImageRotationPlain);
395
+ getRotation(): ImageRotation;
396
+ setRotation(rotation: ImageRotationPlain | ImageRotation): Configuration;
397
+ get scaleRatio(): number;
398
+ set scaleRatio(scaleRatio: number);
399
+ getScaleRatio(): number;
400
+ setScaleRatio(scaleRatio: number): Configuration;
401
+ get concurrentSessions(): number;
402
+ set concurrentSessions(concurrentSessions: number);
403
+ getConcurrentSessions(): number;
404
+ setConcurrentSessions(concurrentSessions: number): Configuration;
405
+ get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>;
406
+ set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>);
407
+ getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>;
408
+ setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
409
+ addBrowsers(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
410
+ addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }): Configuration;
411
+ addBrowser(width: number, height: number, name: BrowserTypePlain): Configuration;
412
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation: ScreenOrientationPlain): Configuration;
413
+ get visualGridOptions(): { [key: string]: any; };
414
+ set visualGridOptions(visualGridOptions: { [key: string]: any; });
415
+ getVisualGridOptions(): { [key: string]: any; };
416
+ setVisualGridOptions(visualGridOptions: { [key: string]: any; }): Configuration;
417
+ setVisualGridOption(key: string, value: any): Configuration;
418
+ get layoutBreakpoints(): boolean | Array<number>;
419
+ set layoutBreakpoints(layoutBreakpoints: boolean | Array<number>);
420
+ getLayoutBreakpoints(): boolean | Array<number>;
421
+ setLayoutBreakpoints(layoutBreakpoints: boolean | Array<number>): Configuration;
422
+ get disableBrowserFetching(): boolean;
423
+ set disableBrowserFetching(disableBrowserFetching: boolean);
424
+ getDisableBrowserFetching(): boolean;
425
+ setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
426
+ get dontCloseBatches(): boolean;
427
+ set dontCloseBatches(dontCloseBatches: boolean);
428
+ getDontCloseBatches(): boolean;
429
+ setDontCloseBatches(dontCloseBatches: boolean): Configuration;
430
+ }
431
+ export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: string; minMatch?: number; language?: string; };
432
+ export type CheckSettingsPlain = {
433
+ name?: string;
434
+ region?: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
435
+ frames?: Array<{ frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); } | (number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>;
436
+ scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; });
437
+ fully?: boolean;
438
+ matchLevel?: MatchLevelPlain;
439
+ useDom?: boolean;
440
+ sendDom?: boolean;
441
+ enablePatterns?: boolean;
442
+ ignoreDisplacements?: boolean;
443
+ ignoreCaret?: boolean;
444
+ ignoreRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
445
+ layoutRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
446
+ strictRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
447
+ contentRegions?: Array<RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))>;
448
+ floatingRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
449
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
450
+ maxUpOffset?: number;
451
+ maxDownOffset?: number;
452
+ maxLeftOffset?: number;
453
+ maxRightOffset?: number;
454
+ }>;
455
+ accessibilityRegions?: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }>;
456
+ disableBrowserFetching?: boolean;
457
+ layoutBreakpoints?: boolean | Array<number>;
458
+ visualGridOptions?: { [key: string]: any; };
459
+ hooks?: { beforeCaptureScreenshot: string; };
460
+ renderId?: string;
461
+ variationGroupId?: string;
462
+ timeout?: number;
463
+ waitBeforeCapture?: number;
464
+ };
465
+ export class CheckSettings {
466
+ constructor(settings: CheckSettingsPlain);
467
+ name(name: string): CheckSettings;
468
+ withName(name: string): CheckSettings;
469
+ region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
470
+ shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
471
+ frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); }): CheckSettings;
472
+ frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
473
+ ignoreRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
474
+ ignoreRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
475
+ ignore(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
476
+ ignores(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
477
+ layoutRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
478
+ layoutRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
479
+ strictRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
480
+ strictRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
481
+ contentRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
482
+ contentRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
483
+ floatingRegion(region: {
484
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
485
+ maxUpOffset?: number;
486
+ maxDownOffset?: number;
487
+ maxLeftOffset?: number;
488
+ maxRightOffset?: number;
489
+ }): CheckSettings;
490
+ floatingRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), maxUpOffset: number, maxDownOffset: number, maxLeftOffset: number, maxRightOffset: number): CheckSettings;
491
+ floatingRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
492
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
493
+ maxUpOffset?: number;
494
+ maxDownOffset?: number;
495
+ maxLeftOffset?: number;
496
+ maxRightOffset?: number;
497
+ }>): CheckSettings;
498
+ floatingRegions(maxOffset: number, regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
499
+ floating(region: {
500
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
501
+ maxUpOffset?: number;
502
+ maxDownOffset?: number;
503
+ maxLeftOffset?: number;
504
+ maxRightOffset?: number;
505
+ }): CheckSettings;
506
+ floating(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
507
+ floatings(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | {
508
+ region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }));
509
+ maxUpOffset?: number;
510
+ maxDownOffset?: number;
511
+ maxLeftOffset?: number;
512
+ maxRightOffset?: number;
513
+ }>): CheckSettings;
514
+ floatings(maxOffset: number, regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
515
+ accessibilityRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }): CheckSettings;
516
+ accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))), type: AccessibilityRegionTypePlain): CheckSettings;
517
+ accessibilityRegions(regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); type?: AccessibilityRegionTypePlain; }>): CheckSettings;
518
+ accessibilityRegions(type: AccessibilityRegionTypePlain, regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))>): CheckSettings;
519
+ scrollRootElement(scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
520
+ fully(fully: boolean): CheckSettings;
521
+ stitchContent(stitchContent: boolean): CheckSettings;
522
+ matchLevel(matchLevel: MatchLevelPlain): CheckSettings;
523
+ layout(): CheckSettings;
524
+ exact(): CheckSettings;
525
+ strict(): CheckSettings;
526
+ content(): CheckSettings;
527
+ useDom(useDom: boolean): CheckSettings;
528
+ sendDom(sendDom: boolean): CheckSettings;
529
+ enablePatterns(enablePatterns: boolean): CheckSettings;
530
+ ignoreDisplacements(ignoreDisplacements: boolean): CheckSettings;
531
+ ignoreCaret(ignoreCaret: boolean): CheckSettings;
532
+ disableBrowserFetching(disableBrowserFetching: boolean): CheckSettings;
533
+ layoutBreakpoints(layoutBreakpoints: boolean | Array<number>): CheckSettings;
534
+ hook(name: string, script: string): CheckSettings;
535
+ beforeRenderScreenshotHook(script: string): CheckSettings;
536
+ webHook(script: string): CheckSettings;
537
+ visualGridOption(key: string, value: any): CheckSettings;
538
+ visualGridOptions(options: { [key: string]: any; }): CheckSettings;
539
+ renderId(renderId: string): CheckSettings;
540
+ variationGroupId(variationGroupId: string): CheckSettings;
541
+ timeout(timeout: number): CheckSettings;
542
+ waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
543
+ }
544
+ export const Target: {
545
+ window(): CheckSettings;
546
+ region(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })))): CheckSettings;
547
+ frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })); scrollRootElement?: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }); }): CheckSettings;
548
+ frame(frame: number | (Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })), scrollRootElement: Element | (string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; })): CheckSettings;
549
+ shadow(selector: string | Selector | { selector: string | Selector; type?: string; shadow?: EyesSelector<Selector>; frame?: EyesSelector<Selector>; }): CheckSettings;
550
+ };
551
+ export class BatchClose {
552
+ static close(settings: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }): Promise<void>;
553
+ constructor(options: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; });
554
+ close(): Promise<void>;
555
+ setBatchIds(batchIds: Array<string>): BatchClose;
556
+ setUrl(serverUrl: string): BatchClose;
557
+ setApiKey(apiKey: string): BatchClose;
558
+ setProxy(proxy: ProxySettingsPlain): BatchClose;
559
+ }
560
+ export type AccessibilityGuidelinesVersionPlain = "WCAG_2_0" | "WCAG_2_1";
1
561
  export enum AccessibilityGuidelinesVersion {
2
- WCAG_2_0 = 'WCAG_2_0',
3
- WCAG_2_1 = 'WCAG_2_1',
562
+ WCAG_2_0 = 'WCAG_2_0',
563
+ WCAG_2_1 = 'WCAG_2_1'
4
564
  }
5
-
565
+ export type AccessibilityLevelPlain = "AA" | "AAA";
6
566
  export enum AccessibilityLevel {
7
- AA = 'AA',
8
- AAA = 'AAA',
567
+ AA = 'AA',
568
+ AAA = 'AAA'
9
569
  }
10
-
570
+ export type AccessibilityRegionTypePlain = "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
11
571
  export enum AccessibilityRegionType {
12
- BoldText = 'BoldText',
13
- GraphicalObject = 'GraphicalObject',
14
- IgnoreContrast = 'IgnoreContrast',
15
- LargeText = 'LargeText',
16
- RegularText = 'RegularText',
572
+ IgnoreContrast = 'IgnoreContrast',
573
+ RegularText = 'RegularText',
574
+ LargeText = 'LargeText',
575
+ BoldText = 'BoldText',
576
+ GraphicalObject = 'GraphicalObject'
17
577
  }
18
-
578
+ export type AccessibilityStatusPlain = "Passed" | "Failed";
19
579
  export enum AccessibilityStatus {
20
- Failed = 'Failed',
21
- Passed = 'Passed',
580
+ Passed = 'Passed',
581
+ Failed = 'Failed'
22
582
  }
23
-
583
+ 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";
24
584
  export enum BrowserType {
25
- CHROME = 'chrome',
26
- CHROME_ONE_VERSION_BACK = 'chrome-one-version-back',
27
- CHROME_TWO_VERSIONS_BACK = 'chrome-two-versions-back',
28
- EDGE = 'edge',
29
- EDGE_CHROMIUM = 'edgechromium',
30
- EDGE_CHROMIUM_ONE_VERSION_BACK = 'edgechromium-one-version-back',
31
- EDGE_CHROMIUM_TWO_VERSIONS_BACK = 'edgechromium-two-versions-back',
32
- EDGE_LEGACY = 'edgelegacy',
33
- FIREFOX = 'firefox',
34
- FIREFOX_ONE_VERSION_BACK = 'firefox-one-version-back',
35
- FIREFOX_TWO_VERSIONS_BACK = 'firefox-two-versions-back',
36
- IE_10 = 'ie10',
37
- IE_11 = 'ie',
38
- SAFARI = 'safari',
39
- SAFARI_EARLY_ACCESS = 'safari-earlyaccess',
40
- SAFARI_ONE_VERSION_BACK = 'safari-one-version-back',
41
- SAFARI_TWO_VERSIONS_BACK = 'safari-two-versions-back',
585
+ CHROME = 'chrome',
586
+ CHROME_ONE_VERSION_BACK = 'chrome-one-version-back',
587
+ CHROME_TWO_VERSIONS_BACK = 'chrome-two-versions-back',
588
+ FIREFOX = 'firefox',
589
+ FIREFOX_ONE_VERSION_BACK = 'firefox-one-version-back',
590
+ FIREFOX_TWO_VERSIONS_BACK = 'firefox-two-versions-back',
591
+ IE_11 = 'ie',
592
+ IE_10 = 'ie10',
593
+ EDGE = 'edge',
594
+ EDGE_CHROMIUM = 'edgechromium',
595
+ EDGE_LEGACY = 'edgelegacy',
596
+ EDGE_CHROMIUM_ONE_VERSION_BACK = 'edgechromium-one-version-back',
597
+ EDGE_CHROMIUM_TWO_VERSIONS_BACK = 'edgechromium-two-versions-back',
598
+ SAFARI = 'safari',
599
+ SAFARI_EARLY_ACCESS = 'safari-earlyaccess',
600
+ SAFARI_ONE_VERSION_BACK = 'safari-one-version-back',
601
+ SAFARI_TWO_VERSIONS_BACK = 'safari-two-versions-back'
42
602
  }
43
-
44
- /** @undocumented */
603
+ export type CorsIframeHandlePlain = "BLANK" | "KEEP" | "SNAPSHOT";
45
604
  export enum CorsIframeHandle {
46
- BLANK = 'BLANK',
47
- KEEP = 'KEEP',
48
- SNAPSHOT = 'SNAPSHOT',
605
+ BLANK = 'BLANK',
606
+ KEEP = 'KEEP',
607
+ SNAPSHOT = 'SNAPSHOT'
49
608
  }
50
-
609
+ 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" | "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";
51
610
  export enum DeviceName {
52
- BlackBerry_Z30 = 'BlackBerry Z30',
53
- Blackberry_PlayBook = 'Blackberry PlayBook',
54
- Galaxy_A5 = 'Galaxy A5',
55
- Galaxy_Note_10 = 'Galaxy Note 10',
56
- Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus',
57
- Galaxy_Note_2 = 'Galaxy Note 2',
58
- Galaxy_Note_3 = 'Galaxy Note 3',
59
- Galaxy_Note_4 = 'Galaxy Note 4',
60
- Galaxy_Note_8 = 'Galaxy Note 8',
61
- Galaxy_Note_9 = 'Galaxy Note 9',
62
- Galaxy_S10 = 'Galaxy S10',
63
- Galaxy_S10_Plus = 'Galaxy S10 Plus',
64
- Galaxy_S20 = 'Galaxy S20',
65
- Galaxy_S3 = 'Galaxy S3',
66
- Galaxy_S5 = 'Galaxy S5',
67
- Galaxy_S8 = 'Galaxy S8',
68
- Galaxy_S8_Plus = 'Galaxy S8 Plus',
69
- Galaxy_S9 = 'Galaxy S9',
70
- Galaxy_S9_Plus = 'Galaxy S9 Plus',
71
- Kindle_Fire_HDX = 'Kindle Fire HDX',
72
- LG_G6 = 'LG G6',
73
- LG_Optimus_L70 = 'LG Optimus L70',
74
- Laptop_with_HiDPI_screen = 'Laptop with HiDPI screen',
75
- Laptop_with_MDPI_screen = 'Laptop with MDPI screen',
76
- Laptop_with_touch = 'Laptop with touch',
77
- Microsoft_Lumia_550 = 'Microsoft Lumia 550',
78
- Microsoft_Lumia_950 = 'Microsoft Lumia 950',
79
- Nexus_10 = 'Nexus 10',
80
- Nexus_4 = 'Nexus 4',
81
- Nexus_5 = 'Nexus 5',
82
- Nexus_5X = 'Nexus 5X',
83
- Nexus_6 = 'Nexus 6',
84
- Nexus_6P = 'Nexus 6P',
85
- Nexus_7 = 'Nexus 7',
86
- Nokia_Lumia_520 = 'Nokia Lumia 520',
87
- Nokia_N9 = 'Nokia N9',
88
- OnePlus_7T = 'OnePlus 7T',
89
- OnePlus_7T_Pro = 'OnePlus 7T Pro',
90
- Pixel_2 = 'Pixel 2',
91
- Pixel_2_XL = 'Pixel 2 XL',
92
- Pixel_3 = 'Pixel 3',
93
- Pixel_3_XL = 'Pixel 3 XL',
94
- Pixel_4 = 'Pixel 4',
95
- Pixel_4_XL = 'Pixel 4 XL',
96
- Pixel_5 = 'Pixel 5',
97
- iPad = 'iPad',
98
- iPad_6th_Gen = 'iPad 6th Gen',
99
- iPad_7th_Gen = 'iPad 7th Gen',
100
- iPad_Air_2 = 'iPad Air 2',
101
- iPad_Mini = 'iPad Mini',
102
- iPad_Pro = 'iPad Pro',
103
- iPhone_11 = 'iPhone 11',
104
- iPhone_11_Pro = 'iPhone 11 Pro',
105
- iPhone_11_Pro_Max = 'iPhone 11 Pro Max',
106
- iPhone_4 = 'iPhone 4',
107
- iPhone_5SE = 'iPhone 5/SE',
108
- iPhone_6_7_8 = 'iPhone 6/7/8',
109
- iPhone_6_7_8_Plus = 'iPhone 6/7/8 Plus',
110
- iPhone_X = 'iPhone X',
111
- iPhone_XR = 'iPhone XR',
112
- iPhone_XS = 'iPhone XS',
113
- iPhone_XS_Max = 'iPhone XS Max',
611
+ Blackberry_PlayBook = 'Blackberry PlayBook',
612
+ BlackBerry_Z30 = 'BlackBerry Z30',
613
+ Galaxy_A5 = 'Galaxy A5',
614
+ Galaxy_Note_10 = 'Galaxy Note 10',
615
+ Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus',
616
+ Galaxy_Note_2 = 'Galaxy Note 2',
617
+ Galaxy_Note_3 = 'Galaxy Note 3',
618
+ Galaxy_Note_4 = 'Galaxy Note 4',
619
+ Galaxy_Note_8 = 'Galaxy Note 8',
620
+ Galaxy_Note_9 = 'Galaxy Note 9',
621
+ Galaxy_S3 = 'Galaxy S3',
622
+ Galaxy_S5 = 'Galaxy S5',
623
+ Galaxy_S8 = 'Galaxy S8',
624
+ Galaxy_S8_Plus = 'Galaxy S8 Plus',
625
+ Galaxy_S9 = 'Galaxy S9',
626
+ Galaxy_S9_Plus = 'Galaxy S9 Plus',
627
+ Galaxy_S10 = 'Galaxy S10',
628
+ Galaxy_S10_Plus = 'Galaxy S10 Plus',
629
+ Galaxy_S20 = 'Galaxy S20',
630
+ iPad = 'iPad',
631
+ iPad_6th_Gen = 'iPad 6th Gen',
632
+ iPad_7th_Gen = 'iPad 7th Gen',
633
+ iPad_Air_2 = 'iPad Air 2',
634
+ iPad_Mini = 'iPad Mini',
635
+ iPad_Pro = 'iPad Pro',
636
+ iPhone_11 = 'iPhone 11',
637
+ iPhone_11_Pro = 'iPhone 11 Pro',
638
+ iPhone_11_Pro_Max = 'iPhone 11 Pro Max',
639
+ iPhone_4 = 'iPhone 4',
640
+ iPhone_5SE = 'iPhone 5/SE',
641
+ iPhone_6_7_8 = 'iPhone 6/7/8',
642
+ iPhone_6_7_8_Plus = 'iPhone 6/7/8 Plus',
643
+ iPhone_X = 'iPhone X',
644
+ iPhone_XR = 'iPhone XR',
645
+ iPhone_XS = 'iPhone XS',
646
+ iPhone_XS_Max = 'iPhone XS Max',
647
+ Kindle_Fire_HDX = 'Kindle Fire HDX',
648
+ Laptop_with_HiDPI_screen = 'Laptop with HiDPI screen',
649
+ Laptop_with_MDPI_screen = 'Laptop with MDPI screen',
650
+ Laptop_with_touch = 'Laptop with touch',
651
+ LG_G6 = 'LG G6',
652
+ LG_Optimus_L70 = 'LG Optimus L70',
653
+ Microsoft_Lumia_550 = 'Microsoft Lumia 550',
654
+ Microsoft_Lumia_950 = 'Microsoft Lumia 950',
655
+ Nexus_10 = 'Nexus 10',
656
+ Nexus_4 = 'Nexus 4',
657
+ Nexus_5 = 'Nexus 5',
658
+ Nexus_5X = 'Nexus 5X',
659
+ Nexus_6 = 'Nexus 6',
660
+ Nexus_6P = 'Nexus 6P',
661
+ Nexus_7 = 'Nexus 7',
662
+ Nokia_Lumia_520 = 'Nokia Lumia 520',
663
+ Nokia_N9 = 'Nokia N9',
664
+ OnePlus_7T = 'OnePlus 7T',
665
+ OnePlus_7T_Pro = 'OnePlus 7T Pro',
666
+ Pixel_2 = 'Pixel 2',
667
+ Pixel_2_XL = 'Pixel 2 XL',
668
+ Pixel_3 = 'Pixel 3',
669
+ Pixel_3_XL = 'Pixel 3 XL',
670
+ Pixel_4 = 'Pixel 4',
671
+ Pixel_4_XL = 'Pixel 4 XL',
672
+ Pixel_5 = 'Pixel 5'
114
673
  }
115
-
674
+ export type FailureReportPlain = "IMMEDIATE" | "ON_CLOSE";
116
675
  export enum FailureReport {
117
- IMMEDIATE = 'IMMEDIATE',
118
- ON_CLOSE = 'ON_CLOSE',
676
+ IMMEDIATE = 'IMMEDIATE',
677
+ ON_CLOSE = 'ON_CLOSE'
119
678
  }
120
-
679
+ export type IosDeviceNamePlain = "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 7" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)";
121
680
  export enum IosDeviceName {
122
- iPad_7 = 'iPad (7th generation)',
123
- iPad_Air_2 = 'iPad Air (2nd generation)',
124
- iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)',
125
- iPhone_11 = 'iPhone 11',
126
- iPhone_11_Pro = 'iPhone 11 Pro',
127
- iPhone_11_Pro_Max = 'iPhone 11 Pro Max',
128
- iPhone_12 = 'iPhone 12',
129
- iPhone_12_Pro = 'iPhone 12 Pro',
130
- iPhone_12_Pro_Max = 'iPhone 12 Pro Max',
131
- iPhone_12_mini = 'iPhone 12 mini',
132
- iPhone_7 = 'iPhone 7',
133
- iPhone_8 = 'iPhone 8',
134
- iPhone_X = 'iPhone X',
135
- iPhone_XR = 'iPhone XR',
136
- iPhone_XS = 'iPhone Xs',
681
+ iPhone_13_Pro_Max = 'iPhone 13 Pro Max',
682
+ iPhone_13_Pro = 'iPhone 13 Pro',
683
+ iPhone_13 = 'iPhone 13',
684
+ iPhone_12_Pro_Max = 'iPhone 12 Pro Max',
685
+ iPhone_12_Pro = 'iPhone 12 Pro',
686
+ iPhone_12 = 'iPhone 12',
687
+ iPhone_12_mini = 'iPhone 12 mini',
688
+ iPhone_11_Pro = 'iPhone 11 Pro',
689
+ iPhone_11_Pro_Max = 'iPhone 11 Pro Max',
690
+ iPhone_11 = 'iPhone 11',
691
+ iPhone_XR = 'iPhone XR',
692
+ iPhone_XS = 'iPhone Xs',
693
+ iPhone_X = 'iPhone X',
694
+ iPhone_8 = 'iPhone 8',
695
+ iPhone_7 = 'iPhone 7',
696
+ iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)',
697
+ iPad_7 = 'iPad (7th generation)',
698
+ iPad_9 = 'iPad (9th generation)',
699
+ iPad_Air_2 = 'iPad Air (2nd generation)'
137
700
  }
138
-
701
+ export type IosVersionPlain = "latest" | "latest-1";
139
702
  export enum IosVersion {
140
- LATEST = 'latest',
141
- /** @deprecated */
142
- LATEST_ONE_VERSION_BACK = 'latest-1',
143
- ONE_VERSION_BACK = 'latest-1',
703
+ LATEST = 'latest',
704
+ ONE_VERSION_BACK = 'latest-1',
705
+ LATEST_ONE_VERSION_BACK = 'latest-1'
144
706
  }
145
-
707
+ export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "Strict" | "Exact";
146
708
  export enum MatchLevel {
147
- Content = 'Content',
148
- Exact = 'Exact',
149
- Layout = 'Layout',
150
- Layout2 = 'Layout2',
151
- LegacyLayout = 'Layout1',
152
- None = 'None',
153
- Strict = 'Strict',
709
+ None = 'None',
710
+ LegacyLayout = 'Layout1',
711
+ Layout = 'Layout',
712
+ Layout2 = 'Layout2',
713
+ Content = 'Content',
714
+ Strict = 'Strict',
715
+ Exact = 'Exact'
154
716
  }
155
-
717
+ export type ScreenOrientationPlain = "portrait" | "landscape";
156
718
  export enum ScreenOrientation {
157
- LANDSCAPE = 'landscape',
158
- PORTRAIT = 'portrait',
719
+ PORTRAIT = 'portrait',
720
+ LANDSCAPE = 'landscape'
159
721
  }
160
-
722
+ export type SessionTypePlain = "SEQUENTIAL" | "PROGRESSION";
161
723
  export enum SessionType {
162
- PROGRESSION = 'PROGRESSION',
163
- SEQUENTIAL = 'SEQUENTIAL',
724
+ SEQUENTIAL = 'SEQUENTIAL',
725
+ PROGRESSION = 'PROGRESSION'
164
726
  }
165
-
727
+ export type StitchModePlain = "Scroll" | "CSS";
166
728
  export enum StitchMode {
167
- CSS = 'CSS',
168
- SCROLL = 'Scroll',
729
+ SCROLL = 'Scroll',
730
+ CSS = 'CSS'
169
731
  }
170
-
732
+ export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
171
733
  export enum TestResultsStatus {
172
- Failed = 'Failed',
173
- Passed = 'Passed',
174
- Unresolved = 'Unresolved',
734
+ Passed = 'Passed',
735
+ Unresolved = 'Unresolved',
736
+ Failed = 'Failed'
175
737
  }
176
-
177
- export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
178
- constructor(settings: AccessibilityMatchSettingsPlain);
179
- constructor(region: RegionPlain);
180
- constructor(
181
- x: number,
182
- y: number,
183
- width: number,
184
- height: number,
185
- type?: 'IgnoreContrast' | 'RegularText' | 'LargeText' | 'BoldText' | 'GraphicalObject',
186
- );
187
- get region(): RegionPlain;
188
- set region(region: RegionPlain);
189
- get type(): 'IgnoreContrast' | 'RegularText' | 'LargeText' | 'BoldText' | 'GraphicalObject';
190
- set type(type: 'IgnoreContrast' | 'RegularText' | 'LargeText' | 'BoldText' | 'GraphicalObject');
191
- getHeight(): number;
192
- getLeft(): number;
193
- getRegion(): Region;
194
- getTop(): number;
195
- getType(): AccessibilityRegionType;
196
- getWidth(): number;
197
- setHeight(height: number): void;
198
- setLeft(left: number): void;
199
- setRegion(region: RegionPlain): void;
200
- setTop(top: number): void;
201
- setType(type: AccessibilityRegionTypePlain): void;
202
- setWidth(width: number): void;
738
+ export class EyesError extends Error {
203
739
  }
204
-
205
- export class ApiUrls implements Required<ApiUrlsPlain> {
206
- get baselineImage(): string;
207
- get checkpointImage(): string;
208
- get checkpointImageThumbnail(): string;
209
- get currentImage(): string;
210
- get diffImage(): string;
211
- getBaselineImage(): string;
212
- getCheckpointImage(): string;
213
- getCheckpointImageThumbnail(): string;
214
- getCurrentImage(): string;
215
- getDiffImage(): string;
216
- /** @deprecated */
217
- setBaselineImage(setBaselineImage: string): void;
218
- /** @deprecated */
219
- setCheckpointImage(checkpointImage: string): void;
220
- /** @deprecated */
221
- setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
222
- /** @deprecated */
223
- setCurrentImage(currentImage: string): void;
224
- /** @deprecated */
225
- setDiffImage(diffImage: string): void;
226
- }
227
-
228
- export class AppUrls implements Required<AppUrlsPlain> {
229
- get step(): string;
230
- get stepEditor(): string;
231
- getStep(): string;
232
- getStepEditor(): string;
233
- /** @deprecated */
234
- setStep(step: string): void;
235
- /** @deprecated */
236
- setStepEditor(stepEditor: string): void;
740
+ export class TestFailedError extends EyesError {
741
+ constructor(message: string, results: TestResultsPlain);
742
+ constructor(results: TestResultsPlain);
743
+ get testResults(): TestResultsPlain;
744
+ getTestResults(): TestResults;
237
745
  }
238
-
239
- export class BatchClose {
240
- constructor(options?: {batchIds: string[]; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain});
241
- close(): Promise<void>;
242
- setApiKey(apiKey: string): this;
243
- setBatchIds(batchIds: string[]): this;
244
- setProxy(proxy: ProxySettingsPlain): this;
245
- setUrl(serverUrl: string): this;
246
- static close(options: {
247
- batchIds: string[];
248
- serverUrl?: string;
249
- apiKey?: string;
250
- proxy?: ProxySettingsPlain;
251
- }): Promise<void>;
746
+ export class DiffsFoundError extends TestFailedError {
747
+ constructor(message: string, results: TestResultsPlain);
748
+ constructor(results: TestResultsPlain);
252
749
  }
253
-
254
- export class BatchInfo implements Required<BatchInfoPlain> {
255
- constructor();
256
- constructor(batch?: BatchInfoPlain);
257
- constructor(name?: string, startedAt?: string | Date, id?: string);
258
- get id(): string;
259
- set id(id: string);
260
- get name(): string;
261
- set name(name: string);
262
- get notifyOnCompletion(): boolean;
263
- set notifyOnCompletion(notifyOnCompletion: boolean);
264
- get properties(): PropertyDataPlain[];
265
- set properties(properties: PropertyDataPlain[]);
266
- get sequenceName(): string;
267
- set sequenceName(sequenceName: string);
268
- get startedAt(): string | Date;
269
- set startedAt(startedAt: string | Date);
270
- addProperty(property: PropertyDataPlain): this;
271
- getId(): string;
272
- getName(): string;
273
- getNotifyOnCompletion(): boolean;
274
- getProperties(): PropertyData[];
275
- getSequenceName(): string;
276
- getStartedAt(): Date | string;
277
- setId(id: string): this;
278
- setName(name: string): this;
279
- setNotifyOnCompletion(notifyOnCompletion: boolean): this;
280
- setProperties(properties: PropertyDataPlain[]): this;
281
- setSequenceName(sequenceName: string): this;
282
- setStartedAt(startedAt: Date): this;
283
- setStartedAt(startedAt: string): this;
750
+ export class NewTestError extends TestFailedError {
751
+ constructor(message: string, results: TestResultsPlain);
752
+ constructor(results: TestResultsPlain);
284
753
  }
285
-
286
- export class CheckSettings {
287
- constructor(settings?: CheckSettingsPlain);
288
- accessibilityRegion(region: {
289
- region: RegionPlain | Element | EyesSelector<Selector>;
290
- type?: AccessibilityRegionTypePlain;
291
- }): this;
292
- accessibilityRegion(region: RegionPlain, type?: AccessibilityRegionTypePlain): this;
293
- accessibilityRegion(region: Element, type?: AccessibilityRegionTypePlain): this;
294
- accessibilityRegion(region: EyesSelector<Selector>, type?: AccessibilityRegionTypePlain): this;
295
- accessibilityRegion(region: LegacyRegionPlain, type?: AccessibilityRegionTypePlain): this;
296
- accessibilityRegions(
297
- ...regions: (
298
- | {region: RegionPlain | Element | EyesSelector<Selector>; type?: AccessibilityRegionTypePlain}
299
- | RegionPlain
300
- | Element
301
- | EyesSelector<Selector>
302
- | LegacyRegionPlain
303
- )[]
304
- ): this;
305
- accessibilityRegions(
306
- type: AccessibilityRegionTypePlain,
307
- ...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]
308
- ): this;
309
- beforeRenderScreenshotHook(script: string): this;
310
- content(): this;
311
- contentRegion(region: RegionPlain): this;
312
- contentRegion(region: Element): this;
313
- contentRegion(region: EyesSelector<Selector>): this;
314
- contentRegion(region: LegacyRegionPlain): this;
315
- contentRegions(...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]): this;
316
- disableBrowserFetching(disableBrowserFetching: boolean): this;
317
- enablePatterns(enablePatterns?: boolean): this;
318
- exact(): this;
319
- /** @deprecated */
320
- floating(region: {
321
- region: RegionPlain | Element | EyesSelector<Selector>;
322
- maxUpOffset?: number;
323
- maxDownOffset?: number;
324
- maxLeftOffset?: number;
325
- maxRightOffset?: number;
326
- }): this;
327
- /** @deprecated */
328
- floating(region: RegionPlain): this;
329
- /** @deprecated */
330
- floating(region: Element): this;
331
- /** @deprecated */
332
- floating(region: EyesSelector<Selector>): this;
333
- /** @deprecated */
334
- floating(region: LegacyRegionPlain): this;
335
- floatingRegion(region: {
336
- region: RegionPlain | Element | EyesSelector<Selector>;
337
- maxUpOffset?: number;
338
- maxDownOffset?: number;
339
- maxLeftOffset?: number;
340
- maxRightOffset?: number;
341
- }): this;
342
- floatingRegion(
343
- region: RegionPlain,
344
- maxUpOffset?: number,
345
- maxDownOffset?: number,
346
- maxLeftOffset?: number,
347
- maxRightOffset?: number,
348
- ): this;
349
- floatingRegion(
350
- region: Element,
351
- maxUpOffset?: number,
352
- maxDownOffset?: number,
353
- maxLeftOffset?: number,
354
- maxRightOffset?: number,
355
- ): this;
356
- floatingRegion(
357
- region: EyesSelector<Selector>,
358
- maxUpOffset?: number,
359
- maxDownOffset?: number,
360
- maxLeftOffset?: number,
361
- maxRightOffset?: number,
362
- ): this;
363
- floatingRegion(
364
- region: LegacyRegionPlain,
365
- maxUpOffset?: number,
366
- maxDownOffset?: number,
367
- maxLeftOffset?: number,
368
- maxRightOffset?: number,
369
- ): this;
370
- floatingRegions(
371
- ...regions: (
372
- | {
373
- region: RegionPlain | Element | EyesSelector<Selector>;
374
- maxUpOffset?: number;
375
- maxDownOffset?: number;
376
- maxLeftOffset?: number;
377
- maxRightOffset?: number;
378
- }
379
- | RegionPlain
380
- | Element
381
- | EyesSelector<Selector>
382
- | LegacyRegionPlain
383
- )[]
384
- ): this;
385
- floatingRegions(
386
- maxOffset: number,
387
- ...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]
388
- ): this;
389
- /** @deprecated */
390
- floatings(
391
- ...regions: (
392
- | {
393
- region: RegionPlain | Element | EyesSelector<Selector>;
394
- maxUpOffset?: number;
395
- maxDownOffset?: number;
396
- maxLeftOffset?: number;
397
- maxRightOffset?: number;
398
- }
399
- | RegionPlain
400
- | Element
401
- | EyesSelector<Selector>
402
- | LegacyRegionPlain
403
- )[]
404
- ): this;
405
- /** @deprecated */
406
- floatings(
407
- maxOffset: number,
408
- ...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]
409
- ): this;
410
- frame(context: {
411
- frame: Element | EyesSelector<Selector> | string | number;
412
- scrollRootElement?: Element | EyesSelector<Selector>;
413
- }): this;
414
- frame(frame: Element, scrollRootElement?: Element): this;
415
- frame(frame: Element, scrollRootElement?: EyesSelector<Selector>): this;
416
- frame(frame: EyesSelector<Selector>, scrollRootElement?: Element): this;
417
- frame(frame: EyesSelector<Selector>, scrollRootElement?: EyesSelector<Selector>): this;
418
- frame(frame: string, scrollRootElement?: Element): this;
419
- frame(frame: string, scrollRootElement?: EyesSelector<Selector>): this;
420
- frame(frame: number, scrollRootElement?: Element): this;
421
- frame(frame: number, scrollRootElement?: EyesSelector<Selector>): this;
422
- fully(fully?: boolean): this;
423
- hook(name: string, script: string): this;
424
- /** @deprecated */
425
- ignore(region: RegionPlain): this;
426
- /** @deprecated */
427
- ignore(region: Element): this;
428
- /** @deprecated */
429
- ignore(region: EyesSelector<Selector>): this;
430
- /** @deprecated */
431
- ignore(region: LegacyRegionPlain): this;
432
- ignoreCaret(ignoreCaret?: boolean): this;
433
- ignoreDisplacements(ignoreDisplacements?: boolean): this;
434
- ignoreRegion(region: RegionPlain): this;
435
- ignoreRegion(region: Element): this;
436
- ignoreRegion(region: EyesSelector<Selector>): this;
437
- ignoreRegion(region: LegacyRegionPlain): this;
438
- ignoreRegions(...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]): this;
439
- /** @deprecated */
440
- ignores(...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]): this;
441
- layout(): this;
442
- layoutBreakpoints(layoutBreakpoints?: boolean): this;
443
- layoutBreakpoints(layoutBreakpoints?: number[]): this;
444
- layoutRegion(region: RegionPlain): this;
445
- layoutRegion(region: Element): this;
446
- layoutRegion(region: EyesSelector<Selector>): this;
447
- layoutRegion(region: LegacyRegionPlain): this;
448
- layoutRegions(...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]): this;
449
- matchLevel(matchLevel: MatchLevelPlain): this;
450
- /** @undocumented */
451
- name(name: string): this;
452
- region(region: RegionPlain): this;
453
- region(region: Element): this;
454
- region(region: EyesSelector<Selector>): this;
455
- region(region: LegacyRegionPlain): this;
456
- renderId(renderId: string): this;
457
- scrollRootElement(scrollRootElement: Element): this;
458
- scrollRootElement(scrollRootElement: EyesSelector<Selector>): this;
459
- sendDom(sendDom?: boolean): this;
460
- shadow(selector: EyesSelector<Selector>): this;
461
- /** @deprecated */
462
- stitchContent(stitchContent?: boolean): this;
463
- strict(): this;
464
- strictRegion(region: RegionPlain): this;
465
- strictRegion(region: Element): this;
466
- strictRegion(region: EyesSelector<Selector>): this;
467
- strictRegion(region: LegacyRegionPlain): this;
468
- strictRegions(...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]): this;
469
- timeout(timeout: number): this;
470
- useDom(useDom?: boolean): this;
471
- variationGroupId(variationGroupId: string): this;
472
- visualGridOption(key: string, value: any): this;
473
- visualGridOptions(options: {[key: string]: any}): this;
474
- /** @deprecated */
475
- webHook(script: string): this;
476
- withName(name: string): this;
754
+ export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: AccessibilityRegionTypePlain; };
755
+ export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
756
+ constructor(settings: AccessibilityMatchSettingsPlain);
757
+ constructor(region: RegionPlain);
758
+ constructor(x: number, y: number, width: number, height: number, type: AccessibilityRegionTypePlain);
759
+ get region(): RegionPlain;
760
+ set region(region: RegionPlain);
761
+ getRegion(): Region;
762
+ setRegion(region: RegionPlain): void;
763
+ getLeft(): number;
764
+ setLeft(left: number): void;
765
+ getTop(): number;
766
+ setTop(top: number): void;
767
+ getWidth(): number;
768
+ setWidth(width: number): void;
769
+ getHeight(): number;
770
+ setHeight(height: number): void;
771
+ get type(): AccessibilityRegionTypePlain;
772
+ set type(type: AccessibilityRegionTypePlain);
773
+ getType(): AccessibilityRegionType;
774
+ setType(type: AccessibilityRegionTypePlain): void;
477
775
  }
478
-
479
- export class ClassicRunner extends EyesRunner {}
480
-
481
- export class Configuration {
482
- constructor(config?: ConfigurationPlain);
483
- get agentId(): string;
484
- set agentId(agentId: string);
485
- get apiKey(): string;
486
- set apiKey(apiKey: string);
487
- get appName(): string;
488
- set appName(appName: string);
489
- get baselineBranchName(): string;
490
- set baselineBranchName(baselineBranchName: string);
491
- get baselineEnvName(): string;
492
- set baselineEnvName(baselineEnvName: string);
493
- get batch(): BatchInfoPlain;
494
- set batch(batch: BatchInfoPlain);
495
- get branchName(): string;
496
- set branchName(branchName: string);
497
- get browsersInfo(): (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo)[];
498
- set browsersInfo(browsersInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo)[]);
499
- get compareWithParentBranch(): boolean;
500
- set compareWithParentBranch(compareWithParentBranch: boolean);
501
- /** @undocumented */
502
- get concurrentSessions(): number;
503
- /** @undocumented */
504
- set concurrentSessions(concurrentSessions: number);
505
- /** @undocumented */
506
- get connectionTimeout(): number;
507
- /** @undocumented */
508
- set connectionTimeout(connectionTimeout: number);
509
- get cut(): CutProviderPlain;
510
- set cut(cut: CutProviderPlain);
511
- /** @undocumented */
512
- get debugScreenshots(): {save: boolean; path?: string; prefix?: string};
513
- /** @undocumented */
514
- set debugScreenshots(debugScreenshots: {save: boolean; path?: string; prefix?: string});
515
- get defaultMatchSettings(): ImageMatchSettingsPlain;
516
- set defaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain);
517
- get deviceInfo(): string;
518
- set deviceInfo(deviceInfo: string);
519
- get disableBrowserFetching(): boolean;
520
- set disableBrowserFetching(disableBrowserFetching: boolean);
521
- get displayName(): string;
522
- set displayName(displayName: string);
523
- /** @undocumented */
524
- get dontCloseBatches(): boolean;
525
- /** @undocumented */
526
- set dontCloseBatches(dontCloseBatches: boolean);
527
- get environmentName(): string;
528
- set environmentName(environmentName: string);
529
- get forceFullPageScreenshot(): boolean;
530
- set forceFullPageScreenshot(forceFullPageScreenshot: boolean);
531
- get hideCaret(): boolean;
532
- set hideCaret(hideCaret: boolean);
533
- get hideScrollbars(): boolean;
534
- set hideScrollbars(hideScrollbars: boolean);
535
- get hostApp(): string;
536
- set hostApp(hostApp: string);
537
- get hostAppInfo(): string;
538
- set hostAppInfo(hostAppInfo: string);
539
- get hostOS(): string;
540
- set hostOS(hostOS: string);
541
- get hostOSInfo(): string;
542
- set hostOSInfo(hostOSInfo: string);
543
- get ignoreBaseline(): boolean;
544
- set ignoreBaseline(ignoreBaseline: boolean);
545
- get isDisabled(): boolean;
546
- set isDisabled(isDisabled: boolean);
547
- get layoutBreakpoints(): boolean | number[];
548
- set layoutBreakpoints(layoutBreakpoints: boolean | number[]);
549
- /** @undocumented */
550
- get logs(): LogHandlerPlain;
551
- /** @undocumented */
552
- set logs(logs: LogHandlerPlain);
553
- get matchTimeout(): number;
554
- set matchTimeout(matchTimeout: number);
555
- get parentBranchName(): string;
556
- set parentBranchName(parentBranchName: string);
557
- get properties(): PropertyDataPlain[];
558
- set properties(properties: PropertyDataPlain[]);
559
- get proxy(): ProxySettingsPlain;
560
- set proxy(proxy: ProxySettingsPlain);
561
- /** @undocumented */
562
- get remoteEvents(): {accessKey?: string; serverUrl: string; timeout?: number};
563
- /** @undocumented */
564
- set remoteEvents(remoteEvents: {accessKey?: string; serverUrl: string; timeout?: number});
565
- /** @undocumented */
566
- get removeSession(): boolean;
567
- /** @undocumented */
568
- set removeSession(removeSession: boolean);
569
- get rotation(): ImageRotationPlain;
570
- set rotation(rotation: ImageRotationPlain);
571
- get saveDiffs(): boolean;
572
- set saveDiffs(saveDiffs: boolean);
573
- get saveFailedTests(): boolean;
574
- set saveFailedTests(saveFailedTests: boolean);
575
- get saveNewTests(): boolean;
576
- set saveNewTests(saveNewTests: boolean);
577
- get scaleRatio(): number;
578
- set scaleRatio(scaleRatio: number);
579
- get scrollRootElement(): Element | EyesSelector<Selector>;
580
- set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
581
- get sendDom(): boolean;
582
- set sendDom(sendDom: boolean);
583
- get serverUrl(): string;
584
- set serverUrl(serverUrl: string);
585
- get sessionType(): 'SEQUENTIAL' | 'PROGRESSION';
586
- set sessionType(sessionType: 'SEQUENTIAL' | 'PROGRESSION');
587
- get stitchMode(): 'Scroll' | 'CSS';
588
- set stitchMode(stitchMode: 'Scroll' | 'CSS');
589
- get stitchOverlap(): number;
590
- set stitchOverlap(stitchOverlap: number);
591
- get testName(): string;
592
- set testName(testName: string);
593
- get viewportSize(): RectangleSizePlain;
594
- set viewportSize(viewportSize: RectangleSizePlain);
595
- get visualGridOptions(): {[key: string]: any};
596
- set visualGridOptions(visualGridOptions: {[key: string]: any});
597
- get waitBeforeScreenshots(): number;
598
- set waitBeforeScreenshots(waitBeforeScreenshots: number);
599
- addBrowser(browserInfo: DesktopBrowserInfo): this;
600
- addBrowser(browserInfo: ChromeEmulationInfo): this;
601
- addBrowser(browserInfo: IOSDeviceInfo): this;
602
- addBrowser(browserInfo: {deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain}): this;
603
- addBrowser(width: number, height: number, name?: BrowserTypePlain): this;
604
- addBrowsers(
605
- ...browsersInfo: (
606
- | DesktopBrowserInfo
607
- | ChromeEmulationInfo
608
- | IOSDeviceInfo
609
- | {deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain}
610
- )[]
611
- ): this;
612
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): this;
613
- addProperty(name: string, value: string): this;
614
- addProperty(prop: PropertyDataPlain): this;
615
- clearProperties(): this;
616
- getAccessibilityValidation(): AccessibilitySettings;
617
- getAgentId(): string;
618
- getApiKey(): string;
619
- getAppName(): string;
620
- getBaselineBranchName(): string;
621
- getBaselineEnvName(): string;
622
- getBatch(): BatchInfo;
623
- getBranchName(): string;
624
- getBrowsersInfo(): (
625
- | DesktopBrowserInfo
626
- | ChromeEmulationInfo
627
- | IOSDeviceInfo
628
- | {deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain}
629
- )[];
630
- getCompareWithParentBranch(): boolean;
631
- /** @undocumented */
632
- getConcurrentSessions(): number;
633
- /** @undocumented */
634
- getConnectionTimeout(): number;
635
- getCut(): CutProviderPlain;
636
- /** @undocumented */
637
- getDebugScreenshotsPath(): string;
638
- /** @undocumented */
639
- getDebugScreenshotsPrefix(): string;
640
- getDefaultMatchSettings(): ImageMatchSettingsPlain;
641
- getDeviceInfo(): string;
642
- getDisableBrowserFetching(): boolean;
643
- getDisplayName(): string;
644
- /** @undocumented */
645
- getDontCloseBatches(): boolean;
646
- getEnablePatterns(): boolean;
647
- getEnvironmentName(): string;
648
- getForceFullPageScreenshot(): boolean;
649
- getHideCaret(): boolean;
650
- getHideScrollbars(): boolean;
651
- getHostApp(): string;
652
- getHostAppInfo(): string;
653
- getHostOS(): string;
654
- getHostOSInfo(): string;
655
- getIgnoreBaseline(): boolean;
656
- getIgnoreCaret(): boolean;
657
- getIgnoreDisplacements(): boolean;
658
- getIsDisabled(): boolean;
659
- getLayoutBreakpoints(): boolean | number[];
660
- /** @undocumented */
661
- getLogHandler(): LogHandlerPlain;
662
- getMatchLevel(): MatchLevel;
663
- getMatchTimeout(): number;
664
- getParentBranchName(): string;
665
- getProperties(): PropertyData[];
666
- getProxy(): ProxySettings;
667
- /** @undocumented */
668
- getRemoteEvents(): {serverUrl: string; accessKey?: string; timeout?: number};
669
- /** @undocumented */
670
- getRemoveSession(): boolean;
671
- getRotation(): ImageRotation;
672
- /** @undocumented */
673
- getSaveDebugScreenshots(): boolean;
674
- getSaveDiffs(): boolean;
675
- getSaveFailedTests(): boolean;
676
- getSaveNewTests(): boolean;
677
- getScaleRatio(): number;
678
- getScrollRootElement(): Element | EyesSelector<Selector>;
679
- getSendDom(): boolean;
680
- getServerUrl(): string;
681
- getSessionType(): SessionType;
682
- /** @undocumented */
683
- getShowLogs(): boolean;
684
- getStitchMode(): StitchMode;
685
- getStitchOverlap(): number;
686
- getTestName(): string;
687
- getUseDom(): boolean;
688
- getViewportSize(): RectangleSize;
689
- getVisualGridOptions(): {[key: string]: any};
690
- getWaitBeforeScreenshots(): number;
691
- setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): this;
692
- setAgentId(agentId: string): this;
693
- setApiKey(apiKey: string): this;
694
- setAppName(appName: string): this;
695
- setBaselineBranchName(baselineBranchName: string): this;
696
- setBaselineEnvName(baselineEnvName: string): this;
697
- setBatch(batch: BatchInfoPlain): this;
698
- setBranchName(branchName: string): this;
699
- setBrowsersInfo(
700
- browsersInfo: (
701
- | DesktopBrowserInfo
702
- | ChromeEmulationInfo
703
- | IOSDeviceInfo
704
- | {deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain}
705
- )[],
706
- ): this;
707
- setCompareWithParentBranch(compareWithParentBranch: boolean): this;
708
- /** @undocumented */
709
- setConcurrentSessions(concurrentSessions: number): this;
710
- /** @undocumented */
711
- setConnectionTimeout(connectionTimeout: number): this;
712
- setCut(cut: CutProviderPlain): this;
713
- /** @undocumented */
714
- setDebugScreenshotsPath(path: string): this;
715
- /** @undocumented */
716
- setDebugScreenshotsPrefix(prefix: string): this;
717
- setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain): this;
718
- setDeviceInfo(deviceInfo: string): this;
719
- setDisableBrowserFetching(disableBrowserFetching: boolean): this;
720
- setDisplayName(displayName: string): this;
721
- /** @undocumented */
722
- setDontCloseBatches(dontCloseBatches: boolean): this;
723
- setEnablePatterns(enablePatterns: boolean): this;
724
- setEnvironmentName(environmentName: string): this;
725
- setForceFullPageScreenshot(forceFullPageScreenshot: boolean): this;
726
- setHideCaret(hideCaret: boolean): this;
727
- setHideScrollbars(hideScrollbars: boolean): this;
728
- setHostApp(hostApp: string): this;
729
- setHostAppInfo(hostAppInfo: string): this;
730
- setHostOS(hostOS: string): this;
731
- setHostOSInfo(hostOSInfo: string): this;
732
- setIgnoreBaseline(ignoreBaseline: boolean): this;
733
- setIgnoreCaret(ignoreCaret: boolean): this;
734
- setIgnoreDisplacements(ignoreDisplacements: boolean): this;
735
- setIsDisabled(isDisabled: boolean): this;
736
- setLayoutBreakpoints(layoutBreakpoints: boolean): this;
737
- setLayoutBreakpoints(layoutBreakpoints: number[]): this;
738
- /** @undocumented */
739
- setLogHandler(handler: LogHandlerPlain): this;
740
- setMatchLevel(matchLevel: MatchLevelPlain): this;
741
- setMatchTimeout(matchTimeout: number): this;
742
- setParentBranchName(parentBranchName: string): this;
743
- setProperties(properties: PropertyDataPlain[]): this;
744
- setProxy(proxy: ProxySettingsPlain): this;
745
- setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): this;
746
- setProxy(isEnabled: false): this;
747
- /** @undocumented */
748
- setRemoteEvents(remoteEvents: {serverUrl: string; accessKey?: string; timeout?: number}): this;
749
- /** @undocumented */
750
- setRemoveSession(removeSession: boolean): this;
751
- setRotation(rotation: ImageRotationPlain): this;
752
- setRotation(rotation: ImageRotation): this;
753
- /** @undocumented */
754
- setSaveDebugScreenshots(save: boolean): this;
755
- setSaveDiffs(saveDiffs: boolean): this;
756
- setSaveFailedTests(saveFailedTests: boolean): this;
757
- setSaveNewTests(saveNewTests: boolean): this;
758
- setScaleRatio(scaleRatio: number): this;
759
- setScrollRootElement(scrollRootElement: Element): this;
760
- setScrollRootElement(scrollRootElement: EyesSelector<Selector>): this;
761
- setSendDom(sendDom: boolean): this;
762
- setServerUrl(serverUrl: string): this;
763
- setSessionType(sessionType: SessionTypePlain): this;
764
- /** @undocumented */
765
- setShowLogs(show: boolean): this;
766
- setStitchMode(stitchMode: StitchModePlain): this;
767
- setStitchOverlap(stitchOverlap: number): this;
768
- setTestName(testName: string): this;
769
- setUseDom(useDom: boolean): this;
770
- setViewportSize(viewportSize: RectangleSizePlain): this;
771
- setVisualGridOption(key: string, value: any): this;
772
- setVisualGridOptions(visualGridOptions: {[key: string]: any}): this;
773
- setWaitBeforeScreenshots(waitBeforeScreenshots: number): this;
776
+ export type AccessibilitySettings = { level?: AccessibilityLevelPlain; guidelinesVersion?: AccessibilityGuidelinesVersionPlain; };
777
+ export type BatchInfoPlain = {
778
+ id?: string;
779
+ name?: string;
780
+ sequenceName?: string;
781
+ startedAt?: string | Date;
782
+ notifyOnCompletion?: boolean;
783
+ properties?: Array<PropertyDataPlain>;
784
+ };
785
+ export class BatchInfo implements Required<BatchInfoPlain> {
786
+ constructor();
787
+ constructor(batch: BatchInfoPlain);
788
+ constructor(name: string, startedAt: string | Date, id: string);
789
+ get id(): string;
790
+ set id(id: string);
791
+ getId(): string;
792
+ setId(id: string): BatchInfo;
793
+ get name(): string;
794
+ set name(name: string);
795
+ getName(): string;
796
+ setName(name: string): BatchInfo;
797
+ get sequenceName(): string;
798
+ set sequenceName(sequenceName: string);
799
+ getSequenceName(): string;
800
+ setSequenceName(sequenceName: string): BatchInfo;
801
+ get startedAt(): string | Date;
802
+ set startedAt(startedAt: string | Date);
803
+ getStartedAt(): string | Date;
804
+ setStartedAt(startedAt: string | Date): BatchInfo;
805
+ get notifyOnCompletion(): boolean;
806
+ set notifyOnCompletion(notifyOnCompletion: boolean);
807
+ getNotifyOnCompletion(): boolean;
808
+ setNotifyOnCompletion(notifyOnCompletion: boolean): BatchInfo;
809
+ get properties(): Array<PropertyDataPlain>;
810
+ set properties(properties: Array<PropertyDataPlain>);
811
+ getProperties(): Array<PropertyData>;
812
+ setProperties(properties: Array<PropertyDataPlain>): BatchInfo;
813
+ addProperty(property: PropertyDataPlain): BatchInfo;
774
814
  }
775
-
776
- export class ConsoleLogHandler extends LogHandler implements ConsoleLogHandlerPlain {
777
- readonly type: 'console';
778
- close(): void;
779
- onMessage(): void;
780
- open(): void;
815
+ export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
816
+ export class CutProvider implements Required<{
817
+ x: number;
818
+ y: number;
819
+ width: number;
820
+ height: number;
821
+ top: number;
822
+ right: number;
823
+ bottom: number;
824
+ left: number;
825
+ }> {
826
+ constructor(rectOrRegion: CutProviderPlain);
827
+ constructor(top: number, bottom: number, left: number, right: number);
828
+ get top(): number;
829
+ get right(): number;
830
+ get bottom(): number;
831
+ get left(): number;
832
+ get width(): number;
833
+ get height(): number;
834
+ get x(): number;
835
+ get y(): number;
836
+ scale(scaleRatio: number): CutProvider;
781
837
  }
782
-
783
- export class CutProvider
784
- implements
785
- Required<
786
- {x: number; y: number; width: number; height: number} & {top: number; right: number; bottom: number; left: number}
787
- > {
788
- constructor(rectOrRegion: CutProviderPlain);
789
- constructor(top: number, bottom: number, left: number, right: number);
790
- get bottom(): number;
791
- get height(): number;
792
- get left(): number;
793
- get right(): number;
794
- get top(): number;
795
- get width(): number;
796
- get x(): number;
797
- get y(): number;
798
- scale(scaleRatio: number): CutProvider;
838
+ export class FixedCutProvider extends CutProvider {
799
839
  }
800
-
801
- export class DiffsFoundError extends TestFailedError {
802
- constructor(message: string, results?: TestResultsPlain);
803
- constructor(results: TestResultsPlain);
840
+ export class UnscaledFixedCutProvider extends CutProvider {
841
+ scale(): UnscaledFixedCutProvider;
804
842
  }
805
-
806
- /** @undocumented */
843
+ export type ExactMatchSettingsPlain = { minDiffIntensity: number; minDiffWidth: number; minDiffHeight: number; matchThreshold: number; };
807
844
  export class ExactMatchSettings implements Required<ExactMatchSettingsPlain> {
808
- constructor(settings: ExactMatchSettingsPlain);
809
- get matchThreshold(): number;
810
- set matchThreshold(matchThreshold: number);
811
- get minDiffHeight(): number;
812
- set minDiffHeight(minDiffHeight: number);
813
- get minDiffIntensity(): number;
814
- set minDiffIntensity(minDiffIntensity: number);
815
- get minDiffWidth(): number;
816
- set minDiffWidth(minDiffWidth: number);
817
- getMatchThreshold(): number;
818
- getMinDiffHeight(): number;
819
- getMinDiffIntensity(): number;
820
- getMinDiffWidth(): number;
821
- setMatchThreshold(value: number): void;
822
- setMinDiffHeight(value: number): void;
823
- setMinDiffIntensity(value: number): void;
824
- setMinDiffWidth(value: number): void;
825
- }
826
-
827
- export class Eyes {
828
- constructor(runner?: EyesRunner, config?: ConfigurationPlain);
829
- constructor(config?: ConfigurationPlain);
830
- static setViewportSize(driver: Driver, viewportSize: RectangleSize): Promise<void>;
831
- get configuration(): ConfigurationPlain;
832
- set configuration(config: ConfigurationPlain);
833
- get driver(): Driver;
834
- get isOpen(): boolean;
835
- get logger(): Logger;
836
- get runner(): EyesRunner;
837
- abort(): Promise<TestResults>;
838
- /** @deprecated */
839
- abortAsync(): Promise<void>;
840
- /** @deprecated */
841
- abortIfNotClosed(): Promise<TestResultsPlain>;
842
- addProperty(name: string, value: string): Configuration;
843
- /**
844
- * @undocumented
845
- * @deprecated
846
- */
847
- addSessionEventHandler(handler: SessionEventHandler): void;
848
- check(name: string, checkSettings: CheckSettings): Promise<MatchResult>;
849
- check(checkSettings?: CheckSettingsPlain): Promise<MatchResult>;
850
- /** @deprecated */
851
- checkElement(element: Element, timeout?: number, name?: string): Promise<MatchResult>;
852
- /** @deprecated */
853
- checkElementBy(selector: EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
854
- /** @deprecated */
855
- checkFrame(element: Element, timeout?: number, name?: string): Promise<MatchResult>;
856
- /** @deprecated */
857
- checkFrame(element: EyesSelector<Selector>, timeout?: number, name?: string): Promise<MatchResult>;
858
- /** @deprecated */
859
- checkFrame(element: string, timeout?: number, name?: string): Promise<MatchResult>;
860
- /** @deprecated */
861
- checkFrame(element: number, timeout?: number, name?: string): Promise<MatchResult>;
862
- /** @deprecated */
863
- checkRegion(region?: RegionPlain, name?: string, timeout?: number): Promise<MatchResult>;
864
- /** @deprecated */
865
- checkRegionBy(
866
- selector: EyesSelector<Selector>,
867
- name?: string,
868
- timeout?: number,
869
- fully?: boolean,
870
- ): Promise<MatchResult>;
871
- /** @deprecated */
872
- checkRegionByElement(element: Element, name?: string, timeout?: number): Promise<MatchResult>;
873
- /** @deprecated */
874
- checkRegionInFrame(
875
- frame: Element,
876
- selector: EyesSelector<Selector>,
877
- timeout?: number,
878
- name?: string,
879
- fully?: boolean,
880
- ): Promise<MatchResult>;
881
- /** @deprecated */
882
- checkRegionInFrame(
883
- frame: EyesSelector<Selector>,
884
- selector: EyesSelector<Selector>,
885
- timeout?: number,
886
- name?: string,
887
- fully?: boolean,
888
- ): Promise<MatchResult>;
889
- /** @deprecated */
890
- checkRegionInFrame(
891
- frame: string,
892
- selector: EyesSelector<Selector>,
893
- timeout?: number,
894
- name?: string,
895
- fully?: boolean,
896
- ): Promise<MatchResult>;
897
- /** @deprecated */
898
- checkRegionInFrame(
899
- frame: number,
900
- selector: EyesSelector<Selector>,
901
- timeout?: number,
902
- name?: string,
903
- fully?: boolean,
904
- ): Promise<MatchResult>;
905
- /** @deprecated */
906
- checkWindow(name?: string, timeout?: number, fully?: boolean): Promise<MatchResult>;
907
- clearProperties(): Configuration;
908
- /**
909
- * @undocumented
910
- * @deprecated
911
- */
912
- clearSessionEventHandlers(): void;
913
- close(throwErr?: boolean): Promise<TestResults>;
914
- /** @deprecated */
915
- closeAsync(): Promise<void>;
916
- extractText(regions: OCRRegion[]): Promise<string[]>;
917
- extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, TextRegion[]>>;
918
- getApiKey(): string;
919
- getAppName(): string;
920
- getBaselineBranchName(): string;
921
- getBaselineEnvName(): string;
922
- /** @deprecated */
923
- getBaselineName(): string;
924
- getBatch(): BatchInfo;
925
- getBranchName(): string;
926
- getConfiguration(): Configuration;
927
- getDebugScreenshotsPath(): string;
928
- getDebugScreenshotsPrefix(): string;
929
- getDeviceInfo(): string;
930
- getDriver(): Driver;
931
- getForceFullPageScreenshot(): boolean;
932
- getHideCaret(): boolean;
933
- getHideScrollbars(): boolean;
934
- getHostApp(): string;
935
- getHostAppInfo(): string;
936
- getHostOS(): string;
937
- getHostOSInfo(): string;
938
- getIgnoreCaret(): boolean;
939
- getIsCutProviderExplicitlySet(): boolean;
940
- getIsDisabled(): boolean;
941
- getIsOpen(): boolean;
942
- getLogHandler(): LogHandler;
943
- getLogger(): Logger;
944
- getMatchLevel(): MatchLevel;
945
- getMatchTimeout(): number;
946
- getParentBranchName(): string;
947
- getProxy(): ProxySettings;
948
- getRotation(): ImageRotation;
949
- getRunner(): EyesRunner;
950
- getSaveDebugScreenshots(): boolean;
951
- getSaveDiffs(): boolean;
952
- getSaveNewTests(): boolean;
953
- getScaleRatio(): number;
954
- getScrollRootElement(): Element | EyesSelector<Selector>;
955
- getSendDom(): boolean;
956
- getServerUrl(): string;
957
- /**
958
- * @undocumented
959
- * @deprecated
960
- */
961
- getSessionEventHandlers(): SessionEventHandlers;
962
- getStitchMode(): StitchMode;
963
- getStitchOverlap(): number;
964
- getTestName(): string;
965
- getViewportSize(): Promise<RectangleSize>;
966
- getWaitBeforeScreenshots(): number;
967
- locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, RegionPlain[]>>;
968
- /** @undocumented */
969
- off(event: string): void;
970
- /** @undocumented */
971
- off(handler: {(...args: any[]): any}): void;
972
- /** @undocumented */
973
- on(handler: {(event: string, data?: Record<string, any>): any}): {(): void};
974
- /** @undocumented */
975
- on(event: 'setSizeWillStart', handler: {(data: {viewportSize: RectangleSizePlain}): any}): {(): void};
976
- /** @undocumented */
977
- on(event: 'setSizeEnded', handler: {(): any}): {(): void};
978
- /** @undocumented */
979
- on(event: 'initStarted', handler: {(): any}): {(): void};
980
- /** @undocumented */
981
- on(event: 'initEnded', handler: {(): any}): {(): void};
982
- /** @undocumented */
983
- on(event: 'testStarted', handler: {(data: {sessionId: string}): any}): {(): void};
984
- /** @undocumented */
985
- on(
986
- event: 'validationWillStart',
987
- handler: {(data: {sessionId: string; validationInfo: ValidationInfoPlain}): any},
988
- ): {(): void};
989
- /** @undocumented */
990
- on(
991
- event: 'validationEnded',
992
- handler: {(data: {sessionId: string; validationId: number; validationResult: ValidationResultPlain}): any},
993
- ): {(): void};
994
- /** @undocumented */
995
- on(event: 'testEnded', handler: {(data: {sessionId: string; testResults: TestResultsPlain}): any}): {(): void};
996
- open(driver: Driver, config?: ConfigurationPlain): Promise<Driver>;
997
- open(
998
- driver: Driver,
999
- appName?: string,
1000
- testName?: string,
1001
- viewportSize?: RectangleSizePlain,
1002
- sessionType?: SessionTypePlain,
1003
- ): Promise<Driver>;
1004
- /**
1005
- * @undocumented
1006
- * @deprecated
1007
- */
1008
- removeSessionEventHandler(handler: SessionEventHandler): void;
1009
- setApiKey(apiKey: string): void;
1010
- setAppName(appName: string): void;
1011
- setBaselineBranchName(baselineBranchName: string): void;
1012
- setBaselineEnvName(baselineEnvName: string): void;
1013
- /** @deprecated */
1014
- setBaselineName(baselineName: string): void;
1015
- setBatch(batch: BatchInfoPlain): void;
1016
- setBatch(name: string, id?: string, startedAt?: Date): void;
1017
- setBatch(name: string, id?: string, startedAt?: string): void;
1018
- setBranchName(branchName: string): void;
1019
- setConfiguration(config: ConfigurationPlain): void;
1020
- setCutProvider(cutProvider: CutProvider): void;
1021
- setDebugScreenshotsPath(path: string): void;
1022
- setDebugScreenshotsPrefix(prefix: string): void;
1023
- setDeviceInfo(deviceInfo: string): void;
1024
- setForceFullPageScreenshot(forceFullPageScreenshot: boolean): void;
1025
- setHideCaret(hideCaret: boolean): void;
1026
- setHideScrollbars(hideScrollbars: boolean): void;
1027
- setHostApp(hostApp: string): void;
1028
- setHostAppInfo(hostAppInfo: string): void;
1029
- setHostOS(hostOS: string): void;
1030
- setHostOSInfo(hostOSInfo: string): void;
1031
- setIgnoreCaret(ignoreCaret: boolean): void;
1032
- setImageCut(cutProvider: CutProvider): void;
1033
- setIsDisabled(isDisabled: boolean): void;
1034
- setLogHandler(handler: LogHandler): void;
1035
- setMatchLevel(matchLevel: MatchLevelPlain): void;
1036
- setMatchTimeout(matchTimeout: number): void;
1037
- setParentBranchName(parentBranchName: string): void;
1038
- setProxy(proxy: ProxySettingsPlain): void;
1039
- setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): void;
1040
- setProxy(isEnabled: false): void;
1041
- setRotation(rotation: ImageRotationPlain): void;
1042
- setRotation(rotation: ImageRotation): void;
1043
- setSaveDebugScreenshots(save: boolean): void;
1044
- setSaveDiffs(saveDiffs: boolean): void;
1045
- setSaveNewTests(saveNewTests: boolean): void;
1046
- setScaleRatio(scaleRatio: number): void;
1047
- setScrollRootElement(scrollRootElement: Element): void;
1048
- setScrollRootElement(scrollRootElement: EyesSelector<Selector>): void;
1049
- setSendDom(sendDom: boolean): void;
1050
- setServerUrl(serverUrl: string): void;
1051
- setStitchMode(stitchMode: StitchModePlain): void;
1052
- setStitchOverlap(stitchOverlap: number): void;
1053
- setTestName(testName: string): void;
1054
- setViewportSize(size: RectangleSizePlain): Promise<void>;
1055
- setWaitBeforeScreenshots(waitBeforeScreenshots: number): void;
1056
- }
1057
-
1058
- export class EyesError extends Error {}
1059
-
1060
- export abstract class EyesRunner {
1061
- constructor();
1062
- getAllTestResults(throwErr?: boolean): Promise<TestResultsSummary>;
1063
- }
1064
-
1065
- export class FileLogHandler extends LogHandler implements FileLogHandlerPlain {
1066
- constructor(verbose?: boolean, filename?: string, append?: boolean);
1067
- readonly append: boolean;
1068
- readonly filename: string;
1069
- readonly type: 'file';
1070
- close(): void;
1071
- onMessage(): void;
1072
- open(): void;
845
+ constructor(settings: ExactMatchSettingsPlain);
846
+ get minDiffIntensity(): number;
847
+ set minDiffIntensity(minDiffIntensity: number);
848
+ getMinDiffIntensity(): number;
849
+ setMinDiffIntensity(value: number): void;
850
+ get minDiffWidth(): number;
851
+ set minDiffWidth(minDiffWidth: number);
852
+ getMinDiffWidth(): number;
853
+ setMinDiffWidth(value: number): void;
854
+ get minDiffHeight(): number;
855
+ set minDiffHeight(minDiffHeight: number);
856
+ getMinDiffHeight(): number;
857
+ setMinDiffHeight(value: number): void;
858
+ get matchThreshold(): number;
859
+ set matchThreshold(matchThreshold: number);
860
+ getMatchThreshold(): number;
861
+ setMatchThreshold(value: number): void;
1073
862
  }
1074
-
1075
- export class FixedCutProvider extends CutProvider {}
1076
-
1077
- /** @undocumented */
863
+ export type FloatingMatchSettingsPlain = {
864
+ region: RegionPlain;
865
+ maxUpOffset?: number;
866
+ maxDownOffset?: number;
867
+ maxLeftOffset?: number;
868
+ maxRightOffset?: number;
869
+ };
1078
870
  export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlain> {
1079
- constructor(settings: FloatingMatchSettingsPlain);
1080
- constructor(region: RegionPlain);
1081
- constructor(
1082
- x: number,
1083
- y: number,
1084
- width: number,
1085
- height: number,
1086
- maxUpOffset?: number,
1087
- maxDownOffset?: number,
1088
- maxLeftOffset?: number,
1089
- maxRightOffset?: number,
1090
- );
1091
- get maxDownOffset(): number;
1092
- set maxDownOffset(maxDownOffset: number);
1093
- get maxLeftOffset(): number;
1094
- set maxLeftOffset(maxLeftOffset: number);
1095
- get maxRightOffset(): number;
1096
- set maxRightOffset(maxRightOffset: number);
1097
- get maxUpOffset(): number;
1098
- set maxUpOffset(maxUpOffset: number);
1099
- get region(): RegionPlain;
1100
- set region(region: RegionPlain);
1101
- getHeight(): number;
1102
- getLeft(): number;
1103
- getMaxDownOffset(): number;
1104
- getMaxLeftOffset(): number;
1105
- getMaxRightOffset(): number;
1106
- getMaxUpOffset(): number;
1107
- getRegion(): Region;
1108
- getTop(): number;
1109
- getWidth(): number;
1110
- setHeight(height: number): void;
1111
- setLeft(left: number): void;
1112
- setMaxDownOffset(maxDownOffset: number): void;
1113
- setMaxLeftOffset(maxLeftOffset: number): void;
1114
- setMaxRightOffset(maxRightOffset: number): void;
1115
- setMaxUpOffset(maxUpOffset: number): void;
1116
- setRegion(region: RegionPlain): void;
1117
- setTop(top: number): void;
1118
- setWidth(width: number): void;
871
+ constructor(settings: FloatingMatchSettingsPlain);
872
+ constructor(region: RegionPlain);
873
+ constructor(x: number, y: number, width: number, height: number, maxUpOffset: number, maxDownOffset: number, maxLeftOffset: number, maxRightOffset: number);
874
+ get region(): RegionPlain;
875
+ set region(region: RegionPlain);
876
+ getRegion(): Region;
877
+ setRegion(region: RegionPlain): void;
878
+ getLeft(): number;
879
+ setLeft(left: number): void;
880
+ getTop(): number;
881
+ setTop(top: number): void;
882
+ getWidth(): number;
883
+ setWidth(width: number): void;
884
+ getHeight(): number;
885
+ setHeight(height: number): void;
886
+ get maxUpOffset(): number;
887
+ set maxUpOffset(maxUpOffset: number);
888
+ getMaxUpOffset(): number;
889
+ setMaxUpOffset(maxUpOffset: number): void;
890
+ get maxDownOffset(): number;
891
+ set maxDownOffset(maxDownOffset: number);
892
+ getMaxDownOffset(): number;
893
+ setMaxDownOffset(maxDownOffset: number): void;
894
+ get maxLeftOffset(): number;
895
+ set maxLeftOffset(maxLeftOffset: number);
896
+ getMaxLeftOffset(): number;
897
+ setMaxLeftOffset(maxLeftOffset: number): void;
898
+ get maxRightOffset(): number;
899
+ set maxRightOffset(maxRightOffset: number);
900
+ getMaxRightOffset(): number;
901
+ setMaxRightOffset(maxRightOffset: number): void;
1119
902
  }
1120
-
1121
- /** @undocumented */
903
+ export type ImageMatchSettingsPlain = {
904
+ exact?: ExactMatchSettingsPlain;
905
+ matchLevel?: MatchLevelPlain;
906
+ ignoreCaret?: boolean;
907
+ useDom?: boolean;
908
+ enablePatterns?: boolean;
909
+ ignoreDisplacements?: boolean;
910
+ ignoreRegions?: Array<RegionPlain>;
911
+ layoutRegions?: Array<RegionPlain>;
912
+ strictRegions?: Array<RegionPlain>;
913
+ contentRegions?: Array<RegionPlain>;
914
+ floatingRegions?: Array<FloatingMatchSettingsPlain | RegionPlain>;
915
+ accessibilityRegions?: Array<AccessibilityMatchSettingsPlain | RegionPlain>;
916
+ accessibilitySettings?: AccessibilitySettings;
917
+ };
1122
918
  export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
1123
- constructor(settings?: ImageMatchSettingsPlain);
1124
- get accessibility(): (RegionPlain | AccessibilityMatchSettingsPlain)[];
1125
- set accessibility(accessibilityRegions: (RegionPlain | AccessibilityMatchSettingsPlain)[]);
1126
- get accessibilityRegions(): (RegionPlain | AccessibilityMatchSettingsPlain)[];
1127
- set accessibilityRegions(accessibilityRegions: (RegionPlain | AccessibilityMatchSettingsPlain)[]);
1128
- get accessibilitySettings(): AccessibilitySettings;
1129
- set accessibilitySettings(accessibilitySettings: AccessibilitySettings);
1130
- get content(): RegionPlain[];
1131
- set content(contentRegions: RegionPlain[]);
1132
- get contentRegions(): RegionPlain[];
1133
- set contentRegions(contentRegions: RegionPlain[]);
1134
- get enablePatterns(): boolean;
1135
- set enablePatterns(enablePatterns: boolean);
1136
- get exact(): ExactMatchSettingsPlain;
1137
- set exact(exact: ExactMatchSettingsPlain);
1138
- get floating(): (RegionPlain | FloatingMatchSettingsPlain)[];
1139
- set floating(floatingRegions: (RegionPlain | FloatingMatchSettingsPlain)[]);
1140
- get floatingRegions(): (RegionPlain | FloatingMatchSettingsPlain)[];
1141
- set floatingRegions(floatingRegions: (RegionPlain | FloatingMatchSettingsPlain)[]);
1142
- get ignoreCaret(): boolean;
1143
- set ignoreCaret(ignoreCaret: boolean);
1144
- get ignoreDisplacements(): boolean;
1145
- set ignoreDisplacements(ignoreDisplacements: boolean);
1146
- get ignoreRegions(): RegionPlain[];
1147
- set ignoreRegions(ignoreRegions: RegionPlain[]);
1148
- get layout(): RegionPlain[];
1149
- set layout(layoutRegions: RegionPlain[]);
1150
- get layoutRegions(): RegionPlain[];
1151
- set layoutRegions(layoutRegions: RegionPlain[]);
1152
- get matchLevel(): 'None' | 'Layout1' | 'Layout' | 'Layout2' | 'Content' | 'Strict' | 'Exact';
1153
- set matchLevel(matchLevel: 'None' | 'Layout1' | 'Layout' | 'Layout2' | 'Content' | 'Strict' | 'Exact');
1154
- get strict(): RegionPlain[];
1155
- set strict(strictRegions: RegionPlain[]);
1156
- get strictRegions(): RegionPlain[];
1157
- set strictRegions(strictRegions: RegionPlain[]);
1158
- get useDom(): boolean;
1159
- set useDom(useDom: boolean);
1160
- getAccessibilityRegions(): AccessibilityMatchSettings[];
1161
- getAccessibilitySettings(): AccessibilitySettings;
1162
- getContentRegions(): Region[];
1163
- getEnablePatterns(): boolean;
1164
- getExact(): ExactMatchSettings;
1165
- getFloatingRegions(): FloatingMatchSettings[];
1166
- getIgnoreCaret(): boolean;
1167
- getIgnoreDisplacements(): boolean;
1168
- getIgnoreRegions(): Region[];
1169
- getLayoutRegions(): Region[];
1170
- getMatchLevel(): MatchLevel;
1171
- getStrictRegions(): Region[];
1172
- getUseDom(): boolean;
1173
- setAccessibilityRegions(accessibilityRegions: AccessibilityMatchSettingsPlain[]): void;
1174
- setAccessibilitySettings(accessibilitySettings: AccessibilitySettings): void;
1175
- setContentRegions(contentRegions: RegionPlain[]): void;
1176
- setEnablePatterns(enablePatterns: boolean): void;
1177
- setExact(exact: ExactMatchSettingsPlain): void;
1178
- setFloatingRegions(floatingRegions: FloatingMatchSettingsPlain[]): void;
1179
- setIgnoreCaret(ignoreCaret: boolean): void;
1180
- setIgnoreDisplacements(ignoreDisplacements: boolean): void;
1181
- setIgnoreRegions(ignoreRegions: RegionPlain[]): void;
1182
- setLayoutRegions(layoutRegions: RegionPlain[]): void;
1183
- setMatchLevel(matchLevel: MatchLevelPlain): void;
1184
- setStrictRegions(strictRegions: RegionPlain[]): void;
1185
- setUseDom(useDom: boolean): void;
919
+ constructor(settings: ImageMatchSettingsPlain);
920
+ get exact(): ExactMatchSettingsPlain;
921
+ set exact(exact: ExactMatchSettingsPlain);
922
+ getExact(): ExactMatchSettings;
923
+ setExact(exact: ExactMatchSettingsPlain): void;
924
+ get matchLevel(): MatchLevelPlain;
925
+ set matchLevel(matchLevel: MatchLevelPlain);
926
+ getMatchLevel(): MatchLevel;
927
+ setMatchLevel(matchLevel: MatchLevelPlain): void;
928
+ get ignoreCaret(): boolean;
929
+ set ignoreCaret(ignoreCaret: boolean);
930
+ getIgnoreCaret(): boolean;
931
+ setIgnoreCaret(ignoreCaret: boolean): void;
932
+ get useDom(): boolean;
933
+ set useDom(useDom: boolean);
934
+ getUseDom(): boolean;
935
+ setUseDom(useDom: boolean): void;
936
+ get enablePatterns(): boolean;
937
+ set enablePatterns(enablePatterns: boolean);
938
+ getEnablePatterns(): boolean;
939
+ setEnablePatterns(enablePatterns: boolean): void;
940
+ get ignoreDisplacements(): boolean;
941
+ set ignoreDisplacements(ignoreDisplacements: boolean);
942
+ getIgnoreDisplacements(): boolean;
943
+ setIgnoreDisplacements(ignoreDisplacements: boolean): void;
944
+ get ignoreRegions(): Array<RegionPlain>;
945
+ set ignoreRegions(ignoreRegions: Array<RegionPlain>);
946
+ getIgnoreRegions(): Array<Region>;
947
+ setIgnoreRegions(ignoreRegions: Array<RegionPlain>): void;
948
+ get layoutRegions(): Array<RegionPlain>;
949
+ set layoutRegions(layoutRegions: Array<RegionPlain>);
950
+ get layout(): Array<RegionPlain>;
951
+ set layout(layout: Array<RegionPlain>);
952
+ getLayoutRegions(): Array<Region>;
953
+ setLayoutRegions(layoutRegions: Array<RegionPlain>): void;
954
+ get strictRegions(): Array<RegionPlain>;
955
+ set strictRegions(strictRegions: Array<RegionPlain>);
956
+ get strict(): Array<RegionPlain>;
957
+ set strict(strict: Array<RegionPlain>);
958
+ getStrictRegions(): Array<Region>;
959
+ setStrictRegions(strictRegions: Array<RegionPlain>): void;
960
+ get contentRegions(): Array<RegionPlain>;
961
+ set contentRegions(contentRegions: Array<RegionPlain>);
962
+ get content(): Array<RegionPlain>;
963
+ set content(content: Array<RegionPlain>);
964
+ getContentRegions(): Array<Region>;
965
+ setContentRegions(contentRegions: Array<RegionPlain>): void;
966
+ get floatingRegions(): Array<FloatingMatchSettingsPlain | RegionPlain>;
967
+ set floatingRegions(floatingRegions: Array<FloatingMatchSettingsPlain | RegionPlain>);
968
+ get floating(): Array<FloatingMatchSettingsPlain | RegionPlain>;
969
+ set floating(floating: Array<FloatingMatchSettingsPlain | RegionPlain>);
970
+ getFloatingRegions(): Array<FloatingMatchSettings>;
971
+ setFloatingRegions(floatingRegions: Array<FloatingMatchSettingsPlain>): void;
972
+ get accessibilityRegions(): Array<AccessibilityMatchSettingsPlain | RegionPlain>;
973
+ set accessibilityRegions(accessibilityRegions: Array<AccessibilityMatchSettingsPlain | RegionPlain>);
974
+ get accessibility(): Array<AccessibilityMatchSettingsPlain | RegionPlain>;
975
+ set accessibility(accessibility: Array<AccessibilityMatchSettingsPlain | RegionPlain>);
976
+ getAccessibilityRegions(): Array<AccessibilityMatchSettings>;
977
+ setAccessibilityRegions(accessibilityRegions: Array<AccessibilityMatchSettingsPlain>): void;
978
+ get accessibilitySettings(): AccessibilitySettings;
979
+ set accessibilitySettings(accessibilitySettings: AccessibilitySettings);
980
+ getAccessibilitySettings(): AccessibilitySettings;
981
+ setAccessibilitySettings(accessibilitySettings: AccessibilitySettings): void;
1186
982
  }
1187
-
983
+ export type ImageRotationPlain = 0 | 270 | -270 | 180 | -180 | 90 | -90;
1188
984
  export class ImageRotation {
1189
- constructor(rotation: ImageRotationPlain);
1190
- get rotation(): ImageRotationPlain;
1191
- set rotation(rotation: ImageRotationPlain);
1192
- getRotation(): ImageRotationPlain;
1193
- setRotation(rotation: ImageRotationPlain): void;
985
+ constructor(rotation: ImageRotationPlain);
986
+ get rotation(): ImageRotationPlain;
987
+ set rotation(rotation: ImageRotationPlain);
988
+ getRotation(): ImageRotationPlain;
989
+ setRotation(rotation: ImageRotationPlain): void;
1194
990
  }
1195
-
991
+ export type LocationPlain = { x: number; y: number; };
1196
992
  export class Location implements Required<LocationPlain> {
1197
- constructor(location: LocationPlain);
1198
- constructor(x: number, y: number);
1199
- get x(): number;
1200
- set x(x: number);
1201
- get y(): number;
1202
- set y(y: number);
1203
- getX(): number;
1204
- getY(): number;
1205
- setX(x: number): void;
1206
- setY(y: number): void;
993
+ constructor(location: LocationPlain);
994
+ constructor(x: number, y: number);
995
+ get x(): number;
996
+ set x(x: number);
997
+ getX(): number;
998
+ setX(x: number): void;
999
+ get y(): number;
1000
+ set y(y: number);
1001
+ getY(): number;
1002
+ setY(y: number): void;
1207
1003
  }
1208
-
1004
+ export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
1005
+ export type CustomLogHandlerPlain = {
1006
+ log(message: any): void;
1007
+ warn?(message: any): void;
1008
+ error?(message: any): void;
1009
+ fatal?(message: any): void;
1010
+ open?(): void;
1011
+ close?(): void;
1012
+ };
1013
+ export type FileLogHandlerPlain = { type: "file"; filename?: string; append?: boolean; };
1014
+ export type ConsoleLogHandlerPlain = { type: "console"; };
1209
1015
  export abstract class LogHandler implements CustomLogHandlerPlain {
1210
- constructor(verbose?: boolean);
1211
- get verbose(): boolean;
1212
- set verbose(verbose: boolean);
1213
- abstract close(): void;
1214
- getIsVerbose(): boolean;
1215
- log(message: string): void;
1216
- abstract onMessage(message: string): void;
1217
- abstract open(): void;
1218
- setIsVerbose(verbose: boolean): void;
1219
- }
1220
-
1221
- export class Logger {
1222
- constructor(options?: {handler?: LogHandlerPlain; label?: string; show?: boolean});
1223
- constructor(show?: boolean);
1224
- close(): void;
1225
- error(...messages: any[]): void;
1226
- extend(label?: string, color?: string): Logger;
1227
- extend(label?: string, color?: string[]): Logger;
1228
- fatal(...messages: any[]): void;
1229
- getLogHandler(): LogHandler;
1230
- log(...messages: any[]): void;
1231
- open(): void;
1232
- setLogHandler(handler: LogHandlerPlain): void;
1233
- verbose(...messages: any[]): void;
1234
- warn(...messages: any[]): void;
1016
+ constructor(verbose: boolean);
1017
+ get verbose(): boolean;
1018
+ set verbose(verbose: boolean);
1019
+ getIsVerbose(): boolean;
1020
+ setIsVerbose(verbose: boolean): void;
1021
+ log(message: string): void;
1022
+ abstract onMessage(message: string): void;
1023
+ abstract open(): void;
1024
+ abstract close(): void;
1235
1025
  }
1236
-
1237
- export class MatchResult implements Required<MatchResultPlain> {
1238
- get asExpected(): boolean;
1239
- get windowId(): number;
1240
- getAsExpected(): boolean;
1241
- getWindowId(): number;
1242
- /** @deprecated */
1243
- setAsExpected(asExpected: boolean): void;
1244
- /** @deprecated */
1245
- setWindowId(windowId: number): void;
1026
+ export class FileLogHandler extends LogHandler implements FileLogHandlerPlain {
1027
+ constructor(verbose: boolean, filename: string, append: boolean);
1028
+ readonly type: "file";
1029
+ readonly filename: string;
1030
+ readonly append: boolean;
1031
+ onMessage(): void;
1032
+ open(): void;
1033
+ close(): void;
1246
1034
  }
1247
-
1248
- export class NewTestError extends TestFailedError {
1249
- constructor(message: string, results?: TestResultsPlain);
1250
- constructor(results: TestResultsPlain);
1035
+ export class ConsoleLogHandler extends LogHandler implements ConsoleLogHandlerPlain {
1036
+ readonly type: "console";
1037
+ onMessage(): void;
1038
+ open(): void;
1039
+ close(): void;
1251
1040
  }
1252
-
1253
1041
  export class NullLogHandler extends LogHandler {
1254
- close(): void;
1255
- onMessage(): void;
1256
- open(): void;
1042
+ onMessage(): void;
1043
+ open(): void;
1044
+ close(): void;
1257
1045
  }
1258
-
1046
+ export type OCRSettings<TPattern extends string = string> = { patterns: Array<TPattern>; ignoreCase?: boolean; firstOnly?: boolean; language?: string; };
1047
+ export type PropertyDataPlain = { name: string; value: string; };
1259
1048
  export class PropertyData implements Required<PropertyDataPlain> {
1260
- constructor(property: PropertyDataPlain);
1261
- constructor(name: string, value: string);
1262
- get name(): string;
1263
- set name(name: string);
1264
- get value(): string;
1265
- set value(value: string);
1266
- getName(): string;
1267
- getValue(): string;
1268
- setName(name: string): void;
1269
- setValue(value: string): void;
1049
+ constructor(property: PropertyDataPlain);
1050
+ constructor(name: string, value: string);
1051
+ get name(): string;
1052
+ set name(name: string);
1053
+ getName(): string;
1054
+ setName(name: string): void;
1055
+ get value(): string;
1056
+ set value(value: string);
1057
+ getValue(): string;
1058
+ setValue(value: string): void;
1270
1059
  }
1271
-
1060
+ export type ProxySettingsPlain = { url: string; username?: string; password?: string; isHttpOnly?: boolean; };
1272
1061
  export class ProxySettings implements Required<ProxySettingsPlain> {
1273
- constructor(proxy: ProxySettingsPlain);
1274
- constructor(url: string, username?: string, password?: string, isHttpOnly?: boolean);
1275
- get isHttpOnly(): boolean;
1276
- get password(): string;
1277
- get url(): string;
1278
- get username(): string;
1279
- getIsHttpOnly(): boolean;
1280
- getPassword(): string;
1281
- getUri(): string;
1282
- getUrl(): string;
1283
- getUsername(): string;
1062
+ constructor(proxy: ProxySettingsPlain);
1063
+ constructor(url: string, username: string, password: string, isHttpOnly: boolean);
1064
+ get url(): string;
1065
+ getUri(): string;
1066
+ getUrl(): string;
1067
+ get username(): string;
1068
+ getUsername(): string;
1069
+ get password(): string;
1070
+ getPassword(): string;
1071
+ get isHttpOnly(): boolean;
1072
+ getIsHttpOnly(): boolean;
1284
1073
  }
1285
-
1074
+ export type RectangleSizePlain = { width: number; height: number; };
1286
1075
  export class RectangleSize implements Required<RectangleSizePlain> {
1287
- constructor(size: RectangleSizePlain);
1288
- constructor(width: number, height: number);
1289
- get height(): number;
1290
- set height(height: number);
1291
- get width(): number;
1292
- set width(width: number);
1293
- getHeight(): number;
1294
- getWidth(): number;
1295
- setHeight(height: number): void;
1296
- setWidth(width: number): void;
1076
+ constructor(size: RectangleSizePlain);
1077
+ constructor(width: number, height: number);
1078
+ get width(): number;
1079
+ set width(width: number);
1080
+ getWidth(): number;
1081
+ setWidth(width: number): void;
1082
+ get height(): number;
1083
+ set height(height: number);
1084
+ getHeight(): number;
1085
+ setHeight(height: number): void;
1297
1086
  }
1298
-
1087
+ export type RegionPlain = LocationPlain & RectangleSizePlain;
1088
+ export type LegacyRegionPlain = { left: number; top: number; width: number; height: number; };
1299
1089
  export class Region implements Required<RegionPlain> {
1300
- constructor(region: RegionPlain);
1301
- constructor(location: LocationPlain, size: RectangleSizePlain);
1302
- constructor(x: number, y: number, width: number, height: number);
1303
- get height(): number;
1304
- set height(height: number);
1305
- get left(): number;
1306
- set left(left: number);
1307
- get top(): number;
1308
- set top(top: number);
1309
- get width(): number;
1310
- set width(width: number);
1311
- get x(): number;
1312
- set x(x: number);
1313
- get y(): number;
1314
- set y(y: number);
1315
- getHeight(): number;
1316
- getLeft(): number;
1317
- getTop(): number;
1318
- getWidth(): number;
1319
- getX(): number;
1320
- getY(): number;
1321
- setHeight(height: number): void;
1322
- setLeft(left: number): void;
1323
- setTop(top: number): void;
1324
- setWidth(width: number): void;
1325
- setX(x: number): void;
1326
- setY(y: number): void;
1090
+ constructor(region: RegionPlain);
1091
+ constructor(location: LocationPlain, size: RectangleSizePlain);
1092
+ constructor(x: number, y: number, width: number, height: number);
1093
+ get x(): number;
1094
+ set x(x: number);
1095
+ get left(): number;
1096
+ set left(left: number);
1097
+ getX(): number;
1098
+ setX(x: number): void;
1099
+ getLeft(): number;
1100
+ setLeft(left: number): void;
1101
+ get y(): number;
1102
+ set y(y: number);
1103
+ get top(): number;
1104
+ set top(top: number);
1105
+ getY(): number;
1106
+ setY(y: number): void;
1107
+ getTop(): number;
1108
+ setTop(top: number): void;
1109
+ get width(): number;
1110
+ set width(width: number);
1111
+ getWidth(): number;
1112
+ setWidth(width: number): void;
1113
+ get height(): number;
1114
+ set height(height: number);
1115
+ getHeight(): number;
1116
+ setHeight(height: number): void;
1327
1117
  }
1328
-
1329
- /**
1330
- * @undocumented
1331
- * @deprecated
1332
- */
1333
- export class RemoteSessionEventHandler extends SessionEventHandler {
1334
- constructor(options: {accessKey?: string; serverUrl: string; timeout?: number});
1335
- constructor(serverUrl: string, accessKey?: string, timeout?: number);
1336
- get accessKey(): string;
1337
- set accessKey(accessKey: string);
1338
- get serverUrl(): string;
1339
- set serverUrl(serverUrl: string);
1340
- get timeout(): number;
1341
- set timeout(timeout: number);
1342
- getAccessKey(): string;
1343
- getServerUrl(): string;
1344
- getTimeout(): number;
1345
- initEnded(): void;
1346
- initStarted(): void;
1347
- setAccessKey(accessKey: string): void;
1348
- setServerUrl(serverUrl: string): void;
1349
- setSizeEnded(): void;
1350
- setSizeWillStart(): void;
1351
- setTimeout(timeout: number): void;
1352
- testEnded(): void;
1353
- testStarted(): void;
1354
- validationEnded(): void;
1355
- validationWillStart(): void;
1356
- }
1357
-
1358
- /** @deprecated */
1118
+ export type DesktopBrowserInfo = { name?: BrowserTypePlain; width: number; height: number; };
1119
+ export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }; };
1120
+ export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: IosVersionPlain; screenOrientation?: ScreenOrientationPlain; }; };
1121
+ export type RunnerOptionsPlain = { testConcurrency?: number; };
1359
1122
  export class RunnerOptionsFluent {
1360
- constructor();
1361
- testConcurrency(concurrency: number): this;
1123
+ testConcurrency(concurrency: number): RunnerOptionsFluent;
1362
1124
  }
1363
-
1364
- /** @deprecated */
1365
- export abstract class SessionEventHandler {
1366
- constructor();
1367
- abstract initEnded(): any;
1368
- abstract initStarted(): any;
1369
- abstract setSizeEnded(): any;
1370
- abstract setSizeWillStart(viewportSize: RectangleSize): any;
1371
- abstract testEnded(sessionId: string, testResults: TestResults): any;
1372
- abstract testStarted(sessionId: string): any;
1373
- abstract validationEnded(sessionId: string, validationId: number, validationResult: ValidationResult): any;
1374
- abstract validationWillStart(sessionId: string, validationInfo: ValidationInfo): any;
1125
+ export function RunnerOptions(): RunnerOptionsFluent;
1126
+ export type VisualLocatorSettings<TLocator extends string = string> = { locatorNames: Array<TLocator>; firstOnly: boolean; };
1127
+ export type ApiUrlsPlain = {
1128
+ readonly baselineImage?: string;
1129
+ readonly currentImage?: string;
1130
+ readonly checkpointImage?: string;
1131
+ readonly checkpointImageThumbnail?: string;
1132
+ readonly diffImage?: string;
1133
+ };
1134
+ export class ApiUrls implements Required<ApiUrlsPlain> {
1135
+ get baselineImage(): string;
1136
+ getBaselineImage(): string;
1137
+ setBaselineImage(setBaselineImage: string): void;
1138
+ get currentImage(): string;
1139
+ getCurrentImage(): string;
1140
+ setCurrentImage(currentImage: string): void;
1141
+ get checkpointImage(): string;
1142
+ getCheckpointImage(): string;
1143
+ setCheckpointImage(checkpointImage: string): void;
1144
+ get checkpointImageThumbnail(): string;
1145
+ getCheckpointImageThumbnail(): string;
1146
+ setCheckpointImageThumbnail(checkpointImageThumbnail: string): void;
1147
+ get diffImage(): string;
1148
+ getDiffImage(): string;
1149
+ setDiffImage(diffImage: string): void;
1375
1150
  }
1376
-
1377
- /** @deprecated */
1378
- export class SessionEventHandlers extends SessionEventHandler {
1379
- addEventHandler(handler: SessionEventHandler): void;
1380
- clearEventHandlers(): void;
1381
- initEnded(): void;
1382
- initStarted(): void;
1383
- removeEventHandler(handler: SessionEventHandler): void;
1384
- setSizeEnded(): void;
1385
- setSizeWillStart(viewportSize: RectangleSize): void;
1386
- testEnded(sessionId: string, testResults: TestResults): void;
1387
- testStarted(sessionId: string): void;
1388
- validationEnded(sessionId: string, validationId: number, validationResult: ValidationResult): void;
1389
- validationWillStart(sessionId: string, validationInfo: ValidationInfo): void;
1151
+ export type AppUrlsPlain = { readonly step?: string; readonly stepEditor?: string; };
1152
+ export class AppUrls implements Required<AppUrlsPlain> {
1153
+ get step(): string;
1154
+ getStep(): string;
1155
+ setStep(step: string): void;
1156
+ get stepEditor(): string;
1157
+ getStepEditor(): string;
1158
+ setStepEditor(stepEditor: string): void;
1159
+ }
1160
+ export type MatchResultPlain = { readonly asExpected?: boolean; readonly windowId?: number; };
1161
+ export class MatchResult implements Required<MatchResultPlain> {
1162
+ get asExpected(): boolean;
1163
+ getAsExpected(): boolean;
1164
+ setAsExpected(asExpected: boolean): void;
1165
+ get windowId(): number;
1166
+ getWindowId(): number;
1167
+ setWindowId(windowId: number): void;
1390
1168
  }
1391
-
1169
+ export type SessionUrlsPlain = { readonly batch?: string; readonly session?: string; };
1392
1170
  export class SessionUrls implements Required<SessionUrlsPlain> {
1393
- get batch(): string;
1394
- get session(): string;
1395
- getBatch(): string;
1396
- getSession(): string;
1397
- /** @deprecated */
1398
- setBatch(batch: string): void;
1399
- /** @deprecated */
1400
- setSession(session: string): void;
1171
+ get batch(): string;
1172
+ getBatch(): string;
1173
+ setBatch(batch: string): void;
1174
+ get session(): string;
1175
+ getSession(): string;
1176
+ setSession(session: string): void;
1401
1177
  }
1402
-
1178
+ export type StepInfoPlain = {
1179
+ readonly name?: string;
1180
+ readonly isDifferent?: boolean;
1181
+ readonly hasBaselineImage?: boolean;
1182
+ readonly hasCurrentImage?: boolean;
1183
+ readonly appUrls?: AppUrlsPlain;
1184
+ readonly apiUrls?: ApiUrlsPlain;
1185
+ readonly renderId?: Array<string>;
1186
+ };
1403
1187
  export class StepInfo implements Required<StepInfoPlain> {
1404
- get apiUrls(): ApiUrlsPlain;
1405
- get appUrls(): AppUrlsPlain;
1406
- get hasBaselineImage(): boolean;
1407
- get hasCurrentImage(): boolean;
1408
- get isDifferent(): boolean;
1409
- get name(): string;
1410
- get renderId(): string[];
1411
- getApiUrls(): ApiUrls;
1412
- getAppUrls(): AppUrls;
1413
- getHasBaselineImage(): boolean;
1414
- getHasCurrentImage(): boolean;
1415
- getIsDifferent(): boolean;
1416
- getName(): string;
1417
- getRenderId(): string[];
1418
- /** @deprecated */
1419
- setApiUrls(apiUrls: ApiUrlsPlain): void;
1420
- /** @deprecated */
1421
- setAppUrls(appUrls: AppUrlsPlain): void;
1422
- /** @deprecated */
1423
- setHasBaselineImage(value: boolean): void;
1424
- /** @deprecated */
1425
- setHasCurrentImage(hasCurrentImage: boolean): void;
1426
- /** @deprecated */
1427
- setIsDifferent(value: boolean): void;
1428
- /** @deprecated */
1429
- setName(value: string): void;
1430
- /** @deprecated */
1431
- setRenderId(renderId: string[]): void;
1188
+ get name(): string;
1189
+ getName(): string;
1190
+ setName(value: string): void;
1191
+ get isDifferent(): boolean;
1192
+ getIsDifferent(): boolean;
1193
+ setIsDifferent(value: boolean): void;
1194
+ get hasBaselineImage(): boolean;
1195
+ getHasBaselineImage(): boolean;
1196
+ setHasBaselineImage(value: boolean): void;
1197
+ get hasCurrentImage(): boolean;
1198
+ getHasCurrentImage(): boolean;
1199
+ setHasCurrentImage(hasCurrentImage: boolean): void;
1200
+ get appUrls(): AppUrlsPlain;
1201
+ getAppUrls(): AppUrls;
1202
+ setAppUrls(appUrls: AppUrlsPlain): void;
1203
+ get apiUrls(): ApiUrlsPlain;
1204
+ getApiUrls(): ApiUrls;
1205
+ setApiUrls(apiUrls: ApiUrlsPlain): void;
1206
+ get renderId(): Array<string>;
1207
+ getRenderId(): Array<string>;
1208
+ setRenderId(renderId: Array<string>): void;
1432
1209
  }
1433
-
1434
- export class TestFailedError extends EyesError {
1435
- constructor(message: string, results?: TestResultsPlain);
1436
- constructor(results: TestResultsPlain);
1437
- get testResults(): TestResultsPlain;
1438
- getTestResults(): TestResults;
1210
+ export type TestAccessibilityStatus = { readonly status: AccessibilityStatusPlain; readonly level: AccessibilityLevelPlain; readonly version: AccessibilityGuidelinesVersionPlain; };
1211
+ export type TestResultsPlain = {
1212
+ readonly id?: string;
1213
+ readonly name?: string;
1214
+ readonly secretToken?: string;
1215
+ readonly status?: TestResultsStatusPlain;
1216
+ readonly appName?: string;
1217
+ readonly batchId?: string;
1218
+ readonly batchName?: string;
1219
+ readonly branchName?: string;
1220
+ readonly hostOS?: string;
1221
+ readonly hostApp?: string;
1222
+ readonly hostDisplaySize?: RectangleSizePlain;
1223
+ readonly accessibilityStatus?: TestAccessibilityStatus;
1224
+ readonly startedAt?: string | Date;
1225
+ readonly duration?: number;
1226
+ readonly isNew?: boolean;
1227
+ readonly isDifferent?: boolean;
1228
+ readonly isAborted?: boolean;
1229
+ readonly appUrls?: SessionUrlsPlain;
1230
+ readonly apiUrls?: SessionUrlsPlain;
1231
+ readonly stepsInfo?: Array<StepInfoPlain>;
1232
+ readonly steps?: number;
1233
+ readonly matches?: number;
1234
+ readonly mismatches?: number;
1235
+ readonly missing?: number;
1236
+ readonly exactMatches?: number;
1237
+ readonly strictMatches?: number;
1238
+ readonly contentMatches?: number;
1239
+ readonly layoutMatches?: number;
1240
+ readonly noneMatches?: number;
1241
+ readonly url?: string;
1242
+ };
1243
+ export class TestResults implements Required<TestResultsPlain> {
1244
+ get id(): string;
1245
+ getId(): string;
1246
+ setId(id: string): void;
1247
+ get name(): string;
1248
+ getName(): string;
1249
+ setName(name: string): void;
1250
+ get secretToken(): string;
1251
+ getSecretToken(): string;
1252
+ setSecretToken(secretToken: string): void;
1253
+ get status(): TestResultsStatusPlain;
1254
+ getStatus(): TestResultsStatus;
1255
+ setStatus(status: TestResultsStatus): void;
1256
+ get appName(): string;
1257
+ getAppName(): string;
1258
+ setAppName(appName: string): void;
1259
+ get batchName(): string;
1260
+ getBatchName(): string;
1261
+ setBatchName(batchName: string): void;
1262
+ get batchId(): string;
1263
+ getBatchId(): string;
1264
+ setBatchId(batchId: string): void;
1265
+ get branchName(): string;
1266
+ getBranchName(): string;
1267
+ setBranchName(branchName: string): void;
1268
+ get hostOS(): string;
1269
+ getHostOS(): string;
1270
+ setHostOS(hostOS: string): void;
1271
+ get hostApp(): string;
1272
+ getHostApp(): string;
1273
+ setHostApp(hostApp: string): void;
1274
+ get hostDisplaySize(): RectangleSizePlain;
1275
+ getHostDisplaySize(): RectangleSize;
1276
+ setHostDisplaySize(hostDisplaySize: RectangleSizePlain): void;
1277
+ get accessibilityStatus(): TestAccessibilityStatus;
1278
+ getAccessibilityStatus(): TestAccessibilityStatus;
1279
+ setAccessibilityStatus(accessibilityStatus: TestAccessibilityStatus): void;
1280
+ get startedAt(): string | Date;
1281
+ getStartedAt(): Date;
1282
+ setStartedAt(startedAt: string | Date): void;
1283
+ get duration(): number;
1284
+ getDuration(): number;
1285
+ setDuration(duration: number): void;
1286
+ get isNew(): boolean;
1287
+ getIsNew(): boolean;
1288
+ setIsNew(isNew: boolean): void;
1289
+ get isDifferent(): boolean;
1290
+ getIsDifferent(): boolean;
1291
+ setIsDifferent(isDifferent: boolean): void;
1292
+ get isAborted(): boolean;
1293
+ getIsAborted(): boolean;
1294
+ setIsAborted(isAborted: boolean): void;
1295
+ get appUrls(): SessionUrlsPlain;
1296
+ getAppUrls(): SessionUrls;
1297
+ setAppUrls(appUrls: SessionUrlsPlain): void;
1298
+ get apiUrls(): SessionUrlsPlain;
1299
+ getApiUrls(): SessionUrls;
1300
+ setApiUrls(apiUrls: SessionUrlsPlain): void;
1301
+ get stepsInfo(): Array<StepInfoPlain>;
1302
+ getStepsInfo(): Array<StepInfo>;
1303
+ setStepsInfo(stepInfo: Array<StepInfoPlain>): void;
1304
+ get steps(): number;
1305
+ getSteps(): number;
1306
+ setSteps(steps: number): void;
1307
+ get matches(): number;
1308
+ getMatches(): number;
1309
+ setMatches(matches: number): void;
1310
+ get mismatches(): number;
1311
+ getMismatches(): number;
1312
+ setMismatches(mismatches: number): void;
1313
+ get missing(): number;
1314
+ getMissing(): number;
1315
+ setMissing(missing: number): void;
1316
+ get exactMatches(): number;
1317
+ getExactMatches(): number;
1318
+ setExactMatches(exactMatches: number): void;
1319
+ get strictMatches(): number;
1320
+ getStrictMatches(): number;
1321
+ setStrictMatches(strictMatches: number): void;
1322
+ get contentMatches(): number;
1323
+ getContentMatches(): number;
1324
+ setContentMatches(contentMatches: number): void;
1325
+ get layoutMatches(): number;
1326
+ getLayoutMatches(): number;
1327
+ setLayoutMatches(layoutMatches: number): void;
1328
+ get noneMatches(): number;
1329
+ getNoneMatches(): number;
1330
+ setNoneMatches(noneMatches: number): void;
1331
+ get url(): string;
1332
+ getUrl(): string;
1333
+ setUrl(url: string): void;
1334
+ isPassed(): boolean;
1335
+ delete(): Promise<void>;
1336
+ deleteSession(): Promise<void>;
1439
1337
  }
1440
-
1338
+ export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; };
1441
1339
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1442
- get exception(): EyesError;
1443
- get testResults(): TestResultsPlain;
1444
- getException(): EyesError;
1445
- getTestResults(): TestResults;
1446
- }
1447
-
1448
- export class TestResults implements Required<TestResultsPlain> {
1449
- get accessibilityStatus(): TestAccessibilityStatus;
1450
- get apiUrls(): SessionUrlsPlain;
1451
- get appName(): string;
1452
- get appUrls(): SessionUrlsPlain;
1453
- get batchId(): string;
1454
- get batchName(): string;
1455
- get branchName(): string;
1456
- get contentMatches(): number;
1457
- get duration(): number;
1458
- get exactMatches(): number;
1459
- get hostApp(): string;
1460
- get hostDisplaySize(): RectangleSizePlain;
1461
- get hostOS(): string;
1462
- get id(): string;
1463
- get isAborted(): boolean;
1464
- get isDifferent(): boolean;
1465
- get isNew(): boolean;
1466
- get layoutMatches(): number;
1467
- get matches(): number;
1468
- get mismatches(): number;
1469
- get missing(): number;
1470
- get name(): string;
1471
- get noneMatches(): number;
1472
- get secretToken(): string;
1473
- get startedAt(): string | Date;
1474
- get status(): 'Passed' | 'Failed' | 'Unresolved';
1475
- get steps(): number;
1476
- get stepsInfo(): StepInfoPlain[];
1477
- get strictMatches(): number;
1478
- get url(): string;
1479
- delete(): Promise<void>;
1480
- /** @deprecated */
1481
- deleteSession(): Promise<void>;
1482
- getAccessibilityStatus(): TestAccessibilityStatus;
1483
- getApiUrls(): SessionUrls;
1484
- getAppName(): string;
1485
- getAppUrls(): SessionUrls;
1486
- getBatchId(): string;
1487
- getBatchName(): string;
1488
- getBranchName(): string;
1489
- getContentMatches(): number;
1490
- getDuration(): number;
1491
- getExactMatches(): number;
1492
- getHostApp(): string;
1493
- getHostDisplaySize(): RectangleSize;
1494
- getHostOS(): string;
1495
- getId(): string;
1496
- getIsAborted(): boolean;
1497
- getIsDifferent(): boolean;
1498
- getIsNew(): boolean;
1499
- getLayoutMatches(): number;
1500
- getMatches(): number;
1501
- getMismatches(): number;
1502
- getMissing(): number;
1503
- getName(): string;
1504
- getNoneMatches(): number;
1505
- getSecretToken(): string;
1506
- getStartedAt(): Date;
1507
- getStatus(): TestResultsStatus;
1508
- getSteps(): number;
1509
- getStepsInfo(): StepInfo[];
1510
- getStrictMatches(): number;
1511
- getUrl(): string;
1512
- isPassed(): boolean;
1513
- /** @deprecated */
1514
- setAccessibilityStatus(accessibilityStatus: TestAccessibilityStatus): void;
1515
- /** @deprecated */
1516
- setApiUrls(apiUrls: SessionUrlsPlain): void;
1517
- /** @deprecated */
1518
- setAppName(appName: string): void;
1519
- /** @deprecated */
1520
- setAppUrls(appUrls: SessionUrlsPlain): void;
1521
- /** @deprecated */
1522
- setBatchId(batchId: string): void;
1523
- /** @deprecated */
1524
- setBatchName(batchName: string): void;
1525
- /** @deprecated */
1526
- setBranchName(branchName: string): void;
1527
- /** @deprecated */
1528
- setContentMatches(contentMatches: number): void;
1529
- /** @deprecated */
1530
- setDuration(duration: number): void;
1531
- /** @deprecated */
1532
- setExactMatches(exactMatches: number): void;
1533
- /** @deprecated */
1534
- setHostApp(hostApp: string): void;
1535
- /** @deprecated */
1536
- setHostDisplaySize(hostDisplaySize: RectangleSizePlain): void;
1537
- /** @deprecated */
1538
- setHostOS(hostOS: string): void;
1539
- /** @deprecated */
1540
- setId(id: string): void;
1541
- /** @deprecated */
1542
- setIsAborted(isAborted: boolean): void;
1543
- /** @deprecated */
1544
- setIsDifferent(isDifferent: boolean): void;
1545
- /** @deprecated */
1546
- setIsNew(isNew: boolean): void;
1547
- /** @deprecated */
1548
- setLayoutMatches(layoutMatches: number): void;
1549
- /** @deprecated */
1550
- setMatches(matches: number): void;
1551
- /** @deprecated */
1552
- setMismatches(mismatches: number): void;
1553
- /** @deprecated */
1554
- setMissing(missing: number): void;
1555
- /** @deprecated */
1556
- setName(name: string): void;
1557
- /** @deprecated */
1558
- setNoneMatches(noneMatches: number): void;
1559
- /** @deprecated */
1560
- setSecretToken(secretToken: string): void;
1561
- /** @deprecated */
1562
- setStartedAt(startedAt: Date): void;
1563
- /** @deprecated */
1564
- setStartedAt(startedAt: string): void;
1565
- /** @deprecated */
1566
- setStatus(status: TestResultsStatus): void;
1567
- /** @deprecated */
1568
- setSteps(steps: number): void;
1569
- /** @deprecated */
1570
- setStepsInfo(stepInfo: StepInfoPlain[]): void;
1571
- /** @deprecated */
1572
- setStrictMatches(strictMatches: number): void;
1573
- /** @deprecated */
1574
- setUrl(url: string): void;
1340
+ get testResults(): TestResultsPlain;
1341
+ getTestResults(): TestResults;
1342
+ get exception(): Error;
1343
+ getException(): Error;
1575
1344
  }
1576
-
1345
+ export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1577
1346
  export class TestResultsSummary implements TestResultsSummaryPlain {
1578
- [Symbol.iterator](): Iterator<TestResultContainer>;
1579
- getAllResults(): TestResultContainer[];
1347
+ getAllResults(): Array<TestResultContainer>;
1348
+ [Symbol.iterator](): Iterator<TestResultContainer, any, undefined>;
1580
1349
  }
1581
-
1582
- /** @undocumented */
1583
- export class UnscaledFixedCutProvider extends CutProvider {
1584
- scale(): UnscaledFixedCutProvider;
1585
- }
1586
-
1587
- /** @undocumented */
1350
+ export type TextRegion = {
1351
+ x: number;
1352
+ y: number;
1353
+ width: number;
1354
+ height: number;
1355
+ text: string;
1356
+ };
1357
+ export type ValidationInfoPlain = { readonly validationId: number; readonly tag: string; };
1588
1358
  export class ValidationInfo implements Required<ValidationInfoPlain> {
1589
- get tag(): string;
1590
- get validationId(): number;
1591
- getTag(): string;
1592
- getValidationId(): number;
1359
+ get validationId(): number;
1360
+ getValidationId(): number;
1361
+ get tag(): string;
1362
+ getTag(): string;
1593
1363
  }
1594
-
1595
- /** @undocumented */
1364
+ export type ValidationResultPlain = { readonly asExpected: boolean; };
1596
1365
  export class ValidationResult implements Required<ValidationResultPlain> {
1597
- get asExpected(): boolean;
1598
- getAsExpected(): boolean;
1366
+ get asExpected(): boolean;
1367
+ getAsExpected(): boolean;
1368
+ }
1369
+ export type EyesSelector<TSelector = never> = string | TSelector | { selector: string | TSelector; type?: string; shadow?: EyesSelector<TSelector>; frame?: EyesSelector<TSelector>; };
1370
+ export class Logger {
1371
+ constructor(options: { show?: boolean; label?: string; handler?: LogHandlerPlain; });
1372
+ constructor(show: boolean);
1373
+ getLogHandler(): LogHandler;
1374
+ setLogHandler(handler: LogHandlerPlain): void;
1375
+ verbose(messages: Array<any>): void;
1376
+ log(messages: Array<any>): void;
1377
+ warn(messages: Array<any>): void;
1378
+ error(messages: Array<any>): void;
1379
+ fatal(messages: Array<any>): void;
1380
+ open(): void;
1381
+ close(): void;
1382
+ extend(label: string, color: string | Array<string>): Logger;
1383
+ }
1384
+ export function closeBatch(spec: { closeBatches(options: { settings: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }; }): Promise<void>; }): (options: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
1385
+ export abstract class EyesRunner {
1386
+ getAllTestResults(throwErr: boolean): Promise<TestResultsSummary>;
1387
+ }
1388
+ export class ClassicRunner extends EyesRunner {
1599
1389
  }
1600
-
1601
1390
  export class VisualGridRunner extends EyesRunner {
1602
- constructor(options?: RunnerOptionsPlain);
1603
- /** @deprecated */
1604
- constructor(options?: RunnerOptionsFluent);
1605
- /** @deprecated */
1606
- constructor(legacyConcurrency?: number);
1607
- /** @deprecated */
1608
- get legacyConcurrency(): number;
1609
- get testConcurrency(): number;
1610
- /** @deprecated */
1611
- getConcurrentSessions(): number;
1391
+ constructor(options: RunnerOptionsPlain);
1392
+ constructor(options: RunnerOptionsFluent);
1393
+ constructor(legacyConcurrency: number);
1394
+ get testConcurrency(): number;
1395
+ get legacyConcurrency(): number;
1396
+ getConcurrentSessions(): number;
1397
+ }
1398
+ export abstract class SessionEventHandler {
1399
+ abstract initStarted(): any;
1400
+ abstract initEnded(): any;
1401
+ abstract setSizeWillStart(viewportSize: RectangleSize): any;
1402
+ abstract setSizeEnded(): any;
1403
+ abstract testStarted(sessionId: string): any;
1404
+ abstract testEnded(sessionId: string, testResults: TestResults): any;
1405
+ abstract validationWillStart(sessionId: string, validationInfo: ValidationInfo): any;
1406
+ abstract validationEnded(sessionId: string, validationId: number, validationResult: ValidationResult): any;
1407
+ }
1408
+ export class SessionEventHandlers extends SessionEventHandler {
1409
+ addEventHandler(handler: SessionEventHandler): void;
1410
+ removeEventHandler(handler: SessionEventHandler): void;
1411
+ clearEventHandlers(): void;
1412
+ initStarted(): void;
1413
+ initEnded(): void;
1414
+ setSizeWillStart(viewportSize: RectangleSize): void;
1415
+ setSizeEnded(): void;
1416
+ testStarted(sessionId: string): void;
1417
+ testEnded(sessionId: string, testResults: TestResults): void;
1418
+ validationWillStart(sessionId: string, validationInfo: ValidationInfo): void;
1419
+ validationEnded(sessionId: string, validationId: number, validationResult: ValidationResult): void;
1420
+ }
1421
+ export class RemoteSessionEventHandler extends SessionEventHandler {
1422
+ constructor(options: { serverUrl: string; accessKey?: string; timeout?: number; });
1423
+ constructor(serverUrl: string, accessKey: string, timeout: number);
1424
+ get serverUrl(): string;
1425
+ set serverUrl(serverUrl: string);
1426
+ getServerUrl(): string;
1427
+ setServerUrl(serverUrl: string): void;
1428
+ get accessKey(): string;
1429
+ set accessKey(accessKey: string);
1430
+ getAccessKey(): string;
1431
+ setAccessKey(accessKey: string): void;
1432
+ get timeout(): number;
1433
+ set timeout(timeout: number);
1434
+ setTimeout(timeout: number): void;
1435
+ getTimeout(): number;
1436
+ initStarted(): void;
1437
+ initEnded(): void;
1438
+ setSizeWillStart(): void;
1439
+ setSizeEnded(): void;
1440
+ testStarted(): void;
1441
+ testEnded(): void;
1442
+ validationWillStart(): void;
1443
+ validationEnded(): void;
1612
1444
  }
1613
-
1614
- export type AccessibilityGuidelinesVersionPlain = 'WCAG_2_0' | 'WCAG_2_1';
1615
-
1616
- export type AccessibilityLevelPlain = 'AA' | 'AAA';
1617
-
1618
- export type AccessibilityMatchSettingsPlain = {region: RegionPlain; type?: AccessibilityRegionTypePlain};
1619
-
1620
- export type AccessibilityRegionTypePlain =
1621
- | 'BoldText'
1622
- | 'GraphicalObject'
1623
- | 'IgnoreContrast'
1624
- | 'LargeText'
1625
- | 'RegularText';
1626
-
1627
- export type AccessibilitySettings = {
1628
- guidelinesVersion?: AccessibilityGuidelinesVersionPlain;
1629
- level?: AccessibilityLevelPlain;
1630
- };
1631
-
1632
- export type AccessibilityStatusPlain = 'Failed' | 'Passed';
1633
-
1634
- export type ApiUrlsPlain = {
1635
- readonly baselineImage?: string;
1636
- readonly checkpointImage?: string;
1637
- readonly checkpointImageThumbnail?: string;
1638
- readonly currentImage?: string;
1639
- readonly diffImage?: string;
1640
- };
1641
-
1642
- export type AppUrlsPlain = {readonly step?: string; readonly stepEditor?: string};
1643
-
1644
- export type BatchInfoPlain = {
1645
- id?: string;
1646
- name?: string;
1647
- notifyOnCompletion?: boolean;
1648
- properties?: PropertyDataPlain[];
1649
- sequenceName?: string;
1650
- startedAt?: Date | string;
1651
- };
1652
-
1653
- export type BrowserTypePlain =
1654
- | 'chrome'
1655
- | 'chrome-one-version-back'
1656
- | 'chrome-two-versions-back'
1657
- | 'edge'
1658
- | 'edgechromium'
1659
- | 'edgechromium-one-version-back'
1660
- | 'edgechromium-two-versions-back'
1661
- | 'edgelegacy'
1662
- | 'firefox'
1663
- | 'firefox-one-version-back'
1664
- | 'firefox-two-versions-back'
1665
- | 'ie10'
1666
- | 'ie'
1667
- | 'safari'
1668
- | 'safari-earlyaccess'
1669
- | 'safari-one-version-back'
1670
- | 'safari-two-versions-back';
1671
-
1672
- export type CheckSettingsPlain = {
1673
- name?: string;
1674
- region?: RegionPlain | Element | EyesSelector<Selector>;
1675
- frames?: (
1676
- | {frame: Element | EyesSelector<Selector> | string | number; scrollRootElement?: Element | EyesSelector<Selector>}
1677
- | Element
1678
- | EyesSelector<Selector>
1679
- | string
1680
- | number
1681
- )[];
1682
- scrollRootElement?: Element | EyesSelector<Selector>;
1683
- fully?: boolean;
1684
- matchLevel?: MatchLevelPlain;
1685
- useDom?: boolean;
1686
- sendDom?: boolean;
1687
- enablePatterns?: boolean;
1688
- ignoreDisplacements?: boolean;
1689
- ignoreCaret?: boolean;
1690
- ignoreRegions?: (RegionPlain | Element | EyesSelector<Selector>)[];
1691
- layoutRegions?: (RegionPlain | Element | EyesSelector<Selector>)[];
1692
- strictRegions?: (RegionPlain | Element | EyesSelector<Selector>)[];
1693
- contentRegions?: (RegionPlain | Element | EyesSelector<Selector>)[];
1694
- floatingRegions?: (
1695
- | {
1696
- region: RegionPlain | Element | EyesSelector<Selector>;
1697
- maxUpOffset?: number;
1698
- maxDownOffset?: number;
1699
- maxLeftOffset?: number;
1700
- maxRightOffset?: number;
1701
- }
1702
- | RegionPlain
1703
- | Element
1704
- | EyesSelector<Selector>
1705
- )[];
1706
- accessibilityRegions?: (
1707
- | {region: RegionPlain | Element | EyesSelector<Selector>; type?: AccessibilityRegionTypePlain}
1708
- | RegionPlain
1709
- | Element
1710
- | EyesSelector<Selector>
1711
- )[];
1712
- disableBrowserFetching?: boolean;
1713
- layoutBreakpoints?: boolean | number[];
1714
- visualGridOptions?: {[key: string]: any};
1715
- hooks?: {beforeCaptureScreenshot: string};
1716
- renderId?: string;
1717
- variationGroupId?: string;
1718
- timeout?: number;
1719
- };
1720
-
1721
- export type ChromeEmulationInfo = {
1722
- chromeEmulationInfo: {deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain};
1723
- };
1724
-
1725
- export type ConfigurationPlain = {
1726
- /** @undocumented */ logs?: LogHandlerPlain /** @undocumented */;
1727
- debugScreenshots?: {save: boolean; path?: string; prefix?: string};
1728
- agentId?: string;
1729
- apiKey?: string;
1730
- serverUrl?: string;
1731
- proxy?: ProxySettingsPlain;
1732
- isDisabled?: boolean /** @undocumented */;
1733
- connectionTimeout?: number /** @undocumented */;
1734
- removeSession?: boolean /** @undocumented */;
1735
- remoteEvents?: {serverUrl: string; accessKey?: string; timeout?: number};
1736
- } & {
1737
- appName?: string;
1738
- testName?: string;
1739
- displayName?: string;
1740
- viewportSize?: RectangleSizePlain;
1741
- sessionType?: SessionTypePlain;
1742
- properties?: PropertyDataPlain[];
1743
- batch?: BatchInfoPlain;
1744
- defaultMatchSettings?: ImageMatchSettingsPlain;
1745
- hostApp?: string;
1746
- hostOS?: string;
1747
- hostAppInfo?: string;
1748
- hostOSInfo?: string;
1749
- deviceInfo?: string;
1750
- baselineEnvName?: string;
1751
- environmentName?: string;
1752
- branchName?: string;
1753
- parentBranchName?: string;
1754
- baselineBranchName?: string;
1755
- compareWithParentBranch?: boolean;
1756
- ignoreBaseline?: boolean;
1757
- saveFailedTests?: boolean;
1758
- saveNewTests?: boolean;
1759
- saveDiffs?: boolean /** @undocumented */;
1760
- dontCloseBatches?: boolean;
1761
- } & {sendDom?: boolean; matchTimeout?: number; forceFullPageScreenshot?: boolean} & {
1762
- waitBeforeScreenshots?: number;
1763
- stitchMode?: StitchModePlain;
1764
- hideScrollbars?: boolean;
1765
- hideCaret?: boolean;
1766
- stitchOverlap?: number;
1767
- scrollRootElement?: Element | EyesSelector<Selector>;
1768
- cut?: CutProviderPlain;
1769
- rotation?: ImageRotationPlain;
1770
- scaleRatio?: number;
1771
- } & {
1772
- /** @undocumented */ concurrentSessions?: number;
1773
- browsersInfo?: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo)[];
1774
- visualGridOptions?: Record<string, any>;
1775
- layoutBreakpoints?: boolean | number[];
1776
- disableBrowserFetching?: boolean;
1777
- };
1778
-
1779
- export type ConsoleLogHandlerPlain = {type: 'console'};
1780
-
1781
- export type CorsIframeHandlePlain = 'BLANK' | 'KEEP' | 'SNAPSHOT';
1782
-
1783
- export type CustomLogHandlerPlain = {
1784
- log(message: any): void;
1785
- warn?(message: any): void;
1786
- error?(message: any): void;
1787
- fatal?(message: any): void;
1788
- open?(): void;
1789
- close?(): void;
1790
- };
1791
-
1792
- export type CutProviderPlain =
1793
- | {top: number; right: number; bottom: number; left: number}
1794
- | {x: number; y: number; width: number; height: number};
1795
-
1796
- export type DesktopBrowserInfo = {height: number; name?: BrowserTypePlain; width: number};
1797
-
1798
- export type DeviceNamePlain =
1799
- | 'BlackBerry Z30'
1800
- | 'Blackberry PlayBook'
1801
- | 'Galaxy A5'
1802
- | 'Galaxy Note 10'
1803
- | 'Galaxy Note 10 Plus'
1804
- | 'Galaxy Note 2'
1805
- | 'Galaxy Note 3'
1806
- | 'Galaxy Note 4'
1807
- | 'Galaxy Note 8'
1808
- | 'Galaxy Note 9'
1809
- | 'Galaxy S10'
1810
- | 'Galaxy S10 Plus'
1811
- | 'Galaxy S20'
1812
- | 'Galaxy S3'
1813
- | 'Galaxy S5'
1814
- | 'Galaxy S8'
1815
- | 'Galaxy S8 Plus'
1816
- | 'Galaxy S9'
1817
- | 'Galaxy S9 Plus'
1818
- | 'Kindle Fire HDX'
1819
- | 'LG G6'
1820
- | 'LG Optimus L70'
1821
- | 'Laptop with HiDPI screen'
1822
- | 'Laptop with MDPI screen'
1823
- | 'Laptop with touch'
1824
- | 'Microsoft Lumia 550'
1825
- | 'Microsoft Lumia 950'
1826
- | 'Nexus 10'
1827
- | 'Nexus 4'
1828
- | 'Nexus 5'
1829
- | 'Nexus 5X'
1830
- | 'Nexus 6'
1831
- | 'Nexus 6P'
1832
- | 'Nexus 7'
1833
- | 'Nokia Lumia 520'
1834
- | 'Nokia N9'
1835
- | 'OnePlus 7T'
1836
- | 'OnePlus 7T Pro'
1837
- | 'Pixel 2'
1838
- | 'Pixel 2 XL'
1839
- | 'Pixel 3'
1840
- | 'Pixel 3 XL'
1841
- | 'Pixel 4'
1842
- | 'Pixel 4 XL'
1843
- | 'Pixel 5'
1844
- | 'iPad'
1845
- | 'iPad 6th Gen'
1846
- | 'iPad 7th Gen'
1847
- | 'iPad Air 2'
1848
- | 'iPad Mini'
1849
- | 'iPad Pro'
1850
- | 'iPhone 11'
1851
- | 'iPhone 11 Pro'
1852
- | 'iPhone 11 Pro Max'
1853
- | 'iPhone 4'
1854
- | 'iPhone 5/SE'
1855
- | 'iPhone 6/7/8'
1856
- | 'iPhone 6/7/8 Plus'
1857
- | 'iPhone X'
1858
- | 'iPhone XR'
1859
- | 'iPhone XS'
1860
- | 'iPhone XS Max';
1861
-
1862
- export type Driver = import('selenium-webdriver').WebDriver;
1863
-
1864
- export type Element = import('selenium-webdriver').WebElement;
1865
-
1866
- /** @undocumented */
1867
- export type ExactMatchSettingsPlain = {
1868
- matchThreshold: number;
1869
- minDiffHeight: number;
1870
- minDiffIntensity: number;
1871
- minDiffWidth: number;
1872
- };
1873
-
1874
- export type EyesSelector<TSelector = never> =
1875
- | TSelector
1876
- | string
1877
- | {frame?: EyesSelector<TSelector>; selector: TSelector | string; shadow?: EyesSelector<TSelector>; type?: string};
1878
-
1879
- export type FailureReportPlain = 'IMMEDIATE' | 'ON_CLOSE';
1880
-
1881
- export type FileLogHandlerPlain = {type: 'file'; filename?: string; append?: boolean};
1882
-
1883
- /** @undocumented */
1884
- export type FloatingMatchSettingsPlain = {
1885
- maxDownOffset?: number;
1886
- maxLeftOffset?: number;
1887
- maxRightOffset?: number;
1888
- maxUpOffset?: number;
1889
- region: RegionPlain;
1890
- };
1891
-
1892
- export type IOSDeviceInfo = {
1893
- iosDeviceInfo: {
1894
- deviceName: IosDeviceNamePlain;
1895
- iosVersion?: IosVersionPlain;
1896
- screenOrientation?: ScreenOrientationPlain;
1897
- };
1898
- };
1899
-
1900
- /** @undocumented */
1901
- export type ImageMatchSettingsPlain = {
1902
- accessibilityRegions?: (RegionPlain | AccessibilityMatchSettingsPlain)[];
1903
- accessibilitySettings?: AccessibilitySettings;
1904
- contentRegions?: RegionPlain[];
1905
- enablePatterns?: boolean;
1906
- exact?: ExactMatchSettingsPlain;
1907
- floatingRegions?: (RegionPlain | FloatingMatchSettingsPlain)[];
1908
- ignoreCaret?: boolean;
1909
- ignoreDisplacements?: boolean;
1910
- ignoreRegions?: RegionPlain[];
1911
- layoutRegions?: RegionPlain[];
1912
- matchLevel?: MatchLevelPlain;
1913
- strictRegions?: RegionPlain[];
1914
- useDom?: boolean;
1915
- };
1916
-
1917
- export type ImageRotationPlain = -270 | -180 | -90 | 0 | 90 | 180 | 270;
1918
-
1919
- export type IosDeviceNamePlain =
1920
- | 'iPad (7th generation)'
1921
- | 'iPad Air (2nd generation)'
1922
- | 'iPad Pro (12.9-inch) (3rd generation)'
1923
- | 'iPhone 11'
1924
- | 'iPhone 11 Pro'
1925
- | 'iPhone 11 Pro Max'
1926
- | 'iPhone 12'
1927
- | 'iPhone 12 Pro'
1928
- | 'iPhone 12 Pro Max'
1929
- | 'iPhone 12 mini'
1930
- | 'iPhone 7'
1931
- | 'iPhone 8'
1932
- | 'iPhone X'
1933
- | 'iPhone XR'
1934
- | 'iPhone Xs';
1935
-
1936
- export type IosVersionPlain = 'latest' | 'latest-1';
1937
-
1938
- /** @deprecated */
1939
- export type LegacyRegionPlain = {height: number; left: number; top: number; width: number};
1940
-
1941
- export type LocationPlain = {x: number; y: number};
1942
-
1943
- export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
1944
-
1945
- export type MatchLevelPlain = 'Content' | 'Exact' | 'Layout' | 'Layout2' | 'Layout1' | 'None' | 'Strict';
1946
-
1947
- export type MatchResultPlain = {readonly asExpected?: boolean; readonly windowId?: number};
1948
-
1949
- export type OCRRegion = {
1950
- target: RegionPlain | Element | EyesSelector<Selector>;
1951
- hint?: string;
1952
- minMatch?: number;
1953
- language?: string;
1954
- };
1955
-
1956
- export type OCRSettings<TPattern extends string = string> = {
1957
- firstOnly?: boolean;
1958
- ignoreCase?: boolean;
1959
- language?: string;
1960
- patterns: TPattern[];
1961
- };
1962
-
1963
- export type PropertyDataPlain = {name: string; value: string};
1964
-
1965
- export type ProxySettingsPlain = {isHttpOnly?: boolean; password?: string; url: string; username?: string};
1966
-
1967
- export type RectangleSizePlain = {height: number; width: number};
1968
-
1969
- export type RegionPlain = LocationPlain & RectangleSizePlain;
1970
-
1971
- export type RunnerOptionsPlain = {testConcurrency?: number};
1972
-
1973
- export type ScreenOrientationPlain = 'landscape' | 'portrait';
1974
-
1975
- export type Selector = import('selenium-webdriver').Locator | {using: string; value: string};
1976
-
1977
- export type SessionTypePlain = 'PROGRESSION' | 'SEQUENTIAL';
1978
-
1979
- export type SessionUrlsPlain = {readonly batch?: string; readonly session?: string};
1980
-
1981
- export type StepInfoPlain = {
1982
- readonly apiUrls?: ApiUrlsPlain;
1983
- readonly appUrls?: AppUrlsPlain;
1984
- readonly hasBaselineImage?: boolean;
1985
- readonly hasCurrentImage?: boolean;
1986
- readonly isDifferent?: boolean;
1987
- readonly name?: string;
1988
- readonly renderId?: string[];
1989
- };
1990
-
1991
- export type StitchModePlain = 'CSS' | 'Scroll';
1992
-
1993
- export type TestAccessibilityStatus = {
1994
- readonly level: AccessibilityLevelPlain;
1995
- readonly status: AccessibilityStatusPlain;
1996
- readonly version: AccessibilityGuidelinesVersionPlain;
1997
- };
1998
-
1999
- export type TestResultContainerPlain = {readonly exception: EyesError; readonly testResults: TestResultsPlain};
2000
-
2001
- export type TestResultsPlain = {
2002
- readonly accessibilityStatus?: TestAccessibilityStatus;
2003
- readonly apiUrls?: SessionUrlsPlain;
2004
- readonly appName?: string;
2005
- readonly appUrls?: SessionUrlsPlain;
2006
- readonly batchId?: string;
2007
- readonly batchName?: string;
2008
- readonly branchName?: string;
2009
- readonly contentMatches?: number;
2010
- readonly duration?: number;
2011
- readonly exactMatches?: number;
2012
- readonly hostApp?: string;
2013
- readonly hostDisplaySize?: RectangleSizePlain;
2014
- readonly hostOS?: string;
2015
- readonly id?: string;
2016
- readonly isAborted?: boolean;
2017
- readonly isDifferent?: boolean;
2018
- readonly isNew?: boolean;
2019
- readonly layoutMatches?: number;
2020
- readonly matches?: number;
2021
- readonly mismatches?: number;
2022
- readonly missing?: number;
2023
- readonly name?: string;
2024
- readonly noneMatches?: number;
2025
- readonly secretToken?: string;
2026
- readonly startedAt?: Date | string;
2027
- readonly status?: TestResultsStatusPlain;
2028
- readonly steps?: number;
2029
- readonly stepsInfo?: StepInfoPlain[];
2030
- readonly strictMatches?: number;
2031
- readonly url?: string;
2032
- };
2033
-
2034
- export type TestResultsStatusPlain = 'Failed' | 'Passed' | 'Unresolved';
2035
-
2036
- export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
2037
-
2038
- export type TextRegion = {height: number; text: string; width: number; x: number; y: number};
2039
-
2040
- /** @undocumented */
2041
- export type ValidationInfoPlain = {readonly tag: string; readonly validationId: number};
2042
-
2043
- /** @undocumented */
2044
- export type ValidationResultPlain = {readonly asExpected: boolean};
2045
-
2046
- export type VisualLocatorSettings<TLocator extends string = string> = {firstOnly: boolean; locatorNames: TLocator[]};
2047
-
2048
- export const Target: {
2049
- window(): CheckSettings;
2050
- region(region: RegionPlain): CheckSettings;
2051
- region(region: Element): CheckSettings;
2052
- region(region: EyesSelector<Selector>): CheckSettings;
2053
- region(region: LegacyRegionPlain): CheckSettings;
2054
- frame(context: {
2055
- frame: Element | EyesSelector<Selector> | string | number;
2056
- scrollRootElement?: Element | EyesSelector<Selector>;
2057
- }): CheckSettings;
2058
- frame(frame: Element, scrollRootElement?: Element): CheckSettings;
2059
- frame(frame: Element, scrollRootElement?: EyesSelector<Selector>): CheckSettings;
2060
- frame(frame: EyesSelector<Selector>, scrollRootElement?: Element): CheckSettings;
2061
- frame(frame: EyesSelector<Selector>, scrollRootElement?: EyesSelector<Selector>): CheckSettings;
2062
- frame(frame: string, scrollRootElement?: Element): CheckSettings;
2063
- frame(frame: string, scrollRootElement?: EyesSelector<Selector>): CheckSettings;
2064
- frame(frame: number, scrollRootElement?: Element): CheckSettings;
2065
- frame(frame: number, scrollRootElement?: EyesSelector<Selector>): CheckSettings;
2066
- shadow(selector: EyesSelector<Selector>): CheckSettings;
2067
- };
2068
-
2069
- /** @deprecated */
2070
- export function RunnerOptions(): RunnerOptionsFluent;
2071
-
2072
- export function closeBatch(spec: {
2073
- closeBatches(options: {
2074
- batchIds: string[];
2075
- serverUrl?: string;
2076
- apiKey?: string;
2077
- proxy?: ProxySettingsPlain;
2078
- }): Promise<void>;
2079
- }): {(options: {batchIds: string[]; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain}): Promise<void>};