@applitools/spec-driver-webdriver 1.0.41 → 1.0.42

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## [1.0.42](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-webdriver@1.0.41...js/spec-driver-webdriver@1.0.42) (2023-08-18)
+
+
+### Code Refactoring
+
+* refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.5.1
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+* @applitools/logger bumped to 2.0.8
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+* @applitools/snippets bumped to 2.4.23
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+* @applitools/driver bumped to 1.13.5
+  #### Bug Fixes
+
+  * optimize driver usage in close ([#1867](https://github.com/applitools/eyes.sdk.javascript1/issues/1867)) ([60dff6b](https://github.com/applitools/eyes.sdk.javascript1/commit/60dff6b160e69d3893c91a1125d668fa18b43072))
+
+
+  #### Code Refactoring
+
+  * refactored spec driver interface ([#1839](https://github.com/applitools/eyes.sdk.javascript1/issues/1839)) ([aa49ec2](https://github.com/applitools/eyes.sdk.javascript1/commit/aa49ec2a7d14b8529acc3a8a4c2baecfa113d98a))
+
+
+
+
 ## [1.0.41](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-webdriver@1.0.40...js/spec-driver-webdriver@1.0.41) (2023-08-03)
 
 

package/dist/spec-driver.js

@@ -26,15 +26,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.build = exports.switchWorld = exports.getWorlds = exports.getCurrentWorld = exports.performAction = exports.getElementAttribute = exports.getElementRegion = exports.setOrientation = exports.getOrientation = exports.getSystemBars = exports.hover = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.getDriverInfo = exports.getCapabilities = exports.getCookies = exports.setWindowSize = exports.getWindowSize = exports.getElementText = exports.setElementText = exports.findElements = exports.findElement = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.extractHostName = exports.untransformSelector = exports.transformSelector = exports.transformElement = exports.transformDriver = exports.isSelector = exports.isShadowRoot = exports.isElement = exports.isDriver = void 0;
+exports.build = exports.switchWorld = exports.getWorlds = exports.getCurrentWorld = exports.takeScreenshot = exports.performAction = exports.visit = exports.getUrl = exports.getTitle = exports.getCookies = exports.getSystemBars = exports.setOrientation = exports.getOrientation = exports.setViewportSize = exports.setWindowSize = exports.getWindowSize = exports.getCapabilities = exports.getDriverInfo = exports.childContext = exports.parentContext = exports.mainContext = exports.click = exports.hover = exports.getElementText = exports.setElementText = exports.getElementAttribute = exports.getElementRegion = exports.findElements = exports.findElement = exports.executeScript = exports.toSimpleCommonSelector = exports.toSelector = exports.toElement = exports.toDriver = exports.isStaleElementError = exports.isEqualElements = exports.isSelector = exports.isShadowRoot = exports.isSecondaryElement = exports.isElement = exports.isSecondaryDriver = exports.isDriver = void 0;
 const url_1 = require("url");
-const utils = __importStar(require("@applitools/utils"));
-const webdriver_1 = __importStar(require("webdriver"));
 const http_proxy_agent_1 = __importDefault(require("http-proxy-agent"));
 const https_proxy_agent_1 = __importDefault(require("https-proxy-agent"));
 const http_1 = __importDefault(require("http"));
 const https_1 = __importDefault(require("https"));
-// #region HELPERS
+const utils = __importStar(require("@applitools/utils"));
 const LEGACY_ELEMENT_ID = 'ELEMENT';
 const ELEMENT_ID = 'element-6066-11e4-a52e-4f735466cecf';
 const SHADOW_ROOT_ID = 'shadow-6066-11e4-a52e-4f735466cecf';
@@ -76,25 +74,78 @@ function extractEnvironment(capabilities) {
         isW3C,
     };
 }
-// #endregion
-// #region UTILITY
+function command(method, url, body) {
+    if (getFrameworkMajorVersion() < 8) {
+        let commandPath;
+        try {
+            commandPath = require.resolve('webdriver/build/command', { paths: [`${process.cwd()}/node_modules`] });
+        }
+        catch {
+            commandPath = 'webdriver/build/command';
+        }
+        const { default: command } = require(commandPath);
+        return command(method, url, body);
+    }
+    else {
+        let frameworkPath;
+        try {
+            frameworkPath = require.resolve('webdriver', { paths: [`${process.cwd()}/node_modules`] });
+        }
+        catch {
+            frameworkPath = 'webdriver';
+        }
+        const { command } = require(frameworkPath);
+        return command(method, url, body);
+    }
+}
+function getFrameworkMajorVersion() {
+    let version;
+    try {
+        version = require(require.resolve('webdriver/package.json', { paths: [`${process.cwd()}/node_modules`] })).version;
+    }
+    catch {
+        version = require('webdriver/package.json').version;
+    }
+    return Number.parseInt(version);
+}
+function getWebDriver() {
+    let frameworkPath;
+    try {
+        frameworkPath = require.resolve('webdriver', { paths: [`${process.cwd()}/node_modules`] });
+    }
+    catch {
+        frameworkPath = 'webdriver';
+    }
+    return getFrameworkMajorVersion() < 8 ? require(frameworkPath).default : require(frameworkPath);
+}
 function isDriver(driver) {
     if (!driver)
         return false;
-    return utils.types.has(driver, ['sessionId', 'serverUrl']) || utils.types.instanceOf(driver, 'Browser');
+    return utils.types.instanceOf(driver, 'Browser');
 }
 exports.isDriver = isDriver;
+function isSecondaryDriver(driver) {
+    if (!driver)
+        return false;
+    return utils.types.has(driver, ['sessionId', 'serverUrl']);
+}
+exports.isSecondaryDriver = isSecondaryDriver;
 function isElement(element) {
-    var _a;
     if (!element)
         return false;
-    return Boolean((_a = element.elementId) !== null && _a !== void 0 ? _a : extractElementId(element));
+    return !!extractElementId(element);
 }
 exports.isElement = isElement;
+function isSecondaryElement(element) {
+    if (!element)
+        return false;
+    return !!element.elementId;
+}
+exports.isSecondaryElement = isSecondaryElement;
 function isShadowRoot(shadowRoot) {
     if (!shadowRoot)
         return false;
-    return Boolean(extractShadowRootId(shadowRoot));
+    return !!extractShadowRootId(shadowRoot);
 }
 exports.isShadowRoot = isShadowRoot;
 function isSelector(selector) {
@@ -103,7 +154,22 @@ function isSelector(selector) {
     return utils.types.has(selector, ['using', 'value']);
 }
 exports.isSelector = isSelector;
-function transformDriver(driver) {
+function isEqualElements(_driver, element1, element2) {
+    if (!element1 || !element2)
+        return false;
+    const elementId1 = extractElementId(element1);
+    const elementId2 = extractElementId(element2);
+    return elementId1 === elementId2;
+}
+exports.isEqualElements = isEqualElements;
+function isStaleElementError(error) {
+    if (!error)
+        return false;
+    const errOrResult = error.originalError || error;
+    return errOrResult instanceof Error && errOrResult.name === 'stale element reference';
+}
+exports.isStaleElementError = isStaleElementError;
+function toDriver(driver) {
     var _a, _b, _c;
     if (!utils.types.has(driver, ['sessionId', 'serverUrl']))
         return driver;
@@ -119,6 +185,12 @@ function transformDriver(driver) {
         logLevel: 'silent',
         ...environment,
     };
+    if (!options.port) {
+        if (options.protocol === 'http')
+            options.port = 80;
+        if (options.protocol === 'https')
+            options.port = 443;
+    }
     if ((_a = driver.proxy) === null || _a === void 0 ? void 0 : _a.url) {
         const proxyUrl = new URL(driver.proxy.url);
         proxyUrl.username = (_b = driver.proxy.username) !== null && _b !== void 0 ? _b : proxyUrl.username;
@@ -136,15 +208,10 @@ function transformDriver(driver) {
         const httpsAgent = new https_1.default.Agent({ rejectUnauthorized: false });
         options.agent = { http: httpAgent, https: httpsAgent };
     }
-    if (!options.port) {
-        if (options.protocol === 'http')
-            options.port = 80;
-        if (options.protocol === 'https')
-            options.port = 443;
-    }
-    const additionalCommands = {
+    const WebDriver = getWebDriver();
+    const attachedDriver = WebDriver.attachToSession(options, undefined, {
         _getWindowSize: {
-            value: (0, webdriver_1.command)('GET', '/session/:sessionId/window/current/size', {
+            value: command('GET', '/session/:sessionId/window/current/size', {
                 command: '_getWindowSize',
                 description: '',
                 ref: '',
@@ -152,7 +219,7 @@ function transformDriver(driver) {
             }),
         },
         _setWindowSize: {
-            value: (0, webdriver_1.command)('POST', '/session/:sessionId/window/current/size', {
+            value: command('POST', '/session/:sessionId/window/current/size', {
                 command: '_setWindowSize',
                 parameters: [
                     { name: 'width', type: 'number', required: true, description: '' },
@@ -163,7 +230,7 @@ function transformDriver(driver) {
             }),
         },
         setWindowPosition: {
-            value: (0, webdriver_1.command)('POST', '/session/:sessionId/window/current/position', {
+            value: command('POST', '/session/:sessionId/window/current/position', {
                 command: 'setWindowPosition',
                 parameters: [
                     { name: 'x', type: 'number', required: true, description: '' },
@@ -173,81 +240,46 @@ function transformDriver(driver) {
                 ref: '',
             }),
         },
-    };
-    return webdriver_1.default.attachToSession(options, undefined, additionalCommands);
+    });
+    attachedDriver.original = driver.original;
+    return attachedDriver;
 }
-exports.transformDriver = transformDriver;
-function transformElement(element) {
+exports.toDriver = toDriver;
+function toElement(element) {
     const elementId = utils.types.has(element, 'elementId') ? element.elementId : extractElementId(element);
     return { [ELEMENT_ID]: elementId, [LEGACY_ELEMENT_ID]: elementId };
 }
-exports.transformElement = transformElement;
-function transformSelector(selector) {
-    if (utils.types.isString(selector)) {
-        return { using: 'css selector', value: selector };
-    }
-    else if (utils.types.has(selector, 'selector')) {
-        if (!utils.types.isString(selector.selector))
+exports.toElement = toElement;
+function toSelector(selector) {
+    if (utils.types.has(selector, 'selector')) {
+        if (utils.types.has(selector, 'type') && selector.type && utils.types.isString(selector.selector)) {
+            return { using: selector.type === 'css' ? 'css selector' : selector.type, value: selector.selector };
+        }
+        else if (isSelector(selector.selector)) {
             return selector.selector;
-        return {
-            using: utils.types.isNull(selector.type) || selector.type === 'css' ? 'css selector' : selector.type,
-            value: selector.selector,
-        };
+        }
+        else {
+            selector = selector.selector;
+        }
     }
-    else {
-        return selector;
+    if (utils.types.isString(selector)) {
+        return { using: 'css selector', value: selector };
     }
+    return selector;
 }
-exports.transformSelector = transformSelector;
-function untransformSelector(selector) {
+exports.toSelector = toSelector;
+function toSimpleCommonSelector(selector) {
     if (utils.types.has(selector, ['using', 'value'])) {
         return { type: selector.using === 'css selector' ? 'css' : selector.using, selector: selector.value };
     }
     return selector;
 }
-exports.untransformSelector = untransformSelector;
-function extractHostName(driver) {
-    var _a, _b;
-    return (_b = (_a = driver.options) === null || _a === void 0 ? void 0 : _a.hostname) !== null && _b !== void 0 ? _b : null;
-}
-exports.extractHostName = extractHostName;
-function isStaleElementError(error) {
-    if (!error)
-        return false;
-    const errOrResult = error.originalError || error;
-    return errOrResult instanceof Error && errOrResult.name === 'stale element reference';
-}
-exports.isStaleElementError = isStaleElementError;
-// #endregion
-// #region COMMANDS
-async function isEqualElements(_driver, element1, element2) {
-    if (!element1 || !element2)
-        return false;
-    const elementId1 = extractElementId(element1);
-    const elementId2 = extractElementId(element2);
-    return elementId1 === elementId2;
-}
-exports.isEqualElements = isEqualElements;
+exports.toSimpleCommonSelector = toSimpleCommonSelector;
 async function executeScript(driver, script, arg) {
     script = utils.types.isFunction(script) ? `return (${script}).apply(null, arguments)` : script;
     return driver.executeScript(script, [arg]);
 }
 exports.executeScript = executeScript;
-async function mainContext(driver) {
-    await driver.switchToFrame(null);
-    return driver;
-}
-exports.mainContext = mainContext;
-async function parentContext(driver) {
-    await driver.switchToParentFrame();
-    return driver;
-}
-exports.parentContext = parentContext;
-async function childContext(driver, element) {
-    await driver.switchToFrame(element);
-    return driver;
-}
-exports.childContext = childContext;
 async function findElement(driver, selector, parent) {
     const parentId = parent ? (isShadowRoot(parent) ? extractShadowRootId(parent) : extractElementId(parent)) : null;
     try {
@@ -256,8 +288,13 @@ async function findElement(driver, selector, parent) {
             : await driver.findElement(selector.using, selector.value);
         return isElement(element) ? element : null;
     }
-    catch {
-        return null;
+    catch (error) {
+        if (/element could not be located/i.test(error.message) ||
+            /cannot locate an element/i.test(error.message) ||
+            /wasn\'t found/i.test(error.message)) {
+            return null;
+        }
+        throw error;
     }
 }
 exports.findElement = findElement;
@@ -268,6 +305,14 @@ async function findElements(driver, selector, parent) {
         : await driver.findElements(selector.using, selector.value);
 }
 exports.findElements = findElements;
+async function getElementRegion(driver, element) {
+    return driver.getElementRect(extractElementId(element));
+}
+exports.getElementRegion = getElementRegion;
+async function getElementAttribute(driver, element, attr) {
+    return driver.getElementAttribute(extractElementId(element), attr);
+}
+exports.getElementAttribute = getElementAttribute;
 async function setElementText(driver, element, text) {
     await driver.elementClear(extractElementId(element));
     await driver.elementSendKeys(extractElementId(element), text);
@@ -277,6 +322,55 @@ async function getElementText(driver, element) {
     return driver.getElementText(extractElementId(element));
 }
 exports.getElementText = getElementText;
+async function hover(driver, element) {
+    if (!driver.isW3C)
+        return await driver.moveToElement(extractElementId(element));
+    await driver.performActions([
+        {
+            type: 'pointer',
+            id: 'mouse',
+            parameters: { pointerType: 'mouse' },
+            actions: [{ type: 'pointerMove', duration: 0, origin: element, x: 0, y: 0 }],
+        },
+    ]);
+}
+exports.hover = hover;
+async function click(driver, element) {
+    await driver.elementClick(extractElementId(element));
+}
+exports.click = click;
+async function mainContext(driver) {
+    await driver.switchToFrame(null);
+    return driver;
+}
+exports.mainContext = mainContext;
+async function parentContext(driver) {
+    await driver.switchToParentFrame();
+    return driver;
+}
+exports.parentContext = parentContext;
+async function childContext(driver, element) {
+    await driver.switchToFrame(element);
+    return driver;
+}
+exports.childContext = childContext;
+async function getDriverInfo(driver) {
+    return { sessionId: driver.sessionId };
+}
+exports.getDriverInfo = getDriverInfo;
+async function getCapabilities(driver) {
+    var _a;
+    try {
+        const capabilities = await ((_a = driver.getSession) === null || _a === void 0 ? void 0 : _a.call(driver));
+        return utils.types.isObject(capabilities) ? capabilities : driver.capabilities;
+    }
+    catch (error) {
+        if (/Cannot call non W3C standard command while in W3C mode/i.test(error.message))
+            return driver.capabilities;
+        throw new Error(`Unable to retrieve capabilities due to an error. The original error is ${error.message}`);
+    }
+}
+exports.getCapabilities = getCapabilities;
 async function getWindowSize(driver) {
     try {
         const rect = await driver.getWindowRect();
@@ -297,6 +391,27 @@ async function setWindowSize(driver, size) {
     }
 }
 exports.setWindowSize = setWindowSize;
+async function setViewportSize(driver, size) {
+    await driver.sendCommandAndGetResult('Emulation.setDeviceMetricsOverride', {
+        ...size,
+        deviceScaleFactor: 0,
+        mobile: false,
+    });
+}
+exports.setViewportSize = setViewportSize;
+async function getOrientation(browser) {
+    const orientation = await browser.getOrientation();
+    return orientation.toLowerCase();
+}
+exports.getOrientation = getOrientation;
+async function setOrientation(browser, orientation) {
+    return await browser.setOrientation(orientation);
+}
+exports.setOrientation = setOrientation;
+async function getSystemBars(browser) {
+    return browser.getSystemBars();
+}
+exports.getSystemBars = getSystemBars;
 async function getCookies(driver, context) {
     if (context)
         return driver.getAllCookies();
@@ -315,23 +430,6 @@ async function getCookies(driver, context) {
     });
 }
 exports.getCookies = getCookies;
-async function getCapabilities(driver) {
-    var _a;
-    try {
-        const capabilities = await ((_a = driver.getSession) === null || _a === void 0 ? void 0 : _a.call(driver));
-        return utils.types.isObject(capabilities) ? capabilities : driver.capabilities;
-    }
-    catch (error) {
-        if (/Cannot call non W3C standard command while in W3C mode/i.test(error.message))
-            return driver.capabilities;
-        throw new Error(`Unable to retrieve capabilities due to an error. The original error is ${error.message}`);
-    }
-}
-exports.getCapabilities = getCapabilities;
-async function getDriverInfo(driver) {
-    return { sessionId: driver.sessionId };
-}
-exports.getDriverInfo = getDriverInfo;
 async function getTitle(driver) {
     return driver.getTitle();
 }
@@ -344,60 +442,14 @@ async function visit(driver, url) {
     await driver.navigateTo(url);
 }
 exports.visit = visit;
-async function takeScreenshot(driver) {
-    return driver.takeScreenshot();
-}
-exports.takeScreenshot = takeScreenshot;
-async function click(driver, element) {
-    const resolvedElement = isSelector(element) ? await findElement(driver, element) : element;
-    if (resolvedElement)
-        await driver.elementClick(extractElementId(resolvedElement));
-}
-exports.click = click;
-async function hover(driver, element) {
-    if (!driver.isW3C)
-        return await driver.moveToElement(extractElementId(element));
-    const { x, y, width, height } = await driver.getElementRect(extractElementId(element));
-    const { scrollX, scrollY } = await driver.executeScript('return {scrollX:window.pageXOffset,scrollY:window.pageYOffset}', []);
-    const offsetX = Math.floor(x - scrollX + width / 2);
-    const offsetY = Math.floor(y - scrollY + height / 2);
-    await driver.performActions([
-        {
-            type: 'pointer',
-            id: 'mouse',
-            parameters: { pointerType: 'mouse' },
-            actions: [{ type: 'pointerMove', duration: 0, x: offsetX, y: offsetY }],
-        },
-    ]);
-}
-exports.hover = hover;
-// #endregion
-// #region APPIUM COMMANDS
-async function getSystemBars(browser) {
-    return browser.getSystemBars();
-}
-exports.getSystemBars = getSystemBars;
-async function getOrientation(browser) {
-    const orientation = await browser.getOrientation();
-    return orientation.toLowerCase();
-}
-exports.getOrientation = getOrientation;
-async function setOrientation(browser, orientation) {
-    return await browser.setOrientation(orientation);
-}
-exports.setOrientation = setOrientation;
-async function getElementRegion(driver, element) {
-    return driver.getElementRect(extractElementId(element));
-}
-exports.getElementRegion = getElementRegion;
-async function getElementAttribute(driver, element, attr) {
-    return driver.getElementAttribute(extractElementId(element), attr);
-}
-exports.getElementAttribute = getElementAttribute;
 async function performAction(driver, steps) {
     return driver.touchPerform(steps.map(({ action, ...options }) => ({ action, options })));
 }
 exports.performAction = performAction;
+async function takeScreenshot(driver) {
+    return driver.takeScreenshot();
+}
+exports.takeScreenshot = takeScreenshot;
 async function getCurrentWorld(driver) {
     const world = await driver.getContext();
     return utils.types.isString(world) ? world : world.id;
@@ -412,13 +464,20 @@ async function switchWorld(driver, id) {
     await driver.switchContext(id);
 }
 exports.switchWorld = switchWorld;
-// #endregion
-// #region TESTING
 const browserOptionsNames = {
     chrome: 'goog:chromeOptions',
     firefox: 'moz:firefoxOptions',
 };
+/*
+ * Spawn a browser with a given configuration (INTERNAL USE ONLY)
+ *
+ * NOTE:
+ * This function is intended for internal use only. As a result it relies on some dev dependencies.
+ * When wiring the spec-driver up to an SDK and calling this function, if you don't have the same dev deps
+ * installed in the SDK, then this function will error.
+ */
 async function build(env) {
+    const WebDriver = getWebDriver();
     const parseEnv = require('@applitools/test-utils/src/parse-env');
     const { browser = '', capabilities, url, proxy, configurable = true, args = [], headless, logLevel = 'silent', } = parseEnv(env);
     const options = {
@@ -454,8 +513,7 @@ async function build(env) {
         };
     }
     options.agent = { https: require('https').Agent({ rejectUnauthorized: false }) };
-    const driver = await webdriver_1.default.newSession(options);
+    const driver = await WebDriver.newSession(options);
     return [driver, () => driver.deleteSession()];
 }
 exports.build = build;
-// #endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/spec-driver-webdriver",
-  "version": "1.0.41",
+  "version": "1.0.42",
   "keywords": [
     "webdriver",
     "chrome devtools protocol",
@@ -45,11 +45,12 @@
     "lint": "run --top-level eslint '**/*.ts'",
     "build": "run --top-level tspc --project ./tsconfig.build.json",
     "test": "run --top-level mocha './test/**/*.spec.ts' -r @applitools/test-utils/mocha-hooks/docker --exit",
-    "setup": "run --top-level browsers:setup"
+    "setup": "run --top-level browsers:setup",
+    "up:framework": "yarn add --dev --caret webdriver${APPLITOOLS_FRAMEWORK_VERSION:+@$APPLITOOLS_FRAMEWORK_VERSION}"
   },
   "dependencies": {
-    "@applitools/driver": "1.13.4",
-    "@applitools/utils": "1.5.0",
+    "@applitools/driver": "1.13.5",
+    "@applitools/utils": "1.5.1",
     "http-proxy-agent": "5.0.0",
     "https-proxy-agent": "5.0.1"
   },
@@ -59,10 +60,10 @@
     "@applitools/test-utils": "^1.5.17",
     "@types/node": "^12.20.55",
     "nock": "^13.3.2",
-    "webdriver": "^7.30.0"
+    "webdriver": "^8.14.3"
   },
   "peerDependencies": {
-    "webdriver": ">=7.27.0"
+    "webdriver": ">=6.0.0"
   },
   "engines": {
     "node": ">=12.13.0"

package/types/index.d.ts

@@ -1,36 +1,42 @@
-declare const _default: import('@applitools/driver').SpecDriver<SpecType>;
+declare const _default: SpecDriver;
 export default _default;
-export function isDriver(driver: any): driver is Driver;
+export function isDriver(driver: any): driver is Driver<unknown>;
+export function isSecondaryDriver(driver: any): driver is StaticDriver<unknown>;
 export function isElement(element: any): element is Element;
+export function isSecondaryElement(element: any): element is StaticElement;
 export function isShadowRoot(shadowRoot: any): shadowRoot is ShadowRoot;
 export function isSelector(selector: any): selector is Selector;
-export function transformDriver(driver: Driver | StaticDriver): Driver;
-export function transformElement(element: Element | StaticElement): Element;
-export function transformSelector(selector: import('@applitools/driver').CommonSelector<Selector>): Selector;
-export function untransformSelector(selector: Selector): import('@applitools/driver').CommonSelector;
-export function extractHostName(driver: Driver): null | string;
+export function isEqualElements(_driver: Driver<unknown>, element1: Element, element2: Element): boolean;
 export function isStaleElementError(error: any): boolean;
-export function isEqualElements(_driver: Driver, element1: Element, element2: Element): Promise<boolean>;
-export function executeScript(driver: Driver, script: string | ((arg: any) => any), arg: any): Promise<any>;
-export function mainContext(driver: Driver): Promise<Driver>;
-export function parentContext(driver: Driver): Promise<Driver>;
-export function childContext(driver: Driver, element: Element): Promise<Driver>;
-export function findElement(driver: Driver, selector: Selector, parent?: undefined | Element | ShadowRoot): Promise<null | Element>;
-export function findElements(driver: Driver, selector: Selector, parent?: undefined | Element | ShadowRoot): Promise<Array<Element>>;
-export function setElementText(driver: Driver, element: Element, text: string): Promise<void>;
-export function getElementText(driver: Driver, element: Element): Promise<string>;
-export function getWindowSize(driver: Driver): Promise<{ width: number; height: number; }>;
-export function setWindowSize(driver: Driver, size: { width: number; height: number; }): Promise<void>;
-export function getCookies(driver: Driver, context?: undefined | boolean): Promise<Array<import('@applitools/driver').Cookie>>;
-export function getCapabilities(driver: Driver): Promise<Record<string, any>>;
-export function getDriverInfo(driver: Driver): Promise<import('@applitools/driver').DriverInfo>;
-export function getTitle(driver: Driver): Promise<string>;
-export function getUrl(driver: Driver): Promise<string>;
-export function visit(driver: Driver, url: string): Promise<void>;
-export function takeScreenshot(driver: Driver): Promise<string>;
-export function click(driver: Driver, element: Element | Selector): Promise<void>;
-export function hover(driver: Driver, element: Element): Promise<any>;
-export function getSystemBars(browser: Driver): Promise<{ statusBar: {
+export function toDriver<TOriginalDriver = never>(driver: StaticDriver<TOriginalDriver>): Driver<TOriginalDriver> | Promise<Driver<TOriginalDriver>>;
+export function toElement(element: StaticElement): Element;
+export function toSelector(selector: import('@applitools/driver').CommonSelector<Selector>): Selector;
+export function toSimpleCommonSelector(selector: Selector): import('@applitools/driver').CommonSelector;
+export function executeScript(driver: Driver<unknown>, script: string | ((arg: any) => any), arg: any): Promise<any>;
+export function findElement(driver: Driver<unknown>, selector: Selector, parent?: undefined | Element | ShadowRoot): Promise<null | Element>;
+export function findElements(driver: Driver<unknown>, selector: Selector, parent?: undefined | Element | ShadowRoot): Promise<Array<Element>>;
+export function getElementRegion(driver: Driver<unknown>, element: Element): Promise<{
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}>;
+export function getElementAttribute(driver: Driver<unknown>, element: Element, attr: string): Promise<string>;
+export function setElementText(driver: Driver<unknown>, element: Element, text: string): Promise<void>;
+export function getElementText(driver: Driver<unknown>, element: Element): Promise<string>;
+export function hover(driver: Driver<unknown>, element: Element): Promise<void>;
+export function click(driver: Driver<unknown>, element: Element): Promise<void>;
+export function mainContext(driver: Driver<unknown>): Promise<Driver<unknown>>;
+export function parentContext(driver: Driver<unknown>): Promise<Driver<unknown>>;
+export function childContext(driver: Driver<unknown>, element: Element): Promise<Driver<unknown>>;
+export function getDriverInfo(driver: Driver<unknown>): Promise<import('@applitools/driver').DriverInfo>;
+export function getCapabilities(driver: Driver<unknown>): Promise<Record<string, any>>;
+export function getWindowSize(driver: Driver<unknown>): Promise<{ width: number; height: number; }>;
+export function setWindowSize(driver: Driver<unknown>, size: { width: number; height: number; }): Promise<void>;
+export function setViewportSize(driver: Driver<unknown>, size: { width: number; height: number; }): Promise<void>;
+export function getOrientation(browser: Driver<unknown>): Promise<"portrait" | "landscape">;
+export function setOrientation(browser: Driver<unknown>, orientation: "portrait" | "landscape"): Promise<void>;
+export function getSystemBars(browser: Driver<unknown>): Promise<{ statusBar: {
     visible: boolean;
     x: number;
     y: number;
@@ -43,21 +49,32 @@ export function getSystemBars(browser: Driver): Promise<{ statusBar: {
     height: number;
     width: number;
 }; }>;
-export function getOrientation(browser: Driver): Promise<"portrait" | "landscape">;
-export function setOrientation(browser: Driver, orientation: "portrait" | "landscape"): Promise<void>;
-export function getElementRegion(driver: Driver, element: Element): Promise<{
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}>;
-export function getElementAttribute(driver: Driver, element: Element, attr: string): Promise<string>;
-export function performAction(driver: Driver, steps: Array<any>): Promise<void>;
-export function getCurrentWorld(driver: Driver): Promise<string>;
-export function getWorlds(driver: Driver): Promise<Array<string>>;
-export function switchWorld(driver: Driver, id: string): Promise<void>;
-export function build(env: any): Promise<[Driver, () => Promise<void>]>;
-export type Driver = import('webdriver').Client & { original?: any; } & { __applitoolsBrand?: undefined; };
+export function getCookies(driver: Driver<unknown>, context?: undefined | boolean): Promise<Array<import('@applitools/driver').Cookie>>;
+export function getTitle(driver: Driver<unknown>): Promise<string>;
+export function getUrl(driver: Driver<unknown>): Promise<string>;
+export function visit(driver: Driver<unknown>, url: string): Promise<void>;
+export function performAction(driver: Driver<unknown>, steps: Array<any>): Promise<void>;
+export function takeScreenshot(driver: Driver<unknown>): Promise<string>;
+export function getCurrentWorld(driver: Driver<unknown>): Promise<string>;
+export function getWorlds(driver: Driver<unknown>): Promise<Array<string>>;
+export function switchWorld(driver: Driver<unknown>, id: string): Promise<void>;
+export function build(env: any): Promise<[Driver<unknown>, () => Promise<void>]>;
+export type StaticDriver<TOriginalDriver = unknown> = {
+    sessionId: string;
+    serverUrl: string;
+    capabilities: Record<string, any>;
+    proxy?: undefined | { url: string; username?: undefined | string; password?: undefined | string; };
+    original?: undefined | TOriginalDriver;
+};
+export type StaticElement = { elementId: string; };
+export type SecondarySpecType = {
+    driver: StaticDriver<unknown>;
+    context: never;
+    element: StaticElement;
+    selector: never;
+    secondary: never;
+};
+export type Driver<TOriginalDriver = unknown> = import('webdriver').Client & { original: TOriginalDriver; } & { __applitoolsBrand?: undefined; };
 export type Element = ({ 'element-6066-11e4-a52e-4f735466cecf': string; } | { ELEMENT: string; }) & { __applitoolsBrand?: undefined; };
 export type ShadowRoot = {
     'shadow-6066-11e4-a52e-4f735466cecf': string;
@@ -68,6 +85,11 @@ export type Selector = {
     value: string;
     __applitoolsBrand?: undefined;
 };
-export type SpecType = { driver: Driver; context: Driver; element: Element; selector: Selector; };
-export type StaticDriver = { sessionId: string; serverUrl: string; capabilities: Record<string, any>; proxy?: undefined | { url: string; username?: undefined | string; password?: undefined | string; }; };
-export type StaticElement = { elementId: string; };
+export type PrimarySpecType = {
+    driver: Driver<unknown>;
+    context: Driver<unknown>;
+    element: Element;
+    selector: Selector;
+    secondary: SecondarySpecType;
+};
+export type SpecDriver = import('@applitools/driver').SpecDriver<PrimarySpecType>;