@applitools/eyes-selenium 4.56.2 → 4.57.0

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 ## Unreleased
 
 
+## 4.57.0 - 2021/11/5
+
+- updated to @applitools/eyes-api@1.1.5 (from 1.1.4)
+- updated to @applitools/eyes-sdk-core@12.23.24 (from 12.23.18)
+- updated to @applitools/visual-grid-client@15.8.43 (from 15.8.37)
+
+## 4.56.5 - 2021/10/20
+
+- updated to @applitools/eyes-sdk-core@12.23.18 (from 12.23.15)
+- updated to @applitools/spec-driver-selenium@1.1.1 (from 1.1.0)
+- updated to @applitools/visual-grid-client@15.8.37 (from 15.8.34)
+
+## 4.56.4 - 2021/10/12
+
+- move spec driver implementation to the separate package
+- updated to @applitools/eyes-api@1.1.4 (from 1.1.3)
+- updated to @applitools/eyes-sdk-core@12.23.15 (from 12.23.14)
+- updated to @applitools/spec-driver-selenium@1.0.2 (from 1.0.1)
+- updated to @applitools/visual-grid-client@15.8.34 (from 15.8.33)
+- updated to @applitools/spec-driver-selenium@1.1.0 (from 1.0.2)
+
+## 4.56.3 - 2021/10/7
+
+- updated to @applitools/eyes-api@1.1.3 (from 1.1.1)
+- updated to @applitools/eyes-sdk-core@12.23.14 (from 12.23.6)
+- updated to @applitools/visual-grid-client@15.8.33 (from 15.8.26)
+
 ## 4.56.2 - 2021/9/13
 
 - updated to @applitools/eyes-sdk-core@12.23.0 (from 12.22.6)

package/dist/api.js

@@ -25,7 +25,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchClose = exports.Target = exports.CheckSettings = exports.Configuration = exports.Eyes = void 0;
 const eyes_sdk_core_1 = require("@applitools/eyes-sdk-core");
 const api = __importStar(require("@applitools/eyes-api"));
-const spec = __importStar(require("./spec-driver"));
+const spec = __importStar(require("@applitools/spec-driver-selenium"));
 const sdk = (0, eyes_sdk_core_1.makeSDK)({
     name: 'eyes.selenium',
     version: `${require('../package.json').version}--${process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION}`,

package/dist/index.js

@@ -10,9 +10,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-if (!process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION) {
-    const { version } = require('selenium-webdriver/package.json');
-    const [major] = version.split('.', 1);
-    process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION = major;
-}
 __exportStar(require("./api"), exports);

package/dist/spec-driver.js

@@ -6,347 +6,8 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapDriver = exports.build = exports.performAction = exports.getElementText = exports.getElementAttribute = exports.getElementRegion = exports.getOrientation = exports.waitUntilDisplayed = exports.scrollIntoView = exports.type = exports.hover = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.getDriverInfo = exports.setWindowSize = exports.getWindowSize = exports.findElements = exports.findElement = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.transformSelector = exports.transformDriver = exports.isSelector = exports.isElement = exports.isDriver = void 0;
-const utils = __importStar(require("@applitools/utils"));
-const legacy = __importStar(require("./legacy"));
-const byHash = ['className', 'css', 'id', 'js', 'linkText', 'name', 'partialLinkText', 'tagName', 'xpath'];
-function extractElementId(element) {
-    return element.getId();
-}
-function isDriver(driver) {
-    return utils.types.instanceOf(driver, 'WebDriver');
-}
-exports.isDriver = isDriver;
-function isElement(element) {
-    return utils.types.instanceOf(element, 'WebElement');
-}
-exports.isElement = isElement;
-function isSelector(selector) {
-    if (!selector)
-        return false;
-    return utils.types.has(selector, ['using', 'value']) || byHash.includes(Object.keys(selector)[0]);
-}
-exports.isSelector = isSelector;
-function transformDriver(driver) {
-    driver.getExecutor().defineCommand('getSessionDetails', 'GET', '/session/:sessionId');
-    driver.getExecutor().defineCommand('getOrientation', 'GET', '/session/:sessionId/orientation');
-    driver.getExecutor().defineCommand('getSystemBars', 'GET', '/session/:sessionId/appium/device/system_bars');
-    driver.getExecutor().defineCommand('performTouch', 'POST', '/session/:sessionId/touch/perform');
-    if (process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3') {
-        driver.getExecutor().defineCommand('switchToParentFrame', 'POST', '/session/:sessionId/frame/parent');
-    }
-    return driver;
-}
-exports.transformDriver = transformDriver;
-function transformSelector(selector) {
-    if (utils.types.isString(selector)) {
-        return { css: selector };
-    }
-    else if (utils.types.has(selector, 'selector')) {
-        if (!utils.types.isString(selector.selector))
-            return selector.selector;
-        if (!utils.types.has(selector, 'type'))
-            return { css: selector.selector };
-        if (selector.type === 'css')
-            return { css: selector.selector };
-        else
-            return { using: selector.type, value: selector.selector };
-    }
-    return selector;
-}
-exports.transformSelector = transformSelector;
-function isStaleElementError(error) {
-    if (!error)
-        return false;
-    error = error.originalError || error;
-    return error instanceof Error && error.name === 'StaleElementReferenceError';
-}
-exports.isStaleElementError = isStaleElementError;
-async function isEqualElements(_driver, element1, element2) {
-    if (!element1 || !element2)
-        return false;
-    const elementId1 = await extractElementId(element1);
-    const elementId2 = await extractElementId(element2);
-    return elementId1 === elementId2;
-}
-exports.isEqualElements = isEqualElements;
-async function executeScript(driver, script, arg) {
-    return driver.executeScript(script, arg);
-}
-exports.executeScript = executeScript;
-async function mainContext(driver) {
-    await driver.switchTo().defaultContent();
-    return driver;
-}
-exports.mainContext = mainContext;
-async function parentContext(driver) {
-    if (process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3') {
-        const { Command } = require('selenium-webdriver/lib/command');
-        await driver.schedule(new Command('switchToParentFrame'));
-        return driver;
-    }
-    await driver.switchTo().parentFrame();
-    return driver;
-}
-exports.parentContext = parentContext;
-async function childContext(driver, element) {
-    await driver.switchTo().frame(element);
-    return driver;
-}
-exports.childContext = childContext;
-async function findElement(driver, selector, parent) {
-    try {
-        const root = parent !== null && parent !== void 0 ? parent : driver;
-        return await root.findElement(selector);
-    }
-    catch (err) {
-        if (err.name === 'NoSuchElementError')
-            return null;
-        else
-            throw err;
-    }
-}
-exports.findElement = findElement;
-async function findElements(driver, selector, parent) {
-    const root = parent !== null && parent !== void 0 ? parent : driver;
-    return root.findElements(selector);
-}
-exports.findElements = findElements;
-async function getWindowSize(driver) {
-    try {
-        const window = driver.manage().window();
-        if (utils.types.isFunction(window.getSize)) {
-            return await window.getSize();
-        }
-        else if (utils.types.isFunction(window.getRect)) {
-            const rect = await window.getRect();
-            return { width: rect.width, height: rect.height };
-        }
-    }
-    catch (err) {
-        const cmd = require('selenium-webdriver/lib/command');
-        return driver.execute(new cmd.Command(cmd.Name.GET_WINDOW_SIZE).setParameter('windowHandle', 'current'));
-    }
-}
-exports.getWindowSize = getWindowSize;
-async function setWindowSize(driver, size) {
-    const window = driver.manage().window();
-    if (utils.types.isFunction(window.setRect)) {
-        await window.setRect({ x: 0, y: 0, width: size.width, height: size.height });
-    }
-    else {
-        await window.setPosition(0, 0);
-        await window.setSize(size.width, size.height);
-    }
-}
-exports.setWindowSize = setWindowSize;
-async function getDriverInfo(driver) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-    const session = await driver.getSession();
-    const capabilities = await driver.getCapabilities();
-    const desiredCapabilities = (_a = capabilities.get('desired')) !== null && _a !== void 0 ? _a : {};
-    const platformName = (_c = (_b = capabilities.get('platformName')) !== null && _b !== void 0 ? _b : capabilities.get('platform')) !== null && _c !== void 0 ? _c : desiredCapabilities.platformName;
-    const isMobile = ['android', 'ios'].includes(platformName === null || platformName === void 0 ? void 0 : platformName.toLowerCase());
-    const info = {
-        sessionId: session.getId(),
-        isMobile,
-        isNative: isMobile && !capabilities.get('browserName'),
-        deviceName: (_d = desiredCapabilities.deviceName) !== null && _d !== void 0 ? _d : capabilities.get('deviceName'),
-        platformName,
-        platformVersion: capabilities.get('platformVersion'),
-        browserName: (_e = capabilities.get('browserName')) !== null && _e !== void 0 ? _e : desiredCapabilities.browserName,
-        browserVersion: (_f = capabilities.get('browserVersion')) !== null && _f !== void 0 ? _f : capabilities.get('version'),
-    };
-    if (info.isNative) {
-        const { Command } = require('selenium-webdriver/lib/command');
-        let details;
-        if (capabilities.has('viewportRect') && capabilities.has('pixelRatio') && capabilities.has('statBarHeight')) {
-            details = {
-                viewportRect: capabilities.get('viewportRect'),
-                pixelRatio: capabilities.get('pixelRatio'),
-                statBarHeight: capabilities.get('statBarHeight'),
-            };
-        }
-        else {
-            const getSessionDetailsCommand = new Command('getSessionDetails');
-            details =
-                process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3'
-                    ? await driver.schedule(getSessionDetailsCommand)
-                    : await driver.execute(getSessionDetailsCommand);
-        }
-        info.pixelRatio = details.pixelRatio;
-        try {
-            const getSystemBars = new Command('getSystemBars');
-            const { statusBar, navigationBar } = process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3'
-                ? await driver.schedule(getSystemBars)
-                : await driver.execute(getSystemBars);
-            info.statusBarHeight = statusBar.visible ? statusBar.height : 0;
-            info.navigationBarHeight = navigationBar.visible ? navigationBar.height : 0;
-        }
-        catch (err) {
-            info.statusBarHeight = (_j = (_g = details.statBarHeight) !== null && _g !== void 0 ? _g : (_h = details.viewportRect) === null || _h === void 0 ? void 0 : _h.top) !== null && _j !== void 0 ? _j : 0;
-            info.navigationBarHeight = 0;
-        }
-    }
-    return info;
-}
-exports.getDriverInfo = getDriverInfo;
-async function getTitle(driver) {
-    return driver.getTitle();
-}
-exports.getTitle = getTitle;
-async function getUrl(driver) {
-    return driver.getCurrentUrl();
-}
-exports.getUrl = getUrl;
-async function visit(driver, url) {
-    await driver.get(url);
-}
-exports.visit = visit;
-async function takeScreenshot(driver) {
-    return driver.takeScreenshot();
-}
-exports.takeScreenshot = takeScreenshot;
-async function click(driver, element) {
-    if (isSelector(element))
-        element = await findElement(driver, element);
-    await element.click();
-}
-exports.click = click;
-async function hover(driver, element) {
-    if (isSelector(element))
-        element = await findElement(driver, element);
-    if (process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3') {
-        const { ActionSequence } = require('selenium-webdriver');
-        const action = new ActionSequence(driver);
-        await action.mouseMove(element).perform();
-    }
-    else {
-        await driver.actions().move({ origin: element }).perform();
-    }
-}
-exports.hover = hover;
-async function type(driver, element, keys) {
-    if (isSelector(element))
-        element = await findElement(driver, element);
-    await element.sendKeys(keys);
-}
-exports.type = type;
-async function scrollIntoView(driver, element, align = false) {
-    if (isSelector(element))
-        element = await findElement(driver, element);
-    await driver.executeScript('arguments[0].scrollIntoView(arguments[1])', element, align);
-}
-exports.scrollIntoView = scrollIntoView;
-async function waitUntilDisplayed(driver, selector, timeout) {
-    const { until } = require('selenium-webdriver');
-    const element = await findElement(driver, selector);
-    await driver.wait(until.elementIsVisible(element), timeout);
-}
-exports.waitUntilDisplayed = waitUntilDisplayed;
-async function getOrientation(driver) {
-    const { Command } = require('selenium-webdriver/lib/command');
-    const getOrientationCommand = new Command('getOrientation');
-    const orientation = process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3'
-        ? await driver.schedule(getOrientationCommand)
-        : await driver.execute(getOrientationCommand);
-    return orientation.toLowerCase();
-}
-exports.getOrientation = getOrientation;
-async function getElementRegion(_driver, element) {
-    return element.getRect();
-}
-exports.getElementRegion = getElementRegion;
-async function getElementAttribute(_driver, element, attr) {
-    return element.getAttribute(attr);
-}
-exports.getElementAttribute = getElementAttribute;
-async function getElementText(_driver, element) {
-    return element.getText();
-}
-exports.getElementText = getElementText;
-async function performAction(driver, steps) {
-    const { Command } = require('selenium-webdriver/lib/command');
-    const performTouchCommand = new Command('performTouch').setParameters({
-        actions: steps.map((_a) => {
-            var { action } = _a, options = __rest(_a, ["action"]);
-            return ({ action, options });
-        }),
-    });
-    if (process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3') {
-        await driver.schedule(performTouchCommand);
-    }
-    else {
-        await driver.execute(performTouchCommand);
-    }
-}
-exports.performAction = performAction;
-const browserOptionsNames = {
-    chrome: 'goog:chromeOptions',
-    firefox: 'moz:firefoxOptions',
-};
-async function build(env) {
-    var _a;
-    const { Builder } = require('selenium-webdriver');
-    const parseEnv = require('@applitools/test-utils/src/parse-env');
-    const { browser, capabilities, url, attach, proxy, configurable = true, appium = false, args = [], headless, } = parseEnv(Object.assign(Object.assign({}, env), { legacy: (_a = env.legacy) !== null && _a !== void 0 ? _a : process.env.APPLITOOLS_SELENIUM_MAJOR_VERSION === '3' }));
-    const desiredCapabilities = Object.assign({}, capabilities);
-    if (configurable) {
-        const browserOptionsName = browserOptionsNames[browser || desiredCapabilities.browserName];
-        if (browserOptionsName) {
-            const browserOptions = desiredCapabilities[browserOptionsName] || {};
-            browserOptions.args = [...(browserOptions.args || []), ...args];
-            if (headless)
-                browserOptions.args.push('headless');
-            if (attach) {
-                browserOptions.debuggerAddress = attach === true ? 'localhost:9222' : attach;
-                if (browser !== 'firefox')
-                    browserOptions.w3c = false;
-            }
-            desiredCapabilities[browserOptionsName] = browserOptions;
-        }
-    }
-    if (appium && browser === 'chrome') {
-        desiredCapabilities['appium:chromeOptions'] = { w3c: false };
-    }
-    const builder = new Builder().withCapabilities(desiredCapabilities);
-    if (url && !attach)
-        builder.usingServer(url.href);
-    if (proxy) {
-        builder.setProxy({
-            proxyType: 'manual',
-            httpProxy: proxy.http || proxy.server,
-            sslProxy: proxy.https || proxy.server,
-            ftpProxy: proxy.ftp,
-            noProxy: proxy.bypass,
-        });
-    }
-    const driver = await builder.build();
-    return [driver, () => driver.quit()];
-}
-exports.build = build;
-exports.wrapDriver = legacy.wrapDriver;
+__exportStar(require("@applitools/spec-driver-selenium"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-selenium",
-  "version": "4.56.2",
+  "version": "4.57.0",
   "description": "Applitools Eyes SDK for Selenium WebDriver",
   "keywords": [
     "eyes-selenium",
@@ -23,7 +23,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/applitools/eyes.sdk.javascript1.git"
+    "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
+    "directory": "packages/eyes-selenium"
   },
   "license": "SEE LICENSE IN LICENSE",
   "author": {
@@ -42,21 +43,19 @@
     "types"
   ],
   "scripts": {
-    "lint": "eslint '**/*.ts' '**/*.js'",
+    "lint": "eslint '**/*.ts'",
     "build": "yarn build:dist && yarn build:types",
-    "doc": "typedoc ./types/index.d.ts --theme minimal --tsconfig ./tsconfig.doc.json",
     "build:dist": "tsc",
     "build:types": "api-extractor ./src/index.ts --out ./types/index.d.ts --external-modules selenium-webdriver",
     "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/master/js/config.js --name 'eyes-selenium'",
-    "test": "yarn build:dist && yarn test:it && yarn test:coverage",
-    "test:it": "mocha --no-timeouts './test/it/**/*.spec.js'",
+    "test": "yarn test:coverage",
     "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-selenium' APPLITOOLS_BATCH_ID=$(uuidgen) XUNIT_FILE=coverage-test-report.xml mocha --config .mocharc.cvg.js",
     "report": "coverage-tests report https://raw.githubusercontent.com/applitools/sdk.coverage.tests/master/js/config.js --name 'eyes-selenium'",
     "setup": "yarn docker:setup",
     "docker:setup": "node ../scripts/scripts/generate-docker-compose-config.js && docker-compose up -d",
     "docker:teardown": "docker-compose down",
     "deps": "bongo deps",
-    "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='selenium selenium@3' -f links='eyes-sdk-core eyes-api types test-utils utils driver snippets screenshoter sdk-shared visual-grid-client' -f linking-depth=3",
+    "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",
@@ -68,18 +67,18 @@
     }
   },
   "dependencies": {
-    "@applitools/eyes-api": "1.1.1",
-    "@applitools/eyes-sdk-core": "12.23.6",
-    "@applitools/utils": "1.2.3",
-    "@applitools/visual-grid-client": "15.8.26"
+    "@applitools/eyes-api": "1.1.5",
+    "@applitools/eyes-sdk-core": "12.23.24",
+    "@applitools/spec-driver-selenium": "1.1.1",
+    "@applitools/visual-grid-client": "15.8.43"
   },
   "devDependencies": {
     "@applitools/api-extractor": "1.1.3",
     "@applitools/scripts": "1.0.1",
     "@applitools/sdk-coverage-tests": "2.3.15",
-    "@applitools/sdk-release-kit": "0.13.3",
-    "@applitools/sdk-shared": "0.9.6",
-    "@applitools/test-utils": "1.0.7",
+    "@applitools/sdk-release-kit": "0.13.4",
+    "@applitools/sdk-shared": "0.9.7",
+    "@applitools/test-utils": "1.0.9",
     "@types/selenium-webdriver": "^4.0.11",
     "@typescript-eslint/eslint-plugin": "^4.15.1",
     "@typescript-eslint/parser": "^4.15.1",
@@ -90,10 +89,9 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.3.1",
     "husky": "^4.3.8",
-    "mocha": "^8.0.1",
-    "ncp": "^2.0.0",
+    "mocha": "^9.1.2",
     "prettier": "^2.1.2",
-    "selenium-webdriver": "^4.0.0-beta.4",
+    "selenium-webdriver": "^4.0.0-rc-2",
     "spec-xunit-file": "0.0.1-3",
     "typescript": "^4.1.3"
   },

package/types/index.d.ts

@@ -120,6 +120,7 @@ export enum FailureReport {
 
 export enum IosDeviceName {
   iPad_7 = 'iPad (7th generation)',
+  iPad_9 = 'iPad (9th generation)',
   iPad_Air_2 = 'iPad Air (2nd generation)',
   iPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)',
   iPhone_11 = 'iPhone 11',
@@ -129,6 +130,9 @@ export enum IosDeviceName {
   iPhone_12_Pro = 'iPhone 12 Pro',
   iPhone_12_Pro_Max = 'iPhone 12 Pro Max',
   iPhone_12_mini = 'iPhone 12 mini',
+  iPhone_13 = 'iPhone 13',
+  iPhone_13_Pro = 'iPhone 13 Pro',
+  iPhone_13_Pro_Max = 'iPhone 13 Pro Max',
   iPhone_7 = 'iPhone 7',
   iPhone_8 = 'iPhone 8',
   iPhone_X = 'iPhone X',
@@ -243,7 +247,7 @@ export class BatchClose {
   setBatchIds(batchIds: string[]): this;
   setProxy(proxy: ProxySettingsPlain): this;
   setUrl(serverUrl: string): this;
-  static close(options: {
+  static close(settings: {
     batchIds: string[];
     serverUrl?: string;
     apiKey?: string;
@@ -292,24 +296,27 @@ export class CheckSettings {
   accessibilityRegion(region: RegionPlain, type?: AccessibilityRegionTypePlain): this;
   accessibilityRegion(region: Element, type?: AccessibilityRegionTypePlain): this;
   accessibilityRegion(region: EyesSelector<Selector>, type?: AccessibilityRegionTypePlain): this;
+  accessibilityRegion(region: LegacyRegionPlain, type?: AccessibilityRegionTypePlain): this;
   accessibilityRegions(
     ...regions: (
       | {region: RegionPlain | Element | EyesSelector<Selector>; type?: AccessibilityRegionTypePlain}
       | RegionPlain
       | Element
       | EyesSelector<Selector>
+      | LegacyRegionPlain
     )[]
   ): this;
   accessibilityRegions(
     type: AccessibilityRegionTypePlain,
-    ...regions: (RegionPlain | Element | EyesSelector<Selector>)[]
+    ...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]
   ): this;
   beforeRenderScreenshotHook(script: string): this;
   content(): this;
   contentRegion(region: RegionPlain): this;
   contentRegion(region: Element): this;
   contentRegion(region: EyesSelector<Selector>): this;
-  contentRegions(...regions: (RegionPlain | Element | EyesSelector<Selector>)[]): this;
+  contentRegion(region: LegacyRegionPlain): this;
+  contentRegions(...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]): this;
   disableBrowserFetching(disableBrowserFetching: boolean): this;
   enablePatterns(enablePatterns?: boolean): this;
   exact(): this;
@@ -327,6 +334,8 @@ export class CheckSettings {
   floating(region: Element): this;
   /** @deprecated */
   floating(region: EyesSelector<Selector>): this;
+  /** @deprecated */
+  floating(region: LegacyRegionPlain): this;
   floatingRegion(region: {
     region: RegionPlain | Element | EyesSelector<Selector>;
     maxUpOffset?: number;
@@ -355,6 +364,13 @@ export class CheckSettings {
     maxLeftOffset?: number,
     maxRightOffset?: number,
   ): this;
+  floatingRegion(
+    region: LegacyRegionPlain,
+    maxUpOffset?: number,
+    maxDownOffset?: number,
+    maxLeftOffset?: number,
+    maxRightOffset?: number,
+  ): this;
   floatingRegions(
     ...regions: (
       | {
@@ -367,9 +383,13 @@ export class CheckSettings {
       | RegionPlain
       | Element
       | EyesSelector<Selector>
+      | LegacyRegionPlain
     )[]
   ): this;
-  floatingRegions(maxOffset: number, ...regions: (RegionPlain | Element | EyesSelector<Selector>)[]): this;
+  floatingRegions(
+    maxOffset: number,
+    ...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]
+  ): this;
   /** @deprecated */
   floatings(
     ...regions: (
@@ -383,10 +403,14 @@ export class CheckSettings {
       | RegionPlain
       | Element
       | EyesSelector<Selector>
+      | LegacyRegionPlain
     )[]
   ): this;
   /** @deprecated */
-  floatings(maxOffset: number, ...regions: (RegionPlain | Element | EyesSelector<Selector>)[]): this;
+  floatings(
+    maxOffset: number,
+    ...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]
+  ): this;
   frame(context: {
     frame: Element | EyesSelector<Selector> | string | number;
     scrollRootElement?: Element | EyesSelector<Selector>;
@@ -402,32 +426,37 @@ export class CheckSettings {
   fully(fully?: boolean): this;
   hook(name: string, script: string): this;
   /** @deprecated */
-  ignore(ignoreRegion: RegionPlain): this;
+  ignore(region: RegionPlain): this;
+  /** @deprecated */
+  ignore(region: Element): this;
   /** @deprecated */
-  ignore(ignoreRegion: Element): this;
+  ignore(region: EyesSelector<Selector>): this;
   /** @deprecated */
-  ignore(ignoreRegion: EyesSelector<Selector>): this;
+  ignore(region: LegacyRegionPlain): this;
   ignoreCaret(ignoreCaret?: boolean): this;
   ignoreDisplacements(ignoreDisplacements?: boolean): this;
-  ignoreRegion(ignoreRegion: RegionPlain): this;
-  ignoreRegion(ignoreRegion: Element): this;
-  ignoreRegion(ignoreRegion: EyesSelector<Selector>): this;
-  ignoreRegions(...ignoreRegions: (RegionPlain | Element | EyesSelector<Selector>)[]): this;
+  ignoreRegion(region: RegionPlain): this;
+  ignoreRegion(region: Element): this;
+  ignoreRegion(region: EyesSelector<Selector>): this;
+  ignoreRegion(region: LegacyRegionPlain): this;
+  ignoreRegions(...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]): this;
   /** @deprecated */
-  ignores(...ignoreRegions: (RegionPlain | Element | EyesSelector<Selector>)[]): this;
+  ignores(...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]): this;
   layout(): this;
   layoutBreakpoints(layoutBreakpoints?: boolean): this;
   layoutBreakpoints(layoutBreakpoints?: number[]): this;
-  layoutRegion(layoutRegion: RegionPlain): this;
-  layoutRegion(layoutRegion: Element): this;
-  layoutRegion(layoutRegion: EyesSelector<Selector>): this;
-  layoutRegions(...layoutRegions: (RegionPlain | Element | EyesSelector<Selector>)[]): this;
+  layoutRegion(region: RegionPlain): this;
+  layoutRegion(region: Element): this;
+  layoutRegion(region: EyesSelector<Selector>): this;
+  layoutRegion(region: LegacyRegionPlain): this;
+  layoutRegions(...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]): this;
   matchLevel(matchLevel: MatchLevelPlain): this;
   /** @undocumented */
   name(name: string): this;
   region(region: RegionPlain): this;
   region(region: Element): this;
   region(region: EyesSelector<Selector>): this;
+  region(region: LegacyRegionPlain): this;
   renderId(renderId: string): this;
   scrollRootElement(scrollRootElement: Element): this;
   scrollRootElement(scrollRootElement: EyesSelector<Selector>): this;
@@ -436,15 +465,17 @@ export class CheckSettings {
   /** @deprecated */
   stitchContent(stitchContent?: boolean): this;
   strict(): this;
-  strictRegion(strictRegion: RegionPlain): this;
-  strictRegion(strictRegion: Element): this;
-  strictRegion(strictRegion: EyesSelector<Selector>): this;
-  strictRegions(...regions: (RegionPlain | Element | EyesSelector<Selector>)[]): this;
+  strictRegion(region: RegionPlain): this;
+  strictRegion(region: Element): this;
+  strictRegion(region: EyesSelector<Selector>): this;
+  strictRegion(region: LegacyRegionPlain): this;
+  strictRegions(...regions: (RegionPlain | Element | EyesSelector<Selector> | LegacyRegionPlain)[]): this;
   timeout(timeout: number): this;
   useDom(useDom?: boolean): this;
   variationGroupId(variationGroupId: string): this;
   visualGridOption(key: string, value: any): this;
   visualGridOptions(options: {[key: string]: any}): this;
+  waitBeforeCapture(waitBeforeCapture: number): this;
   /** @deprecated */
   webHook(script: string): this;
   withName(name: string): this;
@@ -568,6 +599,8 @@ export class Configuration {
   set viewportSize(viewportSize: RectangleSizePlain);
   get visualGridOptions(): {[key: string]: any};
   set visualGridOptions(visualGridOptions: {[key: string]: any});
+  get waitBeforeCapture(): number;
+  set waitBeforeCapture(waitBeforeCapture: number);
   get waitBeforeScreenshots(): number;
   set waitBeforeScreenshots(waitBeforeScreenshots: number);
   addBrowser(browserInfo: DesktopBrowserInfo): this;
@@ -661,6 +694,7 @@ export class Configuration {
   getUseDom(): boolean;
   getViewportSize(): RectangleSize;
   getVisualGridOptions(): {[key: string]: any};
+  getWaitBeforeCapture(): number;
   getWaitBeforeScreenshots(): number;
   setAccessibilityValidation(accessibilityValidation: AccessibilitySettings): this;
   setAgentId(agentId: string): this;
@@ -744,6 +778,7 @@ export class Configuration {
   setViewportSize(viewportSize: RectangleSizePlain): this;
   setVisualGridOption(key: string, value: any): this;
   setVisualGridOptions(visualGridOptions: {[key: string]: any}): this;
+  setWaitBeforeCapture(waitBeforeCapture: number): this;
   setWaitBeforeScreenshots(waitBeforeScreenshots: number): this;
 }
 
@@ -1433,6 +1468,7 @@ export class TestResults implements Required<TestResultsPlain> {
   get hostApp(): string;
   get hostDisplaySize(): RectangleSizePlain;
   get hostOS(): string;
+  get id(): string;
   get isAborted(): boolean;
   get isDifferent(): boolean;
   get isNew(): boolean;
@@ -1448,7 +1484,6 @@ export class TestResults implements Required<TestResultsPlain> {
   get steps(): number;
   get stepsInfo(): StepInfoPlain[];
   get strictMatches(): number;
-  get testId(): string;
   get url(): string;
   delete(): Promise<void>;
   /** @deprecated */
@@ -1690,6 +1725,7 @@ export type CheckSettingsPlain = {
   renderId?: string;
   variationGroupId?: string;
   timeout?: number;
+  waitBeforeCapture?: number;
 };
 
 export type ChromeEmulationInfo = {
@@ -1742,12 +1778,14 @@ export type ConfigurationPlain = {
   cut?: CutProviderPlain;
   rotation?: ImageRotationPlain;
   scaleRatio?: number;
+  waitBeforeCapture?: number;
 } & {
   /** @undocumented */ concurrentSessions?: number;
   browsersInfo?: (DesktopBrowserInfo | ChromeEmulationInfo | IOSDeviceInfo)[];
   visualGridOptions?: Record<string, any>;
   layoutBreakpoints?: boolean | number[];
   disableBrowserFetching?: boolean;
+  waitBeforeCapture?: number;
 };
 
 export type ConsoleLogHandlerPlain = {type: 'console'};
@@ -1845,7 +1883,7 @@ export type ExactMatchSettingsPlain = {
   minDiffWidth: number;
 };
 
-export type EyesSelector<TSelector> =
+export type EyesSelector<TSelector = never> =
   | TSelector
   | string
   | {frame?: EyesSelector<TSelector>; selector: TSelector | string; shadow?: EyesSelector<TSelector>; type?: string};
@@ -1892,6 +1930,7 @@ export type ImageRotationPlain = -270 | -180 | -90 | 0 | 90 | 180 | 270;
 
 export type IosDeviceNamePlain =
   | 'iPad (7th generation)'
+  | 'iPad (9th generation)'
   | 'iPad Air (2nd generation)'
   | 'iPad Pro (12.9-inch) (3rd generation)'
   | 'iPhone 11'
@@ -1901,6 +1940,9 @@ export type IosDeviceNamePlain =
   | 'iPhone 12 Pro'
   | 'iPhone 12 Pro Max'
   | 'iPhone 12 mini'
+  | 'iPhone 13'
+  | 'iPhone 13 Pro'
+  | 'iPhone 13 Pro Max'
   | 'iPhone 7'
   | 'iPhone 8'
   | 'iPhone X'
@@ -1909,6 +1951,9 @@ export type IosDeviceNamePlain =
 
 export type IosVersionPlain = 'latest' | 'latest-1';
 
+/** @deprecated */
+export type LegacyRegionPlain = {height: number; left: number; top: number; width: number};
+
 export type LocationPlain = {x: number; y: number};
 
 export type LogHandlerPlain = CustomLogHandlerPlain | FileLogHandlerPlain | ConsoleLogHandlerPlain;
@@ -1983,6 +2028,7 @@ export type TestResultsPlain = {
   readonly hostApp?: string;
   readonly hostDisplaySize?: RectangleSizePlain;
   readonly hostOS?: string;
+  readonly id?: string;
   readonly isAborted?: boolean;
   readonly isDifferent?: boolean;
   readonly isNew?: boolean;
@@ -1998,7 +2044,6 @@ export type TestResultsPlain = {
   readonly steps?: number;
   readonly stepsInfo?: StepInfoPlain[];
   readonly strictMatches?: number;
-  readonly testId?: string;
   readonly url?: string;
 };
 
@@ -2021,6 +2066,7 @@ export const Target: {
   region(region: RegionPlain): CheckSettings;
   region(region: Element): CheckSettings;
   region(region: EyesSelector<Selector>): CheckSettings;
+  region(region: LegacyRegionPlain): CheckSettings;
   frame(context: {
     frame: Element | EyesSelector<Selector> | string | number;
     scrollRootElement?: Element | EyesSelector<Selector>;
@@ -2041,9 +2087,6 @@ export function RunnerOptions(): RunnerOptionsFluent;
 
 export function closeBatch(spec: {
   closeBatches(options: {
-    batchIds: string[];
-    serverUrl?: string;
-    apiKey?: string;
-    proxy?: ProxySettingsPlain;
+    settings: {batchIds: string[]; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain};
   }): Promise<void>;
 }): {(options: {batchIds: string[]; serverUrl?: string; apiKey?: string; proxy?: ProxySettingsPlain}): Promise<void>};

package/dist/legacy.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapDriver = void 0;
-function wrapDriver(driver) {
-    const api = {
-        get remoteWebDriver() {
-            return driver;
-        },
-        getRemoteWebDriver() {
-            return driver;
-        },
-        async findElementById(id) {
-            return driver.findElement({ id });
-        },
-        async findElementsById(id) {
-            return driver.findElements({ id });
-        },
-        async findElementByName(name) {
-            return driver.findElement({ name });
-        },
-        async findElementsByName(name) {
-            return driver.findElements({ name });
-        },
-        async findElementByCssSelector(css) {
-            return driver.findElement({ css });
-        },
-        async findElementsByCssSelector(css) {
-            return driver.findElements({ css });
-        },
-        async findElementByClassName(className) {
-            throw driver.findElement({ className });
-        },
-        async findElementsByClassName(className) {
-            throw driver.findElements({ className });
-        },
-        async findElementByLinkText(linkText) {
-            throw driver.findElement({ linkText });
-        },
-        async findElementsByLinkText(linkText) {
-            throw driver.findElements({ linkText });
-        },
-        async findElementByPartialLinkText(partialLinkText) {
-            throw driver.findElement({ partialLinkText });
-        },
-        async findElementsByPartialLinkText(partialLinkText) {
-            throw driver.findElements({ partialLinkText });
-        },
-        async findElementByTagName(tagName) {
-            return driver.findElement({ tagName });
-        },
-        async findElementsByTagName(tagName) {
-            return driver.findElements({ tagName });
-        },
-        async findElementByXPath(xpath) {
-            return driver.findElement({ xpath });
-        },
-        async findElementsByXPath(xpath) {
-            return driver.findElements({ xpath });
-        },
-        async getBrowserName() {
-            const capabilities = await driver.getCapabilities();
-            return capabilities.getBrowserName();
-        },
-        async getBrowserVersion() {
-            const capabilities = await driver.getCapabilities();
-            return capabilities.getBrowserVersion();
-        },
-    };
-    return new Proxy(driver, {
-        get(target, key, receiver) {
-            if (Object.hasOwnProperty.call(api, key)) {
-                return Reflect.get(api, key, receiver);
-            }
-            return Reflect.get(target, key);
-        },
-    });
-}
-exports.wrapDriver = wrapDriver;