@applitools/eyes-browser 1.4.13 → 1.4.14

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