@applitools/spec-driver-browser-extension 1.0.7 → 1.0.9

package/CHANGELOG.md

@@ -1,5 +1,66 @@
 # Changelog
 
+## [1.0.9](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-browser-extension@1.0.8...js/spec-driver-browser-extension@1.0.9) (2023-08-30)
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.5.2
+  #### Bug Fixes
+
+  * fixed some types ([498b1d7](https://github.com/applitools/eyes.sdk.javascript1/commit/498b1d7c547df04773b64b66ee39cccb402c093e))
+* @applitools/logger bumped to 2.0.9
+
+* @applitools/spec-driver-playwright bumped to 1.3.24
+
+* @applitools/driver bumped to 1.13.6
+
+
+## [1.0.8](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-browser-extension@1.0.7...js/spec-driver-browser-extension@1.0.8) (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/spec-driver-playwright bumped to 1.3.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.7](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-browser-extension@1.0.6...js/spec-driver-browser-extension@1.0.7) (2023-08-10)
 
 

package/dist/spec-driver.js

@@ -26,10 +26,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDriverInfo = exports.getUrl = exports.getTitle = exports.takeScreenshot = exports.getCookies = exports.setWindowSize = exports.getWindowSize = exports.findElements = exports.findElement = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = exports.isStaleElementError = exports.extractContext = exports.transformSelector = exports.isSelector = exports.isElement = exports.isContext = exports.isDriver = void 0;
-const utils = __importStar(require("@applitools/utils"));
+exports.getUrl = exports.getTitle = exports.takeScreenshot = exports.getCookies = exports.setWindowSize = exports.getWindowSize = exports.getDriverInfo = exports.childContext = exports.parentContext = exports.mainContext = exports.findElements = exports.findElement = exports.executeScript = exports.extractContext = exports.toSelector = exports.isStaleElementError = exports.isSelector = exports.isElement = exports.isContext = exports.isDriver = void 0;
 const webextension_polyfill_1 = __importDefault(require("webextension-polyfill"));
-// #region UTILITY
+const utils = __importStar(require("@applitools/utils"));
 function isDriver(driver) {
     return utils.types.has(driver, ['windowId', 'tabId']);
 }
@@ -46,32 +45,32 @@ function isSelector(selector) {
     return utils.types.has(selector, ['type', 'selector']);
 }
 exports.isSelector = isSelector;
-function transformSelector(selector) {
+function isStaleElementError(error) {
+    if (!error)
+        return false;
+    error = error.originalError || error;
+    return error instanceof Error && error.message === 'StaleElementReferenceError';
+}
+exports.isStaleElementError = isStaleElementError;
+function toSelector(selector) {
     if (utils.types.isString(selector)) {
         return { type: 'css', selector: selector };
     }
     else if (utils.types.has(selector, 'selector')) {
         if (!utils.types.isString(selector.selector))
             return selector.selector;
-        if (!utils.types.has(selector, 'type'))
-            return { type: 'css', selector: selector.selector };
+        return {
+            type: utils.types.has(selector, 'type') ? selector.type : 'css',
+            selector: selector.selector,
+        };
     }
     return selector;
 }
-exports.transformSelector = transformSelector;
+exports.toSelector = toSelector;
 function extractContext(driver) {
     return { ...driver, frameId: 0 };
 }
 exports.extractContext = extractContext;
-function isStaleElementError(error) {
-    if (!error)
-        return false;
-    error = error.originalError || error;
-    return error instanceof Error && error.message === 'StaleElementReferenceError';
-}
-exports.isStaleElementError = isStaleElementError;
-// #endregion
-// #region COMMANDS
 async function executeScript(context, script, arg) {
     const [{ result, error }] = await webextension_polyfill_1.default.scripting.executeScript({
         target: { tabId: context.tabId, frameIds: [context.frameId || 0] },
@@ -86,38 +85,6 @@ async function executeScript(context, script, arg) {
     return result;
 }
 exports.executeScript = executeScript;
-async function mainContext(context) {
-    return { ...context, frameId: 0 };
-}
-exports.mainContext = mainContext;
-async function parentContext(context) {
-    const frames = await webextension_polyfill_1.default.webNavigation.getAllFrames({ tabId: context.tabId });
-    const frame = frames.find(frame => frame.frameId === context.frameId);
-    return { ...context, frameId: frame === null || frame === void 0 ? void 0 : frame.parentFrameId };
-}
-exports.parentContext = parentContext;
-async function childContext(context, element) {
-    const childFrameId = await new Promise(async (resolve, reject) => {
-        const key = utils.general.guid();
-        webextension_polyfill_1.default.runtime.onMessage.addListener(handler);
-        function handler(data, sender) {
-            if (data.key === key) {
-                resolve(sender.frameId);
-                webextension_polyfill_1.default.runtime.onMessage.removeListener(handler);
-            }
-        }
-        await webextension_polyfill_1.default.scripting.executeScript({
-            target: { tabId: context.tabId, frameIds: [context.frameId || 0] },
-            func: (element, key) => {
-                window.refer.deref(element).contentWindow.postMessage({ key, isApplitools: true }, '*'); // eslint-disable-line no-undef
-            },
-            args: [element, key],
-        });
-        setTimeout(() => reject(new Error('No such frame')), 5000);
-    });
-    return { ...context, frameId: childFrameId };
-}
-exports.childContext = childContext;
 async function findElement(context, selector, parent) {
     const [{ result }] = await webextension_polyfill_1.default.scripting.executeScript({
         target: { tabId: context.tabId, frameIds: [context.frameId || 0] },
@@ -161,6 +128,42 @@ async function findElements(context, selector, parent) {
     return result;
 }
 exports.findElements = findElements;
+async function mainContext(context) {
+    return { ...context, frameId: 0 };
+}
+exports.mainContext = mainContext;
+async function parentContext(context) {
+    const frames = await webextension_polyfill_1.default.webNavigation.getAllFrames({ tabId: context.tabId });
+    const frame = frames.find(frame => frame.frameId === context.frameId);
+    return { ...context, frameId: frame.parentFrameId };
+}
+exports.parentContext = parentContext;
+async function childContext(context, element) {
+    const childFrameId = await new Promise(async (resolve, reject) => {
+        const key = utils.general.guid();
+        webextension_polyfill_1.default.runtime.onMessage.addListener(handler);
+        function handler(data, sender) {
+            if (data.key === key) {
+                resolve(sender.frameId);
+                webextension_polyfill_1.default.runtime.onMessage.removeListener(handler);
+            }
+        }
+        await webextension_polyfill_1.default.scripting.executeScript({
+            target: { tabId: context.tabId, frameIds: [context.frameId || 0] },
+            func: (element, key) => {
+                window.refer.deref(element).contentWindow.postMessage({ key, isApplitools: true }, '*'); // eslint-disable-line no-undef
+            },
+            args: [element, key],
+        });
+        setTimeout(() => reject(new Error('No such frame')), 5000);
+    });
+    return { ...context, frameId: childFrameId };
+}
+exports.childContext = childContext;
+async function getDriverInfo() {
+    return { features: { canExecuteOnlyFunctionScripts: true } };
+}
+exports.getDriverInfo = getDriverInfo;
 async function getWindowSize(driver) {
     const [{ result }] = await webextension_polyfill_1.default.scripting.executeScript({
         target: { tabId: driver.tabId, frameIds: [0] },
@@ -208,16 +211,11 @@ async function takeScreenshot(driver) {
 exports.takeScreenshot = takeScreenshot;
 async function getTitle(driver) {
     const { title } = await webextension_polyfill_1.default.tabs.get(driver.tabId);
-    return title;
+    return title || '';
 }
 exports.getTitle = getTitle;
 async function getUrl(driver) {
     const { url } = await webextension_polyfill_1.default.tabs.get(driver.tabId);
-    return url;
+    return url || '';
 }
 exports.getUrl = getUrl;
-async function getDriverInfo() {
-    return { features: { canExecuteOnlyFunctionScripts: true } };
-}
-exports.getDriverInfo = getDriverInfo;
-// #endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/spec-driver-browser-extension",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "keywords": [
     "playwright",
     "chrome devtools protocol",
@@ -39,12 +39,13 @@
     "setup": "run --top-level xvfb:setup"
   },
   "dependencies": {
-    "@applitools/utils": "1.4.0",
+    "@applitools/driver": "1.13.6",
+    "@applitools/utils": "1.5.2",
     "webextension-polyfill": "0.10.0"
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.21",
-    "@applitools/spec-driver-playwright": "^1.3.22",
+    "@applitools/spec-driver-playwright": "^1.3.24",
     "@applitools/test-utils": "^1.5.17",
     "@babel/core": "^7.22.5",
     "@babel/preset-env": "^7.22.5",
@@ -55,7 +56,7 @@
     "babel-loader": "^9.1.2",
     "copy-webpack-plugin": "^11.0.0",
     "core-js": "^3.31.0",
-    "playwright": "^1.34.3",
+    "playwright": "^1.37.0",
     "webpack": "^5.75.0",
     "webpack-cli": "^5.0.1"
   },

package/types/spec-driver.d.ts

@@ -1,65 +1,44 @@
 import type { Size } from '@applitools/utils';
+import type { SpecType, SpecDriver as BaseSpecDriver, CommonSelector, DriverInfo, Cookie } from '@applitools/driver';
 import type { Ref } from './refer';
-type CommonSelector<TSelector = never> = string | {
-    selector: TSelector | string;
-    type?: string;
-};
-type Driver = {
+export type Driver = {
     windowId: number;
     tabId: number;
 };
-type Context = {
+export type Context = {
     windowId: number;
     tabId: number;
     frameId: number;
 };
-type Element = globalThis.Element | Ref;
+export type Element = Ref;
+export type Selector = {
+    type: 'css' | 'xpath';
+    selector: string;
+};
+export type PrimarySpecType = SpecType<Driver, Context, Element, Selector>;
+export type SpecDriver = BaseSpecDriver<PrimarySpecType>;
 declare global {
     interface Window {
         refer: any;
     }
 }
-export declare function isDriver(driver: any): boolean;
-export declare function isContext(context: any): boolean;
-export declare function isElement(element: any): boolean;
-export declare function isSelector(selector: any): boolean;
-export declare function transformSelector(selector: CommonSelector): {
-    selector: string;
-    type?: string | undefined;
-} & Record<"type", unknown>;
-export declare function extractContext(driver: Driver): {
-    frameId: number;
-    windowId: number;
-    tabId: number;
-};
+export declare function isDriver(driver: any): driver is Driver;
+export declare function isContext(context: any): context is Context;
+export declare function isElement(element: any): element is Element;
+export declare function isSelector(selector: any): selector is Selector;
 export declare function isStaleElementError(error: any): boolean;
-export declare function executeScript(context: Context, script: (arg: any) => any, arg: any): Promise<any>;
-export declare function mainContext(context: Context): Promise<{
-    frameId: number;
-    windowId: number;
-    tabId: number;
-}>;
-export declare function parentContext(context: Context): Promise<{
-    frameId: number | undefined;
-    windowId: number;
-    tabId: number;
-}>;
-export declare function childContext(context: Context, element: Element): Promise<{
-    frameId: unknown;
-    windowId: number;
-    tabId: number;
-}>;
-export declare function findElement(context: Context, selector: CommonSelector, parent?: Element | Node): Promise<any>;
-export declare function findElements(context: Context, selector: CommonSelector, parent?: Element | Node): Promise<any>;
+export declare function toSelector(selector: CommonSelector<Selector>): Selector;
+export declare function extractContext(driver: Driver): Context;
+export declare function executeScript(context: Context, script: (arg: any) => any, arg?: any): Promise<any>;
+export declare function findElement(context: Context, selector: Selector, parent?: Element | Node): Promise<Element | null>;
+export declare function findElements(context: Context, selector: Selector, parent?: Element | Node): Promise<Element[]>;
+export declare function mainContext(context: Context): Promise<Context>;
+export declare function parentContext(context: Context): Promise<Context>;
+export declare function childContext(context: Context, element: Element): Promise<Context>;
+export declare function getDriverInfo(): Promise<DriverInfo>;
 export declare function getWindowSize(driver: Driver): Promise<Size>;
 export declare function setWindowSize(driver: Driver, size: Size): Promise<void>;
-export declare function getCookies(_driver: Driver): Promise<any[]>;
+export declare function getCookies(_driver: Driver): Promise<Cookie[]>;
 export declare function takeScreenshot(driver: Driver): Promise<string>;
-export declare function getTitle(driver: Driver): Promise<string | undefined>;
-export declare function getUrl(driver: Driver): Promise<string | undefined>;
-export declare function getDriverInfo(): Promise<{
-    features: {
-        canExecuteOnlyFunctionScripts: boolean;
-    };
-}>;
-export {};
+export declare function getTitle(driver: Driver): Promise<string>;
+export declare function getUrl(driver: Driver): Promise<string>;