@serenity-js/playwright 3.0.0-rc.20

package/lib/screenplay/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("./abilities"), exports);
+__exportStar(require("./models"), exports);
+//# sourceMappingURL=index.js.map

package/lib/screenplay/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/screenplay/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,2CAAyB"}

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

@@ -0,0 +1,25 @@
+import { BrowsingSession, Cookie, CookieData } from '@serenity-js/web';
+import * as playwright from 'playwright-core';
+import { PlaywrightOptions } from '../../PlaywrightOptions';
+import { PlaywrightPage } from '../models';
+/**
+ * @desc
+ *  Playwright-specific implementation of the {@link @serenity-js/web/lib/screenplay/models~BrowsingSession}.
+ *
+ * @see {@link @serenity-js/web/lib/screenplay/models~BrowsingSession}
+ */
+export declare class PlaywrightBrowsingSession extends BrowsingSession<PlaywrightPage> {
+    protected readonly browser: playwright.Browser;
+    protected readonly browserContextOptions: PlaywrightOptions;
+    private currentPlaywrightBrowserContext;
+    constructor(browser: playwright.Browser, browserContextOptions: PlaywrightOptions);
+    protected registerCurrentPage(): Promise<PlaywrightPage>;
+    /**
+     * @override
+     */
+    closeAllPages(): Promise<void>;
+    cookie(name: string): Promise<Cookie>;
+    setCookie(cookie: CookieData): Promise<void>;
+    deleteAllCookies(): Promise<void>;
+    private browserContext;
+}

package/lib/screenplay/models/PlaywrightBrowsingSession.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightBrowsingSession = void 0;
+const model_1 = require("@serenity-js/core/lib/model");
+const web_1 = require("@serenity-js/web");
+const models_1 = require("../models");
+/**
+ * @desc
+ *  Playwright-specific implementation of the {@link @serenity-js/web/lib/screenplay/models~BrowsingSession}.
+ *
+ * @see {@link @serenity-js/web/lib/screenplay/models~BrowsingSession}
+ */
+class PlaywrightBrowsingSession extends web_1.BrowsingSession {
+    constructor(browser, browserContextOptions) {
+        super();
+        this.browser = browser;
+        this.browserContextOptions = browserContextOptions;
+    }
+    async registerCurrentPage() {
+        const context = await this.browserContext();
+        await context.newPage();
+        // calling context.newPage() triggers a callback registered via browserContext(),
+        // which wraps playwright.Page in PlaywrightPage and adds it to the list of pages
+        // returned by this.allPages()
+        const allPages = await this.allPages();
+        return allPages[allPages.length - 1];
+    }
+    /**
+     * @override
+     */
+    async closeAllPages() {
+        await super.closeAllPages();
+        const context = await this.browserContext();
+        await context.close();
+    }
+    async cookie(name) {
+        const context = await this.browserContext();
+        return new models_1.PlaywrightCookie(context, name);
+    }
+    async setCookie(cookie) {
+        const context = await this.browserContext();
+        await context.addCookies([cookie]);
+    }
+    async deleteAllCookies() {
+        const context = await this.browserContext();
+        await context.clearCookies();
+    }
+    async browserContext() {
+        var _a, _b, _c, _d;
+        if (!this.currentPlaywrightBrowserContext) {
+            this.currentPlaywrightBrowserContext = await this.browser.newContext(this.browserContextOptions);
+            this.currentPlaywrightBrowserContext.on('page', async (page) => {
+                await page.waitForLoadState();
+                this.register(new models_1.PlaywrightPage(this, page, this.browserContextOptions, model_1.CorrelationId.create()));
+            });
+            if ((_a = this.browserContextOptions) === null || _a === void 0 ? void 0 : _a.defaultNavigationTimeout) {
+                this.currentPlaywrightBrowserContext.setDefaultNavigationTimeout((_b = this.browserContextOptions) === null || _b === void 0 ? void 0 : _b.defaultNavigationTimeout);
+            }
+            if ((_c = this.browserContextOptions) === null || _c === void 0 ? void 0 : _c.defaultTimeout) {
+                this.currentPlaywrightBrowserContext.setDefaultTimeout((_d = this.browserContextOptions) === null || _d === void 0 ? void 0 : _d.defaultTimeout);
+            }
+        }
+        return this.currentPlaywrightBrowserContext;
+    }
+}
+exports.PlaywrightBrowsingSession = PlaywrightBrowsingSession;
+//# sourceMappingURL=PlaywrightBrowsingSession.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightBrowsingSession.js","sourceRoot":"","sources":["../../../src/screenplay/models/PlaywrightBrowsingSession.ts"],"names":[],"mappings":";;;AAAA,uDAA4D;AAC5D,0CAAuE;AAIvE,sCAA6D;AAE7D;;;;;GAKG;AACH,MAAa,yBAA0B,SAAQ,qBAA+B;IAI1E,YACuB,OAA2B,EAC3B,qBAAwC;QAE3D,KAAK,EAAE,CAAC;QAHW,YAAO,GAAP,OAAO,CAAoB;QAC3B,0BAAqB,GAArB,qBAAqB,CAAmB;IAG/D,CAAC;IAES,KAAK,CAAC,mBAAmB;QAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAE5C,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;QAExB,iFAAiF;QACjF,iFAAiF;QACjF,8BAA8B;QAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAA;QAEtC,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAC,CAAC,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACf,MAAM,KAAK,CAAC,aAAa,EAAE,CAAC;QAE5B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5C,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAY;QACrB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5C,OAAO,IAAI,yBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,MAAkB;QAC9B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAE5C,MAAM,OAAO,CAAC,UAAU,CAAC,CAAE,MAAM,CAAE,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,gBAAgB;QAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAA;QAC3C,MAAM,OAAO,CAAC,YAAY,EAAE,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,cAAc;;QACxB,IAAI,CAAE,IAAI,CAAC,+BAA+B,EAAE;YACxC,IAAI,CAAC,+BAA+B,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAEjG,IAAI,CAAC,+BAA+B,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE;gBACzD,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAE9B,IAAI,CAAC,QAAQ,CACT,IAAI,uBAAc,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,qBAAqB,EAAE,qBAAa,CAAC,MAAM,EAAE,CAAC,CACrF,CAAC;YACN,CAAC,CAAC,CAAC;YAEH,IAAI,MAAA,IAAI,CAAC,qBAAqB,0CAAE,wBAAwB,EAAE;gBACtD,IAAI,CAAC,+BAA+B,CAAC,2BAA2B,CAAC,MAAA,IAAI,CAAC,qBAAqB,0CAAE,wBAAwB,CAAC,CAAC;aAC1H;YAED,IAAI,MAAA,IAAI,CAAC,qBAAqB,0CAAE,cAAc,EAAE;gBAC5C,IAAI,CAAC,+BAA+B,CAAC,iBAAiB,CAAC,MAAA,IAAI,CAAC,qBAAqB,0CAAE,cAAc,CAAC,CAAC;aACtG;SACJ;QAED,OAAO,IAAI,CAAC,+BAA+B,CAAC;IAChD,CAAC;CACJ;AA1ED,8DA0EC"}

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

@@ -0,0 +1,8 @@
+import { Cookie, CookieData } from '@serenity-js/web';
+import * as playwright from 'playwright-core';
+export declare class PlaywrightCookie extends Cookie {
+    private readonly context;
+    constructor(context: playwright.BrowserContext, cookieName: string);
+    delete(): Promise<void>;
+    protected read(): Promise<CookieData>;
+}

package/lib/screenplay/models/PlaywrightCookie.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightCookie = void 0;
+const core_1 = require("@serenity-js/core");
+const web_1 = require("@serenity-js/web");
+const tiny_types_1 = require("tiny-types");
+class PlaywrightCookie extends web_1.Cookie {
+    constructor(context, cookieName) {
+        super(cookieName);
+        this.context = context;
+        (0, tiny_types_1.ensure)('context', context, (0, tiny_types_1.isDefined)());
+    }
+    async delete() {
+        // see https://github.com/microsoft/playwright/issues/10143
+        const cookies = await this.context.cookies();
+        await this.context.clearCookies();
+        await this.context.addCookies(cookies.filter(cookie => cookie.name !== this.cookieName));
+    }
+    async read() {
+        const cookies = await this.context.cookies();
+        const found = cookies.find(cookie => cookie.name === this.cookieName);
+        if (!found) {
+            throw new web_1.CookieMissingError(`Cookie '${this.cookieName}' not set`);
+        }
+        return {
+            name: found.name,
+            value: found.value,
+            domain: found.domain,
+            path: found.path,
+            expiry: found.expires !== undefined
+                ? core_1.Timestamp.fromTimestampInSeconds(Math.round(found.expires))
+                : undefined,
+            httpOnly: found.httpOnly,
+            secure: found.secure,
+        };
+    }
+}
+exports.PlaywrightCookie = PlaywrightCookie;
+//# sourceMappingURL=PlaywrightCookie.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightCookie.js","sourceRoot":"","sources":["../../../src/screenplay/models/PlaywrightCookie.ts"],"names":[],"mappings":";;;AAAA,4CAA8C;AAC9C,0CAA0E;AAE1E,2CAA+C;AAE/C,MAAa,gBAAiB,SAAQ,YAAM;IAExC,YACqB,OAAkC,EACnD,UAAkB;QAElB,KAAK,CAAC,UAAU,CAAC,CAAC;QAHD,YAAO,GAAP,OAAO,CAA2B;QAInD,IAAA,mBAAM,EAAC,SAAS,EAAE,OAAO,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,MAAM;QACR,2DAA2D;QAC3D,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAC7C,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;QAClC,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CACzB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,UAAU,CAAC,CAC5D,CAAC;IACN,CAAC;IAES,KAAK,CAAC,IAAI;QAChB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAE7C,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC;QAEtE,IAAI,CAAE,KAAK,EAAE;YACT,MAAM,IAAI,wBAAkB,CAAC,WAAY,IAAI,CAAC,UAAW,WAAW,CAAC,CAAC;SACzE;QAED,OAAO;YACH,IAAI,EAAQ,KAAK,CAAC,IAAI;YACtB,KAAK,EAAO,KAAK,CAAC,KAAK;YACvB,MAAM,EAAM,KAAK,CAAC,MAAM;YACxB,IAAI,EAAQ,KAAK,CAAC,IAAI;YACtB,MAAM,EAAM,KAAK,CAAC,OAAO,KAAK,SAAS;gBACnC,CAAC,CAAC,gBAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC7D,CAAC,CAAC,SAAS;YACf,QAAQ,EAAI,KAAK,CAAC,QAAQ;YAC1B,MAAM,EAAM,KAAK,CAAC,MAAM;SAC3B,CAAA;IACL,CAAC;CACJ;AAxCD,4CAwCC"}

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

@@ -0,0 +1,13 @@
+import { ModalDialogHandler } from '@serenity-js/web';
+import * as playwright from 'playwright-core';
+export declare class PlaywrightModalDialogHandler extends ModalDialogHandler {
+    private readonly page;
+    private readonly defaultHandler;
+    private currentHandler;
+    constructor(page: playwright.Page);
+    acceptNext(): Promise<void>;
+    acceptNextWithValue(text: string | number): Promise<void>;
+    dismissNext(): Promise<void>;
+    reset(): Promise<void>;
+    discard(): Promise<void>;
+}

package/lib/screenplay/models/PlaywrightModalDialogHandler.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightModalDialogHandler = void 0;
+const web_1 = require("@serenity-js/web");
+class PlaywrightModalDialogHandler extends web_1.ModalDialogHandler {
+    constructor(page) {
+        super();
+        this.page = page;
+        this.defaultHandler = async (dialog) => {
+            await dialog.dismiss();
+            return new web_1.DismissedModalDialog(dialog.message());
+        };
+        this.currentHandler = this.defaultHandler;
+        this.page.on('dialog', async (dialog) => {
+            this.modalDialog = await this.currentHandler(dialog);
+        });
+    }
+    async acceptNext() {
+        this.currentHandler = async (dialog) => {
+            await dialog.accept(dialog.defaultValue());
+            return new web_1.AcceptedModalDialog(dialog.message());
+        };
+    }
+    async acceptNextWithValue(text) {
+        this.currentHandler = async (dialog) => {
+            await dialog.accept(String(text));
+            return new web_1.AcceptedModalDialog(dialog.message());
+        };
+    }
+    async dismissNext() {
+        this.currentHandler = async (dialog) => {
+            await dialog.dismiss();
+            return new web_1.DismissedModalDialog(dialog.message());
+        };
+    }
+    async reset() {
+        this.modalDialog = new web_1.AbsentModalDialog();
+        this.currentHandler = this.defaultHandler;
+    }
+    async discard() {
+        this.page.off('dialog', this.currentHandler);
+    }
+}
+exports.PlaywrightModalDialogHandler = PlaywrightModalDialogHandler;
+//# sourceMappingURL=PlaywrightModalDialogHandler.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightModalDialogHandler.js","sourceRoot":"","sources":["../../../src/screenplay/models/PlaywrightModalDialogHandler.ts"],"names":[],"mappings":";;;AAAA,0CAAiI;AAGjI,MAAa,4BAA6B,SAAQ,wBAAkB;IAUhE,YAA6B,IAAqB;QAC9C,KAAK,EAAE,CAAC;QADiB,SAAI,GAAJ,IAAI,CAAiB;QARjC,mBAAc,GAC3B,KAAK,EAAE,MAAyB,EAAE,EAAE;YAChC,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;YACvB,OAAO,IAAI,0BAAoB,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QACtD,CAAC,CAAA;QAOD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE1C,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAyB,EAAE,EAAE;YACvD,IAAI,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,UAAU;QACZ,IAAI,CAAC,cAAc,GAAG,KAAK,EAAE,MAAyB,EAAE,EAAE;YACtD,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;YAC3C,OAAO,IAAI,yBAAmB,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QACrD,CAAC,CAAA;IACL,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,IAAqB;QAC3C,IAAI,CAAC,cAAc,GAAG,KAAK,EAAE,MAAyB,EAAE,EAAE;YACtD,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAClC,OAAO,IAAI,yBAAmB,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QACrD,CAAC,CAAA;IACL,CAAC;IAED,KAAK,CAAC,WAAW;QACb,IAAI,CAAC,cAAc,GAAG,KAAK,EAAE,MAAyB,EAAE,EAAE;YACtD,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;YACvB,OAAO,IAAI,0BAAoB,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QACtD,CAAC,CAAA;IACL,CAAC;IAED,KAAK,CAAC,KAAK;QACP,IAAI,CAAC,WAAW,GAAG,IAAI,uBAAiB,EAAE,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,OAAO;QACT,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACjD,CAAC;CACJ;AAjDD,oEAiDC"}

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

@@ -0,0 +1,58 @@
+/// <reference types="node" />
+import { CorrelationId } from '@serenity-js/core/lib/model';
+import { Cookie, CookieData, Key, Page, PageElement, PageElements, Selector } from '@serenity-js/web';
+import * as playwright from 'playwright-core';
+import { URL } from 'url';
+import { PlaywrightOptions } from '../../PlaywrightOptions';
+import { PlaywrightBrowsingSession } from './PlaywrightBrowsingSession';
+/**
+ * @desc
+ *  Playwright-specific implementation of the {@link @serenity-js/web/lib/screenplay/models~Page}.
+ *
+ * @see {@link @serenity-js/web/lib/screenplay/models~Page}
+ */
+export declare class PlaywrightPage extends Page<playwright.ElementHandle> {
+    private readonly page;
+    private readonly options;
+    /**
+     * @private
+     */
+    private lastScriptExecutionSummary;
+    constructor(session: PlaywrightBrowsingSession, page: playwright.Page, options: PlaywrightOptions, pageId: CorrelationId);
+    locate(selector: Selector): PageElement<playwright.ElementHandle>;
+    locateAll(selector: Selector): PageElements<playwright.ElementHandle>;
+    navigateTo(destination: string): Promise<void>;
+    navigateBack(): Promise<void>;
+    navigateForward(): Promise<void>;
+    reload(): Promise<void>;
+    sendKeys(keys: (string | Key)[]): Promise<void>;
+    executeScript<Result, InnerArguments extends any[]>(script: string | ((...parameters: InnerArguments) => Result), ...args: InnerArguments): Promise<Result>;
+    executeAsyncScript<Result, Parameters extends any[]>(script: string | ((...args: [...parameters: Parameters, callback: (result: Result) => void]) => void), ...args: Parameters): Promise<Result>;
+    /**
+     * @desc
+     *  Returns the last result of calling {@link BrowseTheWebWithPlaywright#executeAsyncScript}
+     *  or {@link BrowseTheWebWithPlaywright#executeScript}
+     *
+     * @returns {any}
+     */
+    lastScriptExecutionResult<Result = any>(): Result;
+    takeScreenshot(): Promise<string>;
+    cookie(name: string): Promise<Cookie>;
+    setCookie(cookieData: CookieData): Promise<void>;
+    deleteAllCookies(): Promise<void>;
+    title(): Promise<string>;
+    name(): Promise<string>;
+    url(): Promise<URL>;
+    viewportSize(): Promise<{
+        width: number;
+        height: number;
+    }>;
+    setViewportSize(size: {
+        width: number;
+        height: number;
+    }): Promise<void>;
+    close(): Promise<void>;
+    closeOthers(): Promise<void>;
+    isPresent(): Promise<boolean>;
+    private resetState;
+}

package/lib/screenplay/models/PlaywrightPage.js

@@ -0,0 +1,177 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightPage = void 0;
+const core_1 = require("@serenity-js/core");
+const web_1 = require("@serenity-js/web");
+const url_1 = require("url");
+const locators_1 = require("./locators");
+const PlaywrightModalDialogHandler_1 = require("./PlaywrightModalDialogHandler");
+const PlaywrightPageElement_1 = require("./PlaywrightPageElement");
+/**
+ * @desc
+ *  Playwright-specific implementation of the {@link @serenity-js/web/lib/screenplay/models~Page}.
+ *
+ * @see {@link @serenity-js/web/lib/screenplay/models~Page}
+ */
+class PlaywrightPage extends web_1.Page {
+    constructor(session, page, options, pageId) {
+        super(session, new locators_1.PlaywrightRootLocator(page), new PlaywrightModalDialogHandler_1.PlaywrightModalDialogHandler(page), pageId);
+        this.page = page;
+        this.options = options;
+    }
+    locate(selector) {
+        return new PlaywrightPageElement_1.PlaywrightPageElement(new locators_1.PlaywrightLocator(this.rootLocator, selector));
+    }
+    locateAll(selector) {
+        return new web_1.PageElements(new locators_1.PlaywrightLocator(this.rootLocator, selector));
+    }
+    async navigateTo(destination) {
+        var _a;
+        await this.page.goto(destination, { waitUntil: (_a = this.options) === null || _a === void 0 ? void 0 : _a.defaultNavigationWaitUntil });
+        await this.resetState();
+    }
+    async navigateBack() {
+        var _a;
+        await this.page.goBack({ waitUntil: (_a = this.options) === null || _a === void 0 ? void 0 : _a.defaultNavigationWaitUntil });
+        await this.resetState();
+    }
+    async navigateForward() {
+        var _a;
+        await this.page.goForward({ waitUntil: (_a = this.options) === null || _a === void 0 ? void 0 : _a.defaultNavigationWaitUntil });
+        await this.resetState();
+    }
+    async reload() {
+        var _a;
+        await this.page.reload({ waitUntil: (_a = this.options) === null || _a === void 0 ? void 0 : _a.defaultNavigationWaitUntil });
+        await this.resetState();
+    }
+    async sendKeys(keys) {
+        const keySequence = keys.map(key => {
+            if (!web_1.Key.isKey(key)) {
+                return key;
+            }
+            return key.devtoolsName;
+        });
+        await this.page.keyboard.press(keySequence.join('+'));
+    }
+    async executeScript(script, ...args) {
+        const nativeArguments = await Promise.all(args.map(arg => arg instanceof PlaywrightPageElement_1.PlaywrightPageElement
+            ? arg.nativeElement()
+            : arg));
+        const serialisedScript = typeof script === 'function'
+            ? String(script)
+            : String(`function script() { ${script} }`);
+        const result = await this.page.evaluate(new Function(`
+                const parameters = arguments[0];
+                return (${serialisedScript}).apply(null, parameters);
+            `), nativeArguments);
+        this.lastScriptExecutionSummary = new LastScriptExecutionSummary(result);
+        return result;
+    }
+    async executeAsyncScript(script, ...args) {
+        const nativeArguments = await Promise.all(args.map(arg => arg instanceof PlaywrightPageElement_1.PlaywrightPageElement
+            ? arg.nativeElement()
+            : arg));
+        const serialisedScript = typeof script === 'function'
+            ? String(script)
+            : String(`function script() { ${script} }`);
+        const result = await this.page.evaluate(new Function(`
+                const parameters = arguments[0];
+                
+                return new Promise((resolve, reject) => {
+                    try {
+                        return (${serialisedScript}).apply(null, parameters.concat(resolve));
+                    } catch (error) {
+                        return reject(error);
+                    }
+                })
+            `), nativeArguments);
+        this.lastScriptExecutionSummary = new LastScriptExecutionSummary(result);
+        return result;
+    }
+    /**
+     * @desc
+     *  Returns the last result of calling {@link BrowseTheWebWithPlaywright#executeAsyncScript}
+     *  or {@link BrowseTheWebWithPlaywright#executeScript}
+     *
+     * @returns {any}
+     */
+    lastScriptExecutionResult() {
+        if (!this.lastScriptExecutionSummary) {
+            throw new core_1.LogicError(`Make sure to execute a script before checking on the result`);
+        }
+        return this.lastScriptExecutionSummary.result;
+    }
+    async takeScreenshot() {
+        const screenshot = await this.page.screenshot();
+        return screenshot.toString('base64');
+    }
+    async cookie(name) {
+        return this.session.cookie(name);
+    }
+    async setCookie(cookieData) {
+        const url = await this.page.url();
+        const cookie = {
+            name: cookieData.name,
+            value: cookieData.value,
+            domain: cookieData.domain,
+            path: cookieData.path,
+            url: !(cookieData.domain && cookieData.path)
+                ? url
+                : undefined,
+            secure: cookieData.secure,
+            httpOnly: cookieData.httpOnly,
+            expires: cookieData.expiry
+                ? cookieData.expiry.toSeconds()
+                : undefined,
+            sameSite: cookieData.sameSite,
+        };
+        return this.session.setCookie(cookie);
+    }
+    async deleteAllCookies() {
+        await this.session.deleteAllCookies();
+    }
+    title() {
+        return this.page.title();
+    }
+    name() {
+        return this.page.evaluate(
+        /* istanbul ignore next */
+        () => window.name);
+    }
+    async url() {
+        return new url_1.URL(this.page.url());
+    }
+    async viewportSize() {
+        return this.page.viewportSize();
+    }
+    setViewportSize(size) {
+        return this.page.setViewportSize(size);
+    }
+    async close() {
+        await this.resetState();
+        await this.modalDialogHandler.discard();
+        await this.page.close();
+    }
+    async closeOthers() {
+        await this.session.closePagesOtherThan(this);
+    }
+    async isPresent() {
+        return !this.page.isClosed();
+    }
+    async resetState() {
+        this.lastScriptExecutionSummary = undefined;
+        await this.rootLocator.switchToMainFrame();
+        await this.modalDialogHandler.reset();
+    }
+}
+exports.PlaywrightPage = PlaywrightPage;
+/**
+ * @package
+ */
+class LastScriptExecutionSummary {
+    constructor(result) {
+        this.result = result;
+    }
+}
+//# sourceMappingURL=PlaywrightPage.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightPage.js","sourceRoot":"","sources":["../../../src/screenplay/models/PlaywrightPage.ts"],"names":[],"mappings":";;;AAAA,4CAA+C;AAE/C,0CAAsG;AAItG,6BAA0B;AAG1B,yCAAsE;AAEtE,iFAA8E;AAC9E,mEAAgE;AAEhE;;;;;GAKG;AACH,MAAa,cAAe,SAAQ,UAA8B;IAM9D,YACI,OAAkC,EACjB,IAAqB,EACrB,OAA0B,EAC3C,MAAqB;QAErB,KAAK,CACD,OAAO,EACP,IAAI,gCAAqB,CAAC,IAAI,CAAC,EAC/B,IAAI,2DAA4B,CAAC,IAAI,CAAC,EACtC,MAAM,CACT,CAAC;QATe,SAAI,GAAJ,IAAI,CAAiB;QACrB,YAAO,GAAP,OAAO,CAAmB;IAS/C,CAAC;IAED,MAAM,CAAC,QAAkB;QACrB,OAAO,IAAI,6CAAqB,CAC5B,IAAI,4BAAiB,CACjB,IAAI,CAAC,WAAW,EAChB,QAAQ,CACX,CACJ,CAAC;IACN,CAAC;IAED,SAAS,CAAC,QAAkB;QACxB,OAAO,IAAI,kBAAY,CACnB,IAAI,4BAAiB,CACjB,IAAI,CAAC,WAAW,EAChB,QAAQ,CACX,CACJ,CAAC;IACN,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,WAAmB;;QAChC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,MAAA,IAAI,CAAC,OAAO,0CAAE,0BAA0B,EAAE,CAAC,CAAC;QAC3F,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,YAAY;;QACd,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,MAAA,IAAI,CAAC,OAAO,0CAAE,0BAA0B,EAAE,CAAC,CAAC;QAChF,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,eAAe;;QACjB,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,MAAA,IAAI,CAAC,OAAO,0CAAE,0BAA0B,EAAE,CAAC,CAAC;QACnF,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,MAAM;;QACR,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,MAAA,IAAI,CAAC,OAAO,0CAAE,0BAA0B,EAAE,CAAC,CAAC;QAChF,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAsB;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC/B,IAAI,CAAE,SAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBAClB,OAAO,GAAG,CAAC;aACd;YAED,OAAO,GAAG,CAAC,YAAY,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAC1B,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CACxB,CAAC;IACN,CAAC;IAED,KAAK,CAAC,aAAa,CAAuC,MAA4D,EAAE,GAAG,IAAoB;QAE3I,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CACrC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CACX,GAAG,YAAY,6CAAqB;YAChC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAE;YACrB,CAAC,CAAC,GAAG,CACZ,CACc,CAAC;QAEpB,MAAM,gBAAgB,GAAG,OAAO,MAAM,KAAK,UAAU;YACjD,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;YAChB,CAAC,CAAC,MAAM,CAAC,uBAAwB,MAAO,IAAI,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CACnC,IAAI,QAAQ,CAAC;;0BAEE,gBAAiB;aAC/B,CAAyD,EAC1D,eAAe,CAClB,CAAC;QAEF,IAAI,CAAC,0BAA0B,GAAG,IAAI,0BAA0B,CAC5D,MAAM,CACT,CAAC;QAEF,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAmC,MAAqG,EAAE,GAAG,IAAgB;QAEjL,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CACrC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CACX,GAAG,YAAY,6CAAqB;YAChC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAE;YACrB,CAAC,CAAC,GAAG,CACZ,CACU,CAAC;QAEhB,MAAM,gBAAgB,GAAG,OAAO,MAAM,KAAK,UAAU;YACjD,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;YAChB,CAAC,CAAC,MAAM,CAAC,uBAAwB,MAAO,IAAI,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CACnC,IAAI,QAAQ,CAAC;;;;;kCAKU,gBAAiB;;;;;aAKvC,CAAyD,EAC1D,eAAe,CAClB,CAAC;QAEF,IAAI,CAAC,0BAA0B,GAAG,IAAI,0BAA0B,CAC5D,MAAM,CACT,CAAC;QAEF,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,yBAAyB;QACrB,IAAI,CAAE,IAAI,CAAC,0BAA0B,EAAE;YACnC,MAAM,IAAI,iBAAU,CAAC,6DAA6D,CAAC,CAAC;SACvF;QAED,OAAO,IAAI,CAAC,0BAA0B,CAAC,MAAgB,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,cAAc;QAChB,MAAM,UAAU,GAAW,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;QAExD,OAAO,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAY;QACrB,OAAQ,IAAI,CAAC,OAAqC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,UAAsB;QAClC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAElC,MAAM,MAAM,GAAG;YACX,IAAI,EAAQ,UAAU,CAAC,IAAI;YAC3B,KAAK,EAAO,UAAU,CAAC,KAAK;YAC5B,MAAM,EAAM,UAAU,CAAC,MAAM;YAC7B,IAAI,EAAQ,UAAU,CAAC,IAAI;YAC3B,GAAG,EAAS,CAAC,CAAC,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,CAAC;gBAC/C,CAAC,CAAC,GAAG;gBACL,CAAC,CAAC,SAAS;YACf,MAAM,EAAM,UAAU,CAAC,MAAM;YAC7B,QAAQ,EAAI,UAAU,CAAC,QAAQ;YAC/B,OAAO,EAAK,UAAU,CAAC,MAAM;gBACzB,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,EAAE;gBAC/B,CAAC,CAAC,SAAS;YACf,QAAQ,EAAI,UAAU,CAAC,QAAQ;SAClC,CAAC;QAEF,OAAQ,IAAI,CAAC,OAAqC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,CAAC,gBAAgB;QAClB,MAAO,IAAI,CAAC,OAAqC,CAAC,gBAAgB,EAAE,CAAC;IACzE,CAAC;IAED,KAAK;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ;QACrB,0BAA0B;QAC1B,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CACpB,CAAC;IACN,CAAC;IAED,KAAK,CAAC,GAAG;QACL,OAAO,IAAI,SAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,YAAY;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;IACpC,CAAC;IAED,eAAe,CAAC,IAAuC;QACnD,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,KAAK;QACP,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACxB,MAAO,IAAI,CAAC,kBAAmD,CAAC,OAAO,EAAE,CAAC;QAC1E,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,WAAW;QACb,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,SAAS;QACX,OAAO,CAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,UAAU;QACpB,IAAI,CAAC,0BAA0B,GAAG,SAAS,CAAC;QAC5C,MAAM,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAA;QAC1C,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;IAC1C,CAAC;CACJ;AAtOD,wCAsOC;AAED;;GAEG;AACH,MAAM,0BAA0B;IAC5B,YAA4B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;CACjD"}

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

@@ -0,0 +1,24 @@
+import { PageElement, SelectOption, SwitchableOrigin } from '@serenity-js/web';
+import * as playwright from 'playwright-core';
+export declare class PlaywrightPageElement extends PageElement<playwright.ElementHandle> {
+    of(parent: PageElement<playwright.ElementHandle>): PageElement<playwright.ElementHandle>;
+    enterValue(value: string | number | Array<string | number>): Promise<void>;
+    clearValue(): Promise<void>;
+    click(): Promise<void>;
+    doubleClick(): Promise<void>;
+    scrollIntoView(): Promise<void>;
+    hoverOver(): Promise<void>;
+    rightClick(): Promise<void>;
+    selectOptions(...options: Array<SelectOption>): Promise<void>;
+    selectedOptions(): Promise<Array<SelectOption>>;
+    attribute(name: string): Promise<string>;
+    text(): Promise<string>;
+    value(): Promise<string>;
+    switchTo(): Promise<SwitchableOrigin>;
+    isActive(): Promise<boolean>;
+    isClickable(): Promise<boolean>;
+    isEnabled(): Promise<boolean>;
+    isPresent(): Promise<boolean>;
+    isSelected(): Promise<boolean>;
+    isVisible(): Promise<boolean>;
+}