@applitools/eyes-selenium 4.66.2 → 4.66.4

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