@applitools/eyes-testcafe 2.0.0-beta.8 → 2.0.0

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