@serenity-js/playwright 3.0.0-rc.20

package/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [3.0.0-rc.20](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.19...v3.0.0-rc.20) (2022-07-11)
+
+
+### Bug Fixes
+
+* **web:** renamed PagesContext to BrowsingSession to make the name more descriptive ([6b4e998](https://github.com/serenity-js/serenity-js/commit/6b4e9984d80f8f349f367e59bd0e615cd01703ec)), closes [#1236](https://github.com/serenity-js/serenity-js/issues/1236)
+
+
+### Features
+
+* **core:** interactions to Wait.for and Wait.until are now browser-independent ([d115142](https://github.com/serenity-js/serenity-js/commit/d1151427bed96c1ebd0d1dcc4159c6aeedc605de)), closes [#1035](https://github.com/serenity-js/serenity-js/issues/1035) [#1236](https://github.com/serenity-js/serenity-js/issues/1236)
+* **playwright:** configurable navigation and interaction timeouts for BrowseTheWebWithPlaywright ([142b78e](https://github.com/serenity-js/serenity-js/commit/142b78ed5c3ede1f61f5a1c5ae72d785c3fe70a9)), closes [#1236](https://github.com/serenity-js/serenity-js/issues/1236)
+* **playwright:** configurable navigation waitUntil timeout ([2458fcb](https://github.com/serenity-js/serenity-js/commit/2458fcb22c946da41ab59cb21ac0d4cc48012da7)), closes [#1236](https://github.com/serenity-js/serenity-js/issues/1236)
+* **playwright:** initial support for Playwright ([87e88a1](https://github.com/serenity-js/serenity-js/commit/87e88a16cdc06477ed25eb83f9597fd370fdc109)), closes [#493](https://github.com/serenity-js/serenity-js/issues/493) [#563](https://github.com/serenity-js/serenity-js/issues/563) [#911](https://github.com/serenity-js/serenity-js/issues/911)
+* **playwright:** interaction to Select option(s) from a <select /> dropdown ([009041d](https://github.com/serenity-js/serenity-js/commit/009041d83e22ddf3fef14670e0e5fd6d11cdfc73)), closes [#1236](https://github.com/serenity-js/serenity-js/issues/1236)
+* **playwright:** interactions to Scroll, Press, and TakeScreenshot ([1c039d2](https://github.com/serenity-js/serenity-js/commit/1c039d2027057f074f3d9be9685489b1512ac63c)), closes [#493](https://github.com/serenity-js/serenity-js/issues/493) [#563](https://github.com/serenity-js/serenity-js/issues/563) [#911](https://github.com/serenity-js/serenity-js/issues/911)
+* **playwright:** isActive check for PlaywrightPageElement ([dbf44eb](https://github.com/serenity-js/serenity-js/commit/dbf44eb7a8bfbeb45e03d9269d8c454e951c11b2)), closes [#1236](https://github.com/serenity-js/serenity-js/issues/1236)
+* **playwright:** support for executing in-browser JavaScript ([630bedd](https://github.com/serenity-js/serenity-js/commit/630beddbf6f782a85e1a15c0b8b57637498dbd91)), closes [#493](https://github.com/serenity-js/serenity-js/issues/493) [#563](https://github.com/serenity-js/serenity-js/issues/563) [#911](https://github.com/serenity-js/serenity-js/issues/911)
+* **playwright:** support for isClickable ([afc8587](https://github.com/serenity-js/serenity-js/commit/afc8587a2ee2af6a4151512dc621473a3a892b7e)), closes [#1236](https://github.com/serenity-js/serenity-js/issues/1236)
+* **playwright:** support for isVisible, plus consistent visibility checks across the board ([2c5c929](https://github.com/serenity-js/serenity-js/commit/2c5c929802f894f9fe59438a01f08b1b7bec3318)), closes [#1236](https://github.com/serenity-js/serenity-js/issues/1236)
+* **playwright:** support for working with cookies ([1215a8f](https://github.com/serenity-js/serenity-js/commit/1215a8f0d2aabd99bdda8be4e136e0c4f6687803)), closes [#1237](https://github.com/serenity-js/serenity-js/issues/1237)
+* **playwright:** support for working with frames ([89d4621](https://github.com/serenity-js/serenity-js/commit/89d46212073a342fe812a3ad2638a2ad0c39b620)), closes [#1236](https://github.com/serenity-js/serenity-js/issues/1236)
+* **web:** introduced PagesContext and implemented PlaywrightPage ([0045a72](https://github.com/serenity-js/serenity-js/commit/0045a726d540871333f644928218aed00bcd372c)), closes [#1236](https://github.com/serenity-js/serenity-js/issues/1236)
+* **web:** new portable APIs to handle ModalDialog windows ([c94d0ec](https://github.com/serenity-js/serenity-js/commit/c94d0ec43d2bc8aa39f8824f5d0f1e1cbcf137a1)), closes [#1236](https://github.com/serenity-js/serenity-js/issues/1236) [#805](https://github.com/serenity-js/serenity-js/issues/805) [#1156](https://github.com/serenity-js/serenity-js/issues/1156)
+* **web:** standardised support for deep CSS selectors across the Web integration modules ([e9e3f28](https://github.com/serenity-js/serenity-js/commit/e9e3f281191fc5c891841b6c8aab41213da3b0f5)), closes [#1238](https://github.com/serenity-js/serenity-js/issues/1238)

package/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE.md

@@ -0,0 +1 @@
+Copyright 2016- Jan Molak, smartcode ltd.

package/README.md

@@ -0,0 +1,145 @@
+# Serenity/JS
+
+[Serenity/JS](https://serenity-js.org) is a framework designed to make acceptance and regression testing
+of modern full-stack applications faster, more collaborative and easier to scale.
+
+Visit [serenity-js.org](https://serenity-js.org/) for the [latest tutorials](https://serenity-js.org/handbook/)
+and [API docs](https://serenity-js.org/modules/), and follow [@SerenityJS](https://twitter.com/SerenityJS) and [@JanMolak](https://twitter.com/JanMolak) on Twitter for project updates.
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/SerenityJS?style=social)](https://twitter.com/@SerenityJS)
+[![Twitter Follow](https://img.shields.io/twitter/follow/JanMolak?style=social)](https://twitter.com/@JanMolak)
+[![Chat on Gitter](https://badges.gitter.im/serenity-js/Lobby.svg)](https://gitter.im/serenity-js/Lobby)
+
+Subscribe to [Serenity/JS YouTube channel](https://www.youtube.com/channel/UC0RdeVPyjtJopVHvlLrXd1Q) to get notified when new demos and video tutorials are available.
+
+### Learning Serenity/JS
+
+To learn more about Serenity/JS, [follow the tutorial](https://serenity-js.org/handbook/thinking-in-serenity-js/index.html), [review the examples](https://github.com/serenity-js/serenity-js/tree/main/examples), and create your own test suite with [Serenity/JS template projects](https://github.com/serenity-js).
+
+If you have any questions, join us on [Serenity/JS Community Chat](https://gitter.im/serenity-js/Lobby).
+
+## Serenity/JS Playwright
+
+[`@serenity-js/playwright`](https://serenity-js.org/modules/playwright/) module is a [Screenplay Pattern](https://serenity-js.org/handbook/thinking-in-serenity-js/screenplay-pattern.html)-style adapter
+for [Playwright](https://playwright.dev/), that helps with testing Web-based apps.
+
+### Installation
+
+To install this module, run the following command in your [Playwright project directory](https://playwright.dev/docs/intro):
+
+```bash
+npm install --save-dev @serenity-js/{assertions,console-reporter,core,serenity-bdd,web,playwright}
+```
+
+### Usage with Mocha
+
+```typescript
+import { Ensure, equals } from '@serenity-js/assertions';
+import { actorCalled, Actor, ArtifactArchiver, Cast, configure, Duration } from '@serenity-js/core';
+import { ConsoleReporter } from '@serenity-js/console-reporter';
+import { BrowseTheWebWithPlaywright, PlaywrightOptions } from '@serenity-js/playwright';
+import { SerenityBDDReporter } from '@serenity-js/serenity-bdd';
+import { By, Navigate, PageElement, Photographer, TakePhotosOfFailures, Text } from '@serenity-js/web';
+
+import { describe, it, beforeAll, afterAll } from 'mocha';
+import * as playwright from 'playwright';
+
+// example Lean Page Object describing a widget we interact with in the test
+class SerenityJSWebsite {                   
+    static header = () => 
+        PageElement.located(By.css('h1'))   // selector to identify the interactable element
+            .describedAs('header');         // description to be used in reports
+}
+
+// example Actors class, confgures Serenity/JS actors to use Playwright
+class Actors implements Cast {              
+    constructor(                            
+        private readonly browser: playwright.Browser,
+        private readonly options: PlaywrightOptions,
+    ) {
+    }
+
+    prepare(actor: Actor): Actor {
+        return actor.whoCan(
+            BrowseTheWebWithPlaywright.using(this.browser, this.options),
+            // ... add other abilities as needed, like CallAnApi or TakeNotes
+        );
+    }
+}
+
+describe('Serenity/JS', () => {
+
+    let browser: playwright.Browser;
+    
+    beforeAll(async () => {
+        // Start a single browser before all the tests,
+        // Serenity/JS will open new tabs
+        // and manage Playwright browser context as needed  
+        browser = await playwright.chromium.launch({
+            headless: true
+        });
+
+        // Configure Serenity/JS providing your Actors
+        // and required "stage crew memebers" (a.k.a. reporting services)
+        configure({
+            actors: new Actors(browser, {
+                    baseURL: `https://serenity-js.org`,
+                    defaultNavigationTimeout:   Duration.ofSeconds(2).inMilliseconds(),
+                    defaultTimeout:             Duration.ofMilliseconds(750).inMilliseconds(),
+            }),
+            crew: [
+                ArtifactArchiver.storingArtifactsAt(`./target/site/serenity`),
+                Photographer.whoWill(TakePhotosOfFailures),
+                new SerenityBDDReporter(),
+                ConsoleReporter.forDarkTerminals(),
+            ]
+        });
+    });
+    
+    it('supports Playwright', async () => {
+        // actorCalled(name) instantiates or retrieves an existing actor identified by name
+        // Actors class configures the actors to use Playwright 
+        await actorCalled('William')                                
+            .attemptsTo(
+                Navigate.to('https://serenity-js.org'),
+                Ensure.that(
+                    Text.of(SerenityJSWebsite.header()),
+                    equals('Next generation acceptance testing')
+                ),
+            )
+    })
+
+    afterAll(async () => {
+        // Close the browser after all the tests are finished
+        if (browser) {
+            await browser.close()
+        }
+    });
+});
+```
+
+Next steps:
+- Add [`@serenity-js/mocha`](https://serenity-js.org/modules/mocha/) adapter to produce the reports
+- Learn about the [Screenplay Pattern](https://serenity-js.org/handbook/design/screenplay-pattern.html)
+- Explore [`@serenity-js/web`](https://serenity-js.org/modules/web) and [`@serenity-js/assertions`](https://serenity-js.org/modules/assertions) APIs
+
+## Usage with `@playwright/test`
+
+Support for `@playwright/test` is coming soon! 
+
+Give [serenity-js/serenity-js#1240](https://github.com/serenity-js/serenity-js/issues/1240) a 👍 on GitHub 
+to show your interest and get notified when the feature arrives.
+
+## Usage with Cucumber
+
+Tutorial coming soon! 
+
+Follow [@SerenityJS on Twitter](https://twitter.com/@SerenityJS) to get notified about new tutorials.
+
+## More coming soon!
+
+New features, tutorials, and demos are coming soon, so follow us on Twitter and join the [Serenity/JS Community chat channel](https://gitter.im/serenity-js/Lobby) to stay up to date!
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/SerenityJS?style=social)](https://twitter.com/@SerenityJS)
+[![Twitter Follow](https://img.shields.io/twitter/follow/JanMolak?style=social)](https://twitter.com/@JanMolak)
+[![Chat on Gitter](https://badges.gitter.im/serenity-js/Lobby.svg)](https://gitter.im/serenity-js/Lobby)

package/lib/PlaywrightOptions.d.ts

@@ -0,0 +1,40 @@
+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/lib/PlaywrightOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=PlaywrightOptions.js.map

package/lib/PlaywrightOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightOptions.js","sourceRoot":"","sources":["../src/PlaywrightOptions.ts"],"names":[],"mappings":""}

package/lib/index.d.ts

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

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

package/lib/index.js.map

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

package/lib/screenplay/abilities/BrowseTheWebWithPlaywright.d.ts

@@ -0,0 +1,71 @@
+import { Discardable } from '@serenity-js/core';
+import { BrowserCapabilities, BrowseTheWeb } from '@serenity-js/web';
+import * as playwright from 'playwright-core';
+import { PlaywrightOptions } from '../../PlaywrightOptions';
+/**
+ * @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 declare class BrowseTheWebWithPlaywright extends BrowseTheWeb<playwright.ElementHandle> implements Discardable {
+    protected readonly browser: playwright.Browser;
+    /**
+     * @param {playwright~Browser} browser
+     * @param {PlaywrightOptions} options
+     * @returns {BrowseTheWebWithPlaywright}
+     */
+    static using(browser: playwright.Browser, options?: PlaywrightOptions): BrowseTheWebWithPlaywright;
+    /**
+     * @param {playwright~Browser} browser
+     * @param {PlaywrightOptions} browserContextOptions
+     */
+    protected constructor(browser: playwright.Browser, browserContextOptions?: PlaywrightOptions);
+    /**
+     * @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}
+     */
+    discard(): Promise<void>;
+    /**
+     * @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}
+     */
+    browserCapabilities(): Promise<BrowserCapabilities>;
+}

package/lib/screenplay/abilities/BrowseTheWebWithPlaywright.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowseTheWebWithPlaywright = void 0;
+const web_1 = require("@serenity-js/web");
+const models_1 = require("../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}
+ */
+class BrowseTheWebWithPlaywright extends web_1.BrowseTheWeb {
+    /**
+     * @param {playwright~Browser} browser
+     * @param {PlaywrightOptions} browserContextOptions
+     */
+    constructor(browser, browserContextOptions = {}) {
+        super(new models_1.PlaywrightBrowsingSession(browser, browserContextOptions));
+        this.browser = browser;
+    }
+    /**
+     * @param {playwright~Browser} browser
+     * @param {PlaywrightOptions} options
+     * @returns {BrowseTheWebWithPlaywright}
+     */
+    static using(browser, options) {
+        return new BrowseTheWebWithPlaywright(browser, options);
+    }
+    /**
+     * @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() {
+        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() {
+        return {
+            browserName: this.browser._initializer.name,
+            platformName: process.platform,
+            browserVersion: this.browser.version()
+        };
+    }
+}
+exports.BrowseTheWebWithPlaywright = BrowseTheWebWithPlaywright;
+//# sourceMappingURL=BrowseTheWebWithPlaywright.js.map

package/lib/screenplay/abilities/BrowseTheWebWithPlaywright.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowseTheWebWithPlaywright.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWebWithPlaywright.ts"],"names":[],"mappings":";;;AACA,0CAAqE;AAIrE,sCAAsD;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAa,0BAA2B,SAAQ,kBAAsC;IAWlF;;;OAGG;IACH,YAAyC,OAA2B,EAAE,wBAA2C,EAAE;QAC/G,KAAK,CAAC,IAAI,kCAAyB,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC;QADhC,YAAO,GAAP,OAAO,CAAoB;IAEpE,CAAC;IAfD;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,OAA2B,EAAE,OAA2B;QACjE,OAAO,IAAI,0BAA0B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAUD;;;;;;OAMG;IACH,KAAK,CAAC,OAAO;QACT,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,mBAAmB;QACrB,OAAO;YACH,WAAW,EAAG,IAAI,CAAC,OAAe,CAAC,YAAY,CAAC,IAAI;YACpD,YAAY,EAAE,OAAO,CAAC,QAAQ;YAC9B,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;SACzC,CAAA;IACL,CAAC;CACJ;AAjDD,gEAiDC"}

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

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

package/lib/screenplay/abilities/index.js

@@ -0,0 +1,18 @@
+"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("./BrowseTheWebWithPlaywright"), exports);
+//# sourceMappingURL=index.js.map

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

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

package/lib/screenplay/index.d.ts

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