@applitools/eyes-puppeteer 1.17.3 → 1.17.5

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 +25 -0
  2. package/package.json +5 -5
  3. package/types/index.d.ts +100 -131
package/CHANGELOG.md CHANGED
@@ -1,5 +1,30 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.17.5](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-puppeteer@1.17.4...js/eyes-puppeteer@1.17.5) (2023-06-21)
4
+
5
+
6
+ ### Dependencies
7
+
8
+ * @applitools/eyes bumped from 1.2.17 to 1.3.0
9
+ #### Features
10
+
11
+ * added overload for locate method, to call it with custom target ([5d5914a](https://github.com/applitools/eyes.sdk.javascript1/commit/5d5914a5dae6822cde0086d6b9f4d6f9ac7cc4f2))
12
+
13
+
14
+
15
+ * @applitools/spec-driver-puppeteer bumped from 1.1.65 to 1.1.66
16
+
17
+
18
+ ## [1.17.4](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-puppeteer@1.17.3...js/eyes-puppeteer@1.17.4) (2023-06-15)
19
+
20
+
21
+ ### Dependencies
22
+
23
+ * update some dependencies
24
+ * The following workspace dependencies were updated
25
+ * dependencies
26
+ * @applitools/eyes bumped from 1.2.16 to 1.2.17
27
+
3
28
  ## [1.17.3](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-puppeteer@1.17.2...js/eyes-puppeteer@1.17.3) (2023-06-14)
4
29
 
5
30
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-puppeteer",
3
- "version": "1.17.3",
3
+ "version": "1.17.5",
4
4
  "description": "Applitools Eyes SDK for Puppeteer",
5
5
  "keywords": [
6
6
  "eyes-puppeteer",
@@ -36,16 +36,16 @@
36
36
  "scripts": {
37
37
  "lint": "run --top-level eslint '**/*.ts'",
38
38
  "build": "run --top-level tspc --project ./tsconfig.build.json",
39
- "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes-puppeteer'",
39
+ "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes-puppeteer' --meta-path './logs'",
40
40
  "test": "yarn test:coverage",
41
41
  "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-puppeteer' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage run --top-level mocha './test/generic/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-15} --exit",
42
42
  "up:framework": "run --top-level add-silent puppeteer",
43
- "report": "bongo report --name 'puppeteer'",
43
+ "report": "bongo report --name 'puppeteer' --result-path './logs' --meta-path './logs'",
44
44
  "notify": "dlx --package @applitools/bongo bongo send-release-notification --name 'puppeteer'"
45
45
  },
46
46
  "dependencies": {
47
- "@applitools/eyes": "1.2.16",
48
- "@applitools/spec-driver-puppeteer": "1.1.65"
47
+ "@applitools/eyes": "1.3.0",
48
+ "@applitools/spec-driver-puppeteer": "1.1.66"
49
49
  },
50
50
  "devDependencies": {
51
51
  "@applitools/api-extractor": "^1.2.21",
package/types/index.d.ts CHANGED
@@ -33,15 +33,13 @@ export class Eyes {
33
33
  off(handler: (...args: Array<any>) => any): void;
34
34
  getExecutionCloudUrl(): Promise<string>;
35
35
  open(driver: Driver, config?: undefined | ConfigurationPlain): Promise<Driver>;
36
- open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL"): Promise<Driver>;
37
- open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "PROGRESSION"): Promise<Driver>;
36
+ open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | SessionTypePlain): Promise<Driver>;
38
37
  open(config?: undefined | ConfigurationPlain): Promise<void>;
39
- open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL"): Promise<void>;
40
- open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "PROGRESSION"): Promise<void>;
41
- check(name: string, checkSettings: CheckSettingsImage): Promise<MatchResult>;
38
+ open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | SessionTypePlain): Promise<void>;
42
39
  check(name: string, checkSettings: CheckSettingsAutomation): Promise<MatchResult>;
40
+ check(name: string, checkSettings: CheckSettingsImage): Promise<MatchResult>;
43
41
  check(target: {
44
- image: string | URL | Buffer;
42
+ image: string | Buffer | URL;
45
43
  name?: undefined | string;
46
44
  dom?: undefined | string;
47
45
  locationInViewport?: undefined | LocationPlain;
@@ -57,19 +55,29 @@ export class Eyes {
57
55
  checkElementBy(selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
58
56
  checkRegion(region: RegionPlain, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
59
57
  checkRegion(image: string, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
60
- checkRegion(image: URL, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
61
58
  checkRegion(image: Buffer, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
59
+ checkRegion(image: URL, region: RegionPlain, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
62
60
  checkRegionByElement(element: Element, name?: undefined | string, timeout?: undefined | number): Promise<MatchResult>;
63
61
  checkRegionBy(selector: EyesSelector<Selector>, name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
64
62
  checkRegionInFrame(frame: number, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
65
63
  checkRegionInFrame(frame: Element, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
66
64
  checkRegionInFrame(frame: EyesSelector<Selector>, selector: EyesSelector<Selector>, timeout?: undefined | number, name?: undefined | string, fully?: undefined | boolean): Promise<MatchResult>;
67
65
  checkImage(image: string, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
68
- checkImage(image: URL, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
69
66
  checkImage(image: Buffer, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
67
+ checkImage(image: URL, name?: undefined | string, ignoreMismatch?: undefined | boolean): Promise<MatchResult>;
68
+ locate<TLocator extends string>(target: {
69
+ image: string | Buffer | URL;
70
+ size?: undefined | { width: number; height: number; };
71
+ name?: undefined | string;
72
+ source?: undefined | string;
73
+ dom?: undefined | string;
74
+ locationInViewport?: undefined | { x: number; y: number; };
75
+ locationInView?: undefined | { x: number; y: number; };
76
+ fullViewSize?: undefined | { width: number; height: number; };
77
+ }, settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
70
78
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
71
79
  extractTextRegions<TPattern extends string>(target: {
72
- image: string | URL | Buffer;
80
+ image: string | Buffer | URL;
73
81
  size?: undefined | { width: number; height: number; };
74
82
  name?: undefined | string;
75
83
  source?: undefined | string;
@@ -78,10 +86,10 @@ export class Eyes {
78
86
  locationInView?: undefined | { x: number; y: number; };
79
87
  fullViewSize?: undefined | { width: number; height: number; };
80
88
  }, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
81
- extractTextRegions<TPattern extends string>(settingsWithImage: OCRSettings<TPattern> & { image: string | URL | Buffer; }): Promise<Record<TPattern, Array<TextRegion>>>;
89
+ extractTextRegions<TPattern extends string>(settingsWithImage: OCRSettings<TPattern> & { image: string | Buffer | URL; }): Promise<Record<TPattern, Array<TextRegion>>>;
82
90
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
83
91
  extractText(target: {
84
- image: string | URL | Buffer;
92
+ image: string | Buffer | URL;
85
93
  size?: undefined | { width: number; height: number; };
86
94
  name?: undefined | string;
87
95
  source?: undefined | string;
@@ -90,7 +98,7 @@ export class Eyes {
90
98
  locationInView?: undefined | { x: number; y: number; };
91
99
  fullViewSize?: undefined | { width: number; height: number; };
92
100
  }, settings: Array<OCRRegion>): Promise<Array<string>>;
93
- extractText(settingsWithImage: Array<OCRRegion & { image: string | URL | Buffer; }>): Promise<Array<string>>;
101
+ extractText(settingsWithImage: Array<OCRRegion & { image: string | Buffer | URL; }>): Promise<Array<string>>;
94
102
  extractText(settings: Array<OCRRegion>): Promise<Array<string>>;
95
103
  close(throwErr?: undefined | boolean): Promise<TestResults>;
96
104
  closeAsync(): Promise<void>;
@@ -240,25 +248,25 @@ export class CheckSettingsAutomation {
240
248
  densityMetrics(options: { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; }): CheckSettingsAutomation;
241
249
  name(name: string): CheckSettingsAutomation;
242
250
  withName(name: string): CheckSettingsAutomation;
243
- ignoreRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
244
251
  ignoreRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
252
+ ignoreRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
245
253
  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;
246
- ignoreRegions(...regions: Array<LegacyRegionPlain | (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; }>): CheckSettingsAutomation;
247
- ignore(region: LegacyRegionPlain): CheckSettingsAutomation;
254
+ 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;
248
255
  ignore(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
249
- ignores(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
250
- layoutRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
256
+ ignore(region: LegacyRegionPlain): CheckSettingsAutomation;
257
+ ignores(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain>): CheckSettingsAutomation;
251
258
  layoutRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
259
+ layoutRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
252
260
  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;
253
- layoutRegions(...regions: Array<LegacyRegionPlain | (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; }>): CheckSettingsAutomation;
254
- strictRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
261
+ 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;
255
262
  strictRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
263
+ strictRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
256
264
  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;
257
- strictRegions(...regions: Array<LegacyRegionPlain | (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; }>): CheckSettingsAutomation;
258
- contentRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
265
+ 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;
259
266
  contentRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
267
+ contentRegion(region: LegacyRegionPlain): CheckSettingsAutomation;
260
268
  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;
261
- contentRegions(...regions: Array<LegacyRegionPlain | (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; }>): CheckSettingsAutomation;
269
+ 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;
262
270
  floatingRegion(region: {
263
271
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
264
272
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -274,53 +282,45 @@ export class CheckSettingsAutomation {
274
282
  maxLeftOffset?: undefined | number;
275
283
  maxRightOffset?: undefined | number;
276
284
  }): CheckSettingsAutomation;
277
- floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
278
285
  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;
279
- floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
286
+ floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
287
+ floatingRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
280
288
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
281
289
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
282
290
  regionId?: undefined | string;
283
291
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
284
292
  }>): CheckSettingsAutomation;
285
- floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
293
+ 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;
286
294
  floating(region: {
287
295
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
288
296
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
289
297
  regionId?: undefined | string;
290
298
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
291
299
  }): CheckSettingsAutomation;
292
- floating(region: LegacyRegionPlain): CheckSettingsAutomation;
293
300
  floating(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
294
- floatings(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
301
+ floating(region: LegacyRegionPlain): CheckSettingsAutomation;
302
+ floatings(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
295
303
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
296
304
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
297
305
  regionId?: undefined | string;
298
306
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
299
307
  }>): CheckSettingsAutomation;
300
- floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
308
+ 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;
301
309
  accessibilityRegion(region: {
302
310
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
303
311
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
304
312
  regionId?: undefined | string;
305
- type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
313
+ type?: undefined | AccessibilityRegionTypePlain;
306
314
  }): CheckSettingsAutomation;
307
- accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsAutomation;
308
- accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "IgnoreContrast"): CheckSettingsAutomation;
309
- accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "RegularText"): CheckSettingsAutomation;
310
- accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "RegularText"): CheckSettingsAutomation;
311
- accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "LargeText"): CheckSettingsAutomation;
312
- accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "LargeText"): CheckSettingsAutomation;
313
- accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "BoldText"): CheckSettingsAutomation;
314
- accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "BoldText"): CheckSettingsAutomation;
315
- accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsAutomation;
316
- accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "GraphicalObject"): CheckSettingsAutomation;
317
- accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
315
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
316
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsAutomation;
317
+ accessibilityRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
318
318
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
319
319
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
320
320
  regionId?: undefined | string;
321
- type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
321
+ type?: undefined | AccessibilityRegionTypePlain;
322
322
  }>): CheckSettingsAutomation;
323
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))>): CheckSettingsAutomation;
323
+ 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;
324
324
  matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
325
325
  layout(): CheckSettingsAutomation;
326
326
  exact(): CheckSettingsAutomation;
@@ -339,8 +339,8 @@ export class CheckSettings extends CheckSettingsAutomation {
339
339
  }
340
340
  export type TargetAutomation = {
341
341
  window(): CheckSettingsAutomation;
342
- region(region: LegacyRegionPlain): CheckSettingsAutomation;
343
342
  region(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; })))): CheckSettingsAutomation;
343
+ region(region: LegacyRegionPlain): CheckSettingsAutomation;
344
344
  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;
345
345
  frame(frame: number, scrollRootElement?: undefined | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
346
346
  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;
@@ -351,7 +351,7 @@ export type TargetAutomation = {
351
351
  webview(webview?: undefined | boolean): CheckSettingsAutomation;
352
352
  };
353
353
  export const Target: TargetImage & TargetAutomation;
354
- export type OCRRegion = { target: RegionPlain | Element | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
354
+ export type OCRRegion = { target: Element | RegionPlain | EyesSelector<Selector>; hint?: undefined | string; minMatch?: undefined | number; language?: undefined | string; };
355
355
  export type ConfigurationPlain = {
356
356
  debugScreenshots?: undefined | { save: boolean; path?: undefined | string; prefix?: undefined | string; };
357
357
  agentId?: undefined | string;
@@ -366,7 +366,7 @@ export type ConfigurationPlain = {
366
366
  testName?: undefined | string;
367
367
  displayName?: undefined | string;
368
368
  viewportSize?: undefined | RectangleSizePlain;
369
- sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION";
369
+ sessionType?: undefined | SessionTypePlain;
370
370
  properties?: undefined | Array<PropertyDataPlain>;
371
371
  batch?: undefined | BatchInfoPlain;
372
372
  defaultMatchSettings?: undefined | ImageMatchSettingsPlain;
@@ -391,7 +391,7 @@ export type ConfigurationPlain = {
391
391
  matchTimeout?: undefined | number;
392
392
  forceFullPageScreenshot?: undefined | boolean;
393
393
  waitBeforeScreenshots?: undefined | number;
394
- stitchMode?: undefined | "Scroll" | "CSS" | "Resize";
394
+ stitchMode?: undefined | StitchModePlain;
395
395
  hideScrollbars?: undefined | boolean;
396
396
  hideCaret?: undefined | boolean;
397
397
  stitchOverlap?: undefined | number;
@@ -621,37 +621,18 @@ export class Configuration implements Required<ConfigurationPlain> {
621
621
  setConcurrentSessions(concurrentSessions: number): Configuration;
622
622
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
623
623
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
624
- getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
625
- setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
626
- addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
624
+ getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }>;
625
+ setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }>): Configuration;
626
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }>): Configuration;
627
627
  addBrowser(browserInfo: DesktopBrowserInfo): Configuration;
628
628
  addBrowser(browserInfo: ChromeEmulationInfo): Configuration;
629
- addBrowser(browserInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }): Configuration;
630
629
  addBrowser(browserInfo: IOSDeviceInfo): Configuration;
631
630
  addBrowser(browserInfo: AndroidDeviceInfo): Configuration;
632
- addBrowser(width: number, height: number, name?: undefined | "chrome"): Configuration;
633
- addBrowser(width: number, height: number, name?: undefined | "chrome-one-version-back"): Configuration;
634
- addBrowser(width: number, height: number, name?: undefined | "chrome-two-versions-back"): Configuration;
635
- addBrowser(width: number, height: number, name?: undefined | "firefox"): Configuration;
636
- addBrowser(width: number, height: number, name?: undefined | "firefox-one-version-back"): Configuration;
637
- addBrowser(width: number, height: number, name?: undefined | "firefox-two-versions-back"): Configuration;
638
- addBrowser(width: number, height: number, name?: undefined | "ie"): Configuration;
639
- addBrowser(width: number, height: number, name?: undefined | "ie10"): Configuration;
640
- addBrowser(width: number, height: number, name?: undefined | "edge"): Configuration;
641
- addBrowser(width: number, height: number, name?: undefined | "edgechromium"): Configuration;
642
- addBrowser(width: number, height: number, name?: undefined | "edgelegacy"): Configuration;
643
- addBrowser(width: number, height: number, name?: undefined | "edgechromium-one-version-back"): Configuration;
644
- addBrowser(width: number, height: number, name?: undefined | "edgechromium-two-versions-back"): Configuration;
645
- addBrowser(width: number, height: number, name?: undefined | "safari"): Configuration;
646
- addBrowser(width: number, height: number, name?: undefined | "safari-earlyaccess"): Configuration;
647
- addBrowser(width: number, height: number, name?: undefined | "safari-one-version-back"): Configuration;
648
- addBrowser(width: number, height: number, name?: undefined | "safari-two-versions-back"): Configuration;
649
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape"): Configuration;
650
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "portrait"): Configuration;
651
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest"): Configuration;
652
- addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest-1"): Configuration;
653
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest"): Configuration;
654
- addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest-1"): Configuration;
631
+ addBrowser(browserInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }): Configuration;
632
+ addBrowser(width: number, height: number, name?: undefined | BrowserTypePlain): Configuration;
633
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | ScreenOrientationPlain): Configuration;
634
+ addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
635
+ addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | AndroidVersionPlain): Configuration;
655
636
  get visualGridOptions(): { [key: string]: any; };
656
637
  set visualGridOptions(visualGridOptions: { [key: string]: any; });
657
638
  getVisualGridOptions(): { [key: string]: any; };
@@ -834,7 +815,7 @@ export enum IosDeviceName {
834
815
  iPad_Air_2 = 'iPad Air (2nd generation)',
835
816
  iPad_Air_4 = 'iPad Air (4th generation)'
836
817
  }
837
- export type IosVersionPlain = "latest" | "latest-1";
818
+ export type IosVersionPlain = AndroidVersionPlain;
838
819
  export enum IosVersion {
839
820
  LATEST = 'latest',
840
821
  ONE_VERSION_BACK = 'latest-1',
@@ -884,7 +865,7 @@ export enum MatchLevel {
884
865
  Strict = 'Strict',
885
866
  Exact = 'Exact'
886
867
  }
887
- export type ScreenOrientationPlain = "landscape" | "portrait";
868
+ export type ScreenOrientationPlain = "portrait" | "landscape";
888
869
  export enum ScreenOrientation {
889
870
  PORTRAIT = 'portrait',
890
871
  LANDSCAPE = 'landscape'
@@ -902,7 +883,7 @@ export enum StitchMode {
902
883
  RESIZE = 'Resize',
903
884
  Resize = 'Resize'
904
885
  }
905
- export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
886
+ export type TestResultsStatusPlain = AccessibilityStatusPlain;
906
887
  export enum TestResultsStatus {
907
888
  Passed = 'Passed',
908
889
  Unresolved = 'Unresolved',
@@ -924,15 +905,11 @@ export class NewTestError extends TestFailedError {
924
905
  constructor(message: string, results?: undefined | TestResultsPlain);
925
906
  constructor(results: TestResultsPlain);
926
907
  }
927
- export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"; };
908
+ export type AccessibilityMatchSettingsPlain = { region: RegionPlain; type?: undefined | AccessibilityRegionTypePlain; };
928
909
  export class AccessibilityMatchSettings implements Required<AccessibilityMatchSettingsPlain> {
929
910
  constructor(settings: AccessibilityMatchSettingsPlain);
930
911
  constructor(region: RegionPlain);
931
- constructor(x: number, y: number, width: number, height: number, type?: undefined | "IgnoreContrast");
932
- constructor(x: number, y: number, width: number, height: number, type?: undefined | "RegularText");
933
- constructor(x: number, y: number, width: number, height: number, type?: undefined | "LargeText");
934
- constructor(x: number, y: number, width: number, height: number, type?: undefined | "BoldText");
935
- constructor(x: number, y: number, width: number, height: number, type?: undefined | "GraphicalObject");
912
+ constructor(x: number, y: number, width: number, height: number, type?: undefined | AccessibilityRegionTypePlain);
936
913
  get region(): RegionPlain;
937
914
  set region(region: RegionPlain);
938
915
  getRegion(): Region;
@@ -950,7 +927,7 @@ export class AccessibilityMatchSettings implements Required<AccessibilityMatchSe
950
927
  getType(): AccessibilityRegionType;
951
928
  setType(type: AccessibilityRegionTypePlain): void;
952
929
  }
953
- export type AccessibilitySettings = { level?: undefined | "AA" | "AAA"; guidelinesVersion?: undefined | "WCAG_2_0" | "WCAG_2_1"; };
930
+ export type AccessibilitySettings = { level?: undefined | AccessibilityLevelPlain; guidelinesVersion?: undefined | AccessibilityGuidelinesVersionPlain; };
954
931
  export type BatchInfoPlain = {
955
932
  id?: undefined | string;
956
933
  name?: undefined | string;
@@ -995,7 +972,7 @@ export class BatchInfo implements Required<BatchInfoPlain> {
995
972
  export type CheckSettingsImagePlain = {
996
973
  name?: undefined | string;
997
974
  region?: undefined | RegionPlain;
998
- matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
975
+ matchLevel?: undefined | MatchLevelPlain;
999
976
  useDom?: undefined | boolean;
1000
977
  sendDom?: undefined | boolean;
1001
978
  enablePatterns?: undefined | boolean;
@@ -1024,7 +1001,7 @@ export type CheckSettingsImagePlain = {
1024
1001
  region: RegionPlain;
1025
1002
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1026
1003
  regionId?: undefined | string;
1027
- type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
1004
+ type?: undefined | AccessibilityRegionTypePlain;
1028
1005
  }>;
1029
1006
  pageId?: undefined | string;
1030
1007
  variationGroupId?: undefined | string;
@@ -1032,7 +1009,7 @@ export type CheckSettingsImagePlain = {
1032
1009
  };
1033
1010
  export class CheckSettingsImage {
1034
1011
  constructor(settings?: undefined | CheckSettingsImagePlain, target?: undefined | {
1035
- image: string | URL | Buffer;
1012
+ image: string | Buffer | URL;
1036
1013
  name?: undefined | string;
1037
1014
  dom?: undefined | string;
1038
1015
  locationInViewport?: undefined | LocationPlain;
@@ -1040,7 +1017,7 @@ export class CheckSettingsImage {
1040
1017
  fullViewSize?: undefined | RectangleSizePlain;
1041
1018
  });
1042
1019
  constructor(settings?: undefined | CheckSettingsImage, target?: undefined | {
1043
- image: string | URL | Buffer;
1020
+ image: string | Buffer | URL;
1044
1021
  name?: undefined | string;
1045
1022
  dom?: undefined | string;
1046
1023
  locationInViewport?: undefined | LocationPlain;
@@ -1048,8 +1025,8 @@ export class CheckSettingsImage {
1048
1025
  fullViewSize?: undefined | RectangleSizePlain;
1049
1026
  });
1050
1027
  image(image: string): CheckSettingsImage;
1051
- image(image: URL): CheckSettingsImage;
1052
1028
  image(image: Buffer): CheckSettingsImage;
1029
+ image(image: URL): CheckSettingsImage;
1053
1030
  buffer(imageBuffer: Buffer): CheckSettingsImage;
1054
1031
  base64(imageBase64: Buffer): CheckSettingsImage;
1055
1032
  path(imagePath: string): CheckSettingsImage;
@@ -1058,28 +1035,28 @@ export class CheckSettingsImage {
1058
1035
  name(name: string): CheckSettingsImage;
1059
1036
  withDom(dom: string): CheckSettingsImage;
1060
1037
  withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
1061
- region(region: LegacyRegionPlain): CheckSettingsImage;
1062
1038
  region(region: RegionPlain): CheckSettingsImage;
1039
+ region(region: LegacyRegionPlain): CheckSettingsImage;
1063
1040
  withName(name: string): CheckSettingsImage;
1064
- ignoreRegion(region: LegacyRegionPlain): CheckSettingsImage;
1065
1041
  ignoreRegion(region: RegionPlain): CheckSettingsImage;
1042
+ ignoreRegion(region: LegacyRegionPlain): CheckSettingsImage;
1066
1043
  ignoreRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1067
- ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1068
- ignore(region: LegacyRegionPlain): CheckSettingsImage;
1044
+ ignoreRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1069
1045
  ignore(region: RegionPlain): CheckSettingsImage;
1070
- ignores(...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
1071
- layoutRegion(region: LegacyRegionPlain): CheckSettingsImage;
1046
+ ignore(region: LegacyRegionPlain): CheckSettingsImage;
1047
+ ignores(...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1072
1048
  layoutRegion(region: RegionPlain): CheckSettingsImage;
1049
+ layoutRegion(region: LegacyRegionPlain): CheckSettingsImage;
1073
1050
  layoutRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1074
- layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1075
- strictRegion(region: LegacyRegionPlain): CheckSettingsImage;
1051
+ layoutRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1076
1052
  strictRegion(region: RegionPlain): CheckSettingsImage;
1053
+ strictRegion(region: LegacyRegionPlain): CheckSettingsImage;
1077
1054
  strictRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1078
- strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1079
- contentRegion(region: LegacyRegionPlain): CheckSettingsImage;
1055
+ strictRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1080
1056
  contentRegion(region: RegionPlain): CheckSettingsImage;
1057
+ contentRegion(region: LegacyRegionPlain): CheckSettingsImage;
1081
1058
  contentRegion(region: { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
1082
- contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1059
+ contentRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
1083
1060
  floatingRegion(region: {
1084
1061
  region: RegionPlain;
1085
1062
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -1095,53 +1072,45 @@ export class CheckSettingsImage {
1095
1072
  maxLeftOffset?: undefined | number;
1096
1073
  maxRightOffset?: undefined | number;
1097
1074
  }): CheckSettingsImage;
1098
- floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1099
1075
  floatingRegion(region: RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1100
- floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
1076
+ floatingRegion(region: LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
1077
+ floatingRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
1101
1078
  region: RegionPlain;
1102
1079
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1103
1080
  regionId?: undefined | string;
1104
1081
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1105
1082
  }>): CheckSettingsImage;
1106
- floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
1083
+ floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1107
1084
  floating(region: {
1108
1085
  region: RegionPlain;
1109
1086
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1110
1087
  regionId?: undefined | string;
1111
1088
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1112
1089
  }): CheckSettingsImage;
1113
- floating(region: LegacyRegionPlain): CheckSettingsImage;
1114
1090
  floating(region: RegionPlain): CheckSettingsImage;
1115
- floatings(...regions: Array<LegacyRegionPlain | RegionPlain | {
1091
+ floating(region: LegacyRegionPlain): CheckSettingsImage;
1092
+ floatings(...regions: Array<RegionPlain | LegacyRegionPlain | {
1116
1093
  region: RegionPlain;
1117
1094
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1118
1095
  regionId?: undefined | string;
1119
1096
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
1120
1097
  }>): CheckSettingsImage;
1121
- floatings(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
1098
+ floatings(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1122
1099
  accessibilityRegion(region: {
1123
1100
  region: RegionPlain;
1124
1101
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1125
1102
  regionId?: undefined | string;
1126
- type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
1103
+ type?: undefined | AccessibilityRegionTypePlain;
1127
1104
  }): CheckSettingsImage;
1128
- accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsImage;
1129
- accessibilityRegion(region: RegionPlain, type?: undefined | "IgnoreContrast"): CheckSettingsImage;
1130
- accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "RegularText"): CheckSettingsImage;
1131
- accessibilityRegion(region: RegionPlain, type?: undefined | "RegularText"): CheckSettingsImage;
1132
- accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "LargeText"): CheckSettingsImage;
1133
- accessibilityRegion(region: RegionPlain, type?: undefined | "LargeText"): CheckSettingsImage;
1134
- accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "BoldText"): CheckSettingsImage;
1135
- accessibilityRegion(region: RegionPlain, type?: undefined | "BoldText"): CheckSettingsImage;
1136
- accessibilityRegion(region: LegacyRegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsImage;
1137
- accessibilityRegion(region: RegionPlain, type?: undefined | "GraphicalObject"): CheckSettingsImage;
1138
- accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
1105
+ accessibilityRegion(region: RegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsImage;
1106
+ accessibilityRegion(region: LegacyRegionPlain, type?: undefined | AccessibilityRegionTypePlain): CheckSettingsImage;
1107
+ accessibilityRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
1139
1108
  region: RegionPlain;
1140
1109
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
1141
1110
  regionId?: undefined | string;
1142
- type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
1111
+ type?: undefined | AccessibilityRegionTypePlain;
1143
1112
  }>): CheckSettingsImage;
1144
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
1113
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
1145
1114
  matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
1146
1115
  layout(): CheckSettingsImage;
1147
1116
  exact(): CheckSettingsImage;
@@ -1158,8 +1127,8 @@ export class CheckSettingsImage {
1158
1127
  }
1159
1128
  export type TargetImage = {
1160
1129
  image(image: string): CheckSettingsImage;
1161
- image(image: URL): CheckSettingsImage;
1162
1130
  image(image: Buffer): CheckSettingsImage;
1131
+ image(image: URL): CheckSettingsImage;
1163
1132
  buffer(imageBuffer: Buffer): CheckSettingsImage;
1164
1133
  base64(imageBase64: string): CheckSettingsImage;
1165
1134
  path(imagePath: string): CheckSettingsImage;
@@ -1256,7 +1225,7 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
1256
1225
  }
1257
1226
  export type ImageMatchSettingsPlain = {
1258
1227
  exact?: undefined | ExactMatchSettingsPlain;
1259
- matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
1228
+ matchLevel?: undefined | MatchLevelPlain;
1260
1229
  ignoreCaret?: undefined | boolean;
1261
1230
  useDom?: undefined | boolean;
1262
1231
  enablePatterns?: undefined | boolean;
@@ -1355,7 +1324,7 @@ export class Location implements Required<LocationPlain> {
1355
1324
  getY(): number;
1356
1325
  setY(y: number): void;
1357
1326
  }
1358
- export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1327
+ export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
1359
1328
  export type CustomLogHandlerPlain = {
1360
1329
  log(message: any): void;
1361
1330
  warn?(message: any): void;
@@ -1469,10 +1438,10 @@ export class Region implements Required<RegionPlain> {
1469
1438
  getHeight(): number;
1470
1439
  setHeight(height: number): void;
1471
1440
  }
1472
- export type DesktopBrowserInfo = { name?: undefined | "chrome" | "chrome-one-version-back" | "chrome-two-versions-back" | "firefox" | "firefox-one-version-back" | "firefox-two-versions-back" | "ie" | "ie10" | "edge" | "edgechromium" | "edgelegacy" | "edgechromium-one-version-back" | "edgechromium-two-versions-back" | "safari" | "safari-earlyaccess" | "safari-one-version-back" | "safari-two-versions-back"; width: number; height: number; };
1473
- export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1474
- export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1475
- export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1441
+ export type DesktopBrowserInfo = { name?: undefined | BrowserTypePlain; width: number; height: number; };
1442
+ export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1443
+ export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | AndroidVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1444
+ export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | AndroidVersionPlain; screenOrientation?: undefined | ScreenOrientationPlain; }; };
1476
1445
  export type RunnerOptionsPlain = { testConcurrency?: undefined | number; fetchConcurrency?: undefined | number; removeDuplicateTests?: undefined | boolean; };
1477
1446
  export class RunnerOptionsFluent {
1478
1447
  testConcurrency(concurrency: number): RunnerOptionsFluent;
@@ -1567,7 +1536,7 @@ export type TestResultsPlain = {
1567
1536
  readonly id?: undefined | string;
1568
1537
  readonly name?: undefined | string;
1569
1538
  readonly secretToken?: undefined | string;
1570
- readonly status?: undefined | "Passed" | "Failed" | "Unresolved";
1539
+ readonly status?: undefined | AccessibilityStatusPlain;
1571
1540
  readonly appName?: undefined | string;
1572
1541
  readonly batchId?: undefined | string;
1573
1542
  readonly batchName?: undefined | string;
@@ -1695,14 +1664,14 @@ export class TestResults implements Required<TestResultsPlain> {
1695
1664
  delete(): Promise<void>;
1696
1665
  deleteSession(): Promise<void>;
1697
1666
  }
1698
- export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo); };
1667
+ export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; }); };
1699
1668
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1700
1669
  get testResults(): TestResultsPlain;
1701
1670
  getTestResults(): TestResults;
1702
1671
  get exception(): Error;
1703
1672
  getException(): Error;
1704
- get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1705
- getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1673
+ get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1674
+ getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | ScreenOrientationPlain; };
1706
1675
  }
1707
1676
  export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1708
1677
  export class TestResultsSummary implements Iterable<TestResultContainer> {
@@ -1744,7 +1713,7 @@ export class Logger {
1744
1713
  }
1745
1714
  export abstract class EyesRunner {
1746
1715
  constructor(options?: undefined | RunnerOptionsPlain);
1747
- abstract readonly type: "classic" | "ufg";
1716
+ abstract readonly type: "ufg" | "classic";
1748
1717
  getAllTestResults(throwErr?: undefined | boolean): Promise<TestResultsSummary>;
1749
1718
  }
1750
1719
  export class ClassicRunner extends EyesRunner {