@serenity-js/playwright-test 3.0.0-rc.28

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# 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.28](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.27...v3.0.0-rc.28) (2022-09-30)
+
+
+### Bug Fixes
+
+* **core:** activity is now able to detect invocation location on Node 14 ([41f4776](https://github.com/serenity-js/serenity-js/commit/41f4776736620bc32d474d9b66f69c742f8eca96)), closes [#1240](https://github.com/serenity-js/serenity-js/issues/1240)
+* **playwright-test:** bulk-attach all Serenity/JS events to Playwright report ([a5f3d7c](https://github.com/serenity-js/serenity-js/commit/a5f3d7cfb8148cc80275a0736976726432b174f3)), closes [#1240](https://github.com/serenity-js/serenity-js/issues/1240)
+* **playwright-test:** wait for Photographer to finish taking screenshots before dismissing actors ([b0c5adb](https://github.com/serenity-js/serenity-js/commit/b0c5adba83fc92624e91c7385b38f0061cf5a6ed)), closes [#1240](https://github.com/serenity-js/serenity-js/issues/1240)
+* **playwright:** corrected not(isPresent()) for PlaywrightPageElement ([0693b2f](https://github.com/serenity-js/serenity-js/commit/0693b2f2666a8de327c990c72ecf42fc3d7da498)), closes [#1240](https://github.com/serenity-js/serenity-js/issues/1240)
+* **playwright:** upgraded Playwright to 1.26.0 ([a13ab3c](https://github.com/serenity-js/serenity-js/commit/a13ab3c54b37a5017beadf1db2b2cd2e747d8ab4))
+
+
+### Features
+
+* **console-reporter:** improved support for tests executed in parallel ([01264ce](https://github.com/serenity-js/serenity-js/commit/01264ce6110a3199265468f633eee5623fabe008)), closes [#1240](https://github.com/serenity-js/serenity-js/issues/1240)
+* **core:** serenity/JS stage crew members can now be configured using `string` ([786cdad](https://github.com/serenity-js/serenity-js/commit/786cdadcda8e031e06b8bee9698a87a7af00d90c)), closes [#1240](https://github.com/serenity-js/serenity-js/issues/1240) [#594](https://github.com/serenity-js/serenity-js/issues/594)
+* **playwright-test:** first draft of the Serenity/JS Playwright Test reporter ([b9e3d89](https://github.com/serenity-js/serenity-js/commit/b9e3d89752c07ef0fd54ad748c31fd7207665c3a)), closes [#1240](https://github.com/serenity-js/serenity-js/issues/1240)
+* **playwright-test:** improved Playwright Test reports ([6c6b537](https://github.com/serenity-js/serenity-js/commit/6c6b5379dfc324a4fb75d758daa7782109f1c5ab)), closes [#1240](https://github.com/serenity-js/serenity-js/issues/1240)
+* **playwright-test:** support Screenplay Pattern-style scenarios ([c425c54](https://github.com/serenity-js/serenity-js/commit/c425c548034de1b8db60e83671abcb77f9b246e5)), closes [#1240](https://github.com/serenity-js/serenity-js/issues/1240)

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,285 @@
+_** This README is for Serenity/JS version 3.0-RC. Some links might not work yet as we're working on getting the new website and API docs ready. Thanks for your patience and support! **_
+
+# 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 using the [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 Test
+
+[`@serenity-js/playwright-test`](https://serenity-js.org/api/playwright-test/) module offers a Serenity/JS reporter
+and fixtures that integrate [Playwright Test](https://playwright.dev/docs/intro) with Serenity/JS Screenplay Pattern APIs.
+
+### Installation
+
+To install this module, use an existing [Playwright project](https://playwright.dev/docs/intro) or generate a new one by running:
+
+```bash
+npm init playwright@latest
+```
+
+Next, run the following command in your Playwright project directory:
+
+```bash
+npm install --save-dev @serenity-js/{assertions,console-reporter,core,serenity-bdd,web,playwright,playwright-test}
+```
+
+### Serenity/JS Playwright Fixtures
+
+To use Serenity/JS Screenplay Pattern APIs and benefit from the in-depth reporting capabilities,
+import Serenity/JS test fixtures instead of the default ones:
+
+```diff
+// example.spec.ts
++ import { test } from '@serenity-js/playwright-test'
+- import { test } from '@playwright/test'
+
+test.describe('Serenity Screenplay with Playwright', () => {
+    
+    test.describe('New Todo', () => {
+
+        test('should allow me to add todo items', async ({ page }) => {
+            //...
+        })
+    })
+})
+```
+
+If you prefer, Serenity/JS also offers the more concise BDD-style `describe/it` syntax:
+
+```typescript
+// example.spec.ts
+import { describe, it, test } from '@serenity-js/playwright-test'
+
+test.use({
+    headles: true,
+})
+
+describe('Serenity Screenplay with Playwright', () => {
+    
+    describe('New Todo', () => {
+
+        it('should allow me to add todo items', async ({ page }) => {
+            //...
+        })
+    })
+})
+```
+
+### Serenity/JS Screenplay Pattern Actors
+
+Serenity/JS test fixtures simplify how you instantiate and use Serenity/JS Screenplay Pattern Actors.
+
+#### Single-actor scenarios
+
+If your tests need only a single actor, you can inject it using the `actor` fixture.
+To configure the name of your default actor, use the `defaultActorName` configuration property:
+
+```typescript
+// example.spec.ts
+
+import { describe, it, test } from '@serenity-js/playwright-test'   // import fixtures
+import { Navigate, Page } from '@serenity-js/playwright'            // import Screenplay Pattern Web APIs
+import { Ensure, equals } from '@serenity-js/assertions'            // import Screenplay Pattern assertion APIs                            
+
+test.use({
+    headles: true,
+    defaultActorName: 'Serena'  // change default actor name
+})
+
+describe('Serenity Screenplay with Playwright', () => {
+    
+    describe('New Todo', () => {
+
+        // inject default actor:
+        it('should allow me to add todo items', async ({ actor }) => { 
+            
+            // define test workflow
+            await actor.attemptsTo(                                                  
+                Navigate.to('https://todo-app.serenity-js.org/'),
+                Ensure.that(Page.current().title(), equals('Serenity/JS TodoApp')),
+            )
+        })
+    })
+})
+```
+
+#### Multi-actor scenarios
+
+For multi-actor scenarios where you need each actor to use a separate browser, use the `actorCalled` fixture.
+You can also use this pattern to override the default actor name on a per-scenario basis:
+
+```````typescript
+// example.spec.ts
+
+import { describe, it, test } from '@serenity-js/playwright-test'   // import fixtures
+
+describe('Serenity Screenplay with Playwright', () => {
+    
+    describe('Chat app', () => {
+
+        it('should allow actors to send and receive messages', async ({ actorCalled }) => { 
+
+            // define part of the workflow performed by the first actor:
+            await actorCalled('Alice').attemptsTo(                               
+                // navigate to a chat app
+                // post a message to Bob
+            )
+
+            // define parts of the workflow performed by the any other actors:
+            await actorCalled('Bob').attemptsTo(                                 
+                // navigate to a chat app
+                // post a reply to Alice
+            )
+
+            // Note that invoking actorCalled(name) multiple times
+            // while using the same name and within the scope of a single test
+            // returns the same actor, so you don't need to cache them:
+            await actorCalled('Alice').attemptsTo(                              
+                // check if the reply from Bob is received                      
+            )                                                                   
+        })
+    })
+})
+```````
+
+#### Customising Actors
+
+The default [cast](https://serenity-js.org/api/core/class/Cast) of actors is limited to using a single ability
+to [`BrowseTheWebWithPlaywright`](/api/playwright/class/BrowseTheWebWithPlaywright).
+
+If you'd like to give your actors additional abilities, like to [`TakeNotes`](https://serenity-js.org/api/core/class/TakeNotes),
+[`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi),
+or [`ManageALocalServer`](https://serenity-js.org/api/local-server/class/ManageALocalServer), you can install the relevant Serenity/JS module
+and configure them as follows:
+
+```typescript
+// example.spec.ts
+
+import { Cast, TakeNotes } from '@serenity-js/core'
+import { test } from '@serenity-js/playwright-test'
+import { BrowseTheWebWithPlaywright } from '@serenity-js/playwright'
+import { CallAnApi } from '@serenity-js/rest'                            
+
+test.use({
+    actors: async ({ browser, baseURL }, use) => {
+        await use(
+            Cast.whereEveryoneCan(
+                BrowseTheWebWithPlaywright.using(browser),
+                TakeNotes.usingAnEmptyNotepad(),
+                CallAnApi.at(baseURL),
+            )
+        )
+    },
+})
+```
+
+For scenarios where different actors need to be configured differently, you can also implement your own `Cast`:
+
+```typescript
+// example.spec.ts
+
+import { Cast } from '@serenity-js/core'
+import { BrowseTheWebWithPlaywright, PlaywrightOptions } from '@serenity-js/playwright'
+import { test } from '@serenity-js/playwright-test'
+import { CallAnApi } from '@serenity-js/rest'
+import { Browser } from 'playwright'
+
+class Actors implements Cast {
+    constructor(
+        private readonly browser: Browser,
+        private readonly options: PlaywrightOptions,
+    ) {
+    }
+
+    prepare(actor: Actor) {
+        switch (actor.name) {
+            case 'James':
+                return actor.whoCan(BrowseTheWebWithPlaywright.using(this.browser, this.options))
+            default:
+                return actor.whoCan(CallAnApi.at(this.options.baseURL))
+        }
+    }
+}
+
+test.use({
+    actors: async ({ browser, config }) => {
+        await use(new Actors(browser, {
+            defaultNavigationWaitUntil: 'domcontentloaded'
+        }))
+    }
+})
+```
+
+### Serenity Reports
+
+To use Serenity/JS reporting capabilities, register the `@serenity-js/playwright-test` reporter in your
+`playwright.config.ts` and define the appropriate reporting services (a.k.a. your "stage crew").
+
+For example, to enable Serenity/JS Console Reporter and Serenity BDD reporter, install the relevant modules:
+
+```bash
+npm install --save-dev @serenity-js/{console-reporter,serenity-bdd}
+```
+
+Next, configure your Playwright project as follows:
+
+```typescript
+// playwright.conf.ts
+
+import type { PlaywrightTestConfig } from '@playwright/test'
+
+const config: PlaywrightTestConfig = {
+    reporter: [
+        [ '@serenity-js/playwright-test', {
+            crew: [
+                '@serenity-js/serenity-bdd',
+                '@serenity-js/console-reporter',
+                [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+                // '@serenity-js/core:StreamReporter',
+            ]
+        }],
+
+        // optional
+        [ 'html', { open: 'never' } ],          // built-in Playwright HTML reporter
+    ],
+
+    // Other configuration omitted for brevity
+    // For details, see https://playwright.dev/docs/test-configuration
+}
+
+export default config
+```
+
+Note that Serenity/JS reporters work well with the built-in [Playwright reporters](https://playwright.dev/docs/test-reporters).
+
+### Reference implementation
+
+You can find a reference implementation demonstrating how to integrate Serenity/JS with Playwright Test in the [Serenity/JS
+GitHub repository](https://github.com/serenity-js/serenity-js/tree/main/examples/playwright-test-todomvc).
+
+## 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)
+
+If you enjoy using Serenity/JS and would like to keep new features coming, become our [GitHub Sponsor](https://github.com/sponsors/serenity-js)
+and donate as much or as little as you find appropriate.

package/lib/PlaywrightTestConfig.d.ts

@@ -0,0 +1,8 @@
+import type { PlaywrightTestConfig as BasePlaywrightTestConfig } from '@playwright/test';
+import { ClassDescription } from '@serenity-js/core';
+export declare type PlaywrightTestConfig<BaseConfig extends BasePlaywrightTestConfig = BasePlaywrightTestConfig> = Omit<BaseConfig, 'use' | 'reporter'> & {
+    use?: BaseConfig['use'] & {
+        crew: Array<ClassDescription>;
+    };
+};
+//# sourceMappingURL=PlaywrightTestConfig.d.ts.map

package/lib/PlaywrightTestConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightTestConfig.d.ts","sourceRoot":"","sources":["../src/PlaywrightTestConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,IAAI,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AACzF,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,oBAAY,oBAAoB,CAAC,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,IAAI,IAAI,CAAC,UAAU,EAAE,KAAK,GAAG,UAAU,CAAC,GAAG;IAC9I,GAAG,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG;QAAE,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAA;KAAE,CAAA;CAC9D,CAAC"}

package/lib/PlaywrightTestConfig.js

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

package/lib/PlaywrightTestConfig.js.map

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

package/lib/api.d.ts

@@ -0,0 +1,25 @@
+import { PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from '@playwright/test';
+import { Actor, Cast, Duration, Serenity, SerenityConfig, StageCrewMember } from '@serenity-js/core';
+export interface SerenityFixtures extends SerenityConfig {
+    actors: Cast;
+    crew: StageCrewMember[];
+    cueTimeout: Duration;
+    serenity: Serenity;
+    platform: {
+        name: string;
+        version: string;
+    };
+    actorCalled: (name: string) => Actor;
+    defaultActorName: string;
+    actor: Actor;
+}
+export declare type SerenityTestType = TestType<PlaywrightTestArgs & PlaywrightTestOptions & SerenityFixtures, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
+export declare const it: SerenityTestType;
+export declare const test: SerenityTestType;
+export declare const describe: SerenityTestType['describe'];
+export declare const beforeAll: SerenityTestType['beforeAll'];
+export declare const beforeEach: SerenityTestType['beforeEach'];
+export declare const afterEach: SerenityTestType['afterEach'];
+export declare const afterAll: SerenityTestType['afterAll'];
+export declare const expect: SerenityTestType['expect'];
+//# sourceMappingURL=api.d.ts.map

package/lib/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,uBAAuB,EAA0B,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC9J,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAgC,cAAc,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AASnI,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACpD,MAAM,EAAE,IAAI,CAAC;IACb,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,UAAU,EAAE,QAAQ,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5C,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,KAAK,CAAC;IACrC,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CAChB;AAED,oBAAY,gBAAgB,GAAG,QAAQ,CAAC,kBAAkB,GAAG,qBAAqB,GAAG,gBAAgB,EAAE,oBAAoB,GAAG,uBAAuB,CAAC,CAAC;AAEvJ,eAAO,MAAM,EAAE,EAAE,gBAyFf,CAAC;AAEH,eAAO,MAAM,IAAI,EAAE,gBAAqB,CAAC;AACzC,eAAO,MAAM,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAe,CAAC;AAClE,eAAO,MAAM,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAgB,CAAC;AACrE,eAAO,MAAM,UAAU,EAAE,gBAAgB,CAAC,YAAY,CAAiB,CAAC;AACxE,eAAO,MAAM,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAgB,CAAC;AACrE,eAAO,MAAM,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAe,CAAC;AAClE,eAAO,MAAM,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAa,CAAC"}

package/lib/api.js

@@ -0,0 +1,97 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expect = exports.afterAll = exports.afterEach = exports.beforeEach = exports.beforeAll = exports.describe = exports.test = exports.it = void 0;
+const test_1 = require("@playwright/test");
+const core_1 = require("@serenity-js/core");
+const events_1 = require("@serenity-js/core/lib/events");
+const model_1 = require("@serenity-js/core/lib/model");
+const playwright_1 = require("@serenity-js/playwright");
+const os = __importStar(require("os"));
+const reporter_1 = require("./reporter");
+exports.it = test_1.test.extend({
+    cueTimeout: core_1.Duration.ofSeconds(5),
+    crew: [],
+    // eslint-disable-next-line no-empty-pattern
+    platform: ({}, use) => {
+        const platform = os.platform();
+        // https://nodejs.org/api/process.html#process_process_platform
+        const name = platform === 'win32'
+            ? 'Windows'
+            : (platform === 'darwin' ? 'macOS' : 'Linux');
+        use({ name, version: os.release() });
+    },
+    serenity: async ({ crew, cueTimeout, platform }, use, info) => {
+        const domainEventBuffer = new reporter_1.DomainEventBuffer();
+        core_1.serenity.configure({
+            cueTimeout: cueTimeout,
+            crew: [
+                ...crew,
+                domainEventBuffer,
+                new reporter_1.PlaywrightStepReporter(info),
+            ],
+        });
+        core_1.serenity.announce(new events_1.SceneTagged(core_1.serenity.currentSceneId(), new model_1.PlatformTag(platform.name, platform.version), core_1.serenity.currentTime()));
+        await use(core_1.serenity);
+        const serialisedEvents = [];
+        for (const event of domainEventBuffer.flush()) {
+            serialisedEvents.push({
+                type: event.constructor.name,
+                value: event.toJSON(),
+            });
+            if (event instanceof events_1.SceneTagged) {
+                exports.test.info().annotations.push({ type: event.tag.type, description: event.tag.name });
+            }
+        }
+        test_1.test.info().attach('serenity-js-events.json', {
+            contentType: reporter_1.SERENITY_JS_DOMAIN_EVENTS_ATTACHMENT_CONTENT_TYPE,
+            body: Buffer.from(JSON.stringify(serialisedEvents), 'utf8'),
+        });
+    },
+    actors: async ({ browser }, use) => {
+        await use(core_1.Cast.whereEveryoneCan(playwright_1.BrowseTheWebWithPlaywright.using(browser)));
+    },
+    defaultActorName: 'Serena',
+    actor: async ({ actorCalled, defaultActorName }, use) => {
+        await use(actorCalled(defaultActorName));
+    },
+    actorCalled: async ({ serenity, actors, browser, browserName }, use) => {
+        serenity.engage(actors);
+        const sceneId = serenity.currentSceneId();
+        const actorCalled = serenity.theActorCalled.bind(serenity);
+        serenity.announce(new events_1.SceneTagged(sceneId, new model_1.BrowserTag(browserName, browser.version()), serenity.currentTime()));
+        await use(actorCalled);
+        serenity.announce(new events_1.SceneFinishes(sceneId, serenity.currentTime()));
+        await core_1.serenity.waitForNextCue();
+    },
+});
+exports.test = exports.it;
+exports.describe = exports.it.describe;
+exports.beforeAll = exports.it.beforeAll;
+exports.beforeEach = exports.it.beforeEach;
+exports.afterEach = exports.it.afterEach;
+exports.afterAll = exports.it.afterAll;
+exports.expect = exports.it.expect;
+//# sourceMappingURL=api.js.map