@applitools/eyes-webdriverio 5.34.14 → 5.35.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 (8) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/dist/api.js +5 -1
  3. package/dist/index.js +5 -1
  4. package/dist/service.js +8 -16
  5. package/dist/spec-driver.js +5 -1
  6. package/package.json +23 -21
  7. package/types/index.d.ts +26 -57
  8. package/types/service.d.ts +20 -17
package/CHANGELOG.md CHANGED
@@ -6,6 +6,33 @@
6
6
 
7
7
 
8
8
 
9
+
10
+
11
+ ## 5.35.0 - 2022/6/1
12
+
13
+ ### Features
14
+ - Dorp support for Node.js versions <=12
15
+ ### Bug fixes
16
+ - Fixed incorrect calculation of coded regions in classic mode when using CSS stitching
17
+
18
+ ## 5.34.16 - 2022/5/27
19
+
20
+ ### Features
21
+ - Added support for drivers that return screenshots in jpeg format
22
+ ### Bug fixes
23
+ - Improve error message when failed to set viewport size
24
+
25
+ ## 5.34.15 - 2022/5/23
26
+
27
+ ### Features
28
+ - Support iPhone SE `IosDeviceName.iPhone_SE` and iPhone 8 Plus `IosDeviceName.iPhone_8_Plus` iOS devices
29
+ - Support Galaxy S22 `DeviceName.Galaxy_S22` emulation device
30
+ ### Bug fixes
31
+ - Fixed handling of navigation bar size on various devices
32
+ - Allow running with self-signed certificates
33
+ - Fixed bug in native apps when screenshot of the element was taken only for the small visible part of the element
34
+ - Fixed bug when navigation bar was presented in screenshot on Android 12
35
+
9
36
  ## 5.34.14 - 2022/5/5
10
37
 
11
38
  ### Features
package/dist/api.js CHANGED
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
package/dist/index.js CHANGED
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
package/dist/service.js CHANGED
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
@@ -18,17 +22,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
18
22
  __setModuleDefault(result, mod);
19
23
  return result;
20
24
  };
21
- var __rest = (this && this.__rest) || function (s, e) {
22
- var t = {};
23
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
24
- t[p] = s[p];
25
- if (s != null && typeof Object.getOwnPropertySymbols === "function")
26
- for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
27
- if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
28
- t[p[i]] = s[p[i]];
29
- }
30
- return t;
31
- };
32
25
  const eyes_sdk_core_1 = require("@applitools/eyes-sdk-core");
33
26
  const spec = __importStar(require("./spec-driver"));
34
27
  const api_1 = require("./api");
@@ -38,7 +31,7 @@ if (!process.env.APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION) {
38
31
  const [major] = version.split('.', 1);
39
32
  process.env.APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION = major;
40
33
  }
41
- catch (_a) {
34
+ catch {
42
35
  }
43
36
  }
44
37
  const sdk = (0, eyes_sdk_core_1.makeSDK)({
@@ -51,10 +44,9 @@ class EyesOverride extends api_1.Eyes {
51
44
  }
52
45
  EyesOverride._spec = sdk;
53
46
  class EyesService {
54
- constructor(_a) {
55
- var { useVisualGrid, concurrency, eyes } = _a, config = __rest(_a, ["useVisualGrid", "concurrency", "eyes"]);
47
+ constructor({ useVisualGrid, concurrency, eyes, ...config }) {
56
48
  const wdioMajorVersion = Number(process.env.APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION);
57
- config = wdioMajorVersion < 6 ? Object.assign({}, eyes) : config;
49
+ config = wdioMajorVersion < 6 ? { ...eyes } : config;
58
50
  if (!useVisualGrid)
59
51
  config.hideScrollbars = true;
60
52
  this._eyes = new EyesOverride(useVisualGrid ? new api_1.VisualGridRunner({ testConcurrency: concurrency }) : new api_1.ClassicRunner(), config);
package/dist/spec-driver.js CHANGED
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-webdriverio",
3
- "version": "5.34.14",
3
+ "version": "5.35.0",
4
4
  "description": "Applitools Eyes SDK for WebdriverIO",
5
5
  "keywords": [
6
6
  "eyes-webdriverio",
@@ -54,6 +54,7 @@
54
54
  "types": "./types/v5-sync.d.ts"
55
55
  },
56
56
  "./dist/*": "./dist/*.js",
57
+ "./types/*": "./dist/*.d.ts",
57
58
  "./package.json": "./package.json"
58
59
  },
59
60
  "typesVersions": {
@@ -110,45 +111,46 @@
110
111
  }
111
112
  },
112
113
  "dependencies": {
113
- "@applitools/eyes-api": "1.3.0",
114
- "@applitools/eyes-sdk-core": "13.6.1",
115
- "@applitools/spec-driver-webdriverio": "1.2.9",
116
- "@applitools/visual-grid-client": "15.12.12"
114
+ "@applitools/eyes-api": "1.5.0",
115
+ "@applitools/eyes-sdk-core": "13.6.25",
116
+ "@applitools/spec-driver-webdriverio": "1.2.10",
117
+ "@applitools/visual-grid-client": "15.12.36"
117
118
  },
118
119
  "devDependencies": {
119
- "@applitools/api-extractor": "1.2.7",
120
- "@applitools/bongo": "^2.0.3",
120
+ "@applitools/api-extractor": "1.2.8",
121
+ "@applitools/bongo": "^2.1.1",
121
122
  "@applitools/scripts": "1.1.0",
122
123
  "@applitools/sdk-coverage-tests": "^2.3.18",
123
124
  "@applitools/sdk-shared": "0.9.11",
124
125
  "@applitools/test-utils": "1.3.2",
125
- "@types/mocha": "^9.0.0",
126
- "@typescript-eslint/eslint-plugin": "^4.15.1",
127
- "@typescript-eslint/parser": "^4.15.1",
126
+ "@types/mocha": "^9.1.1",
127
+ "@types/node": "12",
128
+ "@typescript-eslint/eslint-plugin": "^5.27.0",
129
+ "@typescript-eslint/parser": "^5.27.0",
128
130
  "@wdio/cli": "^7.16.5",
129
131
  "@wdio/dot-reporter": "^7.16.4",
130
132
  "@wdio/local-runner": "^7.16.5",
131
133
  "@wdio/mocha-framework": "^7.16.4",
132
- "chromedriver": "^95.0.0",
133
- "eslint": "^7.9.0",
134
- "eslint-config-prettier": "^7.2.0",
134
+ "chromedriver": "^101.0.0",
135
+ "eslint": "^8.16.0",
136
+ "eslint-config-prettier": "^8.5.0",
135
137
  "eslint-plugin-mocha-no-only": "^1.1.1",
136
138
  "eslint-plugin-node": "^11.1.0",
137
- "eslint-plugin-prettier": "^3.3.1",
139
+ "eslint-plugin-prettier": "^4.0.0",
138
140
  "geckodriver": "^1.20.0",
139
141
  "husky": "^4.3.8",
140
- "mocha": "^9.1.3",
141
- "prettier": "^2.1.2",
142
+ "mocha": "^10.0.0",
143
+ "prettier": "^2.6.2",
142
144
  "spec-xunit-file": "0.0.1-3",
143
- "ts-node": "^10.2.1",
144
- "ttypescript": "^1.5.12",
145
- "typescript": "^4.5.5",
146
- "webdriverio": "^7.16.12"
145
+ "ts-node": "^10.8.0",
146
+ "ttypescript": "^1.5.13",
147
+ "typescript": "^4.7.2",
148
+ "webdriverio": "^7.19.7"
147
149
  },
148
150
  "peerDependencies": {
149
151
  "webdriverio": "5.0.0 - 7.x.x"
150
152
  },
151
153
  "engines": {
152
- "node": ">=8.9.0"
154
+ "node": ">=12.13.0"
153
155
  }
154
156
  }
package/types/index.d.ts CHANGED
@@ -429,10 +429,10 @@ export class Configuration implements Required<ConfigurationPlain> {
429
429
  setConcurrentSessions(concurrentSessions: number): Configuration;
430
430
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>;
431
431
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>);
432
- getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>;
433
- setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
434
- addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
435
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }): Configuration;
432
+ getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>;
433
+ setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>): Configuration;
434
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>): Configuration;
435
+ addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo): Configuration;
436
436
  addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
437
437
  addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
438
438
  get visualGridOptions(): { [key: string]: any; };
@@ -633,7 +633,7 @@ export enum CorsIframeHandle {
633
633
  KEEP = 'KEEP',
634
634
  SNAPSHOT = 'SNAPSHOT'
635
635
  }
636
- export type DeviceNamePlain = "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5";
636
+ export type DeviceNamePlain = "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5";
637
637
  export enum DeviceName {
638
638
  Blackberry_PlayBook = 'Blackberry PlayBook',
639
639
  BlackBerry_Z30 = 'BlackBerry Z30',
@@ -654,6 +654,7 @@ export enum DeviceName {
654
654
  Galaxy_S10 = 'Galaxy S10',
655
655
  Galaxy_S10_Plus = 'Galaxy S10 Plus',
656
656
  Galaxy_S20 = 'Galaxy S20',
657
+ Galaxy_S22 = 'Galaxy S22',
657
658
  Galaxy_Tab_S7 = 'Galaxy Tab S7',
658
659
  iPad = 'iPad',
659
660
  iPad_6th_Gen = 'iPad 6th Gen',
@@ -704,7 +705,7 @@ export enum FailureReport {
704
705
  IMMEDIATE = 'IMMEDIATE',
705
706
  ON_CLOSE = 'ON_CLOSE'
706
707
  }
707
- export type IosDeviceNamePlain = "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 7" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)";
708
+ export type IosDeviceNamePlain = "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)";
708
709
  export enum IosDeviceName {
709
710
  iPhone_13_Pro_Max = 'iPhone 13 Pro Max',
710
711
  iPhone_13_Pro = 'iPhone 13 Pro',
@@ -720,7 +721,9 @@ export enum IosDeviceName {
720
721
  iPhone_XS = 'iPhone Xs',
721
722
  iPhone_X = 'iPhone X',
722
723
  iPhone_8 = 'iPhone 8',
724
+ iPhone_8_Plus = 'iPhone 8 Plus',
723
725
  iPhone_7 = 'iPhone 7',
726
+ iPhone_SE = 'iPhone SE (1st generation)',
724
727
  iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)',
725
728
  iPad_7 = 'iPad (7th generation)',
726
729
  iPad_9 = 'iPad (9th generation)',
@@ -743,7 +746,7 @@ export enum MatchLevel {
743
746
  Strict = 'Strict',
744
747
  Exact = 'Exact'
745
748
  }
746
- export type ScreenOrientationPlain = "portrait" | "landscape";
749
+ export type ScreenOrientationPlain = "landscape" | "portrait";
747
750
  export enum ScreenOrientation {
748
751
  PORTRAIT = 'portrait',
749
752
  LANDSCAPE = 'landscape'
@@ -753,7 +756,7 @@ export enum SessionType {
753
756
  SEQUENTIAL = 'SEQUENTIAL',
754
757
  PROGRESSION = 'PROGRESSION'
755
758
  }
756
- export type StitchModePlain = "Scroll" | "CSS";
759
+ export type StitchModePlain = "CSS" | "Scroll";
757
760
  export enum StitchMode {
758
761
  SCROLL = 'Scroll',
759
762
  CSS = 'CSS'
@@ -941,8 +944,8 @@ export type ImageMatchSettingsPlain = {
941
944
  layoutRegions?: Array<RegionPlain>;
942
945
  strictRegions?: Array<RegionPlain>;
943
946
  contentRegions?: Array<RegionPlain>;
944
- floatingRegions?: Array<FloatingMatchSettingsPlain | RegionPlain>;
945
- accessibilityRegions?: Array<AccessibilityMatchSettingsPlain | RegionPlain>;
947
+ floatingRegions?: Array<RegionPlain | FloatingMatchSettingsPlain>;
948
+ accessibilityRegions?: Array<RegionPlain | AccessibilityMatchSettingsPlain>;
946
949
  accessibilitySettings?: AccessibilitySettings;
947
950
  };
948
951
  export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
@@ -993,16 +996,16 @@ export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
993
996
  set content(content: Array<RegionPlain>);
994
997
  getContentRegions(): Array<Region>;
995
998
  setContentRegions(contentRegions: Array<RegionPlain>): void;
996
- get floatingRegions(): Array<FloatingMatchSettingsPlain | RegionPlain>;
997
- set floatingRegions(floatingRegions: Array<FloatingMatchSettingsPlain | RegionPlain>);
998
- get floating(): Array<FloatingMatchSettingsPlain | RegionPlain>;
999
- set floating(floating: Array<FloatingMatchSettingsPlain | RegionPlain>);
999
+ get floatingRegions(): Array<RegionPlain | FloatingMatchSettingsPlain>;
1000
+ set floatingRegions(floatingRegions: Array<RegionPlain | FloatingMatchSettingsPlain>);
1001
+ get floating(): Array<RegionPlain | FloatingMatchSettingsPlain>;
1002
+ set floating(floating: Array<RegionPlain | FloatingMatchSettingsPlain>);
1000
1003
  getFloatingRegions(): Array<FloatingMatchSettings>;
1001
1004
  setFloatingRegions(floatingRegions: Array<FloatingMatchSettingsPlain>): void;
1002
- get accessibilityRegions(): Array<AccessibilityMatchSettingsPlain | RegionPlain>;
1003
- set accessibilityRegions(accessibilityRegions: Array<AccessibilityMatchSettingsPlain | RegionPlain>);
1004
- get accessibility(): Array<AccessibilityMatchSettingsPlain | RegionPlain>;
1005
- set accessibility(accessibility: Array<AccessibilityMatchSettingsPlain | RegionPlain>);
1005
+ get accessibilityRegions(): Array<RegionPlain | AccessibilityMatchSettingsPlain>;
1006
+ set accessibilityRegions(accessibilityRegions: Array<RegionPlain | AccessibilityMatchSettingsPlain>);
1007
+ get accessibility(): Array<RegionPlain | AccessibilityMatchSettingsPlain>;
1008
+ set accessibility(accessibility: Array<RegionPlain | AccessibilityMatchSettingsPlain>);
1006
1009
  getAccessibilityRegions(): Array<AccessibilityMatchSettings>;
1007
1010
  setAccessibilityRegions(accessibilityRegions: Array<AccessibilityMatchSettingsPlain>): void;
1008
1011
  get accessibilitySettings(): AccessibilitySettings;
@@ -1031,7 +1034,7 @@ export class Location implements Required<LocationPlain> {
1031
1034
  getY(): number;
1032
1035
  setY(y: number): void;
1033
1036
  }
1034
- export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
1037
+ export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1035
1038
  export type CustomLogHandlerPlain = {
1036
1039
  log(message: any): void;
1037
1040
  warn?(message: any): void;
@@ -1410,14 +1413,14 @@ export type TestResultContainerPlain = { readonly exception?: Error; readonly te
1410
1413
  readonly layoutMatches?: number;
1411
1414
  readonly noneMatches?: number;
1412
1415
  readonly url?: string;
1413
- }; readonly browserInfo?: { name?: "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; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "portrait" | "landscape"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 7" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "portrait" | "landscape"; }; }; };
1416
+ }; readonly browserInfo?: { name?: "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; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "landscape" | "portrait"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "landscape" | "portrait"; }; }; };
1414
1417
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1415
1418
  get testResults(): TestResultsPlain;
1416
1419
  getTestResults(): TestResults;
1417
1420
  get exception(): Error;
1418
1421
  getException(): Error;
1419
- get browserInfo(): { name?: "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; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "portrait" | "landscape"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 7" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "portrait" | "landscape"; }; };
1420
- getBrowserInfo(): { name?: "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; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "portrait" | "landscape"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 7" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "portrait" | "landscape"; }; };
1422
+ get browserInfo(): { name?: "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; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "landscape" | "portrait"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "landscape" | "portrait"; }; };
1423
+ getBrowserInfo(): { name?: "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; } | { chromeEmulationInfo: { deviceName: "Blackberry PlayBook" | "BlackBerry Z30" | "Galaxy A5" | "Galaxy Note 10" | "Galaxy Note 10 Plus" | "Galaxy Note 2" | "Galaxy Note 3" | "Galaxy Note 4" | "Galaxy Note 8" | "Galaxy Note 9" | "Galaxy S3" | "Galaxy S5" | "Galaxy S8" | "Galaxy S8 Plus" | "Galaxy S9" | "Galaxy S9 Plus" | "Galaxy S10" | "Galaxy S10 Plus" | "Galaxy S20" | "Galaxy S22" | "Galaxy Tab S7" | "iPad" | "iPad 6th Gen" | "iPad 7th Gen" | "iPad Air 2" | "iPad Mini" | "iPad Pro" | "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone 4" | "iPhone 5/SE" | "iPhone 6/7/8" | "iPhone 6/7/8 Plus" | "iPhone X" | "iPhone XR" | "iPhone XS" | "iPhone XS Max" | "Kindle Fire HDX" | "Laptop with HiDPI screen" | "Laptop with MDPI screen" | "Laptop with touch" | "LG G6" | "LG Optimus L70" | "Microsoft Lumia 550" | "Microsoft Lumia 950" | "Nexus 10" | "Nexus 4" | "Nexus 5" | "Nexus 5X" | "Nexus 6" | "Nexus 6P" | "Nexus 7" | "Nokia Lumia 520" | "Nokia N9" | "OnePlus 7T" | "OnePlus 7T Pro" | "Pixel 2" | "Pixel 2 XL" | "Pixel 3" | "Pixel 3 XL" | "Pixel 4" | "Pixel 4 XL" | "Pixel 5"; screenOrientation?: "landscape" | "portrait"; }; } | { iosDeviceInfo: { deviceName: "iPhone 11" | "iPhone 11 Pro" | "iPhone 11 Pro Max" | "iPhone X" | "iPhone XR" | "iPhone 13 Pro Max" | "iPhone 13 Pro" | "iPhone 13" | "iPhone 12 Pro Max" | "iPhone 12 Pro" | "iPhone 12" | "iPhone 12 mini" | "iPhone Xs" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 7" | "iPhone SE (1st generation)" | "iPad Pro (12.9-inch) (3rd generation)" | "iPad (7th generation)" | "iPad (9th generation)" | "iPad Air (2nd generation)" | "iPad Air (4th generation)"; iosVersion?: "latest" | "latest-1"; screenOrientation?: "landscape" | "portrait"; }; };
1421
1424
  }
1422
1425
  export type TestResultsSummaryPlain = {
1423
1426
  results: Array<TestResultContainerPlain>;
@@ -1465,41 +1468,7 @@ export class Logger {
1465
1468
  fatal(...messages: Array<any>): void;
1466
1469
  open(): void;
1467
1470
  close(): void;
1468
- extend(options?: Omit<{
1469
- handler?: CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain | {
1470
- type: "rolling file";
1471
- dirname?: string;
1472
- name?: string;
1473
- maxFileLength?: number;
1474
- maxFileNumber?: number;
1475
- };
1476
- format?: (message: any, options: {
1477
- formatting?: boolean;
1478
- label?: string;
1479
- timestamp?: Date;
1480
- level?: "silent" | "fatal" | "error" | "warn" | "info";
1481
- tags?: Record<string, unknown>;
1482
- color?: string | Array<string>;
1483
- colors?: { timestamp?: string | Array<string>; level?: {
1484
- silent?: string | Array<string>;
1485
- fatal?: string | Array<string>;
1486
- error?: string | Array<string>;
1487
- warn?: string | Array<string>;
1488
- info?: string | Array<string>;
1489
- }; tags?: string | Array<string>; message?: string | Array<string>; };
1490
- }) => string;
1491
- label?: string;
1492
- timestamp?: false;
1493
- level?: number | ("silent" | "fatal" | "error" | "warn" | "info");
1494
- colors?: boolean | { timestamp?: string | Array<string>; level?: {
1495
- silent?: string | Array<string>;
1496
- fatal?: string | Array<string>;
1497
- error?: string | Array<string>;
1498
- warn?: string | Array<string>;
1499
- info?: string | Array<string>;
1500
- }; tags?: string | Array<string>; message?: string | Array<string>; };
1501
- console?: boolean | CustomLogHandlerPlain;
1502
- }, "handler">): Logger;
1471
+ tag(name: string, value: any): void;
1503
1472
  extend(label?: string): Logger;
1504
1473
  }
1505
1474
  export function closeBatch(spec: { closeBatches(options: { settings: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }; }): Promise<void>; }): (options: { batchIds: Array<string>; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain; }) => Promise<void>;
package/types/service.d.ts CHANGED
@@ -10,22 +10,25 @@ import type {
10
10
  TestResultsSummary,
11
11
  } from './index'
12
12
 
13
- declare module WebdriverIO {
14
- interface ServiceOption extends ConfigurationPlain {
15
- useVisualGrid?: boolean
16
- concurrency?: number
17
- eyes?: ServiceOption
18
- }
19
- interface Browser {
20
- getEyes(): Eyes
21
- eyesCheck(title: string, checkSettings: CheckSettings | CheckSettingsPlain): Promise<void>
22
- eyesSetScrollRootElement(element: Element | Selector): void
23
- eyesAddProperty(key: string, value: string): void
24
- eyesClearProperties(): void
25
- eyesGetTestResults(): Promise<TestResults>
26
- eyesSetConfiguration(configuration: ConfigurationPlain): void
27
- eyesGetConfiguration(): Configuration
28
- eyesGetIsOpen(): boolean
29
- eyesGetAllTestResults(throwErr: boolean): Promise<TestResultsSummary>
13
+ declare global {
14
+ namespace WebdriverIO {
15
+ interface ServiceOption extends ConfigurationPlain {
16
+ useVisualGrid?: boolean
17
+ concurrency?: number
18
+ eyes?: ServiceOption
19
+ }
20
+ interface Browser {
21
+ getEyes(): Eyes
22
+ eyesCheck(checkSettings?: CheckSettingsPlain): Promise<void>
23
+ eyesCheck(title: string, checkSettings: CheckSettings): Promise<void>
24
+ eyesSetScrollRootElement(element: Element | Selector): void
25
+ eyesAddProperty(key: string, value: string): void
26
+ eyesClearProperties(): void
27
+ eyesGetTestResults(): Promise<TestResults>
28
+ eyesSetConfiguration(configuration: ConfigurationPlain): void
29
+ eyesGetConfiguration(): Configuration
30
+ eyesGetIsOpen(): boolean
31
+ eyesGetAllTestResults(throwErr: boolean): Promise<TestResultsSummary>
32
+ }
30
33
  }
31
34
  }