@applitools/spec-driver-playwright 1.3.21 → 1.3.23

package/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## [1.3.23](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-playwright@1.3.22...js/spec-driver-playwright@1.3.23) (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.3.22](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-playwright@1.3.21...js/spec-driver-playwright@1.3.22) (2023-08-10)
+
+
+### Bug Fixes
+
+* avoid service worker shutdown ([#1830](https://github.com/applitools/eyes.sdk.javascript1/issues/1830)) ([f552d84](https://github.com/applitools/eyes.sdk.javascript1/commit/f552d8425778f300cad31c0297a04f3f282f34e0))
+
 ## [1.3.21](https://github.com/applitools/eyes.sdk.javascript1/compare/js/spec-driver-playwright@1.3.20...js/spec-driver-playwright@1.3.21) (2023-08-03)
 
 

package/dist/spec-driver.js

@@ -23,12 +23,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.build = exports.waitUntilDisplayed = exports.hover = exports.click = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.getDriverInfo = exports.getCookies = exports.setViewportSize = exports.getViewportSize = exports.setElementText = exports.findElements = exports.findElement = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = exports.isStaleElementError = exports.extractContext = exports.untransformSelector = exports.transformSelector = exports.isSelector = exports.isElement = exports.isContext = exports.isDriver = void 0;
+exports.build = exports.takeScreenshot = exports.visit = exports.getUrl = exports.getTitle = exports.getCookies = exports.setViewportSize = exports.getViewportSize = exports.getDriverInfo = exports.childContext = exports.parentContext = exports.mainContext = exports.click = exports.hover = exports.setElementText = exports.findElements = exports.findElement = exports.executeScript = exports.extractContext = exports.toSimpleCommonSelector = exports.toSelector = exports.isStaleElementError = exports.isSelector = exports.isElement = exports.isContext = exports.isDriver = void 0;
 const fs = __importStar(require("fs"));
 const os = __importStar(require("os"));
 const path = __importStar(require("path"));
 const utils = __importStar(require("@applitools/utils"));
-// #region HELPERS
 async function handleToObject(handle) {
     var _a;
     let [, type] = (_a = handle.toString().match(/(?:.+@)?(\w*)(?:\(\d+\))?/i)) !== null && _a !== void 0 ? _a : [];
@@ -49,8 +48,6 @@ async function handleToObject(handle) {
         return handle.jsonValue();
     }
 }
-// #endregion
-// #region UTILITY
 function isDriver(page) {
     if (!page)
         return false;
@@ -75,7 +72,16 @@ function isSelector(selector) {
     return utils.types.isString(selector) || utils.types.instanceOf(selector, 'Locator');
 }
 exports.isSelector = isSelector;
-function transformSelector(selector) {
+function isStaleElementError(err) {
+    var _a, _b, _c, _d;
+    return (((_a = err === null || err === void 0 ? void 0 : err.message) === null || _a === void 0 ? void 0 : _a.includes('Element is not attached to the DOM')) || // universal message
+        ((_b = err === null || err === void 0 ? void 0 : err.message) === null || _b === void 0 ? void 0 : _b.includes('Protocol error (DOM.describeNode)')) || // chrome message
+        ((_c = err === null || err === void 0 ? void 0 : err.message) === null || _c === void 0 ? void 0 : _c.includes('Protocol error (Page.adoptNode)')) || // firefox message
+        ((_d = err === null || err === void 0 ? void 0 : err.message) === null || _d === void 0 ? void 0 : _d.includes('Unable to adopt element handle from a different document')) // webkit message
+    );
+}
+exports.isStaleElementError = isStaleElementError;
+function toSelector(selector) {
     if (utils.types.has(selector, 'selector')) {
         if (!utils.types.has(selector, 'type'))
             return selector.selector;
@@ -84,8 +90,8 @@ function transformSelector(selector) {
     }
     return selector;
 }
-exports.transformSelector = transformSelector;
-function untransformSelector(selector) {
+exports.toSelector = toSelector;
+function toSimpleCommonSelector(selector) {
     if (utils.types.instanceOf(selector, 'Locator')) {
         ;
         [, selector] = selector.toString().match(/Locator@(.+)/);
@@ -94,48 +100,17 @@ function untransformSelector(selector) {
         return { selector };
     return selector;
 }
-exports.untransformSelector = untransformSelector;
+exports.toSimpleCommonSelector = toSimpleCommonSelector;
 function extractContext(page) {
     return isDriver(page) ? page.mainFrame() : page;
 }
 exports.extractContext = extractContext;
-function isStaleElementError(err) {
-    var _a, _b, _c, _d;
-    return (((_a = err === null || err === void 0 ? void 0 : err.message) === null || _a === void 0 ? void 0 : _a.includes('Element is not attached to the DOM')) || // universal message
-        ((_b = err === null || err === void 0 ? void 0 : err.message) === null || _b === void 0 ? void 0 : _b.includes('Protocol error (DOM.describeNode)')) || // chrome message
-        ((_c = err === null || err === void 0 ? void 0 : err.message) === null || _c === void 0 ? void 0 : _c.includes('Protocol error (Page.adoptNode)')) || // firefox message
-        ((_d = err === null || err === void 0 ? void 0 : err.message) === null || _d === void 0 ? void 0 : _d.includes('Unable to adopt element handle from a different document')) // webkit message
-    );
-}
-exports.isStaleElementError = isStaleElementError;
-// #endregion
-// #region COMMANDS
 async function executeScript(frame, script, arg) {
     script = utils.types.isString(script) ? new Function(script) : script;
     const result = await frame.evaluateHandle(script, arg);
     return handleToObject(result);
 }
 exports.executeScript = executeScript;
-async function mainContext(frame) {
-    frame = extractContext(frame);
-    let mainFrame = frame;
-    while (mainFrame.parentFrame()) {
-        mainFrame = mainFrame.parentFrame();
-    }
-    return mainFrame;
-}
-exports.mainContext = mainContext;
-async function parentContext(frame) {
-    var _a;
-    frame = extractContext(frame);
-    return (_a = frame.parentFrame()) !== null && _a !== void 0 ? _a : frame;
-}
-exports.parentContext = parentContext;
-async function childContext(_frame, element) {
-    const frame = (await element.contentFrame());
-    return frame;
-}
-exports.childContext = childContext;
 async function findElement(frame, selector, parent) {
     if (utils.types.instanceOf(selector, 'Locator')) {
         return selector.elementHandle();
@@ -157,6 +132,36 @@ async function setElementText(frame, element, text) {
     await (resolvedElement === null || resolvedElement === void 0 ? void 0 : resolvedElement.fill(text));
 }
 exports.setElementText = setElementText;
+async function hover(_frame, element) {
+    await element.hover();
+}
+exports.hover = hover;
+async function click(_frame, element) {
+    await element.click();
+}
+exports.click = click;
+async function mainContext(frame) {
+    let mainFrame = frame;
+    while (mainFrame.parentFrame()) {
+        mainFrame = mainFrame.parentFrame();
+    }
+    return mainFrame;
+}
+exports.mainContext = mainContext;
+async function parentContext(frame) {
+    var _a;
+    return (_a = frame.parentFrame()) !== null && _a !== void 0 ? _a : frame;
+}
+exports.parentContext = parentContext;
+async function childContext(_frame, element) {
+    const frame = (await element.contentFrame());
+    return frame;
+}
+exports.childContext = childContext;
+async function getDriverInfo(_page) {
+    return { features: { allCookies: true } };
+}
+exports.getDriverInfo = getDriverInfo;
 async function getViewportSize(page) {
     return page.viewportSize();
 }
@@ -174,10 +179,6 @@ async function getCookies(page) {
     });
 }
 exports.getCookies = getCookies;
-async function getDriverInfo(_page) {
-    return { features: { allCookies: true } };
-}
-exports.getDriverInfo = getDriverInfo;
 async function getTitle(page) {
     return page.title();
 }
@@ -194,24 +195,6 @@ async function takeScreenshot(page) {
     return page.screenshot();
 }
 exports.takeScreenshot = takeScreenshot;
-async function click(frame, element) {
-    const resolvedElement = isSelector(element) ? await findElement(frame, element) : element;
-    await (resolvedElement === null || resolvedElement === void 0 ? void 0 : resolvedElement.click());
-}
-exports.click = click;
-async function hover(frame, element) {
-    const resolvedElement = isSelector(element) ? await findElement(frame, element) : element;
-    await (resolvedElement === null || resolvedElement === void 0 ? void 0 : resolvedElement.hover());
-}
-exports.hover = hover;
-async function waitUntilDisplayed(frame, selector) {
-    if (utils.types.instanceOf(selector, 'Locator'))
-        return selector.waitFor();
-    await frame.waitForSelector(selector);
-}
-exports.waitUntilDisplayed = waitUntilDisplayed;
-// #endregion
-// #region BUILD
 const browserNames = {
     chrome: 'chromium',
     safari: 'webkit',
@@ -246,6 +229,12 @@ async function build(env) {
         headless: headless && !extension,
         ignoreDefaultArgs: ['--hide-scrollbars'],
     };
+    // TODO remove this once Playwright provides formal support for headless: 'new' (https://github.com/microsoft/playwright/issues/21194)
+    if (headless === 'new') {
+        options.args.push('--headless=new');
+        delete options.headless;
+        options.ignoreDefaultArgs.push('--headless');
+    }
     if (extension) {
         options.args.push(`--load-extension=${extension}`, `--disable-extensions-except=${extension}`);
     }
@@ -281,4 +270,3 @@ async function build(env) {
     return [page, () => (driver ? driver.close() : context.close())];
 }
 exports.build = build;
-// #endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/spec-driver-playwright",
-  "version": "1.3.21",
+  "version": "1.3.23",
   "keywords": [
     "playwright",
     "chrome devtools protocol",
@@ -37,17 +37,17 @@
     "test": "run --top-level mocha './test/**/*.spec.ts' --exit",
     "setup": "yarn playwright:setup",
     "playwright:setup": "sudo npx playwright install-deps",
-    "up:framework": "run --top-level add-silent playwright"
+    "up:framework": "yarn add --dev --caret playwright${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",
     "@applitools/test-utils": "^1.5.17",
     "@types/node": "^12.20.55",
-    "playwright": "^1.34.3"
+    "playwright": "^1.37.0"
   },
   "peerDependencies": {
     "playwright": ">=1.0.0"

package/types/index.d.ts

@@ -1,34 +1,40 @@
-declare const _default: import('@applitools/driver').SpecDriver<SpecType>;
+declare const _default: SpecDriver;
 export default _default;
 export function isDriver(page: any): page is Driver;
 export function isContext(frame: any): frame is Context;
 export function isElement(element: any): element is Element<Node>;
 export function isSelector(selector: any): selector is Selector;
-export function transformSelector(selector: import('@applitools/driver').CommonSelector<Selector>): Selector;
-export function untransformSelector(selector: Selector): import('@applitools/driver').CommonSelector;
-export function extractContext(page: Driver | Context): Context;
 export function isStaleElementError(err: any): boolean;
+export function toSelector(selector: import('@applitools/driver').CommonSelector<Selector>): Selector;
+export function toSimpleCommonSelector(selector: Selector): import('@applitools/driver').CommonSelector;
+export function extractContext(page: Driver): Context;
 export function executeScript(frame: Context, script: string | ((arg: any) => any), arg: any): Promise<any>;
-export function mainContext(frame: Context): Promise<Context>;
-export function parentContext(frame: Context): Promise<Context>;
-export function childContext(_frame: Context, element: Element<Node>): Promise<Context>;
 export function findElement(frame: Context, selector: Selector, parent?: undefined | Element<Node>): Promise<null | Element<SVGElement | HTMLElement>>;
 export function findElements(frame: Context, selector: Selector, parent?: undefined | Element<Node>): Promise<Array<Element<SVGElement | HTMLElement>>>;
 export function setElementText(frame: Context, element: Selector | Element<Node>, text: string): Promise<void>;
+export function hover(_frame: Context, element: Element<Node>): Promise<void>;
+export function click(_frame: Context, element: Element<Node>): Promise<void>;
+export function mainContext(frame: Context): Promise<Context>;
+export function parentContext(frame: Context): Promise<Context>;
+export function childContext(_frame: Context, element: Element<Node>): Promise<Context>;
+export function getDriverInfo(_page: Driver): Promise<import('@applitools/driver').DriverInfo>;
 export function getViewportSize(page: Driver): Promise<{ width: number; height: number; }>;
 export function setViewportSize(page: Driver, size: { width: number; height: number; }): Promise<void>;
 export function getCookies(page: Driver): Promise<Array<import('@applitools/driver').Cookie>>;
-export function getDriverInfo(_page: Driver): Promise<import('@applitools/driver').DriverInfo>;
 export function getTitle(page: Driver): Promise<string>;
 export function getUrl(page: Driver): Promise<string>;
 export function visit(page: Driver, url: string): Promise<void>;
 export function takeScreenshot(page: Driver): Promise<Buffer>;
-export function click(frame: Context, element: Selector | Element<Node>): Promise<void>;
-export function hover(frame: Context, element: Selector | Element<Node>): Promise<void>;
-export function waitUntilDisplayed(frame: Context, selector: Selector): Promise<void>;
 export function build(env: any): Promise<[Driver, () => Promise<void>]>;
 export type Driver = import('playwright-core').Page & { __applitoolsBrand?: undefined; };
 export type Context = import('playwright-core').Frame & { __applitoolsBrand?: undefined; };
 export type Element<T = Node> = import('playwright-core').ElementHandle<T> & { __applitoolsBrand?: undefined; };
 export type Selector = (string | import('playwright-core').Locator) & { __applitoolsBrand?: undefined; };
-export type SpecType = { driver: Driver; context: Context; element: Element<Node>; selector: Selector; };
+export type PrimarySpecType = {
+    driver: Driver;
+    context: Context;
+    element: Element<Node>;
+    selector: Selector;
+    secondary: never;
+};
+export type SpecDriver = import('@applitools/driver').SpecDriver<PrimarySpecType>;