@applitools/eyes-testcafe 1.14.1 → 1.15.1

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