@applitools/eyes-playwright 1.11.2 → 1.12.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 +37 -0
  2. package/dist/api.js +5 -1
  3. package/dist/index.js +5 -1
  4. package/dist/spec-driver.js +5 -1
  5. package/package.json +23 -26
  6. package/types/index.d.ts +100 -25
package/CHANGELOG.md CHANGED
@@ -3,6 +3,43 @@
3
3
  ## Unreleased
4
4
 
5
5
 
6
+
7
+
8
+
9
+
10
+
11
+
12
+ ## 1.12.0 - 2022/6/1
13
+
14
+ ### Features
15
+ - Dorp support for Node.js versions <=12
16
+ ### Bug fixes
17
+ - Fixed incorrect calculation of coded regions in classic mode when using CSS stitching
18
+
19
+ ## 1.11.4 - 2022/5/27
20
+
21
+ ### Features
22
+ - Support iPhone SE `IosDeviceName.iPhone_SE` and iPhone 8 Plus `IosDeviceName.iPhone_8_Plus` iOS devices
23
+ - Support Galaxy S22 `DeviceName.Galaxy_S22` emulation device
24
+ ### Bug fixes
25
+ - Allow running with self-signed certificates
26
+ - Fixed `CheckSetting`'s `fully` being overridden by `Configuration`'s `forceFullPageScreenshot`
27
+ - Set EyesExceptions (such as new test, diffs exception and failed test exception) to exception property in TestResultsSummary
28
+ - Improve error message when failed to set viewport size
29
+
30
+ ## 1.11.3 - 2022/5/2
31
+
32
+ ### Features
33
+ - Support UFG for native mobile
34
+ - `runner.getAllTestResults` returns the corresponding UFG browser/device configuration for each test. This is available as `runner.getAllTestResults()[i].browserInfo`.
35
+ ### Bug fixes
36
+ - `runner.getAllTestResults` now aborts unclosed tests
37
+ - `runner.getAllTestResults` now returns all results, including aborted tests
38
+ - `extractText` now supports regions that don't use hints while using `x`/`y` coordinates
39
+ - accept ios and android lowercase as driver platformName capability when using custom grid
40
+ - Fixed check region fully in classic execution when using CSS stitching
41
+ - Support data urls in iframes
42
+
6
43
  ## 1.11.2 - 2022/1/13
7
44
 
8
45
  - fix taking multiple dom snapshots with `layoutBreakpoints`
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/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-playwright",
3
- "version": "1.11.2",
3
+ "version": "1.12.0",
4
4
  "description": "Applitools Eyes SDK for Playwright",
5
5
  "keywords": [
6
6
  "eyes-playwright",
@@ -29,11 +29,6 @@
29
29
  },
30
30
  "main": "./dist/index.js",
31
31
  "types": "./types/index.d.ts",
32
- "directories": {
33
- "lib": "./src",
34
- "example": "./example",
35
- "test": "./test"
36
- },
37
32
  "files": [
38
33
  "dist",
39
34
  "types"
@@ -45,11 +40,12 @@
45
40
  "test": "yarn test:coverage",
46
41
  "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-playwright' APPLITOOLS_BATCH_ID=$(uuidgen) XUNIT_FILE=coverage-test-report.xml mocha --config .mocharc.cvg.js",
47
42
  "report": "coverage-tests report https://raw.githubusercontent.com/applitools/sdk.coverage.tests/master/js/config.js --name 'eyes-playwright'",
43
+ "upgrade:framework": "if [ ! -z $APPLITOOLS_PLAYWRIGHT_VERSION ]; then packagejson=`cat package.json`; yarn upgrade --no-lockfile playwright@$APPLITOOLS_PLAYWRIGHT_VERSION; echo \"$packagejson\" > package.json; fi",
48
44
  "deps": "bongo deps",
49
45
  "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='playwright' -f links='types test-utils sdk-shared eyes-sdk-core visual-grid-client eyes-api spec-driver-playwright utils driver snippets screenshoter' -f linking-depth=3",
50
46
  "gh:publish": "gh workflow run publish-playwright.yml --ref $(git rev-parse --abbrev-ref HEAD)",
51
- "preversion": "bongo preversion && yarn build",
52
- "version": "bongo version",
47
+ "preversion": "bongo preversion --verifyPendingChanges && yarn build",
48
+ "version": "bongo version --withPendingChanges",
53
49
  "postversion": "bongo postversion"
54
50
  },
55
51
  "husky": {
@@ -58,39 +54,40 @@
58
54
  }
59
55
  },
60
56
  "dependencies": {
61
- "@applitools/eyes-api": "1.1.6",
62
- "@applitools/eyes-sdk-core": "12.24.13",
63
- "@applitools/spec-driver-playwright": "1.3.0",
64
- "@applitools/visual-grid-client": "15.8.60"
57
+ "@applitools/eyes-api": "1.5.0",
58
+ "@applitools/eyes-sdk-core": "13.6.25",
59
+ "@applitools/spec-driver-playwright": "1.3.1",
60
+ "@applitools/visual-grid-client": "15.12.36"
65
61
  },
66
62
  "devDependencies": {
67
- "@applitools/api-extractor": "1.2.6",
63
+ "@applitools/api-extractor": "1.2.8",
64
+ "@applitools/bongo": "^2.1.1",
68
65
  "@applitools/scripts": "1.1.0",
69
66
  "@applitools/sdk-coverage-tests": "2.3.18",
70
- "@applitools/sdk-release-kit": "0.13.10",
71
67
  "@applitools/sdk-shared": "0.9.11",
72
- "@applitools/test-utils": "1.0.10",
73
- "@types/mocha": "^9.0.0",
74
- "@typescript-eslint/eslint-plugin": "^4.15.1",
75
- "@typescript-eslint/parser": "^4.15.1",
76
- "eslint": "^7.9.0",
77
- "eslint-config-prettier": "^7.2.0",
68
+ "@applitools/test-utils": "1.3.2",
69
+ "@types/mocha": "^9.1.1",
70
+ "@types/node": "12",
71
+ "@typescript-eslint/eslint-plugin": "^5.27.0",
72
+ "@typescript-eslint/parser": "^5.27.0",
73
+ "eslint": "^8.16.0",
74
+ "eslint-config-prettier": "^8.5.0",
78
75
  "eslint-plugin-mocha-no-only": "^1.1.1",
79
76
  "eslint-plugin-node": "^11.1.0",
80
- "eslint-plugin-prettier": "^3.3.1",
77
+ "eslint-plugin-prettier": "^4.0.0",
81
78
  "husky": "^4.3.7",
82
- "mocha": "^8.0.1",
83
- "playwright": "^1.16.3",
84
- "prettier": "^2.1.2",
79
+ "mocha": "^10.0.0",
80
+ "playwright": "^1.22.2",
81
+ "prettier": "^2.6.2",
85
82
  "spec-xunit-file": "0.0.1-3",
86
83
  "ts-node": "^10.2.1",
87
84
  "ttypescript": "^1.5.12",
88
- "typescript": "^4.5.1-rc"
85
+ "typescript": "^4.7.2"
89
86
  },
90
87
  "peerDependencies": {
91
88
  "playwright": ">=1.0.0"
92
89
  },
93
90
  "engines": {
94
- "node": ">=8.9.0"
91
+ "node": ">=12.13.0"
95
92
  }
96
93
  }
package/types/index.d.ts CHANGED
@@ -142,6 +142,7 @@ export type ConfigurationPlain = {
142
142
  apiKey?: string;
143
143
  serverUrl?: string;
144
144
  proxy?: ProxySettingsPlain;
145
+ autProxy?: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
145
146
  isDisabled?: boolean;
146
147
  connectionTimeout?: number;
147
148
  removeSession?: boolean;
@@ -166,6 +167,7 @@ export type ConfigurationPlain = {
166
167
  baselineBranchName?: string;
167
168
  compareWithParentBranch?: boolean;
168
169
  ignoreBaseline?: boolean;
170
+ ignoreGitMergeBase?: boolean;
169
171
  saveFailedTests?: boolean;
170
172
  saveNewTests?: boolean;
171
173
  saveDiffs?: boolean;
@@ -251,6 +253,10 @@ export class Configuration implements Required<ConfigurationPlain> {
251
253
  setProxy(proxy: ProxySettingsPlain): Configuration;
252
254
  setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
253
255
  setProxy(isEnabled: false): Configuration;
256
+ get autProxy(): { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
257
+ set autProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; });
258
+ getAutProxy(): { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
259
+ setAutProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; }): Configuration;
254
260
  get connectionTimeout(): number;
255
261
  set connectionTimeout(connectionTimeout: number);
256
262
  getConnectionTimeout(): number;
@@ -298,6 +304,10 @@ export class Configuration implements Required<ConfigurationPlain> {
298
304
  set compareWithParentBranch(compareWithParentBranch: boolean);
299
305
  getCompareWithParentBranch(): boolean;
300
306
  setCompareWithParentBranch(compareWithParentBranch: boolean): Configuration;
307
+ get ignoreGitMergeBase(): boolean;
308
+ set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
309
+ getIgnoreGitMergeBase(): boolean;
310
+ setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): Configuration;
301
311
  get ignoreBaseline(): boolean;
302
312
  set ignoreBaseline(ignoreBaseline: boolean);
303
313
  getIgnoreBaseline(): boolean;
@@ -404,10 +414,10 @@ export class Configuration implements Required<ConfigurationPlain> {
404
414
  setConcurrentSessions(concurrentSessions: number): Configuration;
405
415
  get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>;
406
416
  set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>);
407
- getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>;
408
- setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
409
- addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
410
- addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }): Configuration;
417
+ getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>;
418
+ setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>): Configuration;
419
+ addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>): Configuration;
420
+ addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo): Configuration;
411
421
  addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
412
422
  addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
413
423
  get visualGridOptions(): { [key: string]: any; };
@@ -458,6 +468,7 @@ export type CheckSettingsPlain = {
458
468
  visualGridOptions?: { [key: string]: any; };
459
469
  hooks?: { beforeCaptureScreenshot: string; };
460
470
  renderId?: string;
471
+ pageId?: string;
461
472
  variationGroupId?: string;
462
473
  timeout?: number;
463
474
  waitBeforeCapture?: number;
@@ -537,6 +548,7 @@ export class CheckSettings {
537
548
  visualGridOption(key: string, value: any): CheckSettings;
538
549
  visualGridOptions(options: { [key: string]: any; }): CheckSettings;
539
550
  renderId(renderId: string): CheckSettings;
551
+ pageId(pageId: string): CheckSettings;
540
552
  variationGroupId(variationGroupId: string): CheckSettings;
541
553
  timeout(timeout: number): CheckSettings;
542
554
  waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
@@ -606,7 +618,7 @@ export enum CorsIframeHandle {
606
618
  KEEP = 'KEEP',
607
619
  SNAPSHOT = 'SNAPSHOT'
608
620
  }
609
- 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" | "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";
621
+ 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";
610
622
  export enum DeviceName {
611
623
  Blackberry_PlayBook = 'Blackberry PlayBook',
612
624
  BlackBerry_Z30 = 'BlackBerry Z30',
@@ -627,6 +639,8 @@ export enum DeviceName {
627
639
  Galaxy_S10 = 'Galaxy S10',
628
640
  Galaxy_S10_Plus = 'Galaxy S10 Plus',
629
641
  Galaxy_S20 = 'Galaxy S20',
642
+ Galaxy_S22 = 'Galaxy S22',
643
+ Galaxy_Tab_S7 = 'Galaxy Tab S7',
630
644
  iPad = 'iPad',
631
645
  iPad_6th_Gen = 'iPad 6th Gen',
632
646
  iPad_7th_Gen = 'iPad 7th Gen',
@@ -676,7 +690,7 @@ export enum FailureReport {
676
690
  IMMEDIATE = 'IMMEDIATE',
677
691
  ON_CLOSE = 'ON_CLOSE'
678
692
  }
679
- 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)";
693
+ 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)";
680
694
  export enum IosDeviceName {
681
695
  iPhone_13_Pro_Max = 'iPhone 13 Pro Max',
682
696
  iPhone_13_Pro = 'iPhone 13 Pro',
@@ -692,11 +706,14 @@ export enum IosDeviceName {
692
706
  iPhone_XS = 'iPhone Xs',
693
707
  iPhone_X = 'iPhone X',
694
708
  iPhone_8 = 'iPhone 8',
709
+ iPhone_8_Plus = 'iPhone 8 Plus',
695
710
  iPhone_7 = 'iPhone 7',
711
+ iPhone_SE = 'iPhone SE (1st generation)',
696
712
  iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)',
697
713
  iPad_7 = 'iPad (7th generation)',
698
714
  iPad_9 = 'iPad (9th generation)',
699
- iPad_Air_2 = 'iPad Air (2nd generation)'
715
+ iPad_Air_2 = 'iPad Air (2nd generation)',
716
+ iPad_Air_4 = 'iPad Air (4th generation)'
700
717
  }
701
718
  export type IosVersionPlain = "latest" | "latest-1";
702
719
  export enum IosVersion {
@@ -714,7 +731,7 @@ export enum MatchLevel {
714
731
  Strict = 'Strict',
715
732
  Exact = 'Exact'
716
733
  }
717
- export type ScreenOrientationPlain = "portrait" | "landscape";
734
+ export type ScreenOrientationPlain = "landscape" | "portrait";
718
735
  export enum ScreenOrientation {
719
736
  PORTRAIT = 'portrait',
720
737
  LANDSCAPE = 'landscape'
@@ -724,7 +741,7 @@ export enum SessionType {
724
741
  SEQUENTIAL = 'SEQUENTIAL',
725
742
  PROGRESSION = 'PROGRESSION'
726
743
  }
727
- export type StitchModePlain = "Scroll" | "CSS";
744
+ export type StitchModePlain = "CSS" | "Scroll";
728
745
  export enum StitchMode {
729
746
  SCROLL = 'Scroll',
730
747
  CSS = 'CSS'
@@ -810,7 +827,8 @@ export class BatchInfo implements Required<BatchInfoPlain> {
810
827
  set properties(properties: Array<PropertyDataPlain>);
811
828
  getProperties(): Array<PropertyData>;
812
829
  setProperties(properties: Array<PropertyDataPlain>): BatchInfo;
813
- addProperty(property: PropertyDataPlain): BatchInfo;
830
+ addProperty(name: string, value: string): BatchInfo;
831
+ addProperty(prop: PropertyDataPlain): BatchInfo;
814
832
  }
815
833
  export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
816
834
  export class CutProvider implements Required<{
@@ -911,8 +929,8 @@ export type ImageMatchSettingsPlain = {
911
929
  layoutRegions?: Array<RegionPlain>;
912
930
  strictRegions?: Array<RegionPlain>;
913
931
  contentRegions?: Array<RegionPlain>;
914
- floatingRegions?: Array<FloatingMatchSettingsPlain | RegionPlain>;
915
- accessibilityRegions?: Array<AccessibilityMatchSettingsPlain | RegionPlain>;
932
+ floatingRegions?: Array<RegionPlain | FloatingMatchSettingsPlain>;
933
+ accessibilityRegions?: Array<RegionPlain | AccessibilityMatchSettingsPlain>;
916
934
  accessibilitySettings?: AccessibilitySettings;
917
935
  };
918
936
  export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
@@ -963,16 +981,16 @@ export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
963
981
  set content(content: Array<RegionPlain>);
964
982
  getContentRegions(): Array<Region>;
965
983
  setContentRegions(contentRegions: Array<RegionPlain>): void;
966
- get floatingRegions(): Array<FloatingMatchSettingsPlain | RegionPlain>;
967
- set floatingRegions(floatingRegions: Array<FloatingMatchSettingsPlain | RegionPlain>);
968
- get floating(): Array<FloatingMatchSettingsPlain | RegionPlain>;
969
- set floating(floating: Array<FloatingMatchSettingsPlain | RegionPlain>);
984
+ get floatingRegions(): Array<RegionPlain | FloatingMatchSettingsPlain>;
985
+ set floatingRegions(floatingRegions: Array<RegionPlain | FloatingMatchSettingsPlain>);
986
+ get floating(): Array<RegionPlain | FloatingMatchSettingsPlain>;
987
+ set floating(floating: Array<RegionPlain | FloatingMatchSettingsPlain>);
970
988
  getFloatingRegions(): Array<FloatingMatchSettings>;
971
989
  setFloatingRegions(floatingRegions: Array<FloatingMatchSettingsPlain>): void;
972
- get accessibilityRegions(): Array<AccessibilityMatchSettingsPlain | RegionPlain>;
973
- set accessibilityRegions(accessibilityRegions: Array<AccessibilityMatchSettingsPlain | RegionPlain>);
974
- get accessibility(): Array<AccessibilityMatchSettingsPlain | RegionPlain>;
975
- set accessibility(accessibility: Array<AccessibilityMatchSettingsPlain | RegionPlain>);
990
+ get accessibilityRegions(): Array<RegionPlain | AccessibilityMatchSettingsPlain>;
991
+ set accessibilityRegions(accessibilityRegions: Array<RegionPlain | AccessibilityMatchSettingsPlain>);
992
+ get accessibility(): Array<RegionPlain | AccessibilityMatchSettingsPlain>;
993
+ set accessibility(accessibility: Array<RegionPlain | AccessibilityMatchSettingsPlain>);
976
994
  getAccessibilityRegions(): Array<AccessibilityMatchSettings>;
977
995
  setAccessibilityRegions(accessibilityRegions: Array<AccessibilityMatchSettingsPlain>): void;
978
996
  get accessibilitySettings(): AccessibilitySettings;
@@ -1001,7 +1019,7 @@ export class Location implements Required<LocationPlain> {
1001
1019
  getY(): number;
1002
1020
  setY(y: number): void;
1003
1021
  }
1004
- export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
1022
+ export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
1005
1023
  export type CustomLogHandlerPlain = {
1006
1024
  log(message: any): void;
1007
1025
  warn?(message: any): void;
@@ -1335,15 +1353,71 @@ export class TestResults implements Required<TestResultsPlain> {
1335
1353
  delete(): Promise<void>;
1336
1354
  deleteSession(): Promise<void>;
1337
1355
  }
1338
- export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; };
1356
+ export type TestResultContainerPlain = { readonly exception?: Error; readonly testResults?: {
1357
+ readonly id?: string;
1358
+ readonly name?: string;
1359
+ readonly secretToken?: string;
1360
+ readonly status?: "Passed" | "Failed" | "Unresolved";
1361
+ readonly appName?: string;
1362
+ readonly batchId?: string;
1363
+ readonly batchName?: string;
1364
+ readonly branchName?: string;
1365
+ readonly hostOS?: string;
1366
+ readonly hostApp?: string;
1367
+ readonly hostDisplaySize?: { width: number; height: number; };
1368
+ readonly accessibilityStatus?: { readonly level: "AA" | "AAA"; readonly version: "WCAG_2_0" | "WCAG_2_1"; readonly status: "Passed" | "Failed"; };
1369
+ readonly startedAt?: string | Date;
1370
+ readonly duration?: number;
1371
+ readonly isNew?: boolean;
1372
+ readonly isDifferent?: boolean;
1373
+ readonly isAborted?: boolean;
1374
+ readonly appUrls?: { readonly batch?: string; readonly session?: string; };
1375
+ readonly apiUrls?: { readonly batch?: string; readonly session?: string; };
1376
+ readonly stepsInfo?: Array<{
1377
+ readonly name?: string;
1378
+ readonly isDifferent?: boolean;
1379
+ readonly hasBaselineImage?: boolean;
1380
+ readonly hasCurrentImage?: boolean;
1381
+ readonly appUrls?: { readonly step?: string; readonly stepEditor?: string; };
1382
+ readonly apiUrls?: {
1383
+ readonly baselineImage?: string;
1384
+ readonly currentImage?: string;
1385
+ readonly checkpointImage?: string;
1386
+ readonly checkpointImageThumbnail?: string;
1387
+ readonly diffImage?: string;
1388
+ };
1389
+ readonly renderId?: Array<string>;
1390
+ }>;
1391
+ readonly steps?: number;
1392
+ readonly matches?: number;
1393
+ readonly mismatches?: number;
1394
+ readonly missing?: number;
1395
+ readonly exactMatches?: number;
1396
+ readonly strictMatches?: number;
1397
+ readonly contentMatches?: number;
1398
+ readonly layoutMatches?: number;
1399
+ readonly noneMatches?: number;
1400
+ readonly url?: string;
1401
+ }; 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"; }; }; };
1339
1402
  export class TestResultContainer implements Required<TestResultContainerPlain> {
1340
1403
  get testResults(): TestResultsPlain;
1341
1404
  getTestResults(): TestResults;
1342
1405
  get exception(): Error;
1343
1406
  getException(): Error;
1407
+ 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"; }; };
1408
+ 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"; }; };
1344
1409
  }
1345
- export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
1346
- export class TestResultsSummary implements TestResultsSummaryPlain {
1410
+ export type TestResultsSummaryPlain = {
1411
+ results: Array<TestResultContainerPlain>;
1412
+ passed: number;
1413
+ unresolved: number;
1414
+ failed: number;
1415
+ exceptions: number;
1416
+ mismatches: number;
1417
+ missing: number;
1418
+ matches: number;
1419
+ };
1420
+ export class TestResultsSummary implements Iterable<TestResultContainerPlain> {
1347
1421
  getAllResults(): Array<TestResultContainer>;
1348
1422
  [Symbol.iterator](): Iterator<TestResultContainer, any, undefined>;
1349
1423
  }
@@ -1379,7 +1453,8 @@ export class Logger {
1379
1453
  fatal(...messages: Array<any>): void;
1380
1454
  open(): void;
1381
1455
  close(): void;
1382
- extend(label?: string, color?: string | Array<string>): Logger;
1456
+ tag(name: string, value: any): void;
1457
+ extend(label?: string): Logger;
1383
1458
  }
1384
1459
  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>;
1385
1460
  export abstract class EyesRunner {