@applitools/eyes-browser 1.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 (71) hide show
  1. package/CHANGELOG.md +70 -0
  2. package/LICENSE +26 -0
  3. package/dist/index.js +93180 -0
  4. package/package.json +75 -0
  5. package/types/BatchClose.d.ts +23 -0
  6. package/types/Eyes.d.ts +249 -0
  7. package/types/Logger.d.ts +30 -0
  8. package/types/Runners.d.ts +40 -0
  9. package/types/SDK.d.ts +11 -0
  10. package/types/SessionEventHandlers.d.ts +78 -0
  11. package/types/enums/AccessibilityGuidelinesVersion.d.ts +5 -0
  12. package/types/enums/AccessibilityLevel.d.ts +5 -0
  13. package/types/enums/AccessibilityRegionType.d.ts +8 -0
  14. package/types/enums/AccessibilityStatus.d.ts +5 -0
  15. package/types/enums/AndroidDeviceName.d.ts +28 -0
  16. package/types/enums/AndroidVersion.d.ts +5 -0
  17. package/types/enums/BrowserType.d.ts +20 -0
  18. package/types/enums/CorsIframeHandle.d.ts +7 -0
  19. package/types/enums/DeviceName.d.ts +73 -0
  20. package/types/enums/FailureReport.d.ts +5 -0
  21. package/types/enums/IosDeviceName.d.ts +64 -0
  22. package/types/enums/IosVersion.d.ts +7 -0
  23. package/types/enums/MatchLevel.d.ts +11 -0
  24. package/types/enums/ScreenOrientation.d.ts +5 -0
  25. package/types/enums/SessionType.d.ts +5 -0
  26. package/types/enums/StitchMode.d.ts +8 -0
  27. package/types/enums/TestResultsStatus.d.ts +6 -0
  28. package/types/errors/DiffsFoundError.d.ts +6 -0
  29. package/types/errors/EyesError.d.ts +2 -0
  30. package/types/errors/NewTestError.d.ts +6 -0
  31. package/types/errors/TestFailedError.d.ts +9 -0
  32. package/types/index.d.ts +61 -0
  33. package/types/input/AUTProxySettings.d.ts +5 -0
  34. package/types/input/AccessibilityMatchSettings.d.ts +34 -0
  35. package/types/input/AccessibilitySettings.d.ts +6 -0
  36. package/types/input/BatchInfo.d.ts +47 -0
  37. package/types/input/CheckSettings.d.ts +239 -0
  38. package/types/input/Configuration.d.ts +383 -0
  39. package/types/input/CutProvider.d.ts +44 -0
  40. package/types/input/DebugScreenshotProvider.d.ts +5 -0
  41. package/types/input/DensityMetrics.d.ts +5 -0
  42. package/types/input/ExactMatchSettings.d.ts +34 -0
  43. package/types/input/EyesSelector.d.ts +6 -0
  44. package/types/input/FloatingMatchSettings.d.ts +50 -0
  45. package/types/input/Image.d.ts +11 -0
  46. package/types/input/ImageMatchSettings.d.ts +95 -0
  47. package/types/input/ImageRotation.d.ts +15 -0
  48. package/types/input/LazyLoadOptions.d.ts +5 -0
  49. package/types/input/Location.d.ts +23 -0
  50. package/types/input/LogHandler.d.ts +45 -0
  51. package/types/input/OCRRegion.d.ts +9 -0
  52. package/types/input/OCRSettings.d.ts +6 -0
  53. package/types/input/PropertyData.d.ts +23 -0
  54. package/types/input/ProxySettings.d.ts +25 -0
  55. package/types/input/RectangleSize.d.ts +23 -0
  56. package/types/input/Region.d.ts +46 -0
  57. package/types/input/RenderInfo.d.ts +37 -0
  58. package/types/input/RunnerOptions.d.ts +20 -0
  59. package/types/input/VisualLocatorSettings.d.ts +4 -0
  60. package/types/output/ApiUrls.d.ts +38 -0
  61. package/types/output/AppUrls.d.ts +23 -0
  62. package/types/output/MatchResult.d.ts +23 -0
  63. package/types/output/SessionUrls.d.ts +23 -0
  64. package/types/output/StepInfo.d.ts +50 -0
  65. package/types/output/TestAccessibilityStatus.d.ts +8 -0
  66. package/types/output/TestResultContainer.d.ts +31 -0
  67. package/types/output/TestResults.d.ts +186 -0
  68. package/types/output/TestResultsSummary.d.ts +18 -0
  69. package/types/output/TextRegion.d.ts +7 -0
  70. package/types/output/ValidationInfo.d.ts +21 -0
  71. package/types/output/ValidationResult.d.ts +18 -0
@@ -0,0 +1,383 @@
1
+ import type * as Core from '@applitools/core';
2
+ import { EyesSelector } from './EyesSelector';
3
+ import { SessionType, SessionTypeEnum } from '../enums/SessionType';
4
+ import { StitchMode, StitchModeEnum } from '../enums/StitchMode';
5
+ import { MatchLevel, MatchLevelEnum } from '../enums/MatchLevel';
6
+ import { BrowserType } from '../enums/BrowserType';
7
+ import { DeviceName } from '../enums/DeviceName';
8
+ import { AndroidDeviceName } from '../enums/AndroidDeviceName';
9
+ import { AndroidVersion } from '../enums/AndroidVersion';
10
+ import { IosDeviceName } from '../enums/IosDeviceName';
11
+ import { IosVersion } from '../enums/IosVersion';
12
+ import { ScreenOrientation } from '../enums/ScreenOrientation';
13
+ import { AccessibilitySettings } from './AccessibilitySettings';
14
+ import { DesktopBrowserInfo, ChromeEmulationInfo, IOSDeviceInfo, AndroidDeviceInfo, ChromeEmulationInfoLegacy } from './RenderInfo';
15
+ import { CutProvider } from './CutProvider';
16
+ import { DebugScreenshotProvider } from './DebugScreenshotProvider';
17
+ import { RectangleSize, RectangleSizeData } from './RectangleSize';
18
+ import { ImageRotation, ImageRotationData } from './ImageRotation';
19
+ import { ProxySettings, ProxySettingsData } from './ProxySettings';
20
+ import { AUTProxySettings } from './AUTProxySettings';
21
+ import { BatchInfo, BatchInfoData } from './BatchInfo';
22
+ import { PropertyData, PropertyDataData } from './PropertyData';
23
+ import { ImageMatchSettings } from './ImageMatchSettings';
24
+ type RenderInfo = DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | ChromeEmulationInfoLegacy;
25
+ export type Configuration<TSpec extends Core.SpecType = Core.SpecType> = {
26
+ /** @undocumented */
27
+ debugScreenshots?: DebugScreenshotProvider;
28
+ agentId?: string;
29
+ apiKey?: string;
30
+ serverUrl?: string;
31
+ proxy?: ProxySettings;
32
+ autProxy?: AUTProxySettings;
33
+ isDisabled?: boolean;
34
+ /** @undocumented */
35
+ connectionTimeout?: number;
36
+ /** @undocumented */
37
+ removeSession?: boolean;
38
+ appName?: string;
39
+ testName?: string;
40
+ displayName?: string;
41
+ viewportSize?: RectangleSize;
42
+ sessionType?: SessionType;
43
+ properties?: PropertyData[];
44
+ batch?: BatchInfo;
45
+ defaultMatchSettings?: ImageMatchSettings;
46
+ hostApp?: string;
47
+ hostOS?: string;
48
+ hostAppInfo?: string;
49
+ hostOSInfo?: string;
50
+ deviceInfo?: string;
51
+ baselineEnvName?: string;
52
+ environmentName?: string;
53
+ branchName?: string;
54
+ parentBranchName?: string;
55
+ baselineBranchName?: string;
56
+ compareWithParentBranch?: boolean;
57
+ ignoreBaseline?: boolean;
58
+ ignoreGitMergeBase?: boolean;
59
+ saveFailedTests?: boolean;
60
+ saveNewTests?: boolean;
61
+ saveDiffs?: boolean;
62
+ /** @undocumented */
63
+ dontCloseBatches?: boolean;
64
+ sendDom?: boolean;
65
+ matchTimeout?: number;
66
+ forceFullPageScreenshot?: boolean;
67
+ waitBeforeScreenshots?: number;
68
+ stitchMode?: StitchMode;
69
+ hideScrollbars?: boolean;
70
+ hideCaret?: boolean;
71
+ stitchOverlap?: number;
72
+ scrollRootElement?: TSpec['element'] | EyesSelector<TSpec['selector']>;
73
+ cut?: CutProvider;
74
+ rotation?: ImageRotation;
75
+ scaleRatio?: number;
76
+ /** @undocumented */
77
+ concurrentSessions?: number;
78
+ browsersInfo?: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo)[];
79
+ visualGridOptions?: Record<string, any>;
80
+ layoutBreakpoints?: boolean | number[] | {
81
+ breakpoints: number[] | boolean;
82
+ reload?: boolean;
83
+ };
84
+ disableBrowserFetching?: boolean;
85
+ waitBeforeCapture?: number;
86
+ };
87
+ export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecType> implements Required<Configuration<TSpec>> {
88
+ protected static readonly _spec: Core.SpecDriver<Core.SpecType>;
89
+ private _spec;
90
+ private _config;
91
+ private _isElementReference;
92
+ private _isSelectorReference;
93
+ constructor(config?: Configuration<TSpec>);
94
+ /** @internal */
95
+ constructor(config?: Configuration<TSpec>, spec?: Core.SpecDriver<TSpec>);
96
+ /** @undocumented */
97
+ get debugScreenshots(): DebugScreenshotProvider;
98
+ /** @undocumented */
99
+ set debugScreenshots(debugScreenshots: DebugScreenshotProvider);
100
+ /** @undocumented */
101
+ getSaveDebugScreenshots(): boolean;
102
+ /** @undocumented */
103
+ setSaveDebugScreenshots(save: boolean): this;
104
+ /** @undocumented */
105
+ getDebugScreenshotsPath(): string;
106
+ /** @undocumented */
107
+ setDebugScreenshotsPath(path: string): this;
108
+ /** @undocumented */
109
+ getDebugScreenshotsPrefix(): string;
110
+ /** @undocumented */
111
+ setDebugScreenshotsPrefix(prefix: string): this;
112
+ get appName(): string;
113
+ set appName(appName: string);
114
+ getAppName(): string;
115
+ setAppName(appName: string): this;
116
+ get testName(): string;
117
+ set testName(testName: string);
118
+ getTestName(): string;
119
+ setTestName(testName: string): this;
120
+ get displayName(): string;
121
+ set displayName(displayName: string);
122
+ getDisplayName(): string;
123
+ setDisplayName(displayName: string): this;
124
+ get isDisabled(): boolean;
125
+ set isDisabled(isDisabled: boolean);
126
+ getIsDisabled(): boolean;
127
+ setIsDisabled(isDisabled: boolean): this;
128
+ get matchTimeout(): number;
129
+ set matchTimeout(matchTimeout: number);
130
+ getMatchTimeout(): number;
131
+ setMatchTimeout(matchTimeout: number): this;
132
+ get sessionType(): SessionType;
133
+ set sessionType(sessionType: SessionType);
134
+ getSessionType(): SessionTypeEnum;
135
+ setSessionType(sessionType: SessionType): this;
136
+ get viewportSize(): RectangleSize;
137
+ set viewportSize(viewportSize: RectangleSize);
138
+ getViewportSize(): RectangleSizeData;
139
+ setViewportSize(viewportSize: RectangleSize): this;
140
+ get agentId(): string;
141
+ set agentId(agentId: string);
142
+ getAgentId(): string;
143
+ setAgentId(agentId: string): this;
144
+ get apiKey(): string;
145
+ set apiKey(apiKey: string);
146
+ getApiKey(): string;
147
+ setApiKey(apiKey: string): this;
148
+ get serverUrl(): string;
149
+ set serverUrl(serverUrl: string);
150
+ getServerUrl(): string;
151
+ setServerUrl(serverUrl: string): this;
152
+ get proxy(): ProxySettings;
153
+ set proxy(proxy: ProxySettings);
154
+ getProxy(): ProxySettingsData;
155
+ setProxy(proxy: ProxySettings): this;
156
+ setProxy(url: string, username?: string, password?: string, deprecatedIsHttpOnly?: boolean): this;
157
+ setProxy(isEnabled: false): this;
158
+ get autProxy(): AUTProxySettings;
159
+ set autProxy(autProxy: AUTProxySettings);
160
+ getAutProxy(): AUTProxySettings;
161
+ setAutProxy(autProxy: AUTProxySettings): this;
162
+ /** @undocumented */
163
+ get connectionTimeout(): number;
164
+ /** @undocumented */
165
+ set connectionTimeout(connectionTimeout: number);
166
+ /** @undocumented */
167
+ getConnectionTimeout(): number;
168
+ /** @undocumented */
169
+ setConnectionTimeout(connectionTimeout: number): this;
170
+ /** @undocumented */
171
+ get removeSession(): boolean;
172
+ /** @undocumented */
173
+ set removeSession(removeSession: boolean);
174
+ /** @undocumented */
175
+ getRemoveSession(): boolean;
176
+ /** @undocumented */
177
+ setRemoveSession(removeSession: boolean): this;
178
+ get batch(): BatchInfo;
179
+ set batch(batch: BatchInfo);
180
+ getBatch(): BatchInfoData;
181
+ setBatch(batch: BatchInfo): this;
182
+ get properties(): PropertyData[];
183
+ set properties(properties: PropertyData[]);
184
+ getProperties(): PropertyDataData[];
185
+ setProperties(properties: PropertyData[]): this;
186
+ addProperty(name: string, value: string): this;
187
+ addProperty(prop: PropertyData): this;
188
+ clearProperties(): this;
189
+ get baselineEnvName(): string;
190
+ set baselineEnvName(baselineEnvName: string);
191
+ getBaselineEnvName(): string;
192
+ setBaselineEnvName(baselineEnvName: string): this;
193
+ get environmentName(): string;
194
+ set environmentName(environmentName: string);
195
+ getEnvironmentName(): string;
196
+ setEnvironmentName(environmentName: string): this;
197
+ get branchName(): string;
198
+ set branchName(branchName: string);
199
+ getBranchName(): string;
200
+ setBranchName(branchName: string): this;
201
+ get parentBranchName(): string;
202
+ set parentBranchName(parentBranchName: string);
203
+ getParentBranchName(): string;
204
+ setParentBranchName(parentBranchName: string): this;
205
+ get baselineBranchName(): string;
206
+ set baselineBranchName(baselineBranchName: string);
207
+ getBaselineBranchName(): string;
208
+ setBaselineBranchName(baselineBranchName: string): this;
209
+ get compareWithParentBranch(): boolean;
210
+ set compareWithParentBranch(compareWithParentBranch: boolean);
211
+ getCompareWithParentBranch(): boolean;
212
+ setCompareWithParentBranch(compareWithParentBranch: boolean): this;
213
+ get ignoreGitMergeBase(): boolean;
214
+ set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
215
+ getIgnoreGitMergeBase(): boolean;
216
+ setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): this;
217
+ get ignoreBaseline(): boolean;
218
+ set ignoreBaseline(ignoreBaseline: boolean);
219
+ getIgnoreBaseline(): boolean;
220
+ setIgnoreBaseline(ignoreBaseline: boolean): this;
221
+ get saveFailedTests(): boolean;
222
+ set saveFailedTests(saveFailedTests: boolean);
223
+ getSaveFailedTests(): boolean;
224
+ setSaveFailedTests(saveFailedTests: boolean): this;
225
+ get saveNewTests(): boolean;
226
+ set saveNewTests(saveNewTests: boolean);
227
+ getSaveNewTests(): boolean;
228
+ setSaveNewTests(saveNewTests: boolean): this;
229
+ get saveDiffs(): boolean;
230
+ set saveDiffs(saveDiffs: boolean);
231
+ getSaveDiffs(): boolean;
232
+ setSaveDiffs(saveDiffs: boolean): this;
233
+ get sendDom(): boolean;
234
+ set sendDom(sendDom: boolean);
235
+ getSendDom(): boolean;
236
+ setSendDom(sendDom: boolean): this;
237
+ get hostApp(): string;
238
+ set hostApp(hostApp: string);
239
+ getHostApp(): string;
240
+ setHostApp(hostApp: string): this;
241
+ get hostOS(): string;
242
+ set hostOS(hostOS: string);
243
+ getHostOS(): string;
244
+ setHostOS(hostOS: string): this;
245
+ get hostAppInfo(): string;
246
+ set hostAppInfo(hostAppInfo: string);
247
+ getHostAppInfo(): string;
248
+ setHostAppInfo(hostAppInfo: string): this;
249
+ get hostOSInfo(): string;
250
+ set hostOSInfo(hostOSInfo: string);
251
+ getHostOSInfo(): string;
252
+ setHostOSInfo(hostOSInfo: string): this;
253
+ get deviceInfo(): string;
254
+ set deviceInfo(deviceInfo: string);
255
+ getDeviceInfo(): string;
256
+ setDeviceInfo(deviceInfo: string): this;
257
+ get defaultMatchSettings(): ImageMatchSettings;
258
+ set defaultMatchSettings(defaultMatchSettings: ImageMatchSettings);
259
+ getDefaultMatchSettings(): ImageMatchSettings;
260
+ setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettings): this;
261
+ getMatchLevel(): MatchLevelEnum;
262
+ setMatchLevel(matchLevel: MatchLevel): this;
263
+ getAccessibilityValidation(): AccessibilitySettings;
264
+ setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): this;
265
+ getUseDom(): boolean;
266
+ setUseDom(useDom: boolean): this;
267
+ getEnablePatterns(): boolean;
268
+ setEnablePatterns(enablePatterns: boolean): this;
269
+ getIgnoreDisplacements(): boolean;
270
+ setIgnoreDisplacements(ignoreDisplacements: boolean): this;
271
+ getIgnoreCaret(): boolean;
272
+ setIgnoreCaret(ignoreCaret: boolean): this;
273
+ get forceFullPageScreenshot(): boolean;
274
+ set forceFullPageScreenshot(forceFullPageScreenshot: boolean);
275
+ getForceFullPageScreenshot(): boolean;
276
+ setForceFullPageScreenshot(forceFullPageScreenshot: boolean): this;
277
+ get waitBeforeScreenshots(): number;
278
+ set waitBeforeScreenshots(waitBeforeScreenshots: number);
279
+ getWaitBeforeScreenshots(): number;
280
+ setWaitBeforeScreenshots(waitBeforeScreenshots: number): this;
281
+ get waitBeforeCapture(): number;
282
+ set waitBeforeCapture(waitBeforeCapture: number);
283
+ getWaitBeforeCapture(): number;
284
+ setWaitBeforeCapture(waitBeforeCapture: number): this;
285
+ get stitchMode(): StitchMode;
286
+ set stitchMode(stitchMode: StitchMode);
287
+ getStitchMode(): StitchModeEnum;
288
+ setStitchMode(stitchMode: StitchMode): this;
289
+ get hideScrollbars(): boolean;
290
+ set hideScrollbars(hideScrollbars: boolean);
291
+ getHideScrollbars(): boolean;
292
+ setHideScrollbars(hideScrollbars: boolean): this;
293
+ get hideCaret(): boolean;
294
+ set hideCaret(hideCaret: boolean);
295
+ getHideCaret(): boolean;
296
+ setHideCaret(hideCaret: boolean): this;
297
+ get stitchOverlap(): number;
298
+ set stitchOverlap(stitchOverlap: number);
299
+ getStitchOverlap(): number;
300
+ setStitchOverlap(stitchOverlap: number): this;
301
+ get scrollRootElement(): TSpec['element'] | EyesSelector<TSpec['selector']>;
302
+ set scrollRootElement(scrollRootElement: TSpec['element'] | EyesSelector<TSpec['selector']>);
303
+ getScrollRootElement(): TSpec['element'] | EyesSelector<TSpec['selector']>;
304
+ setScrollRootElement(scrollRootElement: TSpec['element'] | EyesSelector<TSpec['selector']>): this;
305
+ get cut(): CutProvider;
306
+ set cut(cut: CutProvider);
307
+ getCut(): CutProvider;
308
+ setCut(cut: CutProvider): this;
309
+ get rotation(): ImageRotation;
310
+ set rotation(rotation: ImageRotation);
311
+ getRotation(): ImageRotationData;
312
+ setRotation(rotation: ImageRotation | ImageRotationData): this;
313
+ get scaleRatio(): number;
314
+ set scaleRatio(scaleRatio: number);
315
+ getScaleRatio(): number;
316
+ setScaleRatio(scaleRatio: number): this;
317
+ /** @undocumented */
318
+ get concurrentSessions(): number;
319
+ /** @undocumented */
320
+ set concurrentSessions(concurrentSessions: number);
321
+ /** @undocumented */
322
+ getConcurrentSessions(): number;
323
+ /** @undocumented */
324
+ setConcurrentSessions(concurrentSessions: number): this;
325
+ get browsersInfo(): (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo)[];
326
+ set browsersInfo(browsersInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo)[]);
327
+ getBrowsersInfo(): RenderInfo[];
328
+ setBrowsersInfo(browsersInfo: RenderInfo[]): this;
329
+ addBrowsers(...browsersInfo: RenderInfo[]): this;
330
+ addBrowser(browserInfo: RenderInfo): this;
331
+ addBrowser(width: number, height: number, name?: BrowserType): this;
332
+ addDeviceEmulation(deviceName: DeviceName, screenOrientation?: ScreenOrientation): this;
333
+ addMobileDevice(deviceName: AndroidDeviceName, screenOrientation: ScreenOrientation, version?: AndroidVersion): this;
334
+ addMobileDevice(deviceName: IosDeviceName, screenOrientation: ScreenOrientation, version?: IosVersion): this;
335
+ get visualGridOptions(): {
336
+ [key: string]: any;
337
+ };
338
+ set visualGridOptions(visualGridOptions: {
339
+ [key: string]: any;
340
+ });
341
+ getVisualGridOptions(): {
342
+ [key: string]: any;
343
+ };
344
+ setVisualGridOptions(visualGridOptions: {
345
+ [key: string]: any;
346
+ }): this;
347
+ setVisualGridOption(key: string, value: any): this;
348
+ get layoutBreakpoints(): boolean | number[] | {
349
+ breakpoints: number[] | boolean;
350
+ reload?: boolean;
351
+ };
352
+ set layoutBreakpoints(layoutBreakpoints: boolean | number[] | {
353
+ breakpoints: number[] | boolean;
354
+ reload?: boolean;
355
+ });
356
+ getLayoutBreakpoints(): boolean | number[] | {
357
+ breakpoints: number[] | boolean;
358
+ reload?: boolean;
359
+ };
360
+ setLayoutBreakpoints(layoutBreakpoints: boolean | number[] | {
361
+ breakpoints: number[] | boolean;
362
+ reload?: boolean;
363
+ }): this;
364
+ get disableBrowserFetching(): boolean;
365
+ set disableBrowserFetching(disableBrowserFetching: boolean);
366
+ getDisableBrowserFetching(): boolean;
367
+ setDisableBrowserFetching(disableBrowserFetching: boolean): this;
368
+ /** @undocumented */
369
+ get dontCloseBatches(): boolean;
370
+ /** @undocumented */
371
+ set dontCloseBatches(dontCloseBatches: boolean);
372
+ /** @undocumented */
373
+ getDontCloseBatches(): boolean;
374
+ /** @undocumented */
375
+ setDontCloseBatches(dontCloseBatches: boolean): this;
376
+ /** @internal */
377
+ toObject(): Configuration<TSpec>;
378
+ /** @internal */
379
+ toJSON(): Core.Config<TSpec, 'classic'> & Core.Config<TSpec, 'ufg'>;
380
+ /** @internal */
381
+ toString(): string;
382
+ }
383
+ export {};
@@ -0,0 +1,44 @@
1
+ type CutProviderRect = {
2
+ top: number;
3
+ right: number;
4
+ bottom: number;
5
+ left: number;
6
+ };
7
+ type CutProviderRegion = {
8
+ x: number;
9
+ y: number;
10
+ width: number;
11
+ height: number;
12
+ };
13
+ export type CutProvider = CutProviderRect | CutProviderRegion;
14
+ export declare class CutProviderData implements Required<CutProviderRegion & CutProviderRect> {
15
+ private _region?;
16
+ private _rect?;
17
+ constructor(rectOrRegion: CutProvider);
18
+ constructor(top: number, bottom: number, left: number, right: number);
19
+ get top(): number;
20
+ get right(): number;
21
+ get bottom(): number;
22
+ get left(): number;
23
+ get width(): number;
24
+ get height(): number;
25
+ get x(): number;
26
+ get y(): number;
27
+ scale(scaleRatio: number): CutProviderData;
28
+ /** @internal */
29
+ toObject(): CutProvider;
30
+ /** @internal */
31
+ toJSON(): CutProvider;
32
+ /** @internal */
33
+ toString(): string;
34
+ }
35
+ export declare class FixedCutProviderData extends CutProviderData {
36
+ }
37
+ /** @undocumented */
38
+ export declare class UnscaledFixedCutProviderData extends CutProviderData {
39
+ scale(): UnscaledFixedCutProviderData;
40
+ }
41
+ export declare class NullCutProviderData extends CutProviderData {
42
+ constructor();
43
+ }
44
+ export {};
@@ -0,0 +1,5 @@
1
+ export type DebugScreenshotProvider = {
2
+ save: boolean;
3
+ path?: string;
4
+ prefix?: string;
5
+ };
@@ -0,0 +1,5 @@
1
+ export type DensityMetrics = {
2
+ scaleRatio?: number;
3
+ xdpi?: number;
4
+ ydpi?: number;
5
+ };
@@ -0,0 +1,34 @@
1
+ /** @undocumented */
2
+ export type ExactMatchSettings = {
3
+ minDiffIntensity: number;
4
+ minDiffWidth: number;
5
+ minDiffHeight: number;
6
+ matchThreshold: number;
7
+ };
8
+ /** @undocumented */
9
+ export declare class ExactMatchSettingsData implements Required<ExactMatchSettings> {
10
+ private _settings;
11
+ constructor(settings: ExactMatchSettings);
12
+ get minDiffIntensity(): number;
13
+ set minDiffIntensity(minDiffIntensity: number);
14
+ getMinDiffIntensity(): number;
15
+ setMinDiffIntensity(value: number): void;
16
+ get minDiffWidth(): number;
17
+ set minDiffWidth(minDiffWidth: number);
18
+ getMinDiffWidth(): number;
19
+ setMinDiffWidth(value: number): void;
20
+ get minDiffHeight(): number;
21
+ set minDiffHeight(minDiffHeight: number);
22
+ getMinDiffHeight(): number;
23
+ setMinDiffHeight(value: number): void;
24
+ get matchThreshold(): number;
25
+ set matchThreshold(matchThreshold: number);
26
+ getMatchThreshold(): number;
27
+ setMatchThreshold(value: number): void;
28
+ /** @internal */
29
+ toObject(): ExactMatchSettings;
30
+ /** @internal */
31
+ toJSON(): ExactMatchSettings;
32
+ /** @internal */
33
+ toString(): string;
34
+ }
@@ -0,0 +1,6 @@
1
+ export type EyesSelector<TSelector = never> = TSelector | string | {
2
+ selector: TSelector | string;
3
+ type?: string;
4
+ shadow?: EyesSelector<TSelector>;
5
+ frame?: EyesSelector<TSelector>;
6
+ };
@@ -0,0 +1,50 @@
1
+ import { Region, RegionData } from './Region';
2
+ /** @undocumented */
3
+ export type FloatingMatchSettings = {
4
+ region: Region;
5
+ maxUpOffset?: number;
6
+ maxDownOffset?: number;
7
+ maxLeftOffset?: number;
8
+ maxRightOffset?: number;
9
+ };
10
+ /** @undocumented */
11
+ export declare class FloatingMatchSettingsData implements Required<FloatingMatchSettings> {
12
+ private _settings;
13
+ constructor(settings: FloatingMatchSettings);
14
+ constructor(region: Region);
15
+ constructor(x: number, y: number, width: number, height: number, maxUpOffset?: number, maxDownOffset?: number, maxLeftOffset?: number, maxRightOffset?: number);
16
+ get region(): Region;
17
+ set region(region: Region);
18
+ getRegion(): RegionData;
19
+ setRegion(region: Region): void;
20
+ getLeft(): number;
21
+ setLeft(left: number): void;
22
+ getTop(): number;
23
+ setTop(top: number): void;
24
+ getWidth(): number;
25
+ setWidth(width: number): void;
26
+ getHeight(): number;
27
+ setHeight(height: number): void;
28
+ get maxUpOffset(): number;
29
+ set maxUpOffset(maxUpOffset: number);
30
+ getMaxUpOffset(): number;
31
+ setMaxUpOffset(maxUpOffset: number): void;
32
+ get maxDownOffset(): number;
33
+ set maxDownOffset(maxDownOffset: number);
34
+ getMaxDownOffset(): number;
35
+ setMaxDownOffset(maxDownOffset: number): void;
36
+ get maxLeftOffset(): number;
37
+ set maxLeftOffset(maxLeftOffset: number);
38
+ getMaxLeftOffset(): number;
39
+ setMaxLeftOffset(maxLeftOffset: number): void;
40
+ get maxRightOffset(): number;
41
+ set maxRightOffset(maxRightOffset: number);
42
+ getMaxRightOffset(): number;
43
+ setMaxRightOffset(maxRightOffset: number): void;
44
+ /** @internal */
45
+ toObject(): FloatingMatchSettings;
46
+ /** @internal */
47
+ toJSON(): FloatingMatchSettings;
48
+ /** @internal */
49
+ toString(): string;
50
+ }
@@ -0,0 +1,11 @@
1
+ /// <reference types="node" />
2
+ import { RectangleSize } from './RectangleSize';
3
+ import { Location } from './Location';
4
+ export type Image = {
5
+ image: Buffer | URL | string;
6
+ name?: string;
7
+ dom?: string;
8
+ locationInViewport?: Location;
9
+ locationInView?: Location;
10
+ fullViewSize?: RectangleSize;
11
+ };
@@ -0,0 +1,95 @@
1
+ import { MatchLevel, MatchLevelEnum } from '../enums/MatchLevel';
2
+ import { ExactMatchSettings, ExactMatchSettingsData } from './ExactMatchSettings';
3
+ import { FloatingMatchSettings, FloatingMatchSettingsData } from './FloatingMatchSettings';
4
+ import { AccessibilityMatchSettings, AccessibilityMatchSettingsData } from './AccessibilityMatchSettings';
5
+ import { Region, RegionData } from './Region';
6
+ import { AccessibilitySettings } from './AccessibilitySettings';
7
+ /** @undocumented */
8
+ export type ImageMatchSettings = {
9
+ exact?: ExactMatchSettings;
10
+ matchLevel?: MatchLevel;
11
+ ignoreCaret?: boolean;
12
+ useDom?: boolean;
13
+ enablePatterns?: boolean;
14
+ ignoreDisplacements?: boolean;
15
+ ignoreRegions?: Region[];
16
+ layoutRegions?: Region[];
17
+ strictRegions?: Region[];
18
+ contentRegions?: Region[];
19
+ floatingRegions?: (Region | FloatingMatchSettings)[];
20
+ accessibilityRegions?: (Region | AccessibilityMatchSettings)[];
21
+ accessibilitySettings?: AccessibilitySettings;
22
+ };
23
+ /** @undocumented */
24
+ export declare class ImageMatchSettingsData implements Required<ImageMatchSettings> {
25
+ private _settings;
26
+ constructor(settings?: ImageMatchSettings);
27
+ get exact(): ExactMatchSettings;
28
+ set exact(exact: ExactMatchSettings);
29
+ getExact(): ExactMatchSettingsData;
30
+ setExact(exact: ExactMatchSettings): void;
31
+ get matchLevel(): MatchLevel;
32
+ set matchLevel(matchLevel: MatchLevel);
33
+ getMatchLevel(): MatchLevelEnum;
34
+ setMatchLevel(matchLevel: MatchLevel): void;
35
+ get ignoreCaret(): boolean;
36
+ set ignoreCaret(ignoreCaret: boolean);
37
+ getIgnoreCaret(): boolean;
38
+ setIgnoreCaret(ignoreCaret: boolean): void;
39
+ get useDom(): boolean;
40
+ set useDom(useDom: boolean);
41
+ getUseDom(): boolean;
42
+ setUseDom(useDom: boolean): void;
43
+ get enablePatterns(): boolean;
44
+ set enablePatterns(enablePatterns: boolean);
45
+ getEnablePatterns(): boolean;
46
+ setEnablePatterns(enablePatterns: boolean): void;
47
+ get ignoreDisplacements(): boolean;
48
+ set ignoreDisplacements(ignoreDisplacements: boolean);
49
+ getIgnoreDisplacements(): boolean;
50
+ setIgnoreDisplacements(ignoreDisplacements: boolean): void;
51
+ get ignoreRegions(): Region[];
52
+ set ignoreRegions(ignoreRegions: Region[]);
53
+ getIgnoreRegions(): RegionData[];
54
+ setIgnoreRegions(ignoreRegions: Region[]): void;
55
+ get layoutRegions(): Region[];
56
+ set layoutRegions(layoutRegions: Region[]);
57
+ get layout(): Region[];
58
+ set layout(layoutRegions: Region[]);
59
+ getLayoutRegions(): RegionData[];
60
+ setLayoutRegions(layoutRegions: Region[]): void;
61
+ get strictRegions(): Region[];
62
+ set strictRegions(strictRegions: Region[]);
63
+ get strict(): Region[];
64
+ set strict(strictRegions: Region[]);
65
+ getStrictRegions(): RegionData[];
66
+ setStrictRegions(strictRegions: Region[]): void;
67
+ get contentRegions(): Region[];
68
+ set contentRegions(contentRegions: Region[]);
69
+ get content(): Region[];
70
+ set content(contentRegions: Region[]);
71
+ getContentRegions(): RegionData[];
72
+ setContentRegions(contentRegions: Region[]): void;
73
+ get floatingRegions(): (Region | FloatingMatchSettings)[];
74
+ set floatingRegions(floatingRegions: (Region | FloatingMatchSettings)[]);
75
+ get floating(): (Region | FloatingMatchSettings)[];
76
+ set floating(floatingRegions: (Region | FloatingMatchSettings)[]);
77
+ getFloatingRegions(): FloatingMatchSettingsData[];
78
+ setFloatingRegions(floatingRegions: FloatingMatchSettings[]): void;
79
+ get accessibilityRegions(): (Region | AccessibilityMatchSettings)[];
80
+ set accessibilityRegions(accessibilityRegions: (Region | AccessibilityMatchSettings)[]);
81
+ get accessibility(): (Region | AccessibilityMatchSettings)[];
82
+ set accessibility(accessibilityRegions: (Region | AccessibilityMatchSettings)[]);
83
+ getAccessibilityRegions(): AccessibilityMatchSettingsData[];
84
+ setAccessibilityRegions(accessibilityRegions: AccessibilityMatchSettings[]): void;
85
+ get accessibilitySettings(): AccessibilitySettings;
86
+ set accessibilitySettings(accessibilitySettings: AccessibilitySettings);
87
+ getAccessibilitySettings(): AccessibilitySettings;
88
+ setAccessibilitySettings(accessibilitySettings: AccessibilitySettings): void;
89
+ /** @internal */
90
+ toObject(): ImageMatchSettings;
91
+ /** @internal */
92
+ toJSON(): ImageMatchSettings;
93
+ /** @internal */
94
+ toString(): string;
95
+ }
@@ -0,0 +1,15 @@
1
+ export type ImageRotation = -270 | -180 | -90 | 0 | 90 | 180 | 270;
2
+ export declare class ImageRotationData {
3
+ private _rotation;
4
+ constructor(rotation: ImageRotation);
5
+ get rotation(): ImageRotation;
6
+ set rotation(rotation: ImageRotation);
7
+ getRotation(): ImageRotation;
8
+ setRotation(rotation: ImageRotation): void;
9
+ /** @internal */
10
+ [Symbol.toPrimitive](): ImageRotation;
11
+ /** @internal */
12
+ toJSON(): number;
13
+ /** @internal */
14
+ toString(): string;
15
+ }
@@ -0,0 +1,5 @@
1
+ export type LazyLoadOptions = {
2
+ scrollLength?: number;
3
+ waitingTime?: number;
4
+ maxAmountToScroll?: number;
5
+ };
@@ -0,0 +1,23 @@
1
+ export type Location = {
2
+ x: number;
3
+ y: number;
4
+ };
5
+ export declare class LocationData implements Required<Location> {
6
+ private _location;
7
+ constructor(location: Location);
8
+ constructor(x: number, y: number);
9
+ get x(): number;
10
+ set x(x: number);
11
+ getX(): number;
12
+ setX(x: number): void;
13
+ get y(): number;
14
+ set y(y: number);
15
+ getY(): number;
16
+ setY(y: number): void;
17
+ /** @internal */
18
+ toObject(): Location;
19
+ /** @internal */
20
+ toJSON(): Location;
21
+ /** @internal */
22
+ toString(): string;
23
+ }