@applitools/spec-driver-selenium 1.5.55 → 1.5.56

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## [1.5.56](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-selenium@1.5.55...js/spec-driver-selenium@1.5.56) (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.5.55](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-selenium@1.5.54...js/spec-driver-selenium@1.5.55) (2023-08-03)
 
 

package/dist/spec-driver.js

@@ -23,12 +23,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.build = exports.switchWorld = exports.getWorlds = exports.getCurrentWorld = exports.performAction = exports.getElementAttribute = exports.getElementRegion = exports.getOrientation = exports.setOrientation = exports.getSystemBars = exports.waitUntilDisplayed = exports.hover = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.getCapabilities = exports.getDriverInfo = exports.getCookies = exports.setWindowSize = exports.getWindowSize = exports.getElementText = exports.setElementText = exports.waitForSelector = exports.findElements = exports.findElement = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.untransformSelector = exports.transformSelector = exports.transformDriver = exports.isSelector = 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.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.waitForSelector = exports.findElements = exports.findElement = exports.executeScript = exports.toSimpleCommonSelector = exports.toSelector = exports.toDriver = exports.isStaleElementError = exports.isEqualElements = exports.isSelector = exports.isElement = exports.isDriver = void 0;
 const command_1 = require("selenium-webdriver/lib/command");
 const Selenium = __importStar(require("selenium-webdriver"));
 const utils = __importStar(require("@applitools/utils"));
-// #region HELPERS
-const byHash = ['className', 'css', 'id', 'js', 'linkText', 'name', 'partialLinkText', 'tagName', 'xpath'];
 function extractElementId(element) {
     return isElement(element) ? element.getId() : element['shadow-6066-11e4-a52e-4f735466cecf'];
 }
@@ -37,6 +35,7 @@ function transformShadowRoot(driver, shadowRoot) {
         ? new Selenium.WebElement(driver, shadowRoot['shadow-6066-11e4-a52e-4f735466cecf'])
         : shadowRoot;
 }
+const byHash = ['className', 'css', 'id', 'js', 'linkText', 'name', 'partialLinkText', 'tagName', 'xpath'];
 function isByHashSelector(selector) {
     return byHash.includes(Object.keys(selector)[0]);
 }
@@ -45,8 +44,6 @@ async function executeCustomCommand(driver, command) {
         ? driver.schedule(command)
         : driver.execute(command);
 }
-// #endregion
-// #region UTILITY
 function isDriver(driver) {
     return utils.types.instanceOf(driver, 'WebDriver');
 }
@@ -64,7 +61,22 @@ function isSelector(selector) {
         utils.types.instanceOf(selector, 'RelativeBy'));
 }
 exports.isSelector = isSelector;
-function transformDriver(driver) {
+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;
+function isStaleElementError(error) {
+    if (!error)
+        return false;
+    error = error.originalError || error;
+    return error instanceof Error && error.name === 'StaleElementReferenceError';
+}
+exports.isStaleElementError = isStaleElementError;
+function toDriver(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');
@@ -82,8 +94,8 @@ function transformDriver(driver) {
     }
     return driver;
 }
-exports.transformDriver = transformDriver;
-function transformSelector(selector) {
+exports.toDriver = toDriver;
+function toSelector(selector) {
     if (utils.types.isString(selector)) {
         return { css: selector };
     }
@@ -99,8 +111,8 @@ function transformSelector(selector) {
     }
     return selector;
 }
-exports.transformSelector = transformSelector;
-function untransformSelector(selector) {
+exports.toSelector = toSelector;
+function toSimpleCommonSelector(selector) {
     if (utils.types.instanceOf(selector, 'RelativeBy') || utils.types.isFunction(selector)) {
         return null;
     }
@@ -115,47 +127,11 @@ function untransformSelector(selector) {
     }
     return selector;
 }
-exports.untransformSelector = untransformSelector;
-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;
-// #endregion
-// #region COMMANDS
+exports.toSimpleCommonSelector = toSimpleCommonSelector;
 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_FRAMEWORK_MAJOR_VERSION === '3') {
-        await executeCustomCommand(driver, new command_1.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 ? transformShadowRoot(driver, parent) : driver;
@@ -184,16 +160,76 @@ async function waitForSelector(driver, selector, _parent, options) {
     }
 }
 exports.waitForSelector = waitForSelector;
-async function setElementText(driver, element, keys) {
-    const resolvedElement = isSelector(element) ? await findElement(driver, element) : element;
-    await (resolvedElement === null || resolvedElement === void 0 ? void 0 : resolvedElement.clear());
-    await (resolvedElement === null || resolvedElement === void 0 ? void 0 : resolvedElement.sendKeys(keys));
+async function getElementRegion(_driver, element) {
+    if (utils.types.isFunction(element.getRect)) {
+        return element.getRect();
+    }
+    else {
+        const { x, y } = await element.getLocation();
+        const { width, height } = await element.getSize();
+        return { x, y, width, height };
+    }
+}
+exports.getElementRegion = getElementRegion;
+async function getElementAttribute(_driver, element, attr) {
+    return element.getAttribute(attr);
+}
+exports.getElementAttribute = getElementAttribute;
+async function setElementText(_driver, element, keys) {
+    await element.clear();
+    await element.sendKeys(keys);
 }
 exports.setElementText = setElementText;
 async function getElementText(_driver, element) {
     return element.getText();
 }
 exports.getElementText = getElementText;
+async function hover(driver, element) {
+    if (process.env.APPLITOOLS_FRAMEWORK_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 click(_driver, element) {
+    await element.click();
+}
+exports.click = click;
+async function mainContext(driver) {
+    await driver.switchTo().defaultContent();
+    return driver;
+}
+exports.mainContext = mainContext;
+async function parentContext(driver) {
+    if (process.env.APPLITOOLS_FRAMEWORK_MAJOR_VERSION === '3') {
+        await executeCustomCommand(driver, new command_1.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 getDriverInfo(driver) {
+    const session = await driver.getSession();
+    return { sessionId: session.getId() };
+}
+exports.getDriverInfo = getDriverInfo;
+async function getCapabilities(driver) {
+    var _a;
+    return ((_a = (await executeCustomCommand(driver, new command_1.Command('getSessionDetails')).catch(() => null))) !== null && _a !== void 0 ? _a : (await driver
+        .getCapabilities()
+        .then(capabilities => Array.from(capabilities.keys()).reduce((obj, key) => Object.assign(obj, { [key]: capabilities.get(key) }), {}))));
+}
+exports.getCapabilities = getCapabilities;
 async function getWindowSize(driver) {
     try {
         const rect = await driver.manage().window().getRect();
@@ -223,6 +259,19 @@ async function setWindowSize(driver, size) {
     }
 }
 exports.setWindowSize = setWindowSize;
+async function getOrientation(driver) {
+    const orientation = await executeCustomCommand(driver, new command_1.Command('getOrientation'));
+    return orientation.toLowerCase();
+}
+exports.getOrientation = getOrientation;
+async function setOrientation(driver, orientation) {
+    await executeCustomCommand(driver, new command_1.Command('setOrientation').setParameters({ orientation }));
+}
+exports.setOrientation = setOrientation;
+async function getSystemBars(driver) {
+    return executeCustomCommand(driver, new command_1.Command('getSystemBars'));
+}
+exports.getSystemBars = getSystemBars;
 async function getCookies(driver, context) {
     if (context)
         return driver.manage().getCookies();
@@ -248,18 +297,6 @@ async function getCookies(driver, context) {
     });
 }
 exports.getCookies = getCookies;
-async function getDriverInfo(driver) {
-    const session = await driver.getSession();
-    return { sessionId: session.getId() };
-}
-exports.getDriverInfo = getDriverInfo;
-async function getCapabilities(driver) {
-    var _a;
-    return ((_a = (await executeCustomCommand(driver, new command_1.Command('getSessionDetails')).catch(() => null))) !== null && _a !== void 0 ? _a : (await driver
-        .getCapabilities()
-        .then(capabilities => Array.from(capabilities.keys()).reduce((obj, key) => Object.assign(obj, { [key]: capabilities.get(key) }), {}))));
-}
-exports.getCapabilities = getCapabilities;
 async function getTitle(driver) {
     return driver.getTitle();
 }
@@ -272,68 +309,16 @@ 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) {
-    const resolvedElement = isSelector(element) ? await findElement(driver, element) : element;
-    await (resolvedElement === null || resolvedElement === void 0 ? void 0 : resolvedElement.click());
-}
-exports.click = click;
-async function hover(driver, element) {
-    const resolvedElement = isSelector(element) ? await findElement(driver, element) : element;
-    if (process.env.APPLITOOLS_FRAMEWORK_MAJOR_VERSION === '3') {
-        const { ActionSequence } = require('selenium-webdriver');
-        const action = new ActionSequence(driver);
-        await action.mouseMove(resolvedElement).perform();
-    }
-    else {
-        await driver.actions().move({ origin: resolvedElement }).perform();
-    }
-}
-exports.hover = hover;
-async function waitUntilDisplayed(driver, selector, timeout) {
-    const element = await findElement(driver, selector);
-    await driver.wait(Selenium.until.elementIsVisible(element), timeout);
-}
-exports.waitUntilDisplayed = waitUntilDisplayed;
-// #endregion
-// #region MOBILE COMMANDS
-async function getSystemBars(driver) {
-    return executeCustomCommand(driver, new command_1.Command('getSystemBars'));
-}
-exports.getSystemBars = getSystemBars;
-async function setOrientation(driver, orientation) {
-    await executeCustomCommand(driver, new command_1.Command('setOrientation').setParameters({ orientation }));
-}
-exports.setOrientation = setOrientation;
-async function getOrientation(driver) {
-    const orientation = await executeCustomCommand(driver, new command_1.Command('getOrientation'));
-    return orientation.toLowerCase();
-}
-exports.getOrientation = getOrientation;
-async function getElementRegion(_driver, element) {
-    if (utils.types.isFunction(element.getRect)) {
-        return element.getRect();
-    }
-    else {
-        const { x, y } = await element.getLocation();
-        const { width, height } = await element.getSize();
-        return { x, y, width, height };
-    }
-}
-exports.getElementRegion = getElementRegion;
-async function getElementAttribute(_driver, element, attr) {
-    return element.getAttribute(attr);
-}
-exports.getElementAttribute = getElementAttribute;
 async function performAction(driver, steps) {
     await executeCustomCommand(driver, new command_1.Command('performTouch').setParameters({
         actions: steps.map(({ action, ...options }) => ({ action, options })),
     }));
 }
 exports.performAction = performAction;
+async function takeScreenshot(driver) {
+    return driver.takeScreenshot();
+}
+exports.takeScreenshot = takeScreenshot;
 async function getCurrentWorld(driver) {
     return executeCustomCommand(driver, new command_1.Command('getCurrentContext'));
 }
@@ -346,8 +331,6 @@ async function switchWorld(driver, name) {
     return executeCustomCommand(driver, new command_1.Command('switchToContext').setParameters({ name }));
 }
 exports.switchWorld = switchWorld;
-// #endregion
-// #region TESTING
 const browserOptionsNames = {
     chrome: 'goog:chromeOptions',
     firefox: 'moz:firefoxOptions',
@@ -413,4 +396,3 @@ async function build(env) {
     return [driver, () => driver.quit()];
 }
 exports.build = build;
-// #endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/spec-driver-selenium",
-  "version": "1.5.55",
+  "version": "1.5.56",
   "keywords": [
     "selenium",
     "selenium-webdriver",
@@ -42,11 +42,11 @@
     "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",
-    "up:framework": "run --top-level add-silent selenium-webdriver"
+    "up:framework": "yarn add --dev --caret selenium-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"
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.21",

package/types/index.d.ts

@@ -1,34 +1,37 @@
-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 isElement(element: any): element is Element;
 export function isSelector(selector: any): selector is Selector;
-export function transformDriver(driver: Driver): Driver;
-export function transformSelector(selector: import('@applitools/driver').CommonSelector<Selector>): Selector;
-export function untransformSelector(selector: Selector): null | import('@applitools/driver').CommonSelector;
-export function isStaleElementError(error: any): boolean;
 export function isEqualElements(_driver: Driver, element1: Element, element2: Element): Promise<boolean>;
+export function isStaleElementError(error: any): boolean;
+export function toDriver(driver: Driver): Driver;
+export function toSelector(selector: import('@applitools/driver').CommonSelector<Selector>): Selector;
+export function toSimpleCommonSelector(selector: Selector): null | import('@applitools/driver').CommonSelector;
 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): Promise<null | Element>;
 export function findElements(driver: Driver, selector: Selector, parent?: undefined | Element): Promise<Array<Element>>;
 export function waitForSelector(driver: Driver, selector: Selector, _parent?: undefined | Element, options?: undefined | import('@applitools/driver').WaitOptions): Promise<null | Element>;
-export function setElementText(driver: Driver, element: Element | Selector, keys: string): 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 setElementText(_driver: Driver, element: Element, keys: 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 hover(driver: Driver, element: Element): Promise<void>;
+export function click(_driver: Driver, element: Element): Promise<void>;
+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 getDriverInfo(driver: Driver): Promise<import('@applitools/driver').DriverInfo>;
 export function getCapabilities(driver: Driver): Promise<Record<string, any>>;
-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 | Selector): Promise<void>;
-export function waitUntilDisplayed(driver: Driver, selector: Selector, timeout: number): Promise<void>;
+export function getWindowSize(driver: Driver): Promise<{ width: number; height: number; }>;
+export function setWindowSize(driver: Driver, size: { width: number; height: number; }): Promise<void>;
+export function getOrientation(driver: Driver): Promise<"portrait" | "landscape">;
+export function setOrientation(driver: Driver, orientation: "portrait" | "landscape"): Promise<void>;
 export function getSystemBars(driver: Driver): Promise<{ statusBar: {
     visible: boolean;
     x: number;
@@ -42,16 +45,12 @@ export function getSystemBars(driver: Driver): Promise<{ statusBar: {
     height: number;
     width: number;
 }; }>;
-export function setOrientation(driver: Driver, orientation: import('@applitools/driver').ScreenOrientation): Promise<void>;
-export function getOrientation(driver: Driver): Promise<"portrait" | "landscape">;
-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 getCookies(driver: Driver, context?: undefined | boolean): Promise<Array<import('@applitools/driver').Cookie>>;
+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 performAction(driver: Driver, steps: Array<any>): Promise<void>;
+export function takeScreenshot(driver: Driver): Promise<string>;
 export function getCurrentWorld(driver: Driver): Promise<string>;
 export function getWorlds(driver: Driver): Promise<Array<string>>;
 export function switchWorld(driver: Driver, name: string): Promise<void>;
@@ -60,4 +59,11 @@ export type Driver = import('selenium-webdriver').WebDriver & { __applitoolsBran
 export type Element = import('selenium-webdriver').WebElement & { __applitoolsBrand?: undefined; };
 export type ShadowRoot = { 'shadow-6066-11e4-a52e-4f735466cecf': string; };
 export type Selector = (import('selenium-webdriver').By | import('selenium-webdriver').ByHash | import('selenium-webdriver').RelativeBy | { using: string; value: string; } | ((webdriver: import('selenium-webdriver').WebDriver) => Promise<any>)) & { __applitoolsBrand?: undefined; };
-export type SpecType = { driver: Driver; context: Driver; element: Element; selector: Selector; };
+export type PrimarySpecType = {
+    driver: Driver;
+    context: Driver;
+    element: Element;
+    selector: Selector;
+    secondary: never;
+};
+export type SpecDriver = import('@applitools/driver').SpecDriver<PrimarySpecType>;