@applitools/eyes-selenium 4.58.3 → 4.59.0

package/CHANGELOG.md

@@ -3,6 +3,43 @@
 ## Unreleased
 
 
+
+
+
+## 4.59.0 - 2022/6/1
+
+### Features
+- Dorp support for Node.js versions <=12
+### Bug fixes
+- Fixed incorrect calculation of coded regions in classic mode when using CSS stitching
+
+## 4.58.5 - 2022/5/27
+
+### Features
+- Support iPhone SE `IosDeviceName.iPhone_SE` and iPhone 8 Plus `IosDeviceName.iPhone_8_Plus` iOS devices
+- Support Galaxy S22 `DeviceName.Galaxy_S22` emulation device
+- Added support for drivers that return screenshots in jpeg format
+### Bug fixes
+- Fixed check region fully in classic execution when using CSS stitching
+- Fixed handling of navigation bar size on various devices
+- Fixed bug in native apps when screenshot of the element was taken only for the small visible part of the element
+- Fixed bug when navigation bar was presented in screenshot on Android 12
+- Fixed `CheckSetting`'s `fully` being overridden by `Configuration`'s `forceFullPageScreenshot`
+- Set EyesExceptions (such as new test, diffs exception and failed test exception) to exception property in TestResultsSummary
+- Improve error message when failed to set viewport size
+
+## 4.58.4 - 2022/4/14
+
+### Features
+- Support UFG for native mobile
+- `runner.getAllTestResults` returns the corresponding UFG browser/device configuration for each test. This is available as `runner.getAllTestResults()[i].browserInfo`.
+### Bug fixes
+- `extractText` now supports regions that don't use hints while using `x`/`y` coordinates
+- accept ios and android lowercase as driver platformName capability when using custom grid
+- when running on a native iOS app, allow capturing NavigationBar and TabBar regions
+- When running a native app on Android, in case we test a device in landscape mode, make sure to account for the navigation bar on the left or right and not at the bottom of the image. Also account for an Appium bug when calculating system bars height.
+- Support data urls in iframes
+
 ## 4.58.3 - 2022/1/12
 
 - fix bugs

package/README.md

@@ -36,6 +36,7 @@
   * [Purpose of runners](#purpose-of-runners)
     + [1. Use the Ultrafast grid](#1-use-the-ultra-fast-grid)
     + [2. Manage tests across multiple `Eyes` instances](#2-manage-tests-across-multiple-eyes-instances)
+- [Visual locators](#visual-locators)
 - [Recipes for common tasks](#recipes-for-common-tasks)
   * [Configure Server URL](#configure-server-url)
   * [Configure Proxy](#configure-proxy)
@@ -536,6 +537,62 @@ concurrent sessions ???
 add browsers
 -->
 
+## Visual locators
+
+Information about what are visual locators and how to use them can be found in the documentation page [here](https://applitools.com/docs/features/visual-locators.html).
+
+The API to locate a visual locator in Eyes-Selenium has the following TypeScript signature:
+
+```ts
+// Note: This is a formal TypeScript definition.
+// The reason we use the generic type TLocator here is that is shows how the return value of eyes.locate is an object
+// with the same keys as the array of locatorNames in the input to eyes.locate.
+// We explain this in more detail in the example below.
+
+interface Eyes {
+  locate<TLocator extends string>(settings: VisualLocatorSettings<TLocator>): Promise<Record<TLocator, Array<Region>>>
+}
+
+interface VisualLocatorSettings<TLocator extends string> {
+  locatorNames: Array<TLocator>;
+  firstOnly: boolean;
+}
+
+interface Region {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+```
+
+Here is an example for using this API:
+
+```js
+// first need to call eyes.open
+await eyes.open(driver, 'Test app', 'Test visual locators')
+
+// example for using eyes.locate
+const regionsMap = await eyes.locate({
+  locatorNames: ['locator_a', 'locator_b', 'locator_c'],
+})
+
+// now get the coordinates of one of the locators
+const regionsForLocator_A = regionsMap['locator_a']
+
+// if region is found, perform press at the middle
+if (regionsForLocator_A && regionsForLocator_A.length > 0) {
+  const region = regionsForLocator_A[0]
+  const clickLocation = {
+    x: region.left + region.width / 2,
+    y: region.top + region.height / 2,
+  }
+  await driver.actions({ bridge: true }).move(clickLocation).click().perform()
+}
+```
+
+### 
+
 ## Recipes for common tasks
 
 ### Configure Server URL

package/dist/api.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/spec-driver.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-selenium",
-  "version": "4.58.3",
+  "version": "4.59.0",
   "description": "Applitools Eyes SDK for Selenium WebDriver",
   "keywords": [
     "eyes-selenium",
@@ -33,11 +33,6 @@
   },
   "main": "./dist/index.js",
   "types": "./types/index.d.ts",
-  "directories": {
-    "lib": "./lib",
-    "example": "./example",
-    "test": "./test"
-  },
   "files": [
     "dist",
     "types"
@@ -55,9 +50,9 @@
     "upgrade:framework": "if [ ! -z $APPLITOOLS_SELENIUM_MAJOR_VERSION ]; then packagejson=`cat package.json`; yarn upgrade --no-lockfile selenium-webdriver@$APPLITOOLS_SELENIUM_MAJOR_VERSION; echo \"$packagejson\" > package.json; fi",
     "deps": "bongo deps",
     "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='selenium selenium@3' -f links='types test-utils sdk-shared eyes-sdk-core visual-grid-client eyes-api spec-driver-selenium utils driver snippets screenshoter' -f linking-depth=3",
-    "gh:publish": "gh workflow run publish.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='selenium'",
-    "preversion": "bongo preversion && yarn build",
-    "version": "bongo version",
+    "gh:publish": "gh workflow run publish-selenium.yml --ref $(git rev-parse --abbrev-ref HEAD)",
+    "preversion": "bongo preversion --verifyPendingChanges && yarn build",
+    "version": "bongo version --withPendingChanges",
     "postversion": "bongo postversion"
   },
   "husky": {
@@ -66,39 +61,40 @@
     }
   },
   "dependencies": {
-    "@applitools/eyes-api": "1.1.6",
-    "@applitools/eyes-sdk-core": "12.24.13",
-    "@applitools/spec-driver-selenium": "1.3.3",
-    "@applitools/visual-grid-client": "15.8.60"
+    "@applitools/eyes-api": "1.5.0",
+    "@applitools/eyes-sdk-core": "13.6.25",
+    "@applitools/spec-driver-selenium": "1.3.7",
+    "@applitools/visual-grid-client": "15.12.36"
   },
   "devDependencies": {
-    "@applitools/api-extractor": "1.2.6",
+    "@applitools/api-extractor": "1.2.8",
+    "@applitools/bongo": "^2.1.1",
     "@applitools/scripts": "1.1.0",
     "@applitools/sdk-coverage-tests": "2.3.18",
-    "@applitools/sdk-release-kit": "0.13.10",
     "@applitools/sdk-shared": "0.9.11",
-    "@applitools/test-utils": "1.0.10",
-    "@types/selenium-webdriver": "^4.0.11",
-    "@typescript-eslint/eslint-plugin": "^4.15.1",
-    "@typescript-eslint/parser": "^4.15.1",
+    "@applitools/test-utils": "1.3.2",
+    "@types/node": "12",
+    "@types/selenium-webdriver": "^4.1.1",
+    "@typescript-eslint/eslint-plugin": "^5.27.0",
+    "@typescript-eslint/parser": "^5.27.0",
     "chromedriver": "^87.0.4",
-    "eslint": "^7.9.0",
-    "eslint-config-prettier": "^7.2.0",
+    "eslint": "^8.16.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-mocha-no-only": "^1.1.1",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-prettier": "^4.0.0",
     "husky": "^4.3.8",
-    "mocha": "^9.1.2",
-    "prettier": "^2.1.2",
-    "selenium-webdriver": "^4.1.1",
+    "mocha": "^10.0.0",
+    "prettier": "^2.6.2",
+    "selenium-webdriver": "^4.2.0",
     "spec-xunit-file": "0.0.1-3",
-    "ttypescript": "^1.5.12",
-    "typescript": "^4.5.4"
+    "ttypescript": "^1.5.13",
+    "typescript": "^4.7.2"
   },
   "peerDependencies": {
     "selenium-webdriver": ">=3.6.0"
   },
   "engines": {
-    "node": ">=8.9.0"
+    "node": ">=12.13.0"
   }
 }

package/types/index.d.ts

@@ -142,6 +142,7 @@ export type ConfigurationPlain = {
     apiKey?: string;
     serverUrl?: string;
     proxy?: ProxySettingsPlain;
+    autProxy?: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
     isDisabled?: boolean;
     connectionTimeout?: number;
     removeSession?: boolean;
@@ -166,6 +167,7 @@ export type ConfigurationPlain = {
     baselineBranchName?: string;
     compareWithParentBranch?: boolean;
     ignoreBaseline?: boolean;
+    ignoreGitMergeBase?: boolean;
     saveFailedTests?: boolean;
     saveNewTests?: boolean;
     saveDiffs?: boolean;
@@ -251,6 +253,10 @@ export class Configuration implements Required<ConfigurationPlain> {
     setProxy(proxy: ProxySettingsPlain): Configuration;
     setProxy(url: string, username?: string, password?: string, isHttpOnly?: boolean): Configuration;
     setProxy(isEnabled: false): Configuration;
+    get autProxy(): { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
+    set autProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; });
+    getAutProxy(): { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; };
+    setAutProxy(autProxy: { proxy: { url: string; username?: string; password?: string; isHttpOnly?: boolean; }; domains?: Array<string>; AUTProxyMode?: "Allow" | "Block"; }): Configuration;
     get connectionTimeout(): number;
     set connectionTimeout(connectionTimeout: number);
     getConnectionTimeout(): number;
@@ -298,6 +304,10 @@ export class Configuration implements Required<ConfigurationPlain> {
     set compareWithParentBranch(compareWithParentBranch: boolean);
     getCompareWithParentBranch(): boolean;
     setCompareWithParentBranch(compareWithParentBranch: boolean): Configuration;
+    get ignoreGitMergeBase(): boolean;
+    set ignoreGitMergeBase(ignoreGitMergeBase: boolean);
+    getIgnoreGitMergeBase(): boolean;
+    setIgnoreGitMergeBase(ignoreGitMergeBase: boolean): Configuration;
     get ignoreBaseline(): boolean;
     set ignoreBaseline(ignoreBaseline: boolean);
     getIgnoreBaseline(): boolean;
@@ -404,10 +414,10 @@ export class Configuration implements Required<ConfigurationPlain> {
     setConcurrentSessions(concurrentSessions: number): Configuration;
     get browsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>;
     set browsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo>);
-    getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>;
-    setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
-    addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }>): Configuration;
-    addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; }): Configuration;
+    getBrowsersInfo(): Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>;
+    setBrowsersInfo(browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>): Configuration;
+    addBrowsers(...browsersInfo: Array<DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo>): Configuration;
+    addBrowser(browserInfo: DesktopBrowserInfo | ChromeEmulationInfo | { deviceName: DeviceNamePlain; screenOrientation?: ScreenOrientationPlain; } | IOSDeviceInfo): Configuration;
     addBrowser(width: number, height: number, name?: BrowserTypePlain): Configuration;
     addDeviceEmulation(deviceName: DeviceNamePlain, screenOrientation?: ScreenOrientationPlain): Configuration;
     get visualGridOptions(): { [key: string]: any; };
@@ -458,6 +468,7 @@ export type CheckSettingsPlain = {
     visualGridOptions?: { [key: string]: any; };
     hooks?: { beforeCaptureScreenshot: string; };
     renderId?: string;
+    pageId?: string;
     variationGroupId?: string;
     timeout?: number;
     waitBeforeCapture?: number;
@@ -537,6 +548,7 @@ export class CheckSettings {
     visualGridOption(key: string, value: any): CheckSettings;
     visualGridOptions(options: { [key: string]: any; }): CheckSettings;
     renderId(renderId: string): CheckSettings;
+    pageId(pageId: string): CheckSettings;
     variationGroupId(variationGroupId: string): CheckSettings;
     timeout(timeout: number): CheckSettings;
     waitBeforeCapture(waitBeforeCapture: number): CheckSettings;
@@ -606,7 +618,7 @@ export enum CorsIframeHandle {
     KEEP = 'KEEP',
     SNAPSHOT = 'SNAPSHOT'
 }
-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";
+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";
 export enum DeviceName {
     Blackberry_PlayBook = 'Blackberry PlayBook',
     BlackBerry_Z30 = 'BlackBerry Z30',
@@ -627,6 +639,8 @@ export enum DeviceName {
     Galaxy_S10 = 'Galaxy S10',
     Galaxy_S10_Plus = 'Galaxy S10 Plus',
     Galaxy_S20 = 'Galaxy S20',
+    Galaxy_S22 = 'Galaxy S22',
+    Galaxy_Tab_S7 = 'Galaxy Tab S7',
     iPad = 'iPad',
     iPad_6th_Gen = 'iPad 6th Gen',
     iPad_7th_Gen = 'iPad 7th Gen',
@@ -676,7 +690,7 @@ export enum FailureReport {
     IMMEDIATE = 'IMMEDIATE',
     ON_CLOSE = 'ON_CLOSE'
 }
-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)";
+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)";
 export enum IosDeviceName {
     iPhone_13_Pro_Max = 'iPhone 13 Pro Max',
     iPhone_13_Pro = 'iPhone 13 Pro',
@@ -692,11 +706,14 @@ export enum IosDeviceName {
     iPhone_XS = 'iPhone Xs',
     iPhone_X = 'iPhone X',
     iPhone_8 = 'iPhone 8',
+    iPhone_8_Plus = 'iPhone 8 Plus',
     iPhone_7 = 'iPhone 7',
+    iPhone_SE = 'iPhone SE (1st generation)',
     iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)',
     iPad_7 = 'iPad (7th generation)',
     iPad_9 = 'iPad (9th generation)',
-    iPad_Air_2 = 'iPad Air (2nd generation)'
+    iPad_Air_2 = 'iPad Air (2nd generation)',
+    iPad_Air_4 = 'iPad Air (4th generation)'
 }
 export type IosVersionPlain = "latest" | "latest-1";
 export enum IosVersion {
@@ -724,7 +741,7 @@ export enum SessionType {
     SEQUENTIAL = 'SEQUENTIAL',
     PROGRESSION = 'PROGRESSION'
 }
-export type StitchModePlain = "Scroll" | "CSS";
+export type StitchModePlain = "CSS" | "Scroll";
 export enum StitchMode {
     SCROLL = 'Scroll',
     CSS = 'CSS'
@@ -810,7 +827,8 @@ export class BatchInfo implements Required<BatchInfoPlain> {
     set properties(properties: Array<PropertyDataPlain>);
     getProperties(): Array<PropertyData>;
     setProperties(properties: Array<PropertyDataPlain>): BatchInfo;
-    addProperty(property: PropertyDataPlain): BatchInfo;
+    addProperty(name: string, value: string): BatchInfo;
+    addProperty(prop: PropertyDataPlain): BatchInfo;
 }
 export type CutProviderPlain = { top: number; right: number; bottom: number; left: number; } | { x: number; y: number; width: number; height: number; };
 export class CutProvider implements Required<{
@@ -911,8 +929,8 @@ export type ImageMatchSettingsPlain = {
     layoutRegions?: Array<RegionPlain>;
     strictRegions?: Array<RegionPlain>;
     contentRegions?: Array<RegionPlain>;
-    floatingRegions?: Array<FloatingMatchSettingsPlain | RegionPlain>;
-    accessibilityRegions?: Array<AccessibilityMatchSettingsPlain | RegionPlain>;
+    floatingRegions?: Array<RegionPlain | FloatingMatchSettingsPlain>;
+    accessibilityRegions?: Array<RegionPlain | AccessibilityMatchSettingsPlain>;
     accessibilitySettings?: AccessibilitySettings;
 };
 export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
@@ -963,16 +981,16 @@ export class ImageMatchSettings implements Required<ImageMatchSettingsPlain> {
     set content(content: Array<RegionPlain>);
     getContentRegions(): Array<Region>;
     setContentRegions(contentRegions: Array<RegionPlain>): void;
-    get floatingRegions(): Array<FloatingMatchSettingsPlain | RegionPlain>;
-    set floatingRegions(floatingRegions: Array<FloatingMatchSettingsPlain | RegionPlain>);
-    get floating(): Array<FloatingMatchSettingsPlain | RegionPlain>;
-    set floating(floating: Array<FloatingMatchSettingsPlain | RegionPlain>);
+    get floatingRegions(): Array<RegionPlain | FloatingMatchSettingsPlain>;
+    set floatingRegions(floatingRegions: Array<RegionPlain | FloatingMatchSettingsPlain>);
+    get floating(): Array<RegionPlain | FloatingMatchSettingsPlain>;
+    set floating(floating: Array<RegionPlain | FloatingMatchSettingsPlain>);
     getFloatingRegions(): Array<FloatingMatchSettings>;
     setFloatingRegions(floatingRegions: Array<FloatingMatchSettingsPlain>): void;
-    get accessibilityRegions(): Array<AccessibilityMatchSettingsPlain | RegionPlain>;
-    set accessibilityRegions(accessibilityRegions: Array<AccessibilityMatchSettingsPlain | RegionPlain>);
-    get accessibility(): Array<AccessibilityMatchSettingsPlain | RegionPlain>;
-    set accessibility(accessibility: Array<AccessibilityMatchSettingsPlain | RegionPlain>);
+    get accessibilityRegions(): Array<RegionPlain | AccessibilityMatchSettingsPlain>;
+    set accessibilityRegions(accessibilityRegions: Array<RegionPlain | AccessibilityMatchSettingsPlain>);
+    get accessibility(): Array<RegionPlain | AccessibilityMatchSettingsPlain>;
+    set accessibility(accessibility: Array<RegionPlain | AccessibilityMatchSettingsPlain>);
     getAccessibilityRegions(): Array<AccessibilityMatchSettings>;
     setAccessibilityRegions(accessibilityRegions: Array<AccessibilityMatchSettingsPlain>): void;
     get accessibilitySettings(): AccessibilitySettings;
@@ -1001,7 +1019,7 @@ export class Location implements Required<LocationPlain> {
     getY(): number;
     setY(y: number): void;
 }
-export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
+export type LogHandlerPlain = CustomLogHandlerPlain | ConsoleLogHandlerPlain | FileLogHandlerPlain;
 export type CustomLogHandlerPlain = {
     log(message: any): void;
     warn?(message: any): void;
@@ -1335,15 +1353,71 @@ export class TestResults implements Required<TestResultsPlain> {
     delete(): Promise<void>;
     deleteSession(): Promise<void>;
 }
-export type TestResultContainerPlain = { readonly exception: Error; readonly testResults: TestResultsPlain; };
+export type TestResultContainerPlain = { readonly exception?: Error; readonly testResults?: {
+    readonly id?: string;
+    readonly name?: string;
+    readonly secretToken?: string;
+    readonly status?: "Passed" | "Failed" | "Unresolved";
+    readonly appName?: string;
+    readonly batchId?: string;
+    readonly batchName?: string;
+    readonly branchName?: string;
+    readonly hostOS?: string;
+    readonly hostApp?: string;
+    readonly hostDisplaySize?: { width: number; height: number; };
+    readonly accessibilityStatus?: { readonly level: "AA" | "AAA"; readonly version: "WCAG_2_0" | "WCAG_2_1"; readonly status: "Passed" | "Failed"; };
+    readonly startedAt?: string | Date;
+    readonly duration?: number;
+    readonly isNew?: boolean;
+    readonly isDifferent?: boolean;
+    readonly isAborted?: boolean;
+    readonly appUrls?: { readonly batch?: string; readonly session?: string; };
+    readonly apiUrls?: { readonly batch?: string; readonly session?: string; };
+    readonly stepsInfo?: Array<{
+        readonly name?: string;
+        readonly isDifferent?: boolean;
+        readonly hasBaselineImage?: boolean;
+        readonly hasCurrentImage?: boolean;
+        readonly appUrls?: { readonly step?: string; readonly stepEditor?: string; };
+        readonly apiUrls?: {
+            readonly baselineImage?: string;
+            readonly currentImage?: string;
+            readonly checkpointImage?: string;
+            readonly checkpointImageThumbnail?: string;
+            readonly diffImage?: string;
+        };
+        readonly renderId?: Array<string>;
+    }>;
+    readonly steps?: number;
+    readonly matches?: number;
+    readonly mismatches?: number;
+    readonly missing?: number;
+    readonly exactMatches?: number;
+    readonly strictMatches?: number;
+    readonly contentMatches?: number;
+    readonly layoutMatches?: number;
+    readonly noneMatches?: number;
+    readonly url?: string;
+}; 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?: "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 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?: "portrait" | "landscape"; }; }; };
 export class TestResultContainer implements Required<TestResultContainerPlain> {
     get testResults(): TestResultsPlain;
     getTestResults(): TestResults;
     get exception(): Error;
     getException(): Error;
+    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?: "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 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?: "portrait" | "landscape"; }; };
+    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?: "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 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?: "portrait" | "landscape"; }; };
 }
-export type TestResultsSummaryPlain = Iterable<TestResultContainerPlain>;
-export class TestResultsSummary implements TestResultsSummaryPlain {
+export type TestResultsSummaryPlain = {
+    results: Array<TestResultContainerPlain>;
+    passed: number;
+    unresolved: number;
+    failed: number;
+    exceptions: number;
+    mismatches: number;
+    missing: number;
+    matches: number;
+};
+export class TestResultsSummary implements Iterable<TestResultContainerPlain> {
     getAllResults(): Array<TestResultContainer>;
     [Symbol.iterator](): Iterator<TestResultContainer, any, undefined>;
 }
@@ -1379,7 +1453,8 @@ export class Logger {
     fatal(...messages: Array<any>): void;
     open(): void;
     close(): void;
-    extend(label?: string, color?: string | Array<string>): Logger;
+    tag(name: string, value: any): void;
+    extend(label?: string): Logger;
 }
 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>;
 export abstract class EyesRunner {