@applitools/spec-driver-playwright 1.3.7 → 1.3.9

package/dist/spec-driver.js

@@ -126,32 +126,35 @@ async function mainContext(frame) {
 }
 exports.mainContext = mainContext;
 async function parentContext(frame) {
+    var _a;
     frame = extractContext(frame);
-    return frame.parentFrame();
+    return (_a = frame.parentFrame()) !== null && _a !== void 0 ? _a : frame;
 }
 exports.parentContext = parentContext;
 async function childContext(_frame, element) {
-    return element.contentFrame();
+    const frame = (await element.contentFrame());
+    return frame;
 }
 exports.childContext = childContext;
 async function findElement(frame, selector, parent) {
-    if (utils.types.instanceOf(selector, 'Locator'))
+    if (utils.types.instanceOf(selector, 'Locator')) {
         return selector.elementHandle();
+    }
     const root = parent !== null && parent !== void 0 ? parent : frame;
     return root.$(selector);
 }
 exports.findElement = findElement;
 async function findElements(frame, selector, parent) {
-    if (utils.types.instanceOf(selector, 'Locator'))
-        return selector.elementHandles();
+    if (utils.types.instanceOf(selector, 'Locator')) {
+        return (await selector.elementHandles());
+    }
     const root = parent !== null && parent !== void 0 ? parent : frame;
     return root.$$(selector);
 }
 exports.findElements = findElements;
 async function setElementText(frame, element, text) {
-    if (isSelector(element))
-        element = await findElement(frame, element);
-    await element.fill(text);
+    const resolvedElement = isSelector(element) ? await findElement(frame, element) : element;
+    await (resolvedElement === null || resolvedElement === void 0 ? void 0 : resolvedElement.fill(text));
 }
 exports.setElementText = setElementText;
 async function getViewportSize(page) {
@@ -192,22 +195,21 @@ async function takeScreenshot(page) {
 }
 exports.takeScreenshot = takeScreenshot;
 async function click(frame, element) {
-    if (isSelector(element))
-        element = await findElement(frame, element);
-    await element.click();
+    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) {
-    if (isSelector(element))
-        element = await findElement(frame, element);
-    await element.hover();
+    const resolvedElement = isSelector(element) ? await findElement(frame, element) : element;
+    await (resolvedElement === null || resolvedElement === void 0 ? void 0 : resolvedElement.hover());
 }
 exports.hover = hover;
 async function scrollIntoView(frame, element, align = false) {
-    if (isSelector(element))
-        element = await findElement(frame, element);
-    // @ts-ignore
-    await frame.evaluate(([element, align]) => element.scrollIntoView(align), [element, align]);
+    const resolvedElement = isSelector(element) ? await findElement(frame, element) : element;
+    await frame.evaluate(([element, align]) => element === null || element === void 0 ? void 0 : element.scrollIntoView(align), [
+        resolvedElement,
+        align,
+    ]);
 }
 exports.scrollIntoView = scrollIntoView;
 async function waitUntilDisplayed(frame, selector) {
@@ -223,6 +225,14 @@ const browserNames = {
     safari: 'webkit',
     firefox: 'firefox',
 };
+/*
+ * 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 playwright = require('playwright');
     const parseEnv = require('@applitools/test-utils/src/parse-env');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/spec-driver-playwright",
-  "version": "1.3.7",
+  "version": "1.3.9",
   "keywords": [
     "playwright",
     "chrome devtools protocol",
@@ -35,8 +35,8 @@
     "types"
   ],
   "scripts": {
-    "lint": "eslint '**/*.ts'",
-    "build": "ttsc",
+    "lint": "node ../../node_modules/.bin/eslint '**/*.ts'",
+    "build": "node ../../node_modules/.bin/ttsc --project ./tsconfig.build.json",
     "test": "mocha ./test/**/*.spec.ts --no-timeouts --exit -r ts-node/register",
     "test:sanity": "yarn test",
     "setup": "yarn playwright:setup",
@@ -49,36 +49,18 @@
     "version": "bongo version",
     "postversion": "bongo postversion --skip-release-notification"
   },
-  "husky": {
-    "hooks": {
-      "pre-push": "yarn bongo lint"
-    }
-  },
   "dependencies": {
-    "@applitools/driver": "1.11.25",
-    "@applitools/utils": "1.3.26"
+    "@applitools/driver": "1.11.31",
+    "@applitools/utils": "1.3.30"
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.11",
-    "@applitools/bongo": "^2.2.0",
-    "@applitools/scripts": "1.2.0",
-    "@applitools/test-utils": "1.5.8",
+    "@applitools/bongo": "^2.2.5",
+    "@applitools/test-utils": "1.5.12",
     "@types/mocha": "^9.0.0",
     "@types/node": "12",
-    "@typescript-eslint/eslint-plugin": "^5.27.0",
-    "@typescript-eslint/parser": "^5.27.0",
-    "eslint": "^8.16.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-mocha-no-only": "^1.1.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "husky": "^4.3.7",
     "mocha": "^9.2.2",
-    "playwright": "^1.22.2",
-    "prettier": "^2.6.2",
-    "ts-node": "^10.8.0",
-    "ttypescript": "^1.5.13",
-    "typescript": "^4.8.4"
+    "playwright": "^1.29.2"
   },
   "peerDependencies": {
     "playwright": ">=1.0.0"

package/types/index.d.ts

@@ -1,19 +1,19 @@
-declare const _default: import('@applitools/driver').SpecDriver<Driver, Context, Element<Node>, Selector>;
+declare const _default: import('@applitools/driver').SpecDriver<SpecType>;
 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: string | { selector: string | Selector; type?: string; }): Selector;
-export function untransformSelector(selector: Selector): string | { selector: string; type?: string; };
+export function transformSelector(selector: import('@applitools/driver').CommonSelector<SpecType>): Selector;
+export function untransformSelector(selector: Selector): import('@applitools/driver').CommonSelector<never>;
 export function extractContext(page: Driver | Context): Context;
 export function isStaleElementError(err: any): boolean;
 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?: Element<Node>): Promise<Element<Node>>;
-export function findElements(frame: Context, selector: Selector, parent?: Element<Node>): Promise<Array<Element<Node>>>;
+export function findElement(frame: Context, selector: Selector, parent?: undefined | Element<Node>): Promise<null | Element<HTMLElement | SVGElement>>;
+export function findElements(frame: Context, selector: Selector, parent?: undefined | Element<Node>): Promise<Array<Element<HTMLElement | SVGElement>>>;
 export function setElementText(frame: Context, element: Selector | Element<Node>, text: string): Promise<void>;
 export function getViewportSize(page: Driver): Promise<{ width: number; height: number; }>;
 export function setViewportSize(page: Driver, size: { width: number; height: number; }): Promise<void>;
@@ -28,7 +28,8 @@ export function hover(frame: Context, element: Selector | Element<Node>): Promis
 export function scrollIntoView(frame: Context, element: Selector | Element<Node>, align: boolean): 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').Page & { __applitoolsBrand?: never; };
-export type Context = import('playwright').Frame & { __applitoolsBrand?: never; };
-export type Element<T = Node> = import('playwright').ElementHandle<T> & { __applitoolsBrand?: never; };
-export type Selector = (string | import('playwright').Locator) & { __applitoolsBrand?: never; };
+export type Driver = import('playwright').Page & { __applitoolsBrand?: undefined; };
+export type Context = import('playwright').Frame & { __applitoolsBrand?: undefined; };
+export type Element<T = Node> = import('playwright').ElementHandle<T> & { __applitoolsBrand?: undefined; };
+export type Selector = (string | import('playwright').Locator) & { __applitoolsBrand?: undefined; };
+export type SpecType = { driver: Driver; context: Context; element: Element<Node>; selector: Selector; };