@applitools/eyes-webdriverio 5.41.0 → 5.42.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/legacy.js +1 -0
  3. package/dist/service.js +8 -2
  4. package/package.json +20 -39
  5. package/types/index.d.ts +76 -75
  6. package/types/service.d.ts +1 -1
package/CHANGELOG.md CHANGED
@@ -10,6 +10,18 @@
10
10
 
11
11
 
12
12
 
13
+ ## 5.42.0 - 2023/2/17
14
+
15
+ ### Features
16
+ - Crop screenshot image base on account info
17
+ ### Bug fixes
18
+
19
+ ## 5.41.1 - 2023/2/6
20
+
21
+ ### Features
22
+ ### Bug fixes
23
+ - Fix instability when getting information to connect to the NML
24
+
13
25
  ## 5.41.0 - 2023/2/1
14
26
 
15
27
  ### Features
package/dist/legacy.js CHANGED
@@ -17,6 +17,7 @@ class By {
17
17
  static attributeValue(attr, value) {
18
18
  return new By(`*[${attr}="${value}"]`);
19
19
  }
20
+ // @ts-ignore
20
21
  static name(name) {
21
22
  return By.attributeValue('name', name);
22
23
  }
package/dist/service.js CHANGED
@@ -33,8 +33,10 @@ if (!process.env.APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION) {
33
33
  process.env.APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION = major;
34
34
  }
35
35
  catch {
36
+ // NOTE: ignore error
36
37
  }
37
38
  }
39
+ // TODO have to be removed
38
40
  const sdk = (0, core_1.makeCore)({
39
41
  agentId: `eyes-webdriverio-service/${require('../package.json').version}`,
40
42
  spec,
@@ -75,6 +77,7 @@ class EyesService {
75
77
  await this._eyesOpen();
76
78
  return this._eyes.check(title, checkSettings);
77
79
  });
80
+ // deprecated, alias of eyesCheck
78
81
  browser.addCommand('eyesCheckWindow', async (...args) => {
79
82
  return browser.eyesCheck(...args);
80
83
  });
@@ -88,6 +91,7 @@ class EyesService {
88
91
  this._eyes.getConfiguration().clearProperties();
89
92
  });
90
93
  browser.addCommand('eyesGetTestResults', async () => {
94
+ // because `afterTest` executes after `afterEach`, this is the way to get results in `afterEach` or `it`
91
95
  await this._eyesClose();
92
96
  return this._testResults;
93
97
  });
@@ -107,9 +111,9 @@ class EyesService {
107
111
  beforeTest(test) {
108
112
  var _a, _b, _c;
109
113
  const configuration = this._eyes.getConfiguration();
110
- configuration.setTestName((_a = test.title) !== null && _a !== void 0 ? _a : test.description);
114
+ configuration.setTestName((_a = test.title) !== null && _a !== void 0 ? _a : test.description); // test.title is for mocha, and test.description is for jasmine
111
115
  if (!this._appName) {
112
- configuration.setAppName((_b = test.parent) !== null && _b !== void 0 ? _b : (_c = test.fullName) === null || _c === void 0 ? void 0 : _c.replace(` ${test.description}`, ''));
116
+ configuration.setAppName((_b = test.parent) !== null && _b !== void 0 ? _b : (_c = test.fullName) === null || _c === void 0 ? void 0 : _c.replace(` ${test.description}`, '')); // test.parent is for mocha, and test.id is for jasmine
113
117
  }
114
118
  if (!configuration.getViewportSize()) {
115
119
  configuration.setViewportSize({ width: 800, height: 600 });
@@ -117,6 +121,8 @@ class EyesService {
117
121
  this._eyes.setConfiguration(configuration);
118
122
  }
119
123
  async afterTest() {
124
+ // the next line is required because if we set an element in one test, then the following test
125
+ // will say that the element is not attached to the page (because different browsers are used)
120
126
  this._eyes.getConfiguration().setScrollRootElement(null);
121
127
  await this._eyesClose();
122
128
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-webdriverio",
3
- "version": "5.41.0",
3
+ "version": "5.42.0",
4
4
  "description": "Applitools Eyes SDK for WebdriverIO",
5
5
  "keywords": [
6
6
  "eyes-webdriverio",
@@ -88,73 +88,54 @@
88
88
  "types"
89
89
  ],
90
90
  "scripts": {
91
- "lint": "eslint '**/*.ts'",
92
- "build": "ttsc --project tsconfig.build.v$([ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ] && echo ${APPLITOOLS_WEBDRIVERIO_VERSION%%.*} || echo 8).json",
91
+ "lint": "node ../../node_modules/.bin/eslint '**/*.ts'",
92
+ "build": "node ../../node_modules/.bin/ttsc --project tsconfig.build.v$([ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ] && echo ${APPLITOOLS_WEBDRIVERIO_VERSION%%.*} || echo 8).json",
93
93
  "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes.webdriverio.javascript5'",
94
94
  "test": "yarn test:service && yarn test:coverage",
95
95
  "test:sanity": "echo 'create sanity suite'",
96
96
  "test:service": "mocha ./test/service/unit/*.spec.js && wdio run ./test/service/wdio.conf.js && wdio run ./test/service/no-config/wdio.no-config.conf.js && wdio run ./test/service/vg/wdio.vg.conf.js",
97
- "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-webdriverio-5' APPLITOOLS_BATCH_ID=$(uuidgen) XUNIT_FILE=coverage-test-report.xml mocha --config .mocharc.cvg.js",
97
+ "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-webdriverio-5' APPLITOOLS_BATCH_ID=$(uuidgen) mocha --config .mocharc.cvg.js",
98
98
  "test:coverage:wd": "APPLITOOLS_WEBDRIVERIO_PROTOCOL=wd yarn test:coverage",
99
99
  "test:coverage:cdp": "APPLITOOLS_WEBDRIVERIO_PROTOCOL=cdp yarn test:coverage",
100
100
  "report": "coverage-tests report https://raw.githubusercontent.com/applitools/sdk.coverage.tests/master/js/config.js --name 'eyes.webdriverio.javascript5'",
101
101
  "setup": "yarn docker:setup",
102
- "docker:setup": "node ../scripts/scripts/generate-docker-compose-config.js && docker-compose up -d",
102
+ "docker:setup": "node ../../scripts/generate-docker-compose-config.js && docker-compose up -d",
103
103
  "docker:teardown": "docker-compose down",
104
104
  "upgrade:framework": "if [ ! -z $APPLITOOLS_WEBDRIVERIO_VERSION ]; then packagejson=`cat package.json`; NODE_VERSION=${NODE_VERSION:-$(node -v)} yarn upgrade --no-lockfile webdriverio@$APPLITOOLS_WEBDRIVERIO_VERSION webdriver@$APPLITOOLS_WEBDRIVERIO_VERSION @types/node@${NODE_VERSION%%.*}; echo \"$packagejson\" > package.json; fi",
105
105
  "deps": "bongo deps",
106
106
  "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio(node:14) wdio(node:12) wdio(protocol:cdp) wdio(framework:6) wdio(framework:5)'",
107
- "gh:test:links": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio+cdp wdio@6 wdio@5' -f links='types test-utils sdk-shared eyes-sdk-core visual-grid-client eyes-api spec-driver-webdriverio utils driver snippets screenshoter'",
107
+ "gh:test:links": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='wdio wdio+cdp wdio@6 wdio@5' -f links='types test-utils eyes-sdk-core visual-grid-client eyes-api spec-driver-webdriverio utils driver snippets screenshoter'",
108
108
  "gh:publish": "gh workflow run publish-webdriverio.yml --ref $(git rev-parse --abbrev-ref HEAD)",
109
- "preversion": "bongo preversion --verifyPendingChanges && yarn build",
109
+ "preversion": "bongo preversion --verifyPendingChanges",
110
110
  "version": "bongo version --withPendingChanges",
111
111
  "postversion": "bongo postversion"
112
112
  },
113
- "husky": {
114
- "hooks": {
115
- "pre-push": "yarn bongo lint"
116
- }
117
- },
118
113
  "dependencies": {
119
- "@applitools/core": "1.4.6",
120
- "@applitools/eyes-api": "1.13.1",
121
- "@applitools/spec-driver-webdriverio": "1.4.22"
114
+ "@applitools/core": "2.3.6",
115
+ "@applitools/eyes-api": "1.13.6",
116
+ "@applitools/spec-driver-webdriverio": "1.4.27"
122
117
  },
123
118
  "devDependencies": {
124
119
  "@applitools/api-extractor": "1.2.11",
125
- "@applitools/bongo": "^2.2.2",
126
- "@applitools/scripts": "1.2.0",
120
+ "@applitools/bongo": "^2.2.5",
127
121
  "@applitools/sdk-coverage-tests": "^2.7.10",
128
- "@applitools/sdk-shared": "0.9.15",
129
- "@applitools/test-utils": "1.5.10",
122
+ "@applitools/test-utils": "1.5.12",
130
123
  "@types/mocha": "^9.1.1",
131
124
  "@types/node": "16",
132
- "@typescript-eslint/eslint-plugin": "^5.27.0",
133
- "@typescript-eslint/parser": "^5.27.0",
134
- "@wdio/cli": "^8.2.2",
135
- "@wdio/dot-reporter": "^8.0.14",
136
- "@wdio/globals": "^8.2.2",
137
- "@wdio/local-runner": "^8.2.2",
138
- "@wdio/mocha-framework": "^8.2.1",
125
+ "@wdio/cli": "^8.3.9",
126
+ "@wdio/dot-reporter": "^8.3.0",
127
+ "@wdio/globals": "^8.3.9",
128
+ "@wdio/local-runner": "^8.3.9",
129
+ "@wdio/mocha-framework": "^8.3.0",
139
130
  "chromedriver": "^109.0.0",
140
- "eslint": "^8.16.0",
141
- "eslint-config-prettier": "^8.5.0",
142
- "eslint-plugin-mocha-no-only": "^1.1.1",
143
- "eslint-plugin-node": "^11.1.0",
144
- "eslint-plugin-prettier": "^4.0.0",
145
131
  "expect-webdriverio": "^4.0.1",
146
132
  "geckodriver": "^1.20.0",
147
- "husky": "^4.3.8",
148
133
  "mocha": "^9.2.2",
149
- "prettier": "^2.6.2",
150
- "spec-xunit-file": "0.0.1-3",
151
- "ts-node": "^10.8.0",
152
- "ttypescript": "^1.5.13",
153
- "typescript": "^4.9.4",
154
- "webdriverio": "^8.2.2"
134
+ "mocha-multi": "^1.1.7",
135
+ "webdriverio": "^8.3.9"
155
136
  },
156
137
  "peerDependencies": {
157
- "webdriverio": "5.0.0 - 8.x.x"
138
+ "webdriverio": ">=5.0.0"
158
139
  },
159
140
  "engines": {
160
141
  "node": ">=12.13.0"
package/types/index.d.ts CHANGED
@@ -16,6 +16,7 @@ export class By {
16
16
  export type Driver = Applitools.WebdriverIO.Browser & { __applitoolsBrand?: undefined; };
17
17
  export type Element = (Applitools.WebdriverIO.Element | { ELEMENT: string; } | { 'element-6066-11e4-a52e-4f735466cecf': string; }) & { __applitoolsBrand?: undefined; };
18
18
  export type Selector = (Applitools.WebdriverIO.Selector | { using: string; value: string; }) & { __applitoolsBrand?: undefined; };
19
+ export type SpecType = { driver: Driver; context: Driver; element: Element; selector: Selector; };
19
20
  export class Eyes {
20
21
  static setViewportSize: (driver: Driver, viewportSize: RectangleSize) => Promise<void>;
21
22
  static getExecutionCloudUrl(config?: undefined | ConfigurationPlain): Promise<string>;
@@ -38,9 +39,9 @@ export class Eyes {
38
39
  open(driver: Driver, appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<Driver>;
39
40
  open(config?: undefined | ConfigurationPlain): Promise<void>;
40
41
  open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | "SEQUENTIAL" | "PROGRESSION"): Promise<void>;
41
- check(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<MatchResult>;
42
+ check(name: string, checkSettings: CheckSettingsAutomation | CheckSettingsImage): Promise<MatchResult>;
42
43
  check(target: {
43
- image: string | URL | Buffer;
44
+ image: string | Buffer | URL;
44
45
  name?: undefined | string;
45
46
  dom?: undefined | string;
46
47
  locationInViewport?: undefined | LocationPlain;
@@ -50,7 +51,7 @@ export class Eyes {
50
51
  check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
51
52
  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<RegionPlain>>>;
52
53
  extractTextRegions<TPattern extends string>(target: {
53
- image: string | URL | Buffer;
54
+ image: string | Buffer | URL;
54
55
  size?: undefined | { width: number; height: number; };
55
56
  name?: undefined | string;
56
57
  source?: undefined | string;
@@ -61,7 +62,7 @@ export class Eyes {
61
62
  }, settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
62
63
  extractTextRegions<TPattern extends string>(settings: OCRSettings<TPattern>): Promise<Record<TPattern, Array<TextRegion>>>;
63
64
  extractText(target: {
64
- image: string | URL | Buffer;
65
+ image: string | Buffer | URL;
65
66
  size?: undefined | { width: number; height: number; };
66
67
  name?: undefined | string;
67
68
  source?: undefined | string;
@@ -77,7 +78,7 @@ export class Eyes {
77
78
  setViewportSize(size: RectangleSizePlain): Promise<void>;
78
79
  getScrollRootElement(): Element | EyesSelector<Selector>;
79
80
  setScrollRootElement(scrollRootElement: Element | EyesSelector<Selector>): void;
80
- setLogHandler(handler: LogHandlerPlain | LogHandler): void;
81
+ setLogHandler(handler: LogHandler | LogHandlerPlain): void;
81
82
  getLogHandler(): LogHandler;
82
83
  setCutProvider(cutProvider: CutProvider): void;
83
84
  setImageCut(cutProvider: CutProvider): void;
@@ -204,7 +205,7 @@ export type ConfigurationPlain = {
204
205
  disableBrowserFetching?: undefined | boolean;
205
206
  };
206
207
  export class Configuration implements Required<ConfigurationPlain> {
207
- constructor(config?: undefined | ConfigurationPlain, spec?: undefined | { isElement(element: any): element is Element; isSelector(selector: any): selector is Selector; });
208
+ constructor(config?: undefined | ConfigurationPlain, spec?: undefined | {});
208
209
  get appName(): string;
209
210
  set appName(appName: string);
210
211
  getAppName(): string;
@@ -249,7 +250,7 @@ export class Configuration implements Required<ConfigurationPlain> {
249
250
  set proxy(proxy: ProxySettingsPlain);
250
251
  getProxy(): ProxySettings;
251
252
  setProxy(proxy: ProxySettingsPlain): Configuration;
252
- setProxy(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean): Configuration;
253
+ setProxy(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean): Configuration;
253
254
  setProxy(isEnabled: false): Configuration;
254
255
  get autProxy(): ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; };
255
256
  set autProxy(autProxy: ProxySettingsPlain & { mode?: undefined | "Allow" | "Block"; domains?: undefined | Array<string>; });
@@ -396,12 +397,12 @@ export class Configuration implements Required<ConfigurationPlain> {
396
397
  setScaleRatio(scaleRatio: number): Configuration;
397
398
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>;
398
399
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo>);
399
- getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>;
400
- setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
401
- addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo>): Configuration;
402
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo): Configuration;
400
+ getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>;
401
+ setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>): Configuration;
402
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }>): Configuration;
403
+ addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }): Configuration;
403
404
  addBrowser(width: number, height: number, 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"): Configuration;
404
- addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "landscape" | "portrait"): Configuration;
405
+ addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: undefined | "portrait" | "landscape"): Configuration;
405
406
  addMobileDevice(deviceName: AndroidDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
406
407
  addMobileDevice(deviceName: IosDeviceNamePlain, screenOrientation: ScreenOrientationPlain, version?: undefined | "latest" | "latest-1"): Configuration;
407
408
  get visualGridOptions(): { [key: string]: any; };
@@ -435,7 +436,7 @@ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
435
436
  lazyLoad?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; };
436
437
  };
437
438
  export class CheckSettingsAutomation {
438
- constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: undefined | { isElement(value: any): value is Element; isSelector(value: any): value is Selector; });
439
+ constructor(settings?: undefined | CheckSettingsAutomation | CheckSettingsAutomationPlain, spec?: undefined | {});
439
440
  region(region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))): CheckSettingsAutomation;
440
441
  shadow(selector: string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }): CheckSettingsAutomation;
441
442
  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;
@@ -457,14 +458,14 @@ export class CheckSettingsAutomation {
457
458
  lazyLoad(options?: undefined | boolean | { scrollLength?: undefined | number; waitingTime?: undefined | number; maxAmountToScroll?: undefined | number; }): CheckSettingsAutomation;
458
459
  name(name: string): CheckSettingsAutomation;
459
460
  withName(name: string): CheckSettingsAutomation;
460
- ignoreRegion(region: 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;
461
- 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;
462
- layoutRegion(region: 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;
463
- 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;
464
- strictRegion(region: 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;
465
- 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;
466
- contentRegion(region: 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;
467
- 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;
461
+ ignoreRegion(region: (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;
462
+ 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;
463
+ layoutRegion(region: (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;
464
+ 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;
465
+ strictRegion(region: (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;
466
+ 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;
467
+ contentRegion(region: (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;
468
+ 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;
468
469
  floatingRegion(region: {
469
470
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
470
471
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -480,28 +481,28 @@ export class CheckSettingsAutomation {
480
481
  maxLeftOffset?: undefined | number;
481
482
  maxRightOffset?: undefined | number;
482
483
  }): CheckSettingsAutomation;
483
- floatingRegion(region: LegacyRegionPlain | (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;
484
- floatingRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
484
+ floatingRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsAutomation;
485
+ floatingRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
485
486
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
486
487
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
487
488
  regionId?: undefined | string;
488
489
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
489
490
  }>): CheckSettingsAutomation;
490
- 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;
491
+ 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;
491
492
  accessibilityRegion(region: {
492
493
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
493
494
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
494
495
  regionId?: undefined | string;
495
496
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
496
497
  }): CheckSettingsAutomation;
497
- accessibilityRegion(region: LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))), type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
498
- accessibilityRegions(...regions: Array<LegacyRegionPlain | (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | {
498
+ accessibilityRegion(region: (RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsAutomation;
499
+ accessibilityRegions(...regions: Array<(RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }))) | LegacyRegionPlain | {
499
500
  region: RegionPlain | (Element | (string | Selector | { selector: string | Selector; type?: undefined | string; shadow?: undefined | EyesSelector<Selector>; frame?: undefined | EyesSelector<Selector>; }));
500
501
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
501
502
  regionId?: undefined | string;
502
503
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
503
504
  }>): CheckSettingsAutomation;
504
- 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;
505
+ 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;
505
506
  matchLevel(matchLevel: MatchLevelPlain): CheckSettingsAutomation;
506
507
  layout(): CheckSettingsAutomation;
507
508
  exact(): CheckSettingsAutomation;
@@ -517,7 +518,7 @@ export class CheckSettingsAutomation {
517
518
  }
518
519
  export class CheckSettings extends CheckSettingsAutomation {
519
520
  }
520
- export const Target: TargetImage & TargetAutomation<Element, Selector>;
521
+ export const Target: TargetImage & TargetAutomation<SpecType>;
521
522
  export class BatchClose {
522
523
  static close(settings: { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; }): Promise<void>;
523
524
  constructor(options?: undefined | { batchIds: Array<string>; serverUrl: string; apiKey: string; proxy?: undefined | ProxySettingsPlain; });
@@ -719,7 +720,7 @@ export enum AndroidVersion {
719
720
  LATEST = 'latest',
720
721
  ONE_VERSION_BACK = 'latest-1'
721
722
  }
722
- export type MatchLevelPlain = "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
723
+ export type MatchLevelPlain = "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
723
724
  export enum MatchLevel {
724
725
  None = 'None',
725
726
  LegacyLayout = 'Layout1',
@@ -730,7 +731,7 @@ export enum MatchLevel {
730
731
  Strict = 'Strict',
731
732
  Exact = 'Exact'
732
733
  }
733
- export type ScreenOrientationPlain = "landscape" | "portrait";
734
+ export type ScreenOrientationPlain = "portrait" | "landscape";
734
735
  export enum ScreenOrientation {
735
736
  PORTRAIT = 'portrait',
736
737
  LANDSCAPE = 'landscape'
@@ -745,7 +746,7 @@ export enum StitchMode {
745
746
  SCROLL = 'Scroll',
746
747
  CSS = 'CSS'
747
748
  }
748
- export type TestResultsStatusPlain = "Passed" | "Unresolved" | "Failed";
749
+ export type TestResultsStatusPlain = "Passed" | "Failed" | "Unresolved";
749
750
  export enum TestResultsStatus {
750
751
  Passed = 'Passed',
751
752
  Unresolved = 'Unresolved',
@@ -754,7 +755,7 @@ export enum TestResultsStatus {
754
755
  export class EyesError extends Error {
755
756
  }
756
757
  export class TestFailedError extends EyesError {
757
- constructor(message: string, results?: undefined | TestResultsPlain);
758
+ constructor(message: string, results: TestResultsPlain);
758
759
  constructor(results: TestResultsPlain);
759
760
  get testResults(): TestResultsPlain;
760
761
  getTestResults(): TestResults;
@@ -832,7 +833,7 @@ export class BatchInfo implements Required<BatchInfoPlain> {
832
833
  export type CheckSettingsImagePlain = {
833
834
  name?: undefined | string;
834
835
  region?: undefined | RegionPlain;
835
- matchLevel?: undefined | "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
836
+ matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
836
837
  useDom?: undefined | boolean;
837
838
  sendDom?: undefined | boolean;
838
839
  enablePatterns?: undefined | boolean;
@@ -867,15 +868,15 @@ export type CheckSettingsImagePlain = {
867
868
  variationGroupId?: undefined | string;
868
869
  };
869
870
  export class CheckSettingsImage {
870
- constructor(settings?: undefined | CheckSettingsImagePlain | CheckSettingsImage, target?: undefined | {
871
- image: string | URL | Buffer;
871
+ constructor(settings?: undefined | CheckSettingsImage | CheckSettingsImagePlain, target?: undefined | {
872
+ image: string | Buffer | URL;
872
873
  name?: undefined | string;
873
874
  dom?: undefined | string;
874
875
  locationInViewport?: undefined | LocationPlain;
875
876
  locationInView?: undefined | LocationPlain;
876
877
  fullViewSize?: undefined | RectangleSizePlain;
877
878
  });
878
- image(image: string | URL | Buffer): CheckSettingsImage;
879
+ image(image: string | Buffer | URL): CheckSettingsImage;
879
880
  buffer(imageBuffer: Buffer): CheckSettingsImage;
880
881
  base64(imageBase64: Buffer): CheckSettingsImage;
881
882
  path(imagePath: string): CheckSettingsImage;
@@ -883,16 +884,16 @@ export class CheckSettingsImage {
883
884
  name(name: string): CheckSettingsImage;
884
885
  withDom(dom: string): CheckSettingsImage;
885
886
  withLocation(locationInViewport: LocationPlain): CheckSettingsImage;
886
- region(region: LegacyRegionPlain | RegionPlain): CheckSettingsImage;
887
+ region(region: RegionPlain | LegacyRegionPlain): CheckSettingsImage;
887
888
  withName(name: string): CheckSettingsImage;
888
- ignoreRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
889
- ignoreRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
890
- layoutRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
891
- layoutRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
892
- strictRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
893
- strictRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
894
- contentRegion(region: LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
895
- contentRegions(...regions: Array<LegacyRegionPlain | RegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
889
+ ignoreRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
890
+ ignoreRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
891
+ layoutRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
892
+ layoutRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
893
+ strictRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
894
+ strictRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
895
+ contentRegion(region: RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }): CheckSettingsImage;
896
+ contentRegions(...regions: Array<RegionPlain | LegacyRegionPlain | { region: RegionPlain; padding?: undefined | number | { top: number; bottom: number; left: number; right: number; }; regionId?: undefined | string; }>): CheckSettingsImage;
896
897
  floatingRegion(region: {
897
898
  region: RegionPlain;
898
899
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
@@ -908,28 +909,28 @@ export class CheckSettingsImage {
908
909
  maxLeftOffset?: undefined | number;
909
910
  maxRightOffset?: undefined | number;
910
911
  }): CheckSettingsImage;
911
- floatingRegion(region: LegacyRegionPlain | RegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
912
- floatingRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
912
+ floatingRegion(region: RegionPlain | LegacyRegionPlain, maxUpOffset?: undefined | number, maxDownOffset?: undefined | number, maxLeftOffset?: undefined | number, maxRightOffset?: undefined | number): CheckSettingsImage;
913
+ floatingRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
913
914
  region: RegionPlain;
914
915
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
915
916
  regionId?: undefined | string;
916
917
  offset?: undefined | { top?: undefined | number; bottom?: undefined | number; left?: undefined | number; right?: undefined | number; };
917
918
  }>): CheckSettingsImage;
918
- floatingRegions(maxOffset: number, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
919
+ floatingRegions(maxOffset: number, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
919
920
  accessibilityRegion(region: {
920
921
  region: RegionPlain;
921
922
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
922
923
  regionId?: undefined | string;
923
924
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
924
925
  }): CheckSettingsImage;
925
- accessibilityRegion(region: LegacyRegionPlain | RegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
926
- accessibilityRegions(...regions: Array<LegacyRegionPlain | RegionPlain | {
926
+ accessibilityRegion(region: RegionPlain | LegacyRegionPlain, type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject"): CheckSettingsImage;
927
+ accessibilityRegions(...regions: Array<RegionPlain | LegacyRegionPlain | {
927
928
  region: RegionPlain;
928
929
  padding?: undefined | number | { top: number; bottom: number; left: number; right: number; };
929
930
  regionId?: undefined | string;
930
931
  type?: undefined | "IgnoreContrast" | "RegularText" | "LargeText" | "BoldText" | "GraphicalObject";
931
932
  }>): CheckSettingsImage;
932
- accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<LegacyRegionPlain | RegionPlain>): CheckSettingsImage;
933
+ accessibilityRegions(type: AccessibilityRegionTypePlain, ...regions: Array<RegionPlain | LegacyRegionPlain>): CheckSettingsImage;
933
934
  matchLevel(matchLevel: MatchLevelPlain): CheckSettingsImage;
934
935
  layout(): CheckSettingsImage;
935
936
  exact(): CheckSettingsImage;
@@ -944,18 +945,18 @@ export class CheckSettingsImage {
944
945
  variationGroupId(variationGroupId: string): CheckSettingsImage;
945
946
  }
946
947
  export type TargetImage = {
947
- image(image: string | URL | Buffer): CheckSettingsImage;
948
+ image(image: string | Buffer | URL): CheckSettingsImage;
948
949
  buffer(imageBuffer: Buffer): CheckSettingsImage;
949
950
  base64(imageBase64: string): CheckSettingsImage;
950
951
  path(imagePath: string): CheckSettingsImage;
951
952
  url(imageUrl: string | URL): CheckSettingsImage;
952
953
  };
953
- export type TargetAutomation<TElement, TSelector> = {
954
+ export type TargetAutomation<TSpec extends SpecType = SpecType> = {
954
955
  window(): CheckSettingsAutomation;
955
- region(region: LegacyRegionPlain | (RegionPlain | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })))): CheckSettingsAutomation;
956
- frame(context: { frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })); scrollRootElement?: undefined | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })); }): CheckSettingsAutomation;
957
- frame(frame: number | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; })), scrollRootElement?: undefined | (TElement | (string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; }))): CheckSettingsAutomation;
958
- shadow(selector: string | TSelector | { selector: string | TSelector; type?: undefined | string; shadow?: undefined | EyesSelector<TSelector>; frame?: undefined | EyesSelector<TSelector>; }): CheckSettingsAutomation;
956
+ region(region: LegacyRegionPlain | (RegionPlain | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })))): CheckSettingsAutomation;
957
+ frame(context: { frame: number | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })); scrollRootElement?: undefined | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })); }): CheckSettingsAutomation;
958
+ frame(frame: number | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; })), scrollRootElement?: undefined | (TSpec["element"] | (string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }))): CheckSettingsAutomation;
959
+ shadow(selector: string | TSpec["selector"] | { selector: string | TSpec["selector"]; type?: undefined | string; shadow?: undefined | EyesSelector<TSpec["selector"]>; frame?: undefined | EyesSelector<TSpec["selector"]>; }): CheckSettingsAutomation;
959
960
  webview(webview?: undefined | string | boolean): CheckSettingsAutomation;
960
961
  };
961
962
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
@@ -1048,7 +1049,7 @@ export class FloatingMatchSettings implements Required<FloatingMatchSettingsPlai
1048
1049
  }
1049
1050
  export type ImageMatchSettingsPlain = {
1050
1051
  exact?: undefined | ExactMatchSettingsPlain;
1051
- matchLevel?: undefined | "Strict" | "None" | "Layout" | "Layout1" | "Layout2" | "Content" | "IgnoreColors" | "Exact";
1052
+ matchLevel?: undefined | "None" | "Layout1" | "Layout" | "Layout2" | "Content" | "IgnoreColors" | "Strict" | "Exact";
1052
1053
  ignoreCaret?: undefined | boolean;
1053
1054
  useDom?: undefined | boolean;
1054
1055
  enablePatterns?: undefined | boolean;
@@ -1147,7 +1148,7 @@ export class Location implements Required<LocationPlain> {
1147
1148
  getY(): number;
1148
1149
  setY(y: number): void;
1149
1150
  }
1150
- export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1151
+ export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
1151
1152
  export type CustomLogHandlerPlain = { log(message: any): void; };
1152
1153
  export type FileLogHandlerPlain = { type: "file"; filename?: undefined | string; append?: undefined | boolean; };
1153
1154
  export type ConsoleLogHandlerPlain = { type: "console"; };
@@ -1196,10 +1197,10 @@ export class PropertyData implements Required<PropertyDataPlain> {
1196
1197
  getValue(): string;
1197
1198
  setValue(value: string): void;
1198
1199
  }
1199
- export type ProxySettingsPlain = { url: string; username?: undefined | string; password?: undefined | string; isHttpOnly?: undefined | boolean; };
1200
+ export type ProxySettingsPlain = { url: string; username?: undefined | string; password?: undefined | string; };
1200
1201
  export class ProxySettings implements Required<ProxySettingsPlain> {
1201
1202
  constructor(proxy: ProxySettingsPlain);
1202
- constructor(url: string, username?: undefined | string, password?: undefined | string, isHttpOnly?: undefined | boolean);
1203
+ constructor(url: string, username?: undefined | string, password?: undefined | string, deprecatedIsHttpOnly?: undefined | boolean);
1203
1204
  get url(): string;
1204
1205
  getUri(): string;
1205
1206
  getUrl(): string;
@@ -1255,9 +1256,9 @@ export class Region implements Required<RegionPlain> {
1255
1256
  setHeight(height: number): void;
1256
1257
  }
1257
1258
  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; };
1258
- export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1259
- export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1260
- export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "landscape" | "portrait"; }; };
1259
+ export type ChromeEmulationInfo = { chromeEmulationInfo: { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }; };
1260
+ export type IOSDeviceInfo = { iosDeviceInfo: { deviceName: IosDeviceNamePlain; iosVersion?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "portrait" | "landscape"; }; };
1261
+ export type AndroidDeviceInfo = { androidDeviceInfo: { deviceName: AndroidDeviceNamePlain; version?: undefined | "latest" | "latest-1"; screenOrientation?: undefined | "portrait" | "landscape"; }; };
1261
1262
  export type RunnerOptionsPlain = { testConcurrency?: undefined | number; };
1262
1263
  export class RunnerOptionsFluent {
1263
1264
  testConcurrency(concurrency: number): RunnerOptionsFluent;
@@ -1334,7 +1335,7 @@ export type TestResultsPlain = {
1334
1335
  readonly id?: undefined | string;
1335
1336
  readonly name?: undefined | string;
1336
1337
  readonly secretToken?: undefined | string;
1337
- readonly status?: undefined | "Passed" | "Unresolved" | "Failed";
1338
+ readonly status?: undefined | "Passed" | "Failed" | "Unresolved";
1338
1339
  readonly appName?: undefined | string;
1339
1340
  readonly batchId?: undefined | string;
1340
1341
  readonly batchName?: undefined | string;
@@ -1426,14 +1427,14 @@ export class TestResults implements Required<TestResultsPlain> {
1426
1427
  isPassed(): boolean;
1427
1428
  delete(): Promise<void>;
1428
1429
  }
1429
- export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; readonly browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo; };
1430
+ export type TestResultContainerPlain = { readonly exception?: undefined | Error; readonly testResults?: undefined | TestResultsPlain; readonly browserInfo?: undefined | (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; }); };
1430
1431
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1431
1432
  get testResults(): TestResultsPlain;
1432
1433
  getTestResults(): TestResults;
1433
1434
  get exception(): Error;
1434
1435
  getException(): Error;
1435
- get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1436
- getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "landscape" | "portrait"; } | IOSDeviceInfo | AndroidDeviceInfo;
1436
+ get browserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; };
1437
+ getBrowserInfo(): DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | AndroidDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: undefined | "portrait" | "landscape"; };
1437
1438
  }
1438
1439
  export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1439
1440
  export class TestResultsSummary implements Iterable<TestResultContainer> {
@@ -1482,7 +1483,7 @@ export class ClassicRunner extends EyesRunner {
1482
1483
  }
1483
1484
  export class VisualGridRunner extends EyesRunner {
1484
1485
  constructor(options?: undefined | RunnerOptionsPlain);
1485
- get testConcurrency(): number;
1486
+ get testConcurrency(): undefined | number;
1486
1487
  }
1487
1488
  export abstract class SessionEventHandler {
1488
1489
  abstract initStarted(): any;
@@ -1514,14 +1515,14 @@ export class RemoteSessionEventHandler extends SessionEventHandler {
1514
1515
  set serverUrl(serverUrl: string);
1515
1516
  getServerUrl(): string;
1516
1517
  setServerUrl(serverUrl: string): void;
1517
- get accessKey(): string;
1518
- set accessKey(accessKey: string);
1519
- getAccessKey(): string;
1518
+ get accessKey(): undefined | string;
1519
+ set accessKey(accessKey: undefined | string);
1520
+ getAccessKey(): undefined | string;
1520
1521
  setAccessKey(accessKey: string): void;
1521
- get timeout(): number;
1522
- set timeout(timeout: number);
1522
+ get timeout(): undefined | number;
1523
+ set timeout(timeout: undefined | number);
1523
1524
  setTimeout(timeout: number): void;
1524
- getTimeout(): number;
1525
+ getTimeout(): undefined | number;
1525
1526
  initStarted(): void;
1526
1527
  initEnded(): void;
1527
1528
  setSizeWillStart(): void;
package/types/service.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ConfigurationPlain } from './api';
1
+ import { ConfigurationPlain } from './index';
2
2
  interface EyesServiceOptions extends ConfigurationPlain {
3
3
  useVisualGrid?: boolean;
4
4
  concurrency?: number;