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