@applitools/eyes-webdriverio 5.34.10 → 5.34.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/package.json +10 -10
  3. package/types/index.d.ts +66 -3
package/CHANGELOG.md CHANGED
@@ -3,6 +3,32 @@
3
3
  ## Unreleased
4
4
 
5
5
 
6
+
7
+
8
+ ## 5.34.13 - 2022/3/25
9
+
10
+ ### Features
11
+ - Support pageCoverage info in Native
12
+ - `runner.getAllTestResults` returns the corresponding UFG browser/device configuration for each test. This is available as `runner.getAllTestResults()[i].browserInfo`.
13
+ ### Bug fixes
14
+ - `runner.getAllTestResults` now aborts unclosed tests
15
+ - `runner.getAllTestResults` now returns all results, including aborted tests
16
+
17
+ ## 5.34.12 - 2022/2/16
18
+
19
+ - fix image scaling on pages without viewport metatag
20
+ - fix safari's viewport detection on iOS devices
21
+ - updated to @applitools/eyes-api@1.1.8 (from 1.1.7)
22
+ - updated to @applitools/eyes-sdk-core@13.0.4 (from 13.0.2)
23
+ - updated to @applitools/visual-grid-client@15.8.65 (from 15.8.63)
24
+
25
+ ## 5.34.11 - 2022/2/10
26
+
27
+ - allow setting ‘setImageCut’ also after eyes.open (change done in eyes-sdk-core)
28
+ - updated to @applitools/eyes-sdk-core@13.0.2 (from 13.0.0)
29
+ - updated to @applitools/spec-driver-webdriverio@1.2.7 (from 1.2.6)
30
+ - updated to @applitools/visual-grid-client@15.8.63 (from 15.8.62)
31
+
6
32
  ## 5.34.10 - 2022/1/24
7
33
 
8
34
  - Fixed BatchInfo.addProperty bug
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applitools/eyes-webdriverio",
3
- "version": "5.34.10",
3
+ "version": "5.34.13",
4
4
  "description": "Applitools Eyes SDK for WebdriverIO",
5
5
  "keywords": [
6
6
  "eyes-webdriverio",
@@ -85,7 +85,7 @@
85
85
  "scripts": {
86
86
  "lint": "eslint '**/*.ts'",
87
87
  "build": "ttsc --project tsconfig$([ ! -z $APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION ] && echo .v$APPLITOOLS_WEBDRIVERIO_MAJOR_VERSION).json",
88
- "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes.webdriverio.javascript5' --tests https://raw.githubusercontent.com/applitools/sdk.coverage.tests/default-window-fully-true/coverage-tests.js",
88
+ "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes.webdriverio.javascript5'",
89
89
  "test": "yarn test:service && yarn test:coverage",
90
90
  "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",
91
91
  "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",
@@ -100,8 +100,8 @@
100
100
  "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)'",
101
101
  "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' -f linking-depth=3",
102
102
  "gh:publish": "gh workflow run publish-webdriverio.yml --ref $(git rev-parse --abbrev-ref HEAD)",
103
- "preversion": "bongo preversion && yarn build",
104
- "version": "bongo version",
103
+ "preversion": "bongo preversion --verifyPendingChanges && yarn build",
104
+ "version": "bongo version --withPendingChanges",
105
105
  "postversion": "bongo postversion"
106
106
  },
107
107
  "husky": {
@@ -110,18 +110,18 @@
110
110
  }
111
111
  },
112
112
  "dependencies": {
113
- "@applitools/eyes-api": "1.1.7",
114
- "@applitools/eyes-sdk-core": "13.0.0",
115
- "@applitools/spec-driver-webdriverio": "1.2.6",
116
- "@applitools/visual-grid-client": "15.8.62"
113
+ "@applitools/eyes-api": "1.2.0",
114
+ "@applitools/eyes-sdk-core": "13.1.2",
115
+ "@applitools/spec-driver-webdriverio": "1.2.8",
116
+ "@applitools/visual-grid-client": "15.10.1"
117
117
  },
118
118
  "devDependencies": {
119
119
  "@applitools/api-extractor": "1.2.7",
120
120
  "@applitools/scripts": "1.1.0",
121
121
  "@applitools/sdk-coverage-tests": "^2.3.18",
122
- "@applitools/sdk-release-kit": "^0.13.11",
122
+ "@applitools/sdk-release-kit": "^1.0.4",
123
123
  "@applitools/sdk-shared": "0.9.11",
124
- "@applitools/test-utils": "1.0.11",
124
+ "@applitools/test-utils": "1.1.5",
125
125
  "@types/mocha": "^9.0.0",
126
126
  "@typescript-eslint/eslint-plugin": "^4.15.1",
127
127
  "@typescript-eslint/parser": "^4.15.1",
package/types/index.d.ts CHANGED
@@ -157,6 +157,7 @@ export type ConfigurationPlain = {
157
157
  apiKey?: string;
158
158
  serverUrl?: string;
159
159
  proxy?: ProxySettingsPlain;
160
+ autProxy?: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
160
161
  isDisabled?: boolean;
161
162
  connectionTimeout?: number;
162
163
  removeSession?: boolean;
@@ -267,6 +268,10 @@ export class Configuration implements Required<ConfigurationPlain> {
267
268
  setProxy(proxy: ProxySettingsPlain): Configuration;
268
269
  setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
269
270
  setProxy(isEnabled: false): Configuration;
271
+ get autProxy(): { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
272
+ set autProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; });
273
+ getAutProxy(): { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
274
+ setAutProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; }): Configuration;
270
275
  get connectionTimeout(): number;
271
276
  set connectionTimeout(connectionTimeout: number);
272
277
  getConnectionTimeout(): number;
@@ -478,6 +483,7 @@ export type CheckSettingsPlain = {
478
483
  visualGridOptions?: { [key: string]: any; };
479
484
  hooks?: { beforeCaptureScreenshot: string; };
480
485
  renderId?: string;
486
+ pageId?: string;
481
487
  variationGroupId?: string;
482
488
  timeout?: number;
483
489
  waitBeforeCapture?: number;
@@ -557,6 +563,7 @@ export class CheckSettings {
557
563
  visualGridOption(key: string, value: any): CheckSettings;
558
564
  visualGridOptions(options: { [key: string]: any; }): CheckSettings;
559
565
  renderId(renderId: string): CheckSettings;
566
+ pageId(pageId: string): CheckSettings;
560
567
  variationGroupId(variationGroupId: string): CheckSettings;
561
568
  timeout(timeout: number): CheckSettings;
562
569
  waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
@@ -1358,15 +1365,71 @@ export class TestResults implements Required<TestResultsPlain> {
1358
1365
  delete(): Promise<void>;
1359
1366
  deleteSession(): Promise<void>;
1360
1367
  }
1361
- export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; };
1368
+ export type TestResultContainerPlain = { readonly exception?: Error; readonly testResults?: {
1369
+ readonly id?: string;
1370
+ readonly name?: string;
1371
+ readonly secretToken?: string;
1372
+ readonly status?: "Passed" | "Failed" | "Unresolved";
1373
+ readonly appName?: string;
1374
+ readonly batchId?: string;
1375
+ readonly batchName?: string;
1376
+ readonly branchName?: string;
1377
+ readonly hostOS?: string;
1378
+ readonly hostApp?: string;
1379
+ readonly hostDisplaySize?: { width: number; height: number; };
1380
+ readonly accessibilityStatus?: { readonly level: "AA" | "AAA"; readonly version: "WCAG_2_0" | "WCAG_2_1"; readonly status: "Passed" | "Failed"; };
1381
+ readonly startedAt?: string | Date;
1382
+ readonly duration?: number;
1383
+ readonly isNew?: boolean;
1384
+ readonly isDifferent?: boolean;
1385
+ readonly isAborted?: boolean;
1386
+ readonly appUrls?: { readonly batch?: string; readonly session?: string; };
1387
+ readonly apiUrls?: { readonly batch?: string; readonly session?: string; };
1388
+ readonly stepsInfo?: Array<{
1389
+ readonly name?: string;
1390
+ readonly isDifferent?: boolean;
1391
+ readonly hasBaselineImage?: boolean;
1392
+ readonly hasCurrentImage?: boolean;
1393
+ readonly appUrls?: { readonly step?: string; readonly stepEditor?: string; };
1394
+ readonly apiUrls?: {
1395
+ readonly baselineImage?: string;
1396
+ readonly currentImage?: string;
1397
+ readonly checkpointImage?: string;
1398
+ readonly checkpointImageThumbnail?: string;
1399
+ readonly diffImage?: string;
1400
+ };
1401
+ readonly renderId?: Array<string>;
1402
+ }>;
1403
+ readonly steps?: number;
1404
+ readonly matches?: number;
1405
+ readonly mismatches?: number;
1406
+ readonly missing?: number;
1407
+ readonly exactMatches?: number;
1408
+ readonly strictMatches?: number;
1409
+ readonly contentMatches?: number;
1410
+ readonly layoutMatches?: number;
1411
+ readonly noneMatches?: number;
1412
+ 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"; }; }; };
1362
1414
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1363
1415
  get testResults(): TestResultsPlain;
1364
1416
  getTestResults(): TestResults;
1365
1417
  get exception(): Error;
1366
1418
  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"; }; };
1367
1421
  }
1368
- export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1369
- export class TestResultsSummary implements TestResultsSummaryPlain {
1422
+ export type TestResultsSummaryPlain = {
1423
+ results: Array<TestResultContainerPlain>;
1424
+ passed: number;
1425
+ unresolved: number;
1426
+ failed: number;
1427
+ exceptions: number;
1428
+ mismatches: number;
1429
+ missing: number;
1430
+ matches: number;
1431
+ };
1432
+ export class TestResultsSummary implements Iterable<TestResultContainerPlain> {
1370
1433
  getAllResults(): Array<TestResultContainer>;
1371
1434
  [Symbol.iterator](): Iterator<TestResultContainer, any, undefined>;
1372
1435
  }