@applitools/eyes-nightwatch 1.25.10 → 1.25.12

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 (3) hide show
  1. package/CHANGELOG.md +67 -0
  2. package/package.json +6 -6
  3. package/types/index.d.ts +385 -384
package/types/index.d.ts CHANGED
@@ -173,7 +173,7 @@ export class Eyes {
173
173
  }
174
174
  export type CheckSettingsImagePlain = {
175
175
  name?: undefined | string;
176
- region?: undefined | RegionPlain;
176
+ region?: undefined | RegionPlain | LegacyRegionPlain;
177
177
  matchLevel?: undefined | MatchLevelPlain;
178
178
  useDom?: undefined | boolean;
179
179
  sendDom?: undefined | boolean;
@@ -181,17 +181,17 @@ export type CheckSettingsImagePlain = {
181
181
  ignoreDisplacements?: undefined | boolean;
182
182
  ignoreMismatch?: undefined | boolean;
183
183
  ignoreCaret?: undefined | boolean;
184
- ignoreRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
185
- layoutRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
186
- strictRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
187
- contentRegions?: undefined | Array<RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
188
- floatingRegions?: undefined | Array<RegionPlain | {
189
- region: RegionPlain;
184
+ ignoreRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
185
+ layoutRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
186
+ strictRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
187
+ contentRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
188
+ floatingRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | {
189
+ region: RegionPlain | LegacyRegionPlain;
190
190
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
191
191
  regionId?: undefined | string;
192
192
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
193
193
  } | {
194
- region: RegionPlain;
194
+ region: RegionPlain | LegacyRegionPlain;
195
195
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
196
196
  regionId?: undefined | string;
197
197
  maxUpOffset?: undefined | number;
@@ -199,14 +199,14 @@ export type CheckSettingsImagePlain = {
199
199
  maxLeftOffset?: undefined | number;
200
200
  maxRightOffset?: undefined | number;
201
201
  }>;
202
- accessibilityRegions?: undefined | Array<RegionPlain | {
203
- region: RegionPlain;
202
+ accessibilityRegions?: undefined | Array<RegionPlain | LegacyRegionPlain | {
203
+ region: RegionPlain | LegacyRegionPlain;
204
204
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
205
205
  regionId?: undefined | string;
206
206
  type?: undefined | AccessibilityRegionTypePlain;
207
207
  }>;
208
208
  dynamicRegions?: undefined | Array<RegionPlain | {
209
- region: RegionPlain;
209
+ region: RegionPlain | LegacyRegionPlain;
210
210
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
211
211
  regionId?: undefined | string;
212
212
  type?: undefined | string | Array<string>;
@@ -217,7 +217,7 @@ export type CheckSettingsImagePlain = {
217
217
  };
218
218
  export type CheckSettingsAutomationPlain = {
219
219
  name?: undefined | string;
220
- region?: undefined | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })));
220
+ region?: undefined | (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })));
221
221
  matchLevel?: undefined | MatchLevelPlain;
222
222
  useDom?: undefined | boolean;
223
223
  sendDom?: undefined | boolean;
@@ -225,17 +225,17 @@ export type CheckSettingsAutomationPlain = {
225
225
  ignoreDisplacements?: undefined | boolean;
226
226
  ignoreMismatch?: undefined | boolean;
227
227
  ignoreCaret?: undefined | boolean;
228
- ignoreRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
229
- layoutRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
230
- strictRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
231
- contentRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
232
- floatingRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
233
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
228
+ ignoreRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
229
+ layoutRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
230
+ strictRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
231
+ contentRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>;
232
+ floatingRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
233
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
234
234
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
235
235
  regionId?: undefined | string;
236
236
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
237
237
  } | {
238
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
238
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
239
239
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
240
240
  regionId?: undefined | string;
241
241
  maxUpOffset?: undefined | number;
@@ -243,14 +243,14 @@ export type CheckSettingsAutomationPlain = {
243
243
  maxLeftOffset?: undefined | number;
244
244
  maxRightOffset?: undefined | number;
245
245
  }>;
246
- accessibilityRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
247
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
246
+ accessibilityRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
247
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
248
248
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
249
249
  regionId?: undefined | string;
250
250
  type?: undefined | AccessibilityRegionTypePlain;
251
251
  }>;
252
- dynamicRegions?: undefined | Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
253
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
252
+ dynamicRegions?: undefined | Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
253
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
254
254
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
255
255
  regionId?: undefined | string;
256
256
  type?: undefined | string | Array<string>;
@@ -265,6 +265,7 @@ export type CheckSettingsAutomationPlain = {
265
265
  disableBrowserFetching?: undefined | boolean;
266
266
  layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
267
267
  visualGridOptions?: undefined | { [key: string]: any; };
268
+ ufgOptions?: undefined | { [key: string]: any; };
268
269
  nmgOptions?: undefined | { [key: string]: any; };
269
270
  useSystemScreenshot?: undefined | boolean;
270
271
  hooks?: undefined | { beforeCaptureScreenshot: string; };
@@ -276,6 +277,7 @@ export class CheckSettingsAutomation {
276
277
  constructor(settings?: undefined | CheckSettingsAutomation);
277
278
  constructor(settings?: undefined | CheckSettingsAutomationPlain);
278
279
  region(region: RegionPlain): CheckSettingsAutomation;
280
+ region(region: LegacyRegionPlain): CheckSettingsAutomation;
279
281
  region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
280
282
  shadow(selector: string): CheckSettingsAutomation;
281
283
  shadow(selector: Selector): CheckSettingsAutomation;
@@ -309,33 +311,30 @@ export class CheckSettingsAutomation {
309
311
  densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
310
312
  name(name: string): CheckSettingsAutomation;
311
313
  withName(name: string): CheckSettingsAutomation;
312
- ignoreRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
313
- ignoreRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
314
- ignoreRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
315
- ignoreRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
316
- ignore(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
314
+ ignoreRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
315
+ ignoreRegion(region: { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
316
+ ignoreRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
317
+ ignore(region: RegionPlain): CheckSettingsAutomation;
317
318
  ignore(region: LegacyRegionPlain): CheckSettingsAutomation;
318
- ignores(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain>): CheckSettingsAutomation;
319
- layoutRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
320
- layoutRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
321
- layoutRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
322
- layoutRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
323
- strictRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
324
- strictRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
325
- strictRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
326
- strictRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
327
- contentRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
328
- contentRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
329
- contentRegion(region: { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
330
- contentRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | { region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
319
+ ignore(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
320
+ ignores(...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
321
+ layoutRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
322
+ layoutRegion(region: { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
323
+ layoutRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
324
+ strictRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
325
+ strictRegion(region: { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
326
+ strictRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
327
+ contentRegion(region: (RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
328
+ contentRegion(region: { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsAutomation;
329
+ contentRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | { region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsAutomation;
331
330
  floatingRegion(region: {
332
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
331
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
333
332
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
334
333
  regionId?: undefined | string;
335
334
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
336
335
  }): CheckSettingsAutomation;
337
336
  floatingRegion(region: {
338
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
337
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
339
338
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
340
339
  regionId?: undefined | string;
341
340
  maxUpOffset?: undefined | number;
@@ -343,59 +342,65 @@ export class CheckSettingsAutomation {
343
342
  maxLeftOffset?: undefined | number;
344
343
  maxRightOffset?: undefined | number;
345
344
  }): CheckSettingsAutomation;
346
- floatingRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
345
+ floatingRegion(region: RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
347
346
  floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
348
- floatingRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
349
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
347
+ floatingRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
348
+ floatingRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
349
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
350
350
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
351
351
  regionId?: undefined | string;
352
352
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
353
353
  }>): CheckSettingsAutomation;
354
- floatingRegions(maxOffset: number, ...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain>): CheckSettingsAutomation;
354
+ floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
355
355
  floating(region: {
356
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
356
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
357
357
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
358
358
  regionId?: undefined | string;
359
359
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
360
360
  }): CheckSettingsAutomation;
361
- floating(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
361
+ floating(region: RegionPlain): CheckSettingsAutomation;
362
362
  floating(region: LegacyRegionPlain): CheckSettingsAutomation;
363
- floatings(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
364
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
363
+ floating(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
364
+ floatings(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
365
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
365
366
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
366
367
  regionId?: undefined | string;
367
368
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
368
369
  }>): CheckSettingsAutomation;
369
- floatings(maxOffset: number, ...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain>): CheckSettingsAutomation;
370
+ floatings(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
370
371
  accessibilityRegion(region: {
371
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
372
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
372
373
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
373
374
  regionId?: undefined | string;
374
375
  type?: undefined | AccessibilityRegionTypePlain;
375
376
  }): CheckSettingsAutomation;
376
- accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
377
+ accessibilityRegion(region: RegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
377
378
  accessibilityRegion(region: LegacyRegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
378
- accessibilityRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
379
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
379
+ accessibilityRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
380
+ accessibilityRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
381
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
380
382
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
381
383
  regionId?: undefined | string;
382
384
  type?: undefined | AccessibilityRegionTypePlain;
383
385
  }>): CheckSettingsAutomation;
384
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain>): CheckSettingsAutomation;
386
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))>): CheckSettingsAutomation;
385
387
  dynamicRegion(region: {
386
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
388
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
387
389
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
388
390
  regionId?: undefined | string;
389
391
  type?: undefined | string | Array<string>;
390
392
  }): CheckSettingsAutomation;
391
393
  dynamicRegion(region: RegionPlain): CheckSettingsAutomation;
394
+ dynamicRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
392
395
  dynamicRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
393
396
  dynamicRegion(region: RegionPlain, type?: undefined | string): CheckSettingsAutomation;
397
+ dynamicRegion(region: LegacyRegionPlain, type?: undefined | string): CheckSettingsAutomation;
394
398
  dynamicRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | string): CheckSettingsAutomation;
395
399
  dynamicRegion(region: RegionPlain, type?: undefined | Array<string>): CheckSettingsAutomation;
400
+ dynamicRegion(region: LegacyRegionPlain, type?: undefined | Array<string>): CheckSettingsAutomation;
396
401
  dynamicRegion(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), type?: undefined | Array<string>): CheckSettingsAutomation;
397
- dynamicRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
398
- region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
402
+ dynamicRegions(...regions: Array<(RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
403
+ region: RegionPlain | LegacyRegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
399
404
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
400
405
  regionId?: undefined | string;
401
406
  type?: undefined | string | Array<string>;
@@ -419,8 +424,9 @@ export class CheckSettings extends CheckSettingsAutomation {
419
424
  }
420
425
  export type TargetAutomation = {
421
426
  window(): CheckSettingsAutomation;
422
- region(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
427
+ region(region: RegionPlain): CheckSettingsAutomation;
423
428
  region(region: LegacyRegionPlain): CheckSettingsAutomation;
429
+ region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
424
430
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
425
431
  frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
426
432
  frame(frame: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
@@ -432,8 +438,9 @@ export type TargetAutomation = {
432
438
  };
433
439
  export const TargetAutomation: {
434
440
  window(): CheckSettingsAutomation;
435
- region(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
441
+ region(region: RegionPlain): CheckSettingsAutomation;
436
442
  region(region: LegacyRegionPlain): CheckSettingsAutomation;
443
+ region(region: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
437
444
  frame(context: { frame: number | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })); }): CheckSettingsAutomation;
438
445
  frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
439
446
  frame(frame: (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })), scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
@@ -447,64 +454,158 @@ export type Target = TargetImage & TargetAutomation;
447
454
  export const Target: TargetImage & TargetAutomation;
448
455
  export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
449
456
  export type ConfigurationPlain = {
450
- debugScreenshots?: undefined | { save: boolean; path?: undefined | string; prefix?: undefined | string; };
457
+ accessibilityValidation?: undefined | AccessibilitySettings;
451
458
  agentId?: undefined | string;
452
459
  apiKey?: undefined | string;
453
- serverUrl?: undefined | string;
454
- proxy?: undefined | ProxySettingsPlain;
455
- autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
456
- isDisabled?: undefined | boolean;
457
- connectionTimeout?: undefined | number;
458
- removeSession?: undefined | boolean;
459
460
  appName?: undefined | string;
460
- testName?: undefined | string;
461
- displayName?: undefined | string;
462
- viewportSize?: undefined | RectangleSizePlain;
463
- sessionType?: undefined | SessionTypePlain;
464
- properties?: undefined | Array<PropertyDataPlain>;
461
+ autProxy?: undefined | (ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
462
+ baselineBranchName?: undefined | string;
463
+ baselineEnvName?: undefined | string;
465
464
  batch?: undefined | BatchInfoPlain;
465
+ branchName?: undefined | string;
466
+ browsersInfo?: undefined | Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
467
+ captureStatusBar?: undefined | boolean;
468
+ compareWithParentBranch?: undefined | boolean;
469
+ concurrentSessions?: undefined | number;
470
+ connectionTimeout?: undefined | number;
471
+ cut?: undefined | CutProviderPlain;
472
+ debugScreenshots?: undefined | { save: boolean; path?: undefined | string; prefix?: undefined | string; };
466
473
  defaultMatchSettings?: undefined | ImageMatchSettingsPlain;
467
- hostApp?: undefined | string;
468
- hostOS?: undefined | string;
469
- hostAppInfo?: undefined | string;
470
- hostOSInfo?: undefined | string;
471
474
  deviceInfo?: undefined | string;
472
- baselineEnvName?: undefined | string;
475
+ disableBrowserFetching?: undefined | boolean;
476
+ disableNMLUrlCache?: undefined | boolean;
477
+ displayName?: undefined | string;
478
+ dontCloseBatches?: undefined | boolean;
479
+ enablePatterns?: undefined | boolean;
473
480
  environmentName?: undefined | string;
474
- branchName?: undefined | string;
475
- parentBranchName?: undefined | string;
481
+ forceFullPageScreenshot?: undefined | boolean;
476
482
  gitMergeBaseTimestamp?: undefined | string;
477
- baselineBranchName?: undefined | string;
478
- compareWithParentBranch?: undefined | boolean;
483
+ hideCaret?: undefined | boolean;
484
+ hideScrollbars?: undefined | boolean;
485
+ hostApp?: undefined | string;
486
+ hostAppInfo?: undefined | string;
487
+ hostOS?: undefined | string;
488
+ hostOSInfo?: undefined | string;
479
489
  ignoreBaseline?: undefined | boolean;
490
+ ignoreCaret?: undefined | boolean;
491
+ ignoreDisplacements?: undefined | boolean;
480
492
  ignoreGitMergeBase?: undefined | boolean;
493
+ isDisabled?: undefined | boolean;
494
+ layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
495
+ matchLevel?: undefined | MatchLevelPlain;
496
+ matchTimeout?: undefined | number;
497
+ mobileOptions?: undefined | { keepNavigationBar?: undefined | boolean; };
498
+ parentBranchName?: undefined | string;
499
+ properties?: undefined | Array<PropertyDataPlain>;
500
+ proxy?: undefined | ProxySettingsPlain;
501
+ removeSession?: undefined | boolean;
502
+ rotation?: undefined | ImageRotationPlain;
503
+ saveDiffs?: undefined | boolean;
481
504
  saveFailedTests?: undefined | boolean;
482
505
  saveNewTests?: undefined | boolean;
483
- saveDiffs?: undefined | boolean;
484
- dontCloseBatches?: undefined | boolean;
506
+ scaleRatio?: undefined | number;
507
+ scrollRootElement?: undefined | Element | EyesSelector<Selector>;
485
508
  sendDom?: undefined | boolean;
486
- matchTimeout?: undefined | number;
487
- forceFullPageScreenshot?: undefined | boolean;
488
- waitBeforeScreenshots?: undefined | number;
509
+ serverUrl?: undefined | string;
510
+ sessionType?: undefined | SessionTypePlain;
489
511
  stitchMode?: undefined | StitchModePlain;
490
- hideScrollbars?: undefined | boolean;
491
- hideCaret?: undefined | boolean;
492
512
  stitchOverlap?: undefined | number;
493
- scrollRootElement?: undefined | Element | EyesSelector<Selector>;
494
- cut?: undefined | CutProviderPlain;
495
- rotation?: undefined | ImageRotationPlain;
496
- scaleRatio?: undefined | number;
497
- concurrentSessions?: undefined | number;
498
- browsersInfo?: undefined | Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone SE (3rd generation)" | "iPhone SE (2nd generation)" | "iPhone 13 mini" | "iPhone Xs Max"; }; })>;
513
+ testName?: undefined | string;
514
+ useDom?: undefined | boolean;
515
+ viewportSize?: undefined | RectangleSizePlain;
499
516
  visualGridOptions?: undefined | Record<string, any>;
500
- layoutBreakpoints?: undefined | boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
501
- disableBrowserFetching?: undefined | boolean;
502
517
  waitBeforeCapture?: undefined | number;
503
- disableNMLUrlCache?: undefined | boolean;
504
- captureStatusBar?: undefined | boolean;
518
+ waitBeforeScreenshots?: undefined | number;
505
519
  };
506
520
  export class Configuration implements Required<ConfigurationPlain> {
507
521
  constructor(config?: undefined | ConfigurationPlain);
522
+ get accessibilityValidation(): AccessibilitySettings;
523
+ set accessibilityValidation(accessibilityValidation: AccessibilitySettings);
524
+ getAccessibilityValidation(): AccessibilitySettings;
525
+ setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): Configuration;
526
+ get agentId(): string;
527
+ set agentId(agentId: string);
528
+ getAgentId(): string;
529
+ setAgentId(agentId: string): Configuration;
530
+ get apiKey(): string;
531
+ set apiKey(apiKey: string);
532
+ getApiKey(): string;
533
+ setApiKey(apiKey: string): Configuration;
534
+ get appName(): string;
535
+ set appName(appName: string);
536
+ getAppName(): string;
537
+ setAppName(appName: string): Configuration;
538
+ get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
539
+ set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
540
+ getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
541
+ setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
542
+ get baselineBranchName(): string;
543
+ set baselineBranchName(baselineBranchName: string);
544
+ getBaselineBranchName(): string;
545
+ setBaselineBranchName(baselineBranchName: string): Configuration;
546
+ get baselineEnvName(): string;
547
+ set baselineEnvName(baselineEnvName: string);
548
+ getBaselineEnvName(): string;
549
+ setBaselineEnvName(baselineEnvName: string): Configuration;
550
+ get batch(): BatchInfoPlain;
551
+ set batch(batch: BatchInfoPlain);
552
+ getBatch(): BatchInfo;
553
+ setBatch(batch: BatchInfoPlain): Configuration;
554
+ get branchName(): string;
555
+ set branchName(branchName: string);
556
+ getBranchName(): string;
557
+ setBranchName(branchName: string): Configuration;
558
+ get browsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
559
+ set browsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>);
560
+ getBrowsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs Max"; }; })>;
561
+ setBrowsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
562
+ addBrowsers(...browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
563
+ addBrowser(browserInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })): Configuration;
564
+ addBrowser(width: number, height: number, name?: undefined | BrowserTypePlain): Configuration;
565
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | ScreenOrientationPlain): Configuration;
566
+ addMultiDeviceTarget(deviceName: "iPhone X"): Configuration;
567
+ addMultiDeviceTarget(deviceName: "iPhone 14 Plus"): Configuration;
568
+ addMultiDeviceTarget(deviceName: "iPhone 14 Pro"): Configuration;
569
+ addMultiDeviceTarget(deviceName: "iPhone XR"): Configuration;
570
+ addMultiDeviceTarget(deviceName: "iPhone 11"): Configuration;
571
+ addMultiDeviceTarget(deviceName: "iPhone 11 Pro Max"): Configuration;
572
+ addMultiDeviceTarget(deviceName: "iPhone 11 Pro"): Configuration;
573
+ addMultiDeviceTarget(deviceName: "iPhone SE (2nd generation)"): Configuration;
574
+ addMultiDeviceTarget(deviceName: "iPhone SE (3rd generation)"): Configuration;
575
+ addMultiDeviceTarget(deviceName: "iPhone Xs"): Configuration;
576
+ addMultiDeviceTarget(deviceName: "iPhone 12"): Configuration;
577
+ addMultiDeviceTarget(deviceName: "iPhone 12 mini"): Configuration;
578
+ addMultiDeviceTarget(deviceName: "iPhone 12 Pro Max"): Configuration;
579
+ addMultiDeviceTarget(deviceName: "iPhone 12 Pro"): Configuration;
580
+ addMultiDeviceTarget(deviceName: "iPhone 13"): Configuration;
581
+ addMultiDeviceTarget(deviceName: "iPhone 13 mini"): Configuration;
582
+ addMultiDeviceTarget(deviceName: "iPhone 13 Pro Max"): Configuration;
583
+ addMultiDeviceTarget(deviceName: "iPhone 13 Pro"): Configuration;
584
+ addMultiDeviceTarget(deviceName: "iPhone 14"): Configuration;
585
+ addMultiDeviceTarget(deviceName: "iPhone 14 Pro Max"): Configuration;
586
+ addMultiDeviceTarget(deviceName: "iPhone 8"): Configuration;
587
+ addMultiDeviceTarget(deviceName: "iPhone 8 Plus"): Configuration;
588
+ addMultiDeviceTarget(deviceName: "iPhone Xs Max"): Configuration;
589
+ get captureStatusBar(): boolean;
590
+ set captureStatusBar(captureStatusBar: boolean);
591
+ getCaptureStatusBar(): boolean;
592
+ setCaptureStatusBar(captureStatusBar: boolean): Configuration;
593
+ get compareWithParentBranch(): boolean;
594
+ set compareWithParentBranch(compareWithParentBranch: boolean);
595
+ getCompareWithParentBranch(): boolean;
596
+ setCompareWithParentBranch(compareWithParentBranch: boolean): Configuration;
597
+ get concurrentSessions(): number;
598
+ set concurrentSessions(concurrentSessions: number);
599
+ getConcurrentSessions(): number;
600
+ setConcurrentSessions(concurrentSessions: number): Configuration;
601
+ get connectionTimeout(): number;
602
+ set connectionTimeout(connectionTimeout: number);
603
+ getConnectionTimeout(): number;
604
+ setConnectionTimeout(connectionTimeout: number): Configuration;
605
+ get cut(): CutProviderPlain;
606
+ set cut(cut: CutProviderPlain);
607
+ getCut(): CutProviderPlain;
608
+ setCut(cut: CutProviderPlain): Configuration;
508
609
  get debugScreenshots(): { save: boolean; path?: undefined | string; prefix?: undefined | string; };
509
610
  set debugScreenshots(debugScreenshots: { save: boolean; path?: undefined | string; prefix?: undefined | string; });
510
611
  getSaveDebugScreenshots(): boolean;
@@ -513,111 +614,138 @@ export class Configuration implements Required<ConfigurationPlain> {
513
614
  setDebugScreenshotsPath(path: string): Configuration;
514
615
  getDebugScreenshotsPrefix(): string;
515
616
  setDebugScreenshotsPrefix(prefix: string): Configuration;
516
- get appName(): string;
517
- set appName(appName: string);
518
- getAppName(): string;
519
- setAppName(appName: string): Configuration;
520
- get testName(): string;
521
- set testName(testName: string);
522
- getTestName(): string;
523
- setTestName(testName: string): Configuration;
617
+ get defaultMatchSettings(): ImageMatchSettingsPlain;
618
+ set defaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain);
619
+ getDefaultMatchSettings(): ImageMatchSettingsPlain;
620
+ setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain): Configuration;
621
+ get deviceInfo(): string;
622
+ set deviceInfo(deviceInfo: string);
623
+ getDeviceInfo(): string;
624
+ setDeviceInfo(deviceInfo: string): Configuration;
625
+ get disableBrowserFetching(): boolean;
626
+ set disableBrowserFetching(disableBrowserFetching: boolean);
627
+ getDisableBrowserFetching(): boolean;
628
+ setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
629
+ get disableNMLUrlCache(): boolean;
630
+ set disableNMLUrlCache(disableNMLUrlCache: boolean);
631
+ getDisableNMLUrlCache(): boolean;
632
+ setDisableNMLUrlCache(disableNMLUrlCache: boolean): Configuration;
524
633
  get displayName(): string;
525
634
  set displayName(displayName: string);
526
635
  getDisplayName(): string;
527
636
  setDisplayName(displayName: string): Configuration;
637
+ get dontCloseBatches(): boolean;
638
+ set dontCloseBatches(dontCloseBatches: boolean);
639
+ getDontCloseBatches(): boolean;
640
+ setDontCloseBatches(dontCloseBatches: boolean): Configuration;
641
+ get enablePatterns(): boolean;
642
+ set enablePatterns(enablePatterns: boolean);
643
+ getEnablePatterns(): boolean;
644
+ setEnablePatterns(enablePatterns: boolean): Configuration;
645
+ get environmentName(): string;
646
+ set environmentName(environmentName: string);
647
+ getEnvironmentName(): string;
648
+ setEnvironmentName(environmentName: string): Configuration;
649
+ get forceFullPageScreenshot(): boolean;
650
+ set forceFullPageScreenshot(forceFullPageScreenshot: boolean);
651
+ getForceFullPageScreenshot(): boolean;
652
+ setForceFullPageScreenshot(forceFullPageScreenshot: boolean): Configuration;
653
+ get gitMergeBaseTimestamp(): string;
654
+ set gitMergeBaseTimestamp(gitMergeBaseTimestamp: string);
655
+ getGitMergeBaseTimestamp(): string;
656
+ setGitMergeBaseTimestamp(gitMergeBaseTimestamp: string): Configuration;
657
+ get hideCaret(): boolean;
658
+ set hideCaret(hideCaret: boolean);
659
+ getHideCaret(): boolean;
660
+ setHideCaret(hideCaret: boolean): Configuration;
661
+ get hideScrollbars(): boolean;
662
+ set hideScrollbars(hideScrollbars: boolean);
663
+ getHideScrollbars(): boolean;
664
+ setHideScrollbars(hideScrollbars: boolean): Configuration;
665
+ get hostApp(): string;
666
+ set hostApp(hostApp: string);
667
+ getHostApp(): string;
668
+ setHostApp(hostApp: string): Configuration;
669
+ get hostAppInfo(): string;
670
+ set hostAppInfo(hostAppInfo: string);
671
+ getHostAppInfo(): string;
672
+ setHostAppInfo(hostAppInfo: string): Configuration;
673
+ get hostOS(): string;
674
+ set hostOS(hostOS: string);
675
+ getHostOS(): string;
676
+ setHostOS(hostOS: string): Configuration;
677
+ get hostOSInfo(): string;
678
+ set hostOSInfo(hostOSInfo: string);
679
+ getHostOSInfo(): string;
680
+ setHostOSInfo(hostOSInfo: string): Configuration;
681
+ get ignoreBaseline(): boolean;
682
+ set ignoreBaseline(ignoreBaseline: boolean);
683
+ getIgnoreBaseline(): boolean;
684
+ setIgnoreBaseline(ignoreBaseline: boolean): Configuration;
685
+ get ignoreCaret(): boolean;
686
+ set ignoreCaret(ignoreCaret: boolean);
687
+ getIgnoreCaret(): boolean;
688
+ setIgnoreCaret(ignoreCaret: boolean): Configuration;
689
+ get ignoreDisplacements(): boolean;
690
+ set ignoreDisplacements(ignoreDisplacements: boolean);
691
+ getIgnoreDisplacements(): boolean;
692
+ setIgnoreDisplacements(ignoreDisplacements: boolean): Configuration;
693
+ get ignoreGitMergeBase(): boolean;
694
+ set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
695
+ getIgnoreGitMergeBase(): boolean;
696
+ setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): Configuration;
528
697
  get isDisabled(): boolean;
529
698
  set isDisabled(isDisabled: boolean);
530
699
  getIsDisabled(): boolean;
531
700
  setIsDisabled(isDisabled: boolean): Configuration;
701
+ get layoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
702
+ set layoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; });
703
+ getLayoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
704
+ setLayoutBreakpoints(layoutBreakpoints: boolean): Configuration;
705
+ setLayoutBreakpoints(layoutBreakpoints: Array<number>): Configuration;
706
+ setLayoutBreakpoints(layoutBreakpoints: { breakpoints: boolean | Array<number>; reload?: undefined | boolean; }): Configuration;
707
+ get matchLevel(): MatchLevelPlain;
708
+ set matchLevel(matchLevel: MatchLevelPlain);
709
+ getMatchLevel(): MatchLevel;
710
+ setMatchLevel(matchLevel: MatchLevelPlain): Configuration;
532
711
  get matchTimeout(): number;
533
712
  set matchTimeout(matchTimeout: number);
534
713
  getMatchTimeout(): number;
535
714
  setMatchTimeout(matchTimeout: number): Configuration;
536
- get sessionType(): SessionTypePlain;
537
- set sessionType(sessionType: SessionTypePlain);
538
- getSessionType(): SessionType;
539
- setSessionType(sessionType: SessionTypePlain): Configuration;
540
- get viewportSize(): RectangleSizePlain;
541
- set viewportSize(viewportSize: RectangleSizePlain);
542
- getViewportSize(): RectangleSize;
543
- setViewportSize(viewportSize: RectangleSizePlain): Configuration;
544
- get agentId(): string;
545
- set agentId(agentId: string);
546
- getAgentId(): string;
547
- setAgentId(agentId: string): Configuration;
548
- get apiKey(): string;
549
- set apiKey(apiKey: string);
550
- getApiKey(): string;
551
- setApiKey(apiKey: string): Configuration;
552
- get serverUrl(): string;
553
- set serverUrl(serverUrl: string);
554
- getServerUrl(): string;
555
- setServerUrl(serverUrl: string): Configuration;
715
+ get mobileOptions(): { keepNavigationBar?: undefined | boolean; };
716
+ set mobileOptions(mobileOptions: { keepNavigationBar?: undefined | boolean; });
717
+ getMobileOptions(): { keepNavigationBar?: undefined | boolean; };
718
+ setMobileOptions(mobileOptions: { keepNavigationBar?: undefined | boolean; }): Configuration;
719
+ get parentBranchName(): string;
720
+ set parentBranchName(parentBranchName: string);
721
+ getParentBranchName(): string;
722
+ setParentBranchName(parentBranchName: string): Configuration;
723
+ get properties(): Array<PropertyDataPlain>;
724
+ set properties(properties: Array<PropertyDataPlain>);
725
+ getProperties(): Array<PropertyData>;
726
+ setProperties(properties: Array<PropertyDataPlain>): Configuration;
727
+ addProperty(name: string, value: string): Configuration;
728
+ addProperty(prop: PropertyDataPlain): Configuration;
729
+ clearProperties(): Configuration;
556
730
  get proxy(): ProxySettingsPlain;
557
731
  set proxy(proxy: ProxySettingsPlain);
558
732
  getProxy(): ProxySettings;
559
733
  setProxy(proxy: ProxySettingsPlain): Configuration;
560
734
  setProxy(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean): Configuration;
561
735
  setProxy(isEnabled: false): Configuration;
562
- get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
563
- set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
564
- getAutProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
565
- setAutProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; }): Configuration;
566
- get connectionTimeout(): number;
567
- set connectionTimeout(connectionTimeout: number);
568
- getConnectionTimeout(): number;
569
- setConnectionTimeout(connectionTimeout: number): Configuration;
570
736
  get removeSession(): boolean;
571
737
  set removeSession(removeSession: boolean);
572
738
  getRemoveSession(): boolean;
573
739
  setRemoveSession(removeSession: boolean): Configuration;
574
- get batch(): BatchInfoPlain;
575
- set batch(batch: BatchInfoPlain);
576
- getBatch(): BatchInfo;
577
- setBatch(batch: BatchInfoPlain): Configuration;
578
- get properties(): Array<PropertyDataPlain>;
579
- set properties(properties: Array<PropertyDataPlain>);
580
- getProperties(): Array<PropertyData>;
581
- setProperties(properties: Array<PropertyDataPlain>): Configuration;
582
- addProperty(name: string, value: string): Configuration;
583
- addProperty(prop: PropertyDataPlain): Configuration;
584
- clearProperties(): Configuration;
585
- get baselineEnvName(): string;
586
- set baselineEnvName(baselineEnvName: string);
587
- getBaselineEnvName(): string;
588
- setBaselineEnvName(baselineEnvName: string): Configuration;
589
- get environmentName(): string;
590
- set environmentName(environmentName: string);
591
- getEnvironmentName(): string;
592
- setEnvironmentName(environmentName: string): Configuration;
593
- get branchName(): string;
594
- set branchName(branchName: string);
595
- getBranchName(): string;
596
- setBranchName(branchName: string): Configuration;
597
- get parentBranchName(): string;
598
- set parentBranchName(parentBranchName: string);
599
- getParentBranchName(): string;
600
- setParentBranchName(parentBranchName: string): Configuration;
601
- get baselineBranchName(): string;
602
- set baselineBranchName(baselineBranchName: string);
603
- getBaselineBranchName(): string;
604
- setBaselineBranchName(baselineBranchName: string): Configuration;
605
- get gitMergeBaseTimestamp(): string;
606
- set gitMergeBaseTimestamp(gitMergeBaseTimestamp: string);
607
- getGitMergeBaseTimestamp(): string;
608
- setGitMergeBaseTimestamp(gitMergeBaseTimestamp: string): Configuration;
609
- get compareWithParentBranch(): boolean;
610
- set compareWithParentBranch(compareWithParentBranch: boolean);
611
- getCompareWithParentBranch(): boolean;
612
- setCompareWithParentBranch(compareWithParentBranch: boolean): Configuration;
613
- get ignoreGitMergeBase(): boolean;
614
- set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
615
- getIgnoreGitMergeBase(): boolean;
616
- setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): Configuration;
617
- get ignoreBaseline(): boolean;
618
- set ignoreBaseline(ignoreBaseline: boolean);
619
- getIgnoreBaseline(): boolean;
620
- setIgnoreBaseline(ignoreBaseline: boolean): Configuration;
740
+ get rotation(): ImageRotationPlain;
741
+ set rotation(rotation: ImageRotationPlain);
742
+ getRotation(): ImageRotation;
743
+ setRotation(rotation: ImageRotationPlain): Configuration;
744
+ setRotation(rotation: ImageRotation): Configuration;
745
+ get saveDiffs(): boolean;
746
+ set saveDiffs(saveDiffs: boolean);
747
+ getSaveDiffs(): boolean;
748
+ setSaveDiffs(saveDiffs: boolean): Configuration;
621
749
  get saveFailedTests(): boolean;
622
750
  set saveFailedTests(saveFailedTests: boolean);
623
751
  getSaveFailedTests(): boolean;
@@ -626,160 +754,60 @@ export class Configuration implements Required<ConfigurationPlain> {
626
754
  set saveNewTests(saveNewTests: boolean);
627
755
  getSaveNewTests(): boolean;
628
756
  setSaveNewTests(saveNewTests: boolean): Configuration;
629
- get saveDiffs(): boolean;
630
- set saveDiffs(saveDiffs: boolean);
631
- getSaveDiffs(): boolean;
632
- setSaveDiffs(saveDiffs: boolean): Configuration;
757
+ get scaleRatio(): number;
758
+ set scaleRatio(scaleRatio: number);
759
+ getScaleRatio(): number;
760
+ setScaleRatio(scaleRatio: number): Configuration;
761
+ get scrollRootElement(): Element | EyesSelector<Selector>;
762
+ set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
763
+ getScrollRootElement(): Element | EyesSelector<Selector>;
764
+ setScrollRootElement(scrollRootElement: Element): Configuration;
765
+ setScrollRootElement(scrollRootElement: EyesSelector<Selector>): Configuration;
633
766
  get sendDom(): boolean;
634
767
  set sendDom(sendDom: boolean);
635
768
  getSendDom(): boolean;
636
769
  setSendDom(sendDom: boolean): Configuration;
637
- get hostApp(): string;
638
- set hostApp(hostApp: string);
639
- getHostApp(): string;
640
- setHostApp(hostApp: string): Configuration;
641
- get hostOS(): string;
642
- set hostOS(hostOS: string);
643
- getHostOS(): string;
644
- setHostOS(hostOS: string): Configuration;
645
- get hostAppInfo(): string;
646
- set hostAppInfo(hostAppInfo: string);
647
- getHostAppInfo(): string;
648
- setHostAppInfo(hostAppInfo: string): Configuration;
649
- get hostOSInfo(): string;
650
- set hostOSInfo(hostOSInfo: string);
651
- getHostOSInfo(): string;
652
- setHostOSInfo(hostOSInfo: string): Configuration;
653
- get deviceInfo(): string;
654
- set deviceInfo(deviceInfo: string);
655
- getDeviceInfo(): string;
656
- setDeviceInfo(deviceInfo: string): Configuration;
657
- get defaultMatchSettings(): ImageMatchSettingsPlain;
658
- set defaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain);
659
- getDefaultMatchSettings(): ImageMatchSettingsPlain;
660
- setDefaultMatchSettings(defaultMatchSettings: ImageMatchSettingsPlain): Configuration;
661
- getMatchLevel(): MatchLevel;
662
- setMatchLevel(matchLevel: MatchLevelPlain): Configuration;
663
- getAccessibilityValidation(): AccessibilitySettings;
664
- setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): Configuration;
665
- getUseDom(): boolean;
666
- setUseDom(useDom: boolean): Configuration;
667
- getEnablePatterns(): boolean;
668
- setEnablePatterns(enablePatterns: boolean): Configuration;
669
- getIgnoreDisplacements(): boolean;
670
- setIgnoreDisplacements(ignoreDisplacements: boolean): Configuration;
671
- getIgnoreCaret(): boolean;
672
- setIgnoreCaret(ignoreCaret: boolean): Configuration;
673
- get forceFullPageScreenshot(): boolean;
674
- set forceFullPageScreenshot(forceFullPageScreenshot: boolean);
675
- getForceFullPageScreenshot(): boolean;
676
- setForceFullPageScreenshot(forceFullPageScreenshot: boolean): Configuration;
677
- get waitBeforeScreenshots(): number;
678
- set waitBeforeScreenshots(waitBeforeScreenshots: number);
679
- getWaitBeforeScreenshots(): number;
680
- setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration;
681
- get waitBeforeCapture(): number;
682
- set waitBeforeCapture(waitBeforeCapture: number);
683
- getWaitBeforeCapture(): number;
684
- setWaitBeforeCapture(waitBeforeCapture: number): Configuration;
770
+ get serverUrl(): string;
771
+ set serverUrl(serverUrl: string);
772
+ getServerUrl(): string;
773
+ setServerUrl(serverUrl: string): Configuration;
774
+ get sessionType(): SessionTypePlain;
775
+ set sessionType(sessionType: SessionTypePlain);
776
+ getSessionType(): SessionType;
777
+ setSessionType(sessionType: SessionTypePlain): Configuration;
685
778
  get stitchMode(): StitchModePlain;
686
779
  set stitchMode(stitchMode: StitchModePlain);
687
780
  getStitchMode(): StitchMode;
688
781
  setStitchMode(stitchMode: StitchModePlain): Configuration;
689
- get hideScrollbars(): boolean;
690
- set hideScrollbars(hideScrollbars: boolean);
691
- getHideScrollbars(): boolean;
692
- setHideScrollbars(hideScrollbars: boolean): Configuration;
693
- get hideCaret(): boolean;
694
- set hideCaret(hideCaret: boolean);
695
- getHideCaret(): boolean;
696
- setHideCaret(hideCaret: boolean): Configuration;
697
782
  get stitchOverlap(): number;
698
783
  set stitchOverlap(stitchOverlap: number);
699
784
  getStitchOverlap(): number;
700
785
  setStitchOverlap(stitchOverlap: number): Configuration;
701
- get scrollRootElement(): Element | EyesSelector<Selector>;
702
- set scrollRootElement(scrollRootElement: Element | EyesSelector<Selector>);
703
- getScrollRootElement(): Element | EyesSelector<Selector>;
704
- setScrollRootElement(scrollRootElement: Element): Configuration;
705
- setScrollRootElement(scrollRootElement: EyesSelector<Selector>): Configuration;
706
- get cut(): CutProviderPlain;
707
- set cut(cut: CutProviderPlain);
708
- getCut(): CutProviderPlain;
709
- setCut(cut: CutProviderPlain): Configuration;
710
- get rotation(): ImageRotationPlain;
711
- set rotation(rotation: ImageRotationPlain);
712
- getRotation(): ImageRotation;
713
- setRotation(rotation: ImageRotationPlain): Configuration;
714
- setRotation(rotation: ImageRotation): Configuration;
715
- get scaleRatio(): number;
716
- set scaleRatio(scaleRatio: number);
717
- getScaleRatio(): number;
718
- setScaleRatio(scaleRatio: number): Configuration;
719
- get concurrentSessions(): number;
720
- set concurrentSessions(concurrentSessions: number);
721
- getConcurrentSessions(): number;
722
- setConcurrentSessions(concurrentSessions: number): Configuration;
723
- get browsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone SE (3rd generation)" | "iPhone SE (2nd generation)" | "iPhone 13 mini" | "iPhone Xs Max"; }; })>;
724
- set browsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone SE (3rd generation)" | "iPhone SE (2nd generation)" | "iPhone 13 mini" | "iPhone Xs Max"; }; })>);
725
- getBrowsersInfo(): Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { iosDeviceInfo: { deviceName: "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone SE (3rd generation)" | "iPhone SE (2nd generation)" | "iPhone 13 mini" | "iPhone Xs Max"; }; })>;
726
- setBrowsersInfo(browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
727
- addBrowsers(...browsersInfo: Array<(DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })>): Configuration;
728
- addBrowser(browserInfo: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; })): Configuration;
729
- addBrowser(width: number, height: number, name?: undefined | BrowserTypePlain): Configuration;
730
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | ScreenOrientationPlain): Configuration;
731
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
732
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
733
- addMultiDeviceTarget(deviceName: "iPhone X"): Configuration;
734
- addMultiDeviceTarget(deviceName: "iPhone 14 Plus"): Configuration;
735
- addMultiDeviceTarget(deviceName: "iPhone 14 Pro"): Configuration;
736
- addMultiDeviceTarget(deviceName: "iPhone XR"): Configuration;
737
- addMultiDeviceTarget(deviceName: "iPhone 11"): Configuration;
738
- addMultiDeviceTarget(deviceName: "iPhone 11 Pro Max"): Configuration;
739
- addMultiDeviceTarget(deviceName: "iPhone 11 Pro"): Configuration;
740
- addMultiDeviceTarget(deviceName: "iPhone 8"): Configuration;
741
- addMultiDeviceTarget(deviceName: "iPhone 8 Plus"): Configuration;
742
- addMultiDeviceTarget(deviceName: "iPhone Xs"): Configuration;
743
- addMultiDeviceTarget(deviceName: "iPhone 12"): Configuration;
744
- addMultiDeviceTarget(deviceName: "iPhone 12 mini"): Configuration;
745
- addMultiDeviceTarget(deviceName: "iPhone 12 Pro Max"): Configuration;
746
- addMultiDeviceTarget(deviceName: "iPhone 12 Pro"): Configuration;
747
- addMultiDeviceTarget(deviceName: "iPhone 13"): Configuration;
748
- addMultiDeviceTarget(deviceName: "iPhone 13 Pro Max"): Configuration;
749
- addMultiDeviceTarget(deviceName: "iPhone 13 Pro"): Configuration;
750
- addMultiDeviceTarget(deviceName: "iPhone 14"): Configuration;
751
- addMultiDeviceTarget(deviceName: "iPhone 14 Pro Max"): Configuration;
752
- addMultiDeviceTarget(deviceName: "iPhone SE (3rd generation)"): Configuration;
753
- addMultiDeviceTarget(deviceName: "iPhone SE (2nd generation)"): Configuration;
754
- addMultiDeviceTarget(deviceName: "iPhone 13 mini"): Configuration;
755
- addMultiDeviceTarget(deviceName: "iPhone Xs Max"): Configuration;
786
+ get testName(): string;
787
+ set testName(testName: string);
788
+ getTestName(): string;
789
+ setTestName(testName: string): Configuration;
790
+ get useDom(): boolean;
791
+ set useDom(useDom: boolean);
792
+ getUseDom(): boolean;
793
+ setUseDom(useDom: boolean): Configuration;
794
+ get viewportSize(): RectangleSizePlain;
795
+ set viewportSize(viewportSize: RectangleSizePlain);
796
+ getViewportSize(): RectangleSize;
797
+ setViewportSize(viewportSize: RectangleSizePlain): Configuration;
756
798
  get visualGridOptions(): { [key: string]: any; };
757
799
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
758
800
  getVisualGridOptions(): { [key: string]: any; };
759
801
  setVisualGridOptions(visualGridOptions: { [key: string]: any; }): Configuration;
760
802
  setVisualGridOption(key: string, value: any): Configuration;
761
- get layoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
762
- set layoutBreakpoints(layoutBreakpoints: boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; });
763
- getLayoutBreakpoints(): boolean | Array<number> | { breakpoints: boolean | Array<number>; reload?: undefined | boolean; };
764
- setLayoutBreakpoints(layoutBreakpoints: boolean): Configuration;
765
- setLayoutBreakpoints(layoutBreakpoints: Array<number>): Configuration;
766
- setLayoutBreakpoints(layoutBreakpoints: { breakpoints: boolean | Array<number>; reload?: undefined | boolean; }): Configuration;
767
- get disableBrowserFetching(): boolean;
768
- set disableBrowserFetching(disableBrowserFetching: boolean);
769
- getDisableBrowserFetching(): boolean;
770
- setDisableBrowserFetching(disableBrowserFetching: boolean): Configuration;
771
- get dontCloseBatches(): boolean;
772
- set dontCloseBatches(dontCloseBatches: boolean);
773
- getDontCloseBatches(): boolean;
774
- setDontCloseBatches(dontCloseBatches: boolean): Configuration;
775
- get disableNMLUrlCache(): boolean;
776
- set disableNMLUrlCache(disableNMLUrlCache: boolean);
777
- getDisableNMLUrlCache(): boolean;
778
- setDisableNMLUrlCache(disableNMLUrlCache: boolean): Configuration;
779
- get captureStatusBar(): boolean;
780
- set captureStatusBar(captureStatusBar: boolean);
781
- getCaptureStatusBar(): boolean;
782
- setCaptureStatusBar(captureStatusBar: boolean): Configuration;
803
+ get waitBeforeCapture(): number;
804
+ set waitBeforeCapture(waitBeforeCapture: number);
805
+ getWaitBeforeCapture(): number;
806
+ setWaitBeforeCapture(waitBeforeCapture: number): Configuration;
807
+ get waitBeforeScreenshots(): number;
808
+ set waitBeforeScreenshots(waitBeforeScreenshots: number);
809
+ getWaitBeforeScreenshots(): number;
810
+ setWaitBeforeScreenshots(waitBeforeScreenshots: number): Configuration;
783
811
  }
784
812
  export class BatchClose {
785
813
  static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
@@ -922,17 +950,19 @@ export enum FailureReport {
922
950
  IMMEDIATE = 'IMMEDIATE',
923
951
  ON_CLOSE = 'ON_CLOSE'
924
952
  }
925
- export type IosDeviceNamePlain = "iPhone X" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (4th generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPhone 8" | "iPhone 8 Plus" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 15" | "iPhone 15 Pro Max";
953
+ export type IosDeviceNamePlain = "iPhone X" | "iPhone 14 Plus" | "iPhone 14 Pro" | "iPhone 15 Pro" | "iPhone XR" | "iPhone 11" | "iPhone 11 Pro Max" | "iPhone 11 Pro" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad (10th generation)" | "iPad mini (6th generation)" | "iPad Air (4th generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad Pro (11-inch) (4th generation)" | "iPhone SE (2nd generation)" | "iPhone SE (3rd generation)" | "iPhone Xs" | "iPhone 12" | "iPhone 12 mini" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 13" | "iPhone 13 mini" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 14" | "iPhone 14 Pro Max" | "iPhone 15" | "iPhone 15 Pro Max" | "iPhone 15 Plus" | "iPhone 16" | "iPhone 16 Pro Max" | "iPhone 16 Pro" | "iPhone 16 Plus";
926
954
  export enum IosDeviceName {
927
955
  iPad_7 = 'iPad (7th generation)',
928
956
  iPad_9 = 'iPad (9th generation)',
957
+ iPad_10 = 'iPad (10th generation)',
958
+ iPad_mini_6 = 'iPad mini (6th generation)',
929
959
  iPad_Air_4 = 'iPad Air (4th generation)',
930
960
  iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)',
931
961
  iPad_Pro_12_9_inch_3 = 'iPad Pro (12.9-inch) (3rd generation)',
932
962
  iPad_Pro_4 = 'iPad Pro (11-inch) (4th generation)',
933
963
  iPad_Pro_11_inch_4 = 'iPad Pro (11-inch) (4th generation)',
934
- iPhone_8 = 'iPhone 8',
935
- iPhone_8_Plus = 'iPhone 8 Plus',
964
+ iPhone_SE_2 = 'iPhone SE (2nd generation)',
965
+ iPhone_SE_3 = 'iPhone SE (3rd generation)',
936
966
  iPhone_X = 'iPhone X',
937
967
  iPhone_XR = 'iPhone XR',
938
968
  iPhone_XS = 'iPhone Xs',
@@ -945,56 +975,28 @@ export enum IosDeviceName {
945
975
  iPhone_12_Pro_Max = 'iPhone 12 Pro Max',
946
976
  iPhone_12_Pro = 'iPhone 12 Pro',
947
977
  iPhone_13 = 'iPhone 13',
978
+ iPhone_13_mini = 'iPhone 13 mini',
948
979
  iPhone_13_Pro_Max = 'iPhone 13 Pro Max',
949
980
  iPhone_13_Pro = 'iPhone 13 Pro',
950
981
  iPhone_14 = 'iPhone 14',
951
982
  iPhone_14_Pro_Max = 'iPhone 14 Pro Max',
983
+ iPhone_14_Pro = 'iPhone 14 Pro',
984
+ iPhone_14_Plus = 'iPhone 14 Plus',
952
985
  iPhone_15 = 'iPhone 15',
953
- iPhone_15_Pro_Max = 'iPhone 15 Pro Max'
986
+ iPhone_15_Pro_Max = 'iPhone 15 Pro Max',
987
+ iPhone_15_Pro = 'iPhone 15 Pro',
988
+ iPhone_15_Plus = 'iPhone 15 Plus',
989
+ iPhone_16 = 'iPhone 16',
990
+ iPhone_16_Pro_Max = 'iPhone 16 Pro Max',
991
+ iPhone_16_Pro = 'iPhone 16 Pro',
992
+ iPhone_16_Plus = 'iPhone 16 Plus'
954
993
  }
955
- export type IosVersionPlain = AndroidVersionPlain;
994
+ export type IosVersionPlain = "latest" | "latest-1";
956
995
  export enum IosVersion {
957
996
  LATEST = 'latest',
958
997
  ONE_VERSION_BACK = 'latest-1',
959
998
  LATEST_ONE_VERSION_BACK = 'latest-1'
960
999
  }
961
- export type AndroidDeviceNamePlain = "Galaxy S20" | "Galaxy S22" | "Galaxy S21" | "Galaxy S21 Ultra" | "Galaxy S10" | "Galaxy S9" | "Galaxy S10 Plus" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Tab S8" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5" | "Galaxy Tab S7" | "Sony Xperia 10 II" | "Galaxy S20 Plus" | "Galaxy S21 Plus" | "Xiaomi Redmi Note 11 Pro" | "Xiaomi Redmi Note 11" | "Xiaomi Redmi Note 10 JE" | "Pixel 6" | "Galaxy S22 Plus" | "Sony Xperia 1 II" | "Sony Xperia Ace II" | "Huawei P30 Lite";
962
- export enum AndroidDeviceName {
963
- Galaxy_S20 = 'Galaxy S20',
964
- Galaxy_S20_Plus = 'Galaxy S20 Plus',
965
- Galaxy_S20_PLUS = 'Galaxy S20 Plus',
966
- Galaxy_S21_Ultra = 'Galaxy S21 Ultra',
967
- Galaxy_S21_ULTRA = 'Galaxy S21 Ultra',
968
- Galaxy_Note_10_Plus = 'Galaxy Note 10 Plus',
969
- Galaxy_S9 = 'Galaxy S9',
970
- Galaxy_S10 = 'Galaxy S10',
971
- Galaxy_S10_Plus = 'Galaxy S10 Plus',
972
- Pixel_4_XL = 'Pixel 4 XL',
973
- Pixel_3_XL = 'Pixel 3 XL',
974
- Galaxy_S21 = 'Galaxy S21',
975
- Galaxy_S21_Plus = 'Galaxy S21 Plus',
976
- Galaxy_S21_PLUS = 'Galaxy S21 Plus',
977
- Xiaomi_Redmi_Note_11_Pro = 'Xiaomi Redmi Note 11 Pro',
978
- Xiaomi_Redmi_Note_11 = 'Xiaomi Redmi Note 11',
979
- Xiaomi_Redmi_Note_10_JE = 'Xiaomi Redmi Note 10 JE',
980
- Pixel_6 = 'Pixel 6',
981
- Galaxy_Note_10 = 'Galaxy Note 10',
982
- Pixel_4 = 'Pixel 4',
983
- Pixel_5 = 'Pixel 5',
984
- Galaxy_S22 = 'Galaxy S22',
985
- Galaxy_S22_Plus = 'Galaxy S22 Plus',
986
- Galaxy_Tab_S8 = 'Galaxy Tab S8',
987
- Galaxy_Tab_S7 = 'Galaxy Tab S7',
988
- Sony_Xperia_10_II = 'Sony Xperia 10 II',
989
- Sony_Xperia_1_II = 'Sony Xperia 1 II',
990
- Sony_Xperia_Ace_II = 'Sony Xperia Ace II',
991
- Huawei_P30_Lite = 'Huawei P30 Lite'
992
- }
993
- export type AndroidVersionPlain = "latest" | "latest-1";
994
- export enum AndroidVersion {
995
- LATEST = 'latest',
996
- ONE_VERSION_BACK = 'latest-1'
997
- }
998
1000
  export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Dynamic" | "Exact";
999
1001
  export enum MatchLevel {
1000
1002
  None = 'None',
@@ -1170,31 +1172,31 @@ export class CheckSettingsImage {
1170
1172
  withName(name: string): CheckSettingsImage;
1171
1173
  ignoreRegion(region: RegionPlain): CheckSettingsImage;
1172
1174
  ignoreRegion(region: LegacyRegionPlain): CheckSettingsImage;
1173
- ignoreRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1174
- ignoreRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1175
+ ignoreRegion(region: { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1176
+ ignoreRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1175
1177
  ignore(region: RegionPlain): CheckSettingsImage;
1176
1178
  ignore(region: LegacyRegionPlain): CheckSettingsImage;
1177
1179
  ignores(...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1178
1180
  layoutRegion(region: RegionPlain): CheckSettingsImage;
1179
1181
  layoutRegion(region: LegacyRegionPlain): CheckSettingsImage;
1180
- layoutRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1181
- layoutRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1182
+ layoutRegion(region: { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1183
+ layoutRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1182
1184
  strictRegion(region: RegionPlain): CheckSettingsImage;
1183
1185
  strictRegion(region: LegacyRegionPlain): CheckSettingsImage;
1184
- strictRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1185
- strictRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1186
+ strictRegion(region: { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1187
+ strictRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1186
1188
  contentRegion(region: RegionPlain): CheckSettingsImage;
1187
1189
  contentRegion(region: LegacyRegionPlain): CheckSettingsImage;
1188
- contentRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1189
- contentRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1190
+ contentRegion(region: { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1191
+ contentRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain | LegacyRegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1190
1192
  floatingRegion(region: {
1191
- region: RegionPlain;
1193
+ region: RegionPlain | LegacyRegionPlain;
1192
1194
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1193
1195
  regionId?: undefined | string;
1194
1196
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1195
1197
  }): CheckSettingsImage;
1196
1198
  floatingRegion(region: {
1197
- region: RegionPlain;
1199
+ region: RegionPlain | LegacyRegionPlain;
1198
1200
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1199
1201
  regionId?: undefined | string;
1200
1202
  maxUpOffset?: undefined | number;
@@ -1205,14 +1207,14 @@ export class CheckSettingsImage {
1205
1207
  floatingRegion(region: RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1206
1208
  floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1207
1209
  floatingRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
1208
- region: RegionPlain;
1210
+ region: RegionPlain | LegacyRegionPlain;
1209
1211
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1210
1212
  regionId?: undefined | string;
1211
1213
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1212
1214
  }>): CheckSettingsImage;
1213
1215
  floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1214
1216
  floating(region: {
1215
- region: RegionPlain;
1217
+ region: RegionPlain | LegacyRegionPlain;
1216
1218
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1217
1219
  regionId?: undefined | string;
1218
1220
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
@@ -1220,14 +1222,14 @@ export class CheckSettingsImage {
1220
1222
  floating(region: RegionPlain): CheckSettingsImage;
1221
1223
  floating(region: LegacyRegionPlain): CheckSettingsImage;
1222
1224
  floatings(...regions: Array<RegionPlain | LegacyRegionPlain | {
1223
- region: RegionPlain;
1225
+ region: RegionPlain | LegacyRegionPlain;
1224
1226
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1225
1227
  regionId?: undefined | string;
1226
1228
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1227
1229
  }>): CheckSettingsImage;
1228
1230
  floatings(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1229
1231
  accessibilityRegion(region: {
1230
- region: RegionPlain;
1232
+ region: RegionPlain | LegacyRegionPlain;
1231
1233
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1232
1234
  regionId?: undefined | string;
1233
1235
  type?: undefined | AccessibilityRegionTypePlain;
@@ -1235,14 +1237,14 @@ export class CheckSettingsImage {
1235
1237
  accessibilityRegion(region: RegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsImage;
1236
1238
  accessibilityRegion(region: LegacyRegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsImage;
1237
1239
  accessibilityRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
1238
- region: RegionPlain;
1240
+ region: RegionPlain | LegacyRegionPlain;
1239
1241
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1240
1242
  regionId?: undefined | string;
1241
1243
  type?: undefined | AccessibilityRegionTypePlain;
1242
1244
  }>): CheckSettingsImage;
1243
1245
  accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1244
1246
  dynamicRegion(region: {
1245
- region: RegionPlain;
1247
+ region: RegionPlain | LegacyRegionPlain;
1246
1248
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1247
1249
  regionId?: undefined | string;
1248
1250
  type?: undefined | string | Array<string>;
@@ -1251,7 +1253,7 @@ export class CheckSettingsImage {
1251
1253
  dynamicRegion(region: RegionPlain, type?: undefined | string): CheckSettingsImage;
1252
1254
  dynamicRegion(region: RegionPlain, type?: undefined | Array<string>): CheckSettingsImage;
1253
1255
  dynamicRegions(...regions: Array<RegionPlain | {
1254
- region: RegionPlain;
1256
+ region: RegionPlain | LegacyRegionPlain;
1255
1257
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1256
1258
  regionId?: undefined | string;
1257
1259
  type?: undefined | string | Array<string>;
@@ -1596,8 +1598,7 @@ export class Region implements Required<RegionPlain> {
1596
1598
  }
1597
1599
  export type DesktopBrowserInfo = { name?: undefined | BrowserTypePlain; width: number; height: number; };
1598
1600
  export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1599
- export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | AndroidVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1600
- export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | AndroidVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1601
+ export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | IosVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1601
1602
  export type RunnerOptionsPlain = { testConcurrency?: undefined | number; fetchConcurrency?: undefined | number; removeDuplicateTests?: undefined | boolean; };
1602
1603
  export class RunnerOptionsFluent {
1603
1604
  testConcurrency(concurrency: number): RunnerOptionsFluent;
@@ -1829,14 +1830,14 @@ export class TestResults implements Required<TestResultsPlain> {
1829
1830
  delete(): Promise<void>;
1830
1831
  deleteSession(): Promise<void>;
1831
1832
  }
1832
- export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }); };
1833
+ export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }); };
1833
1834
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1834
1835
  get testResults(): TestResultsPlain;
1835
1836
  getTestResults(): TestResults;
1836
1837
  get exception(): Error;
1837
1838
  getException(): Error;
1838
- get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1839
- getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1839
+ get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1840
+ getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1840
1841
  }
1841
1842
  export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1842
1843
  export class TestResultsSummary implements Iterable<TestResultContainer> {