@applitools/eyes 1.33.1 → 1.33.3

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 (142) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/package.json +3 -3
  3. package/dist/BatchClose.js +0 -84
  4. package/dist/Eyes.js +0 -750
  5. package/dist/Logger.js +0 -122
  6. package/dist/Runners.js +0 -130
  7. package/dist/SDK.js +0 -45
  8. package/dist/SessionEventHandlers.js +0 -193
  9. package/dist/cli/cli.js +0 -56
  10. package/dist/cli/load-config.js +0 -73
  11. package/dist/enums/AccessibilityGuidelinesVersion.js +0 -9
  12. package/dist/enums/AccessibilityLevel.js +0 -9
  13. package/dist/enums/AccessibilityRegionType.js +0 -12
  14. package/dist/enums/AccessibilityStatus.js +0 -9
  15. package/dist/enums/BrowserType.js +0 -23
  16. package/dist/enums/CorsIframeHandle.js +0 -10
  17. package/dist/enums/DeviceName.js +0 -105
  18. package/dist/enums/DynamicTextType.js +0 -13
  19. package/dist/enums/FailureReport.js +0 -8
  20. package/dist/enums/IosDeviceName.js +0 -47
  21. package/dist/enums/IosMultiDeviceTarget.js +0 -30
  22. package/dist/enums/IosVersion.js +0 -10
  23. package/dist/enums/MatchLevel.js +0 -15
  24. package/dist/enums/ScreenOrientation.js +0 -8
  25. package/dist/enums/SessionType.js +0 -8
  26. package/dist/enums/StitchMode.js +0 -11
  27. package/dist/enums/TestResultsStatus.js +0 -9
  28. package/dist/errors/DiffsFoundError.js +0 -38
  29. package/dist/errors/EyesError.js +0 -6
  30. package/dist/errors/NewTestError.js +0 -38
  31. package/dist/errors/TestFailedError.js +0 -47
  32. package/dist/index.js +0 -128
  33. package/dist/input/AUTProxySettings.js +0 -2
  34. package/dist/input/AccessibilityMatchSettings.js +0 -109
  35. package/dist/input/AccessibilitySettings.js +0 -2
  36. package/dist/input/BatchInfo.js +0 -153
  37. package/dist/input/CheckSettings.js +0 -663
  38. package/dist/input/Configuration.js +0 -1179
  39. package/dist/input/CutProvider.js +0 -132
  40. package/dist/input/DebugScreenshotProvider.js +0 -2
  41. package/dist/input/DensityMetrics.js +0 -2
  42. package/dist/input/ExactMatchSettings.js +0 -102
  43. package/dist/input/EyesSelector.js +0 -2
  44. package/dist/input/FloatingMatchSettings.js +0 -152
  45. package/dist/input/Image.js +0 -2
  46. package/dist/input/ImageMatchSettings.js +0 -271
  47. package/dist/input/ImageRotation.js +0 -59
  48. package/dist/input/LatestCommitInfo.js +0 -2
  49. package/dist/input/LazyLoadOptions.js +0 -2
  50. package/dist/input/Location.js +0 -74
  51. package/dist/input/LogHandler.js +0 -90
  52. package/dist/input/OCRRegion.js +0 -2
  53. package/dist/input/OCRSettings.js +0 -2
  54. package/dist/input/PropertyData.js +0 -76
  55. package/dist/input/ProxySettings.js +0 -77
  56. package/dist/input/RectangleSize.js +0 -74
  57. package/dist/input/Region.js +0 -135
  58. package/dist/input/RenderInfo.js +0 -2
  59. package/dist/input/RunnerOptions.js +0 -56
  60. package/dist/input/VisualLocatorSettings.js +0 -2
  61. package/dist/output/ApiUrls.js +0 -102
  62. package/dist/output/AppUrls.js +0 -66
  63. package/dist/output/MatchResult.js +0 -66
  64. package/dist/output/SessionUrls.js +0 -66
  65. package/dist/output/StepInfo.js +0 -118
  66. package/dist/output/TestAccessibilityStatus.js +0 -2
  67. package/dist/output/TestResultContainer.js +0 -49
  68. package/dist/output/TestResults.js +0 -378
  69. package/dist/output/TestResultsSummary.js +0 -49
  70. package/dist/output/TextRegion.js +0 -2
  71. package/dist/output/ValidationInfo.js +0 -60
  72. package/dist/output/ValidationResult.js +0 -53
  73. package/types/BatchClose.d.ts +0 -23
  74. package/types/Eyes.d.ts +0 -255
  75. package/types/Logger.d.ts +0 -30
  76. package/types/Runners.d.ts +0 -41
  77. package/types/SDK.d.ts +0 -20
  78. package/types/SessionEventHandlers.d.ts +0 -78
  79. package/types/cli/cli.d.ts +0 -2
  80. package/types/cli/load-config.d.ts +0 -1
  81. package/types/enums/AccessibilityGuidelinesVersion.d.ts +0 -5
  82. package/types/enums/AccessibilityLevel.d.ts +0 -5
  83. package/types/enums/AccessibilityRegionType.d.ts +0 -8
  84. package/types/enums/AccessibilityStatus.d.ts +0 -5
  85. package/types/enums/BrowserType.d.ts +0 -20
  86. package/types/enums/CorsIframeHandle.d.ts +0 -7
  87. package/types/enums/DeviceName.d.ts +0 -101
  88. package/types/enums/DynamicTextType.d.ts +0 -9
  89. package/types/enums/FailureReport.d.ts +0 -5
  90. package/types/enums/IosDeviceName.d.ts +0 -43
  91. package/types/enums/IosMultiDeviceTarget.d.ts +0 -26
  92. package/types/enums/IosVersion.d.ts +0 -7
  93. package/types/enums/MatchLevel.d.ts +0 -12
  94. package/types/enums/ScreenOrientation.d.ts +0 -5
  95. package/types/enums/SessionType.d.ts +0 -5
  96. package/types/enums/StitchMode.d.ts +0 -8
  97. package/types/enums/TestResultsStatus.d.ts +0 -6
  98. package/types/errors/DiffsFoundError.d.ts +0 -6
  99. package/types/errors/EyesError.d.ts +0 -2
  100. package/types/errors/NewTestError.d.ts +0 -6
  101. package/types/errors/TestFailedError.d.ts +0 -9
  102. package/types/index.d.ts +0 -60
  103. package/types/input/AUTProxySettings.d.ts +0 -5
  104. package/types/input/AccessibilityMatchSettings.d.ts +0 -34
  105. package/types/input/AccessibilitySettings.d.ts +0 -6
  106. package/types/input/BatchInfo.d.ts +0 -47
  107. package/types/input/CheckSettings.d.ts +0 -266
  108. package/types/input/Configuration.d.ts +0 -437
  109. package/types/input/CutProvider.d.ts +0 -44
  110. package/types/input/DebugScreenshotProvider.d.ts +0 -5
  111. package/types/input/DensityMetrics.d.ts +0 -5
  112. package/types/input/ExactMatchSettings.d.ts +0 -34
  113. package/types/input/EyesSelector.d.ts +0 -6
  114. package/types/input/FloatingMatchSettings.d.ts +0 -50
  115. package/types/input/Image.d.ts +0 -11
  116. package/types/input/ImageMatchSettings.d.ts +0 -95
  117. package/types/input/ImageRotation.d.ts +0 -15
  118. package/types/input/LatestCommitInfo.d.ts +0 -4
  119. package/types/input/LazyLoadOptions.d.ts +0 -5
  120. package/types/input/Location.d.ts +0 -23
  121. package/types/input/LogHandler.d.ts +0 -45
  122. package/types/input/OCRRegion.d.ts +0 -9
  123. package/types/input/OCRSettings.d.ts +0 -6
  124. package/types/input/PropertyData.d.ts +0 -23
  125. package/types/input/ProxySettings.d.ts +0 -25
  126. package/types/input/RectangleSize.d.ts +0 -23
  127. package/types/input/Region.d.ts +0 -46
  128. package/types/input/RenderInfo.d.ts +0 -47
  129. package/types/input/RunnerOptions.d.ts +0 -21
  130. package/types/input/VisualLocatorSettings.d.ts +0 -4
  131. package/types/output/ApiUrls.d.ts +0 -41
  132. package/types/output/AppUrls.d.ts +0 -23
  133. package/types/output/MatchResult.d.ts +0 -23
  134. package/types/output/SessionUrls.d.ts +0 -23
  135. package/types/output/StepInfo.d.ts +0 -50
  136. package/types/output/TestAccessibilityStatus.d.ts +0 -8
  137. package/types/output/TestResultContainer.d.ts +0 -31
  138. package/types/output/TestResults.d.ts +0 -186
  139. package/types/output/TestResultsSummary.d.ts +0 -18
  140. package/types/output/TextRegion.d.ts +0 -7
  141. package/types/output/ValidationInfo.d.ts +0 -21
  142. package/types/output/ValidationResult.d.ts +0 -18
@@ -1,437 +0,0 @@
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 { IosMultiDeviceTarget } from '../enums/IosMultiDeviceTarget';
9
- import { ScreenOrientation } from '../enums/ScreenOrientation';
10
- import { AccessibilitySettings } from './AccessibilitySettings';
11
- import { RenderInfo, RenderInfoLegacy } from './RenderInfo';
12
- import { CutProvider } from './CutProvider';
13
- import { DebugScreenshotProvider } from './DebugScreenshotProvider';
14
- import { RectangleSize, RectangleSizeData } from './RectangleSize';
15
- import { ImageRotation, ImageRotationData } from './ImageRotation';
16
- import { ProxySettings, ProxySettingsData } from './ProxySettings';
17
- import { AUTProxySettings } from './AUTProxySettings';
18
- import { BatchInfo, BatchInfoData } from './BatchInfo';
19
- import { PropertyData, PropertyDataData } from './PropertyData';
20
- import { ImageMatchSettings } from './ImageMatchSettings';
21
- import { LatestCommitInfo } from './LatestCommitInfo';
22
- export type Configuration<TSpec extends Core.SpecType = Core.SpecType> = {
23
- accessibilityValidation?: AccessibilitySettings;
24
- agentId?: string;
25
- apiKey?: string;
26
- appName?: string;
27
- autProxy?: AUTProxySettings;
28
- baselineBranchName?: string;
29
- baselineEnvName?: string;
30
- batch?: BatchInfo;
31
- branchName?: string;
32
- browsersInfo?: RenderInfo[];
33
- captureStatusBar?: boolean;
34
- compareWithParentBranch?: boolean;
35
- /** @undocumented */
36
- concurrentSessions?: number;
37
- /** @undocumented */
38
- connectionTimeout?: number;
39
- cut?: CutProvider;
40
- /** @undocumented */
41
- debugScreenshots?: DebugScreenshotProvider;
42
- defaultMatchSettings?: ImageMatchSettings;
43
- deviceInfo?: string;
44
- disableBrowserFetching?: boolean;
45
- disableNMLUrlCache?: boolean;
46
- displayName?: string;
47
- /** @undocumented */
48
- dontCloseBatches?: boolean;
49
- enablePatterns?: boolean;
50
- environmentName?: string;
51
- /** @deprecated use fully instead */
52
- forceFullPageScreenshot?: boolean;
53
- fully?: boolean;
54
- gitMergeBaseTimestamp?: string;
55
- latestCommitInfo?: LatestCommitInfo;
56
- hideCaret?: boolean;
57
- hideScrollbars?: boolean;
58
- hostApp?: string;
59
- hostAppInfo?: string;
60
- hostOS?: string;
61
- hostOSInfo?: string;
62
- ignoreBaseline?: boolean;
63
- ignoreCaret?: boolean;
64
- ignoreDisplacements?: boolean;
65
- ignoreGitMergeBase?: boolean;
66
- isDisabled?: boolean;
67
- layoutBreakpoints?: boolean | number[] | {
68
- breakpoints: number[] | boolean;
69
- reload?: boolean;
70
- };
71
- matchLevel?: MatchLevel;
72
- matchTimeout?: number;
73
- mobileOptions?: {
74
- keepNavigationBar?: boolean;
75
- };
76
- parentBranchName?: string;
77
- properties?: PropertyData[];
78
- proxy?: ProxySettings;
79
- /** @undocumented */
80
- removeSession?: boolean;
81
- rotation?: ImageRotation;
82
- saveDiffs?: boolean;
83
- saveFailedTests?: boolean;
84
- saveNewTests?: boolean;
85
- scaleRatio?: number;
86
- scrollRootElement?: TSpec['element'] | EyesSelector<TSpec['selector']>;
87
- sendDom?: boolean;
88
- serverUrl?: string;
89
- sessionType?: SessionType;
90
- stitchMode?: StitchMode;
91
- stitchOverlap?: number;
92
- testName?: string;
93
- useDom?: boolean;
94
- viewportSize?: RectangleSize;
95
- visualGridOptions?: Record<string, any>;
96
- waitBeforeCapture?: number | (() => Promise<void>);
97
- waitBeforeScreenshots?: number;
98
- };
99
- export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecType> implements Required<Configuration<TSpec>> {
100
- protected static readonly _spec: Core.SpecDriver<Core.SpecType>;
101
- private _spec;
102
- private _config;
103
- private _isElementReference;
104
- private _isSelectorReference;
105
- constructor(config?: Configuration<TSpec>);
106
- /** @internal */
107
- constructor(config?: Configuration<TSpec>, spec?: Core.SpecDriver<TSpec>);
108
- get accessibilityValidation(): AccessibilitySettings;
109
- set accessibilityValidation(accessibilityValidation: AccessibilitySettings);
110
- getAccessibilityValidation(): AccessibilitySettings;
111
- setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): this;
112
- get agentId(): string;
113
- set agentId(agentId: string);
114
- getAgentId(): string;
115
- setAgentId(agentId: string): this;
116
- get apiKey(): string;
117
- set apiKey(apiKey: string);
118
- getApiKey(): string;
119
- setApiKey(apiKey: string): this;
120
- get appName(): string;
121
- set appName(appName: string);
122
- getAppName(): string;
123
- setAppName(appName: string): this;
124
- get autProxy(): AUTProxySettings;
125
- set autProxy(autProxy: AUTProxySettings);
126
- getAutProxy(): AUTProxySettings;
127
- setAutProxy(autProxy: AUTProxySettings): this;
128
- get baselineBranchName(): string;
129
- set baselineBranchName(baselineBranchName: string);
130
- getBaselineBranchName(): string;
131
- setBaselineBranchName(baselineBranchName: string): this;
132
- get baselineEnvName(): string;
133
- set baselineEnvName(baselineEnvName: string);
134
- getBaselineEnvName(): string;
135
- setBaselineEnvName(baselineEnvName: string): this;
136
- get batch(): BatchInfo;
137
- set batch(batch: BatchInfo);
138
- getBatch(): BatchInfoData;
139
- setBatch(batch: BatchInfo): this;
140
- get branchName(): string;
141
- set branchName(branchName: string);
142
- getBranchName(): string;
143
- setBranchName(branchName: string): this;
144
- get browsersInfo(): RenderInfo[];
145
- set browsersInfo(browsersInfo: RenderInfo[]);
146
- getBrowsersInfo(): RenderInfo[];
147
- setBrowsersInfo(browsersInfo: RenderInfoLegacy[]): this;
148
- addBrowsers(...browsersInfo: RenderInfoLegacy[]): this;
149
- addBrowser(browserInfo: RenderInfoLegacy): this;
150
- addBrowser(width: number, height: number, name?: BrowserType): this;
151
- addDeviceEmulation(deviceName: DeviceName, screenOrientation?: ScreenOrientation): this;
152
- addMultiDeviceTarget(deviceName: IosMultiDeviceTarget): this;
153
- get captureStatusBar(): boolean;
154
- set captureStatusBar(captureStatusBar: boolean);
155
- getCaptureStatusBar(): boolean;
156
- setCaptureStatusBar(captureStatusBar: boolean): this;
157
- get compareWithParentBranch(): boolean;
158
- set compareWithParentBranch(compareWithParentBranch: boolean);
159
- getCompareWithParentBranch(): boolean;
160
- setCompareWithParentBranch(compareWithParentBranch: boolean): this;
161
- /** @undocumented */
162
- get concurrentSessions(): number;
163
- /** @undocumented */
164
- set concurrentSessions(concurrentSessions: number);
165
- /** @undocumented */
166
- getConcurrentSessions(): number;
167
- /** @undocumented */
168
- setConcurrentSessions(concurrentSessions: number): this;
169
- /** @undocumented */
170
- get connectionTimeout(): number;
171
- /** @undocumented */
172
- set connectionTimeout(connectionTimeout: number);
173
- /** @undocumented */
174
- getConnectionTimeout(): number;
175
- /** @undocumented */
176
- setConnectionTimeout(connectionTimeout: number): this;
177
- get cut(): CutProvider;
178
- set cut(cut: CutProvider);
179
- getCut(): CutProvider;
180
- setCut(cut: CutProvider): this;
181
- /** @undocumented */
182
- get debugScreenshots(): DebugScreenshotProvider;
183
- /** @undocumented */
184
- set debugScreenshots(debugScreenshots: DebugScreenshotProvider);
185
- /** @undocumented */
186
- getSaveDebugScreenshots(): boolean;
187
- /** @undocumented */
188
- setSaveDebugScreenshots(save: boolean): this;
189
- /** @undocumented */
190
- getDebugScreenshotsPath(): string;
191
- /** @undocumented */
192
- setDebugScreenshotsPath(path: string): this;
193
- /** @undocumented */
194
- getDebugScreenshotsPrefix(): string;
195
- /** @undocumented */
196
- setDebugScreenshotsPrefix(prefix: string): this;
197
- get defaultMatchSettings(): ImageMatchSettings;
198
- set defaultMatchSettings(defaultMatchSettings: ImageMatchSettings);
199
- getDefaultMatchSettings(): ImageMatchSettings;
200
- setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettings): this;
201
- get deviceInfo(): string;
202
- set deviceInfo(deviceInfo: string);
203
- getDeviceInfo(): string;
204
- setDeviceInfo(deviceInfo: string): this;
205
- get disableBrowserFetching(): boolean;
206
- set disableBrowserFetching(disableBrowserFetching: boolean);
207
- getDisableBrowserFetching(): boolean;
208
- setDisableBrowserFetching(disableBrowserFetching: boolean): this;
209
- get disableNMLUrlCache(): boolean;
210
- set disableNMLUrlCache(disableNMLUrlCache: boolean);
211
- getDisableNMLUrlCache(): boolean;
212
- setDisableNMLUrlCache(disableNMLUrlCache: boolean): this;
213
- get displayName(): string;
214
- set displayName(displayName: string);
215
- getDisplayName(): string;
216
- setDisplayName(displayName: string): this;
217
- /** @undocumented */
218
- get dontCloseBatches(): boolean;
219
- /** @undocumented */
220
- set dontCloseBatches(dontCloseBatches: boolean);
221
- /** @undocumented */
222
- getDontCloseBatches(): boolean;
223
- /** @undocumented */
224
- setDontCloseBatches(dontCloseBatches: boolean): this;
225
- get enablePatterns(): boolean;
226
- set enablePatterns(enablePatterns: boolean);
227
- getEnablePatterns(): boolean;
228
- setEnablePatterns(enablePatterns: boolean): this;
229
- get environmentName(): string;
230
- set environmentName(environmentName: string);
231
- getEnvironmentName(): string;
232
- setEnvironmentName(environmentName: string): this;
233
- get forceFullPageScreenshot(): boolean;
234
- set forceFullPageScreenshot(forceFullPageScreenshot: boolean);
235
- getForceFullPageScreenshot(): boolean;
236
- setForceFullPageScreenshot(forceFullPageScreenshot: boolean): this;
237
- get gitMergeBaseTimestamp(): string;
238
- set gitMergeBaseTimestamp(gitMergeBaseTimestamp: string);
239
- getGitMergeBaseTimestamp(): string;
240
- setGitMergeBaseTimestamp(gitMergeBaseTimestamp: string): this;
241
- get latestCommitInfo(): LatestCommitInfo;
242
- set latestCommitInfo(latestCommitInfo: LatestCommitInfo);
243
- getLatestCommitInfo(): LatestCommitInfo;
244
- setLatestCommitInfo(latestCommitInfo: LatestCommitInfo): this;
245
- get hideCaret(): boolean;
246
- set hideCaret(hideCaret: boolean);
247
- getHideCaret(): boolean;
248
- setHideCaret(hideCaret: boolean): this;
249
- get hideScrollbars(): boolean;
250
- set hideScrollbars(hideScrollbars: boolean);
251
- getHideScrollbars(): boolean;
252
- setHideScrollbars(hideScrollbars: boolean): this;
253
- get hostApp(): string;
254
- set hostApp(hostApp: string);
255
- getHostApp(): string;
256
- setHostApp(hostApp: string): this;
257
- get hostAppInfo(): string;
258
- set hostAppInfo(hostAppInfo: string);
259
- getHostAppInfo(): string;
260
- setHostAppInfo(hostAppInfo: string): this;
261
- get hostOS(): string;
262
- set hostOS(hostOS: string);
263
- getHostOS(): string;
264
- setHostOS(hostOS: string): this;
265
- get hostOSInfo(): string;
266
- set hostOSInfo(hostOSInfo: string);
267
- getHostOSInfo(): string;
268
- setHostOSInfo(hostOSInfo: string): this;
269
- get ignoreBaseline(): boolean;
270
- set ignoreBaseline(ignoreBaseline: boolean);
271
- getIgnoreBaseline(): boolean;
272
- setIgnoreBaseline(ignoreBaseline: boolean): this;
273
- get ignoreCaret(): boolean;
274
- set ignoreCaret(ignoreCaret: boolean);
275
- getIgnoreCaret(): boolean;
276
- setIgnoreCaret(ignoreCaret: boolean): this;
277
- get ignoreDisplacements(): boolean;
278
- set ignoreDisplacements(ignoreDisplacements: boolean);
279
- getIgnoreDisplacements(): boolean;
280
- setIgnoreDisplacements(ignoreDisplacements: boolean): this;
281
- get ignoreGitMergeBase(): boolean;
282
- set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
283
- getIgnoreGitMergeBase(): boolean;
284
- setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): this;
285
- get isDisabled(): boolean;
286
- set isDisabled(isDisabled: boolean);
287
- getIsDisabled(): boolean;
288
- setIsDisabled(isDisabled: boolean): this;
289
- get layoutBreakpoints(): boolean | number[] | {
290
- breakpoints: number[] | boolean;
291
- reload?: boolean;
292
- };
293
- set layoutBreakpoints(layoutBreakpoints: boolean | number[] | {
294
- breakpoints: number[] | boolean;
295
- reload?: boolean;
296
- });
297
- getLayoutBreakpoints(): boolean | number[] | {
298
- breakpoints: number[] | boolean;
299
- reload?: boolean;
300
- };
301
- setLayoutBreakpoints(layoutBreakpoints: boolean | number[] | {
302
- breakpoints: number[] | boolean;
303
- reload?: boolean;
304
- }): this;
305
- get matchLevel(): MatchLevel;
306
- set matchLevel(matchLevel: MatchLevel);
307
- getMatchLevel(): MatchLevelEnum;
308
- setMatchLevel(matchLevel: MatchLevel): this;
309
- get matchTimeout(): number;
310
- set matchTimeout(matchTimeout: number);
311
- getMatchTimeout(): number;
312
- setMatchTimeout(matchTimeout: number): this;
313
- get mobileOptions(): {
314
- keepNavigationBar?: boolean;
315
- };
316
- set mobileOptions(mobileOptions: {
317
- keepNavigationBar?: boolean;
318
- });
319
- getMobileOptions(): {
320
- keepNavigationBar?: boolean;
321
- };
322
- setMobileOptions(mobileOptions: {
323
- keepNavigationBar?: boolean;
324
- }): this;
325
- get parentBranchName(): string;
326
- set parentBranchName(parentBranchName: string);
327
- getParentBranchName(): string;
328
- setParentBranchName(parentBranchName: string): this;
329
- get properties(): PropertyData[];
330
- set properties(properties: PropertyData[]);
331
- getProperties(): PropertyDataData[];
332
- setProperties(properties: PropertyData[]): this;
333
- addProperty(name: string, value: string): this;
334
- addProperty(prop: PropertyData): this;
335
- clearProperties(): this;
336
- get proxy(): ProxySettings;
337
- set proxy(proxy: ProxySettings);
338
- getProxy(): ProxySettingsData;
339
- setProxy(proxy: ProxySettings): this;
340
- setProxy(url: string, username?: string, password?: string, deprecatedIsHttpOnly?: boolean): this;
341
- setProxy(isEnabled: false): this;
342
- /** @undocumented */
343
- get removeSession(): boolean;
344
- /** @undocumented */
345
- set removeSession(removeSession: boolean);
346
- /** @undocumented */
347
- getRemoveSession(): boolean;
348
- /** @undocumented */
349
- setRemoveSession(removeSession: boolean): this;
350
- get rotation(): ImageRotation;
351
- set rotation(rotation: ImageRotation);
352
- getRotation(): ImageRotationData;
353
- setRotation(rotation: ImageRotation | ImageRotationData): this;
354
- get saveDiffs(): boolean;
355
- set saveDiffs(saveDiffs: boolean);
356
- getSaveDiffs(): boolean;
357
- setSaveDiffs(saveDiffs: boolean): this;
358
- get saveFailedTests(): boolean;
359
- set saveFailedTests(saveFailedTests: boolean);
360
- getSaveFailedTests(): boolean;
361
- setSaveFailedTests(saveFailedTests: boolean): this;
362
- get saveNewTests(): boolean;
363
- set saveNewTests(saveNewTests: boolean);
364
- getSaveNewTests(): boolean;
365
- setSaveNewTests(saveNewTests: boolean): this;
366
- get scaleRatio(): number;
367
- set scaleRatio(scaleRatio: number);
368
- getScaleRatio(): number;
369
- setScaleRatio(scaleRatio: number): this;
370
- get scrollRootElement(): TSpec['element'] | EyesSelector<TSpec['selector']>;
371
- set scrollRootElement(scrollRootElement: TSpec['element'] | EyesSelector<TSpec['selector']>);
372
- getScrollRootElement(): TSpec['element'] | EyesSelector<TSpec['selector']>;
373
- setScrollRootElement(scrollRootElement: TSpec['element'] | EyesSelector<TSpec['selector']>): this;
374
- get sendDom(): boolean;
375
- set sendDom(sendDom: boolean);
376
- getSendDom(): boolean;
377
- setSendDom(sendDom: boolean): this;
378
- get serverUrl(): string;
379
- set serverUrl(serverUrl: string);
380
- getServerUrl(): string;
381
- setServerUrl(serverUrl: string): this;
382
- get sessionType(): SessionType;
383
- set sessionType(sessionType: SessionType);
384
- getSessionType(): SessionTypeEnum;
385
- setSessionType(sessionType: SessionType): this;
386
- get stitchMode(): StitchMode;
387
- set stitchMode(stitchMode: StitchMode);
388
- getStitchMode(): StitchModeEnum;
389
- setStitchMode(stitchMode: StitchMode): this;
390
- get stitchOverlap(): number;
391
- set stitchOverlap(stitchOverlap: number);
392
- getStitchOverlap(): number;
393
- setStitchOverlap(stitchOverlap: number): this;
394
- get testName(): string;
395
- set testName(testName: string);
396
- getTestName(): string;
397
- setTestName(testName: string): this;
398
- get useDom(): boolean;
399
- set useDom(useDom: boolean);
400
- getUseDom(): boolean;
401
- setUseDom(useDom: boolean): this;
402
- get viewportSize(): RectangleSize;
403
- set viewportSize(viewportSize: RectangleSize);
404
- getViewportSize(): RectangleSizeData;
405
- setViewportSize(viewportSize: RectangleSize): this;
406
- get visualGridOptions(): {
407
- [key: string]: any;
408
- };
409
- set visualGridOptions(visualGridOptions: {
410
- [key: string]: any;
411
- });
412
- getVisualGridOptions(): {
413
- [key: string]: any;
414
- };
415
- setVisualGridOptions(visualGridOptions: {
416
- [key: string]: any;
417
- }): this;
418
- setVisualGridOption(key: string, value: any): this;
419
- get waitBeforeCapture(): number | (() => Promise<void>);
420
- set waitBeforeCapture(waitBeforeCapture: number | (() => Promise<void>));
421
- getWaitBeforeCapture(): number | (() => Promise<void>);
422
- setWaitBeforeCapture(waitBeforeCapture: number | (() => Promise<void>)): this;
423
- get waitBeforeScreenshots(): number;
424
- set waitBeforeScreenshots(waitBeforeScreenshots: number);
425
- getWaitBeforeScreenshots(): number;
426
- setWaitBeforeScreenshots(waitBeforeScreenshots: number): this;
427
- get fully(): boolean;
428
- set fully(fully: boolean);
429
- getFully(): boolean;
430
- setFully(fully: boolean): this;
431
- /** @internal */
432
- toObject(): Configuration<TSpec>;
433
- /** @internal */
434
- toJSON(): Core.Config<TSpec, 'classic'> & Core.Config<TSpec, 'ufg'>;
435
- /** @internal */
436
- toString(): string;
437
- }
@@ -1,44 +0,0 @@
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 {};
@@ -1,5 +0,0 @@
1
- export type DebugScreenshotProvider = {
2
- save: boolean;
3
- path?: string;
4
- prefix?: string;
5
- };
@@ -1,5 +0,0 @@
1
- export type DensityMetrics = {
2
- scaleRatio?: number;
3
- xdpi?: number;
4
- ydpi?: number;
5
- };
@@ -1,34 +0,0 @@
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
- }
@@ -1,6 +0,0 @@
1
- export type EyesSelector<TSelector = never> = TSelector | string | {
2
- selector: TSelector | string;
3
- type?: string;
4
- shadow?: EyesSelector<TSelector>;
5
- frame?: EyesSelector<TSelector>;
6
- };
@@ -1,50 +0,0 @@
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
- }
@@ -1,11 +0,0 @@
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
- };