@serenity-js/playwright 3.0.0-rc.20

package/lib/screenplay/models/PlaywrightPageElement.js

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightPageElement = void 0;
+const core_1 = require("@serenity-js/core");
+const web_1 = require("@serenity-js/web");
+const scripts = require("@serenity-js/web/lib/scripts");
+const tiny_types_1 = require("tiny-types");
+class PlaywrightPageElement extends web_1.PageElement {
+    of(parent) {
+        return new PlaywrightPageElement(this.locator.of(parent.locator));
+    }
+    async enterValue(value) {
+        const text = [].concat(value).join('');
+        const element = await this.nativeElement();
+        return element.fill(text);
+    }
+    async clearValue() {
+        try {
+            const element = await this.nativeElement();
+            await element.fill('');
+        }
+        catch (error) {
+            throw new core_1.LogicError(`The input field doesn't seem to have a 'value' attribute that could be cleared.`, error);
+        }
+    }
+    async click() {
+        const element = await this.nativeElement();
+        return element.click();
+    }
+    async doubleClick() {
+        const element = await this.nativeElement();
+        return element.dblclick();
+    }
+    async scrollIntoView() {
+        const element = await this.nativeElement();
+        return element.scrollIntoViewIfNeeded();
+    }
+    async hoverOver() {
+        const element = await this.nativeElement();
+        return element.hover();
+    }
+    async rightClick() {
+        const element = await this.nativeElement();
+        return element.click({ button: 'right' });
+    }
+    async selectOptions(...options) {
+        const element = await this.nativeElement();
+        const optionsToSelect = options.map(option => ({
+            value: option.value,
+            label: option.label,
+        }));
+        await element.selectOption(optionsToSelect);
+    }
+    async selectedOptions() {
+        const element = await this.nativeElement();
+        const options = await element.$$eval('option', 
+        /* istanbul ignore next */
+        (optionNodes) => optionNodes.map((optionNode) => {
+            return {
+                selected: optionNode.selected,
+                disabled: optionNode.disabled,
+                label: optionNode.label,
+                value: optionNode.value,
+            };
+        }));
+        return options.map(option => new web_1.SelectOption(option.label, option.value, option.selected, option.disabled));
+    }
+    async attribute(name) {
+        const element = await this.nativeElement();
+        return element.getAttribute(name);
+    }
+    async text() {
+        const element = await this.nativeElement();
+        return element.innerText(); // eslint-disable-line unicorn/prefer-dom-node-text-content
+    }
+    async value() {
+        const element = await this.nativeElement();
+        return element.inputValue();
+    }
+    async switchTo() {
+        try {
+            const element = await this.nativeElement();
+            const frame = await element.contentFrame();
+            if (frame) {
+                const locator = this.locator;
+                await locator.switchToFrame(element);
+                return {
+                    switchBack: async () => {
+                        await locator.switchToParentFrame();
+                    }
+                };
+            }
+            const previouslyFocusedElement = await element.evaluateHandle(
+            /* istanbul ignore next */
+            (domNode) => {
+                const currentlyFocusedElement = document.activeElement;
+                domNode.focus();
+                return currentlyFocusedElement;
+            });
+            return new PreviouslyFocusedElementSwitcher(previouslyFocusedElement);
+        }
+        catch (error) {
+            throw new core_1.LogicError(`Couldn't switch to page element located ${this.locator}`, error);
+        }
+    }
+    async isActive() {
+        try {
+            const element = await this.nativeElement();
+            return element.evaluate(
+            /* istanbul ignore next */
+            domNode => domNode === document.activeElement);
+        }
+        catch {
+            return false;
+        }
+    }
+    async isClickable() {
+        try {
+            const element = await this.nativeElement();
+            await element.click({ trial: true });
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    async isEnabled() {
+        try {
+            const element = await this.nativeElement();
+            return element.isEnabled();
+        }
+        catch {
+            return false;
+        }
+    }
+    async isPresent() {
+        try {
+            const element = await this.nativeElement();
+            return element !== null;
+        }
+        catch (error) {
+            if (error.name === 'TimeoutError') {
+                return false;
+            }
+            throw error;
+        }
+    }
+    async isSelected() {
+        try {
+            const element = await this.nativeElement();
+            // works for <option />
+            const selected = await element.getAttribute('selected');
+            if (selected !== null) {
+                return true;
+            }
+            // works only for checkboxes and radio buttons, throws for other elements
+            return await element.isChecked();
+        }
+        catch {
+            return false;
+        }
+    }
+    async isVisible() {
+        try {
+            const element = await this.nativeElement();
+            const isVisible = await element.isVisible();
+            if (!isVisible) {
+                return false;
+            }
+            return await element.evaluate(scripts.isVisible);
+        }
+        catch {
+            return false;
+        }
+    }
+}
+exports.PlaywrightPageElement = PlaywrightPageElement;
+/**
+ * @private
+ */
+class PreviouslyFocusedElementSwitcher {
+    constructor(node) {
+        this.node = node;
+        (0, tiny_types_1.ensure)('DOM element', node, (0, tiny_types_1.isDefined)());
+    }
+    async switchBack() {
+        await this.node.evaluate(
+        /* istanbul ignore next */
+        (domNode) => {
+            domNode.focus();
+        }, this.node);
+    }
+}
+//# sourceMappingURL=PlaywrightPageElement.js.map

package/lib/screenplay/models/PlaywrightPageElement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightPageElement.js","sourceRoot":"","sources":["../../../src/screenplay/models/PlaywrightPageElement.ts"],"names":[],"mappings":";;;AAAA,4CAA+C;AAC/C,0CAA+E;AAC/E,wDAAwD;AAExD,2CAA+C;AAI/C,MAAa,qBAAsB,SAAQ,iBAAqC;IAC5E,EAAE,CAAC,MAA6C;QAC5C,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAA+C;QAC5D,MAAM,IAAI,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEvC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,UAAU;QACZ,IAAI;YACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3C,MAAM,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SAC1B;QACD,OAAM,KAAK,EAAE;YACT,MAAM,IAAI,iBAAU,CAAC,iFAAiF,EAAE,KAAK,CAAC,CAAC;SAClH;IACL,CAAC;IAED,KAAK,CAAC,KAAK;QACP,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,OAAO,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,WAAW;QACb,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,cAAc;QAChB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,SAAS;QACX,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,OAAO,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,UAAU;QACZ,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,GAAG,OAA4B;QAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAE3C,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CACzC,CAAC;YACG,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,KAAK,EAAE,MAAM,CAAC,KAAK;SACtB,CAAC,CACL,CAAC;QAEF,MAAM,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,eAAe;QACjB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAE3C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAChC,QAAQ;QACR,0BAA0B;QAC1B,CAAC,WAAqC,EAAE,EAAE,CACtC,WAAW,CAAC,GAAG,CAAC,CAAC,UAA6B,EAAE,EAAE;YAC9C,OAAO;gBACH,QAAQ,EAAI,UAAU,CAAC,QAAQ;gBAC/B,QAAQ,EAAI,UAAU,CAAC,QAAQ;gBAC/B,KAAK,EAAO,UAAU,CAAC,KAAK;gBAC5B,KAAK,EAAO,UAAU,CAAC,KAAK;aAC/B,CAAA;QACL,CAAC,CAAC,CACT,CAAC;QAEF,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CACxB,IAAI,kBAAY,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CACjF,CAAC;IACN,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAY;QACxB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,IAAI;QACN,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,OAAO,CAAC,SAAS,EAAE,CAAC,CAAqB,2DAA2D;IAC/G,CAAC;IAED,KAAK,CAAC,KAAK;QACP,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,OAAO,CAAC,UAAU,EAAE,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,QAAQ;QACV,IAAI;YACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAE3C,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,YAAY,EAAE,CAAC;YAE3C,IAAI,KAAK,EAAE;gBACP,MAAM,OAAO,GAAI,IAAI,CAAC,OAA6B,CAAC;gBAEpD,MAAM,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBAErC,OAAO;oBACH,UAAU,EAAE,KAAK,IAAmB,EAAE;wBAClC,MAAM,OAAO,CAAC,mBAAmB,EAAE,CAAC;oBACxC,CAAC;iBACJ,CAAA;aACJ;YAED,MAAM,wBAAwB,GAAG,MAAM,OAAO,CAAC,cAAc;YACzD,0BAA0B;YAC1B,CAAC,OAAoB,EAAE,EAAE;gBACrB,MAAM,uBAAuB,GAAG,QAAQ,CAAC,aAAa,CAAC;gBACvD,OAAO,CAAC,KAAK,EAAE,CAAC;gBAChB,OAAO,uBAAuB,CAAC;YACnC,CAAC,CACJ,CAAC;YAEF,OAAO,IAAI,gCAAgC,CAAC,wBAAwB,CAAC,CAAC;SACzE;QAAC,OAAM,KAAK,EAAE;YACX,MAAM,IAAI,iBAAU,CAAC,2CAA4C,IAAI,CAAC,OAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;SAC5F;IACL,CAAC;IAED,KAAK,CAAC,QAAQ;QACV,IAAI;YACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3C,OAAO,OAAO,CAAC,QAAQ;YACnB,0BAA0B;YAC1B,OAAO,CAAC,EAAE,CAAC,OAAO,KAAK,QAAQ,CAAC,aAAa,CAChD,CAAC;SACL;QAAC,MAAM;YACJ,OAAO,KAAK,CAAC;SAChB;IACL,CAAC;IAED,KAAK,CAAC,WAAW;QACb,IAAI;YACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3C,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAErC,OAAO,IAAI,CAAC;SACf;QAAC,MAAM;YACJ,OAAO,KAAK,CAAC;SAChB;IACL,CAAC;IAED,KAAK,CAAC,SAAS;QACX,IAAI;YACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3C,OAAO,OAAO,CAAC,SAAS,EAAE,CAAC;SAC9B;QAAC,MAAM;YACJ,OAAO,KAAK,CAAC;SAChB;IACL,CAAC;IAED,KAAK,CAAC,SAAS;QACX,IAAI;YACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3C,OAAO,OAAO,KAAK,IAAI,CAAC;SAC3B;QACD,OAAM,KAAK,EAAE;YACT,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE;gBAC/B,OAAO,KAAK,CAAC;aAChB;YACD,MAAM,KAAK,CAAC;SACf;IACL,CAAC;IAED,KAAK,CAAC,UAAU;QAEZ,IAAI;YACA,MAAM,OAAO,GAA6B,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAErE,uBAAuB;YACvB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YACxD,IAAI,QAAQ,KAAK,IAAI,EAAE;gBACnB,OAAO,IAAI,CAAC;aACf;YAED,yEAAyE;YACzE,OAAO,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;SACpC;QAAC,MAAM;YACJ,OAAO,KAAK,CAAC;SAChB;IACL,CAAC;IAED,KAAK,CAAC,SAAS;QACX,IAAI;YACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAE3C,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAC5C,IAAI,CAAE,SAAS,EAAE;gBACb,OAAO,KAAK,CAAC;aAChB;YAED,OAAO,MAAM,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;SACpD;QAAC,MAAM;YACJ,OAAO,KAAK,CAAC;SAChB;IACL,CAAC;CACJ;AA/MD,sDA+MC;AAED;;GAEG;AACH,MAAM,gCAAgC;IAClC,YAA6B,IAAyB;QAAzB,SAAI,GAAJ,IAAI,CAAqB;QAClD,IAAA,mBAAM,EAAC,aAAa,EAAE,IAAI,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,UAAU;QACZ,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ;QACpB,0BAA0B;QAC1B,CAAC,OAAoB,EAAE,EAAE;YACrB,OAAO,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC,EACD,IAAI,CAAC,IAAI,CACZ,CAAC;IACN,CAAC;CACJ"}

package/lib/screenplay/models/index.d.ts

@@ -0,0 +1,5 @@
+export * from './locators';
+export * from './PlaywrightBrowsingSession';
+export * from './PlaywrightCookie';
+export * from './PlaywrightPage';
+export * from './PlaywrightPageElement';

package/lib/screenplay/models/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./locators"), exports);
+__exportStar(require("./PlaywrightBrowsingSession"), exports);
+__exportStar(require("./PlaywrightCookie"), exports);
+__exportStar(require("./PlaywrightPage"), exports);
+__exportStar(require("./PlaywrightPageElement"), exports);
+//# sourceMappingURL=index.js.map

package/lib/screenplay/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,8DAA4C;AAC5C,qDAAmC;AACnC,mDAAiC;AACjC,0DAAwC"}

package/lib/screenplay/models/locators/PlaywrightLocator.d.ts

@@ -0,0 +1,13 @@
+import { Locator, PageElement, RootLocator, Selector } from '@serenity-js/web';
+import * as playwright from 'playwright';
+import { PlaywrightRootLocator } from './PlaywrightRootLocator';
+export declare class PlaywrightLocator extends Locator<playwright.ElementHandle, string> {
+    constructor(parent: RootLocator<playwright.ElementHandle>, selector: Selector);
+    protected nativeSelector(): string;
+    nativeElement(): Promise<playwright.ElementHandle>;
+    allNativeElements(): Promise<Array<playwright.ElementHandle>>;
+    of(parent: PlaywrightRootLocator): Locator<playwright.ElementHandle, string>;
+    locate(child: PlaywrightLocator): Locator<playwright.ElementHandle, string>;
+    element(): PageElement<playwright.ElementHandle>;
+    allElements(): Promise<Array<PageElement<playwright.ElementHandle>>>;
+}

package/lib/screenplay/models/locators/PlaywrightLocator.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightLocator = void 0;
+const core_1 = require("@serenity-js/core");
+const web_1 = require("@serenity-js/web");
+const PlaywrightPageElement_1 = require("../PlaywrightPageElement");
+class PlaywrightLocator extends web_1.Locator {
+    constructor(parent, selector) {
+        super(parent, selector);
+    }
+    // todo: refactor; replace with a map and some more generic lookup mechanism
+    nativeSelector() {
+        if (this.selector instanceof web_1.ByCss) {
+            return `:light(${this.selector.value})`;
+        }
+        if (this.selector instanceof web_1.ByDeepCss) {
+            return this.selector.value;
+        }
+        if (this.selector instanceof web_1.ByCssContainingText) {
+            return `:light(${this.selector.value}):has-text("${this.selector.text}")`;
+        }
+        if (this.selector instanceof web_1.ById) {
+            return `id=${this.selector.value}`;
+        }
+        if (this.selector instanceof web_1.ByTagName) {
+            return `:light(${this.selector.value})`;
+        }
+        if (this.selector instanceof web_1.ByXPath) {
+            return `xpath=${this.selector.value}`;
+        }
+        throw new core_1.LogicError((0, core_1.f) `${this.selector} is not supported by ${this.constructor.name}`);
+    }
+    async nativeElement() {
+        const parent = await this.parent.nativeElement();
+        if (!parent) {
+            throw new core_1.LogicError(`Couldn't find parent element ${this.parent} of ${this}`);
+        }
+        return parent.waitForSelector(this.nativeSelector(), { state: 'attached' });
+    }
+    async allNativeElements() {
+        const parent = await this.parent.nativeElement();
+        if (!parent) {
+            return;
+        }
+        return parent.$$(this.nativeSelector());
+    }
+    of(parent) {
+        return new PlaywrightLocator(parent, this.selector);
+    }
+    locate(child) {
+        return new PlaywrightLocator(this, child.selector);
+    }
+    element() {
+        return new PlaywrightPageElement_1.PlaywrightPageElement(this);
+    }
+    async allElements() {
+        const elements = await this.allNativeElements();
+        return elements.map(childElement => new PlaywrightPageElement_1.PlaywrightPageElement(new ExistingElementLocator(this.parent, this.selector, childElement)));
+    }
+}
+exports.PlaywrightLocator = PlaywrightLocator;
+/**
+ * @private
+ */
+class ExistingElementLocator extends PlaywrightLocator {
+    constructor(parent, selector, existingNativeElement) {
+        super(parent, selector);
+        this.existingNativeElement = existingNativeElement;
+    }
+    async nativeElement() {
+        return this.existingNativeElement;
+    }
+    async allNativeElements() {
+        return [this.existingNativeElement];
+    }
+}
+//# sourceMappingURL=PlaywrightLocator.js.map

package/lib/screenplay/models/locators/PlaywrightLocator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightLocator.js","sourceRoot":"","sources":["../../../../src/screenplay/models/locators/PlaywrightLocator.ts"],"names":[],"mappings":";;;AAAA,4CAAkD;AAClD,0CAAgJ;AAGhJ,oEAAiE;AAGjE,MAAa,iBAAkB,SAAQ,aAAyC;IAE5E,YACI,MAA6C,EAC7C,QAAkB;QAElB,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,4EAA4E;IAClE,cAAc;QACpB,IAAI,IAAI,CAAC,QAAQ,YAAY,WAAK,EAAE;YAChC,OAAO,UAAW,IAAI,CAAC,QAAQ,CAAC,KAAM,GAAG,CAAC;SAC7C;QAED,IAAI,IAAI,CAAC,QAAQ,YAAY,eAAS,EAAE;YACpC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;SAC9B;QAED,IAAI,IAAI,CAAC,QAAQ,YAAY,yBAAmB,EAAE;YAC9C,OAAO,UAAW,IAAI,CAAC,QAAQ,CAAC,KAAM,eAAgB,IAAI,CAAC,QAAQ,CAAC,IAAK,IAAI,CAAC;SACjF;QAED,IAAI,IAAI,CAAC,QAAQ,YAAY,UAAI,EAAE;YAC/B,OAAO,MAAO,IAAI,CAAC,QAAQ,CAAC,KAAM,EAAE,CAAC;SACxC;QAED,IAAI,IAAI,CAAC,QAAQ,YAAY,eAAS,EAAE;YACpC,OAAO,UAAW,IAAI,CAAC,QAAQ,CAAC,KAAM,GAAG,CAAC;SAC7C;QAED,IAAI,IAAI,CAAC,QAAQ,YAAY,aAAO,EAAE;YAClC,OAAO,SAAU,IAAI,CAAC,QAAQ,CAAC,KAAM,EAAE,CAAC;SAC3C;QAED,MAAM,IAAI,iBAAU,CAAC,IAAA,QAAC,EAAA,GAAI,IAAI,CAAC,QAAS,wBAAyB,IAAI,CAAC,WAAW,CAAC,IAAK,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED,KAAK,CAAC,aAAa;QAEf,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QAEjD,IAAI,CAAE,MAAM,EAAE;YACV,MAAM,IAAI,iBAAU,CAAC,gCAAiC,IAAI,CAAC,MAAO,OAAQ,IAAK,EAAE,CAAC,CAAC;SACtF;QAED,OAAO,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,KAAK,CAAC,iBAAiB;QACnB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QAEjD,IAAI,CAAE,MAAM,EAAE;YACV,OAAO;SACV;QAED,OAAO,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,EAAE,CAAC,MAA6B;QAC5B,OAAO,IAAI,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,CAAC,KAAwB;QAC3B,OAAO,IAAI,iBAAiB,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACvD,CAAC;IAED,OAAO;QACH,OAAO,IAAI,6CAAqB,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,WAAW;QACb,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAEhD,OAAO,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAC/B,IAAI,6CAAqB,CACrB,IAAI,sBAAsB,CACtB,IAAI,CAAC,MAA+B,EACpC,IAAI,CAAC,QAAQ,EACb,YAAY,CACf,CACJ,CACJ,CAAC;IACN,CAAC;CACJ;AApFD,8CAoFC;AAED;;GAEG;AACH,MAAM,sBAAuB,SAAQ,iBAAiB;IAClD,YACI,MAA6C,EAC7C,QAAkB,EACD,qBAA+C;QAEhE,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAFP,0BAAqB,GAArB,qBAAqB,CAA0B;IAGpE,CAAC;IAED,KAAK,CAAC,aAAa;QACf,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,iBAAiB;QACnB,OAAO,CAAE,IAAI,CAAC,qBAAqB,CAAE,CAAC;IAC1C,CAAC;CACJ"}

package/lib/screenplay/models/locators/PlaywrightRootLocator.d.ts

@@ -0,0 +1,11 @@
+import { RootLocator } from '@serenity-js/web';
+import * as playwright from 'playwright';
+export declare class PlaywrightRootLocator extends RootLocator<playwright.ElementHandle> {
+    private readonly page;
+    private currentFrame;
+    constructor(page: playwright.Page);
+    nativeElement(): Promise<Pick<playwright.ElementHandle, '$' | '$$' | 'waitForSelector'>>;
+    switchToFrame(frame: playwright.ElementHandle): Promise<void>;
+    switchToParentFrame(): Promise<void>;
+    switchToMainFrame(): Promise<void>;
+}

package/lib/screenplay/models/locators/PlaywrightRootLocator.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightRootLocator = void 0;
+const web_1 = require("@serenity-js/web");
+const tiny_types_1 = require("tiny-types");
+class PlaywrightRootLocator extends web_1.RootLocator {
+    constructor(page) {
+        super();
+        this.page = page;
+        this.currentFrame = this.page.mainFrame();
+    }
+    async nativeElement() {
+        return this.currentFrame;
+    }
+    async switchToFrame(frame) {
+        this.currentFrame = (0, tiny_types_1.ensure)('frame', await frame.contentFrame(), (0, tiny_types_1.isDefined)());
+    }
+    async switchToParentFrame() {
+        this.currentFrame = (0, tiny_types_1.ensure)('parent frame', this.currentFrame.parentFrame(), (0, tiny_types_1.isDefined)());
+    }
+    async switchToMainFrame() {
+        this.currentFrame = this.page.mainFrame();
+    }
+}
+exports.PlaywrightRootLocator = PlaywrightRootLocator;
+//# sourceMappingURL=PlaywrightRootLocator.js.map

package/lib/screenplay/models/locators/PlaywrightRootLocator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightRootLocator.js","sourceRoot":"","sources":["../../../../src/screenplay/models/locators/PlaywrightRootLocator.ts"],"names":[],"mappings":";;;AAAA,0CAA+C;AAE/C,2CAA+C;AAE/C,MAAa,qBAAsB,SAAQ,iBAAqC;IAI5E,YAA6B,IAAqB;QAC9C,KAAK,EAAE,CAAC;QADiB,SAAI,GAAJ,IAAI,CAAiB;QAE9C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,aAAa;QACf,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,KAA+B;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAA,mBAAM,EAAC,OAAO,EAAE,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;IACjF,CAAC;IAED,KAAK,CAAC,mBAAmB;QACrB,IAAI,CAAC,YAAY,GAAG,IAAA,mBAAM,EAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;IAC7F,CAAC;IAED,KAAK,CAAC,iBAAiB;QACnB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;IAC9C,CAAC;CACJ;AAxBD,sDAwBC"}

package/lib/screenplay/models/locators/index.d.ts

@@ -0,0 +1,2 @@
+export * from './PlaywrightLocator';
+export * from './PlaywrightRootLocator';

package/lib/screenplay/models/locators/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./PlaywrightLocator"), exports);
+__exportStar(require("./PlaywrightRootLocator"), exports);
+//# sourceMappingURL=index.js.map

package/lib/screenplay/models/locators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/screenplay/models/locators/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,0DAAwC"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@serenity-js/playwright",
+  "version": "3.0.0-rc.20",
+  "description": "Serenity/JS Screenplay Pattern library for Playwright",
+  "author": {
+    "name": "Jan Molak",
+    "email": "jan.molak@smartcodeltd.co.uk",
+    "url": "https://janmolak.com"
+  },
+  "funding": {
+    "url": "https://github.com/sponsors/serenity-js"
+  },
+  "homepage": "https://serenity-js.org",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "keywords": [
+    "serenity-js",
+    "playwright",
+    "tdd",
+    "bdd",
+    "test",
+    "testing"
+  ],
+  "scripts": {
+    "clean": "rimraf .nyc_output lib target",
+    "lint": "eslint --ext ts --config ../../.eslintrc.yml .",
+    "lint:fix": "npm run lint -- --fix",
+    "~test": "nyc mocha --config ../../.mocharc.yml 'spec/**/*.spec.*'",
+    "compile": "tsc --project tsconfig.json",
+    "site": "esdoc -c .esdoc.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/serenity-js/serenity-js.git",
+    "directory": "packages/playwright"
+  },
+  "bugs": {
+    "url": "https://github.com/serenity-js/serenity-js/issues"
+  },
+  "engines": {
+    "node": "^14 || ^16",
+    "npm": "^6 || ^7 || ^8"
+  },
+  "dependencies": {
+    "@serenity-js/core": "3.0.0-rc.20",
+    "@serenity-js/web": "3.0.0-rc.20",
+    "tiny-types": "^1.18.4"
+  },
+  "peerDependencies": {
+    "playwright-core": "^1.23.1"
+  },
+  "devDependencies": {
+    "@documentation/esdoc-template": "3.0.0",
+    "@integration/testing-tools": "3.0.0",
+    "@types/chai": "^4.3.1",
+    "@types/mocha": "^9.1.1",
+    "mocha": "^10.0.0",
+    "nyc": "^15.1.0",
+    "playwright-core": "^1.23.1",
+    "ts-node": "10.8.0",
+    "typescript": "^4.7.4"
+  },
+  "gitHead": "105a84c6ab140c06e38d328274473a32b290080d"
+}

package/src/PlaywrightOptions.ts

@@ -0,0 +1,43 @@
+import * as playwright from 'playwright-core';
+
+/**
+ * @desc
+ *  Playwright-specific options used to configure the ability to {@link BrowseTheWebWithPlaywright}
+ *
+ * @extends {playwright~BrowserContextOptions}
+ */
+export interface PlaywrightOptions extends playwright.BrowserContextOptions {
+    /**
+     * @desc
+     *  This setting will change the default maximum navigation time for the browser context used by {@link BrowseTheWebWithPlaywright}
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-navigation-timeout
+     *
+     * @type {?number}
+     */
+    defaultNavigationTimeout?: number;
+
+    /**
+     * @desc
+     *  When to consider navigation operation succeeded, defaults to `load`. Events can be either:
+     *  - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
+     *  - `'load'` - consider operation to be finished when the `load` event is fired.
+     *  - `'networkidle'` - consider operation to be finished when there are no network connections for at least `500` ms.
+     *  - `'commit'` - consider operation to be finished when network response is received and the document started loading.
+     *
+     * @see https://playwright.dev/docs/api/class-page#page-goto-option-wait-until
+     *
+     * @type {?string}
+     */
+    defaultNavigationWaitUntil?: 'load'|'domcontentloaded'|'networkidle'|'commit';
+
+    /**
+     * @desc
+     *  This setting will change the default maximum time for all Playwright methods accepting `timeout` option.
+     *
+     * @see https://playwright.dev/docs/api/class-page#page-set-default-timeout
+     *
+     * @type {?number}
+     */
+    defaultTimeout?: number;
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './PlaywrightOptions';
+export * from './screenplay';

package/src/screenplay/abilities/BrowseTheWebWithPlaywright.ts

@@ -0,0 +1,89 @@
+import { Discardable } from '@serenity-js/core';
+import { BrowserCapabilities, BrowseTheWeb } from '@serenity-js/web';
+import * as playwright from 'playwright-core';
+
+import { PlaywrightOptions } from '../../PlaywrightOptions';
+import { PlaywrightBrowsingSession } from '../models';
+
+/**
+ * @desc
+ *  An {@link @serenity-js/core/lib/screenplay~Ability} that enables the {@link Actor}
+ *  to interact with web front-ends using [Playwright](https://playwright.dev/).
+ *
+ * @example <caption>Using a Playwright browser</caption>
+ *  import { actorCalled } from '@serenity-js/core';
+ *  import { BrowseTheWebWithPlaywright } from '@serenity-js/playwright';
+ *  import { By, Navigate, PageElement } from '@serenity-js/web';
+ *  import { Ensure, equals } from '@serenity-js/assertions';
+ *  import { Browser, chromium } from 'playwright';
+ *
+ *  const HomePage = {
+ *      title: PageElement.located(By.css('h1')).describedAs('title')
+ *  }
+ *
+ *  const browser = await chromium.launch({ headless: true });
+ *
+ *  await actorCalled('Wendy')
+ *      .whoCan(BrowseTheWebWithPlaywright.using(browser))
+ *      .attemptsTo(
+ *          Navigate.to(`https://serenity-js.org`),
+ *          Ensure.that(Text.of(HomePage.title), equals('Serenity/JS')),
+ *      );
+ *
+ * @extends {@serenity-js/web/lib/screenplay/abilities~BrowseTheWeb}
+ *
+ * @public
+ *
+ * @see https://playwright.dev/
+ * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
+ */
+export class BrowseTheWebWithPlaywright extends BrowseTheWeb<playwright.ElementHandle> implements Discardable {
+
+    /**
+     * @param {playwright~Browser} browser
+     * @param {PlaywrightOptions} options
+     * @returns {BrowseTheWebWithPlaywright}
+     */
+    static using(browser: playwright.Browser, options?: PlaywrightOptions): BrowseTheWebWithPlaywright {
+        return new BrowseTheWebWithPlaywright(browser, options);
+    }
+
+    /**
+     * @param {playwright~Browser} browser
+     * @param {PlaywrightOptions} browserContextOptions
+     */
+    protected constructor(protected readonly browser: playwright.Browser, browserContextOptions: PlaywrightOptions = {}) {
+        super(new PlaywrightBrowsingSession(browser, browserContextOptions));
+    }
+
+    /**
+     * @desc
+     *  Automatically closes any open {@link Page}s when the {@link SceneFinishes}
+     *
+     * @see {@link PlaywrightBrowsingSession#closeAllPages}
+     * @see {@link @serenity-js/core/lib/screenplay/abilities~Discardable}
+     */
+    async discard(): Promise<void> {
+        await this.session.closeAllPages();
+    }
+
+    /**
+     * @desc
+     *  Returns basic meta-data about the browser associated with this ability.
+     *
+     *  **Please note** that since Playwright does not expose information about the operating system
+     *  the tests are running on, **Serenity/JS assumes that the tests are running locally**
+     *  and therefore returns the value of Node.js `process.platform` for `platformName`.
+     *
+     * @returns {Promise<BrowserCapabilities>}
+     *
+     * @see {@link @serenity-js/web/lib/screenplay/abilities~BrowserCapabilities}
+     */
+    async browserCapabilities(): Promise<BrowserCapabilities> {
+        return {
+            browserName: (this.browser as any)._initializer.name,   // todo: raise a PR to Playwright to expose this information
+            platformName: process.platform,                         // todo: get the actual platform from Playwright
+            browserVersion: this.browser.version()
+        }
+    }
+}

package/src/screenplay/abilities/index.ts

@@ -0,0 +1 @@
+export * from './BrowseTheWebWithPlaywright';

package/src/screenplay/index.ts

@@ -0,0 +1,2 @@
+export * from './abilities';
+export * from './models';