@serenity-js/webdriverio-8 3.31.0

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,234 @@
+# Serenity/JS with WebdriverIO 8 🚀
+
+[![Follow Serenity/JS on LinkedIn](https://img.shields.io/badge/Follow-Serenity%2FJS%20-0077B5?logo=linkedin)](https://www.linkedin.com/company/serenity-js)
+[![Watch Serenity/JS on YouTube](https://img.shields.io/badge/Watch-@serenity--js-E62117?logo=youtube)](https://www.youtube.com/@serenity-js)
+[![Join Serenity/JS Community Chat](https://img.shields.io/badge/Chat-Serenity%2FJS%20Community-FBD30B?logo=matrix)](https://matrix.to/#/#serenity-js:gitter.im)
+[![GitHub stars](https://img.shields.io/github/stars/serenity-js/serenity-js?label=Serenity%2FJS&logo=github&style=badge)](https://github.com/serenity-js/serenity-js)
+[![Support Serenity/JS on GitHub](https://img.shields.io/badge/Support-@serenity--js-703EC8?logo=github)](https://github.com/sponsors/serenity-js)
+
+[Serenity/JS](https://serenity-js.org) revolutionises automated testing by enabling your team to write **expressive**, **maintainable tests** that align
+with **your unique domain**. Seamlessly integrating with [WebdriverIO](https://webdriver.io) and test runners like
+[**Mocha**](https://serenity-js.org/handbook/test-runners/mocha/),
+[**Cucumber**](https://serenity-js.org/handbook/test-runners/cucumber/),
+and [**Jasmine**](https://serenity-js.org/handbook/test-runners/jasmine/),
+Serenity/JS also offers **advanced reporting** that provides clear insights into test results,
+helping both technical teams and business stakeholders understand the quality of the system under test.
+
+Serenity/JS WebdriverIO 8 module is intended for existing projects that can't yet upgrade to WebdriverIO 9. 
+If you're starting a new project, we recommend using the [Serenity/JS WebdriverIO module](https://serenity-js.org/api/webdriverio/).
+
+## 🚀 Why choose Serenity/JS?
+
+- Write **expressive**, **maintainable** tests that align with your unique domain using the [**Serenity/JS Screenplay Pattern**](https://serenity-js.org/handbook/design/screenplay-pattern) APIs.
+- **Leverage advanced reporting** to track progress, detect failures, and share results with both technical and business stakeholders.
+- Build on flexible, modular, and extensible architecture that supports a wide range of test automation needs.
+- Integrate with WebdriverIO 8 and modern test automation tools.
+
+## 🛠️ Integrate WebdriverIO 8 with Serenity/JS in 4 steps
+
+### 1. Installing Serenity/JS modules
+
+To add Serenity/JS to an existing WebdriverIO 8 project, install the following Serenity/JS modules from NPM:
+
+```sh
+npm install --save-dev @serenity-js/core @serenity-js/web @serenity-js/webdriverio-8 @serenity-js/assertions @serenity-js/rest @serenity-js/console-reporter @serenity-js/serenity-bdd
+```
+
+Learn more about Serenity/JS modules:
+- [`@serenity-js/core`](/api/core/)
+- [`@serenity-js/web`](/api/web/)
+- [`@serenity-js/webdriverio-8`](/api/webdriverio-8/)
+- [`@serenity-js/assertions`](/api/assertions/)
+- [`@serenity-js/rest`](/api/rest/)
+- [`@serenity-js/console-reporter`](/api/console-reporter/)
+- [`@serenity-js/serenity-bdd`](/api/serenity-bdd/)
+
+If you prefer to review a reference implementation first, clone a [Serenity/JS Project Template](https://serenity-js.org/handbook/getting-started/project-templates/) for your preferred test runner.
+
+### 2. Configuring Serenity/JS
+
+To enable integration with Serenity/JS, configure WebdriverIO as follows:
+
+```ts
+// wdio.conf.ts
+import { WebdriverIOConfig } from '@serenity-js/webdriverio-8';
+
+export const config: WebdriverIOConfig = {
+
+    // Tell WebdriverIO to use Serenity/JS framework with the WebdriverIO 8 adapter
+    // When you're ready to upgrade to WebdriverIO 9, switch to '@serenity-js/webdriverio'
+    framework: '@serenity-js/webdriverio-8',
+
+    // Serenity/JS configuration
+    serenity: {
+        // Configure Serenity/JS to use the appropriate adapter
+        // for your test runner
+        runner: 'cucumber', // or 'mocha', or 'jasmine'
+
+        // Register Serenity/JS reporting services, a.k.a. the "stage crew"
+        crew: [
+            // Optional, print test execution results to standard output
+            '@serenity-js/console-reporter',
+
+            // Optional, produce Serenity BDD reports
+            // and living documentation (HTML)
+            '@serenity-js/serenity-bdd',
+            [ '@serenity-js/core:ArtifactArchiver', {
+                outputDirectory: 'target/site/serenity'
+            } ],
+
+            // Optional, automatically capture screenshots
+            // upon interaction failure
+            [ '@serenity-js/web:Photographer', {
+                strategy: 'TakePhotosOfFailures'
+            } ],
+        ]
+    },
+
+    // Location of your test files
+    specs: [
+        './test/specs/**/*.spec.ts',    // for Mocha or Jasmine
+        // './features/**/*.feature',   // for Cucumber
+    ],
+
+    // Configure your Cucumber runner
+    cucumberOpts: {
+        // see Cucumber configuration options below
+    },
+
+
+    // ... or Jasmine runner
+    jasmineOpts: {
+        // see Jasmine configuration options below
+    },
+
+    // ... or Mocha runner
+    mochaOpts: {
+        // see Mocha configuration options below
+    },
+
+    runner: 'local',
+
+    // Enable TypeScript in-memory compilation
+    autoCompileOpts: {
+        autoCompile: true,
+        tsNodeOpts: {
+            transpileOnly: true,
+            project: 'tsconfig.json'
+        }
+    },
+
+    // Any other WebdriverIO configuration
+};
+```
+
+Learn more about:
+- [Serenity/JS Cucumber configuration options](/api/cucumber-adapter/interface/CucumberConfig/)
+- [Serenity/JS Jasmine configuration options](/api/jasmine-adapter/interface/JasmineConfig/)
+- [Serenity/JS Mocha configuration options](/api/mocha-adapter/interface/MochaConfig/)
+- [WebdriverIO configuration file](https://webdriver.io/docs/configurationfile/)
+
+### 3. Generating Serenity BDD reports and living documentation 
+
+[Serenity BDD reports and living documentation](https://serenity-bdd.github.io/docs/reporting/the_serenity_reports) are generated by [Serenity BDD CLI](https://github.com/serenity-bdd/serenity-core/tree/main/serenity-cli),
+a Java program provided by the [`@serenity-js/serenity-bdd`](/api/serenity-bdd/) module.
+
+To produce Serenity BDD reports, your test suite must:
+- produce intermediate Serenity BDD `.json` reports, by registering [`SerenityBDDReporter`](/api/serenity-bdd/class/SerenityBDDReporter/) as per the [configuration instructions](#configuring-serenityjs-and-webdriverio)
+- invoke the Serenity BDD CLI when you want to produce the report, by calling `serenity-bdd run`
+
+The pattern used by all the [Serenity/JS Project Templates](/handbook/getting-started/project-templates/) relies
+on using the following Node modules:
+- [`npm-failsafe`](https://www.npmjs.com/package/npm-failsafe) to run the reporting process even if the test suite itself has failed (which is precisely when you need test reports the most...).
+- [`rimraf`](https://www.npmjs.com/package/rimraf) as a convenience method to remove any test reports left over from the previous run
+
+```json title="package.json"
+{
+  "scripts": {
+    "test": "failsafe test:clean test:wdio test:report",
+    "test:clean": "rimraf target",
+    "test:wdio": "wdio run ./wdio.conf.ts",
+    "test:report": "serenity-bdd run"
+  }
+}
+```
+
+To learn more about the `SerenityBDDReporter`, please consult:
+- installation instructions in [`@serenity-js/serenity-bdd` documentation](/api/serenity-bdd/),
+- configuration examples in [`SerenityBDDReporter` API docs](/api/serenity-bdd/class/SerenityBDDReporter/),
+- [Serenity/JS examples on GitHub](https://github.com/serenity-js/serenity-js/tree/main/examples).
+
+### 4. Writing a test scenario
+
+Assuming you're using WebdriverIO 8 with Mocha, create a test file under `./test/specs/example.spec.ts` with the following contents:
+
+```ts
+// ./test/specs/example.spec.ts
+import { describe, it } from 'mocha'
+
+import { Ensure, equals } from '@serenity-js/assertions'
+import { actorCalled } from '@serenity-js/core'
+import { By, Navigate, PageElement, Text } from '@serenity-js/web'
+
+describe('Example', () => {
+
+    it('interacts with a web page', async () => {
+
+        await actorCalled('Alice').attemptsTo(
+            Navigate.to('https://serenity-js.org'),
+            Ensure.that(
+                Text.of(PageElement.located(By.id('cta-start-automating'))),
+                equals('Start automating 🚀')
+            ),
+        )
+    })    
+})
+```
+
+You'll notice that the example test file uses:
+- [`@serenity-js/assertions`](https://serenity-js.org/api/assertions/) - to make assertions about the state of the system under test
+- [`@serenity-js/core`](https://serenity-js.org/api/core/) - to create and manage actors
+- [`@serenity-js/web`](https://serenity-js.org/api/web/) - to interact with web pages
+
+You'll also notice that the file **does not** use the `@serenity-js/webdriverio-8` module directly.
+This is because the `@serenity-js/web` module provides a higher-level API for interacting with web pages, 
+allowing you to switch to `@serenity-js/webdriverio` whenever you're ready to upgrade to WebdriverIO 9 without changing your test scenarios.
+
+You can learn more about these and other Serenity/JS modules in the [Serenity/JS API documentation](https://serenity-js.org/api/).
+You might also want to check out the [Serenity/JS WebdriverIO integration guide](https://serenity-js.org/handbook/test-runners/webdriverio/) for more details on configuring your framework.
+
+### 4. Running your tests and generating reports
+
+To run your tests and generate Serenity/JS reports, execute the following command in your terminal:
+
+```sh
+npm test
+```
+
+Your test results will be available in the `target/site/serenity` directory.
+To view them, open the `index.html` file in your preferred web browser.
+
+## 💡️ Learn Serenity/JS
+
+- [Serenity/JS WebdriverIO integration guide](https://serenity-js.org/handbook/test-runners/webdriverio/) - Integrate Serenity/JS with your WebdriverIO test suite, enable Serenity BDD reports, and start using the Screenplay Pattern
+- [Serenity/JS Handbook](https://serenity-js.org/handbook/) - Write high-quality automated acceptance tests with Serenity/JS
+- [Serenity/JS API documentation](https://serenity-js.org/api/) - Explore Serenity/JS modules and features
+- [Serenity/JS Project Templates](https://serenity-js.org/handbook/getting-started/project-templates/) - Kickstart your projects with best practices built right in
+
+## 👋 Join the Serenity/JS Community
+
+- [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im) - Meet Serenity/JS developers and maintainers
+- [Serenity/JS Forum](https://github.com/orgs/serenity-js/discussions/categories/how-to) - Find answers to your Serenity/JS questions
+- [Contribute to Serenity/JS](https://serenity-js.org/community/contributing/) - Learn how to propose features, report bugs, and contribute to the Serenity/JS codebase
+
+## 📣 Stay up to date
+
+- [Serenity/JS on YouTube](https://www.youtube.com/@serenity-js) - Subscribe for tutorials, demos, conference talks, and more
+- [Serenity/JS on LinkedIn](https://www.linkedin.com/company/serenity-js) - Follow for release and community event announcements
+- [Serenity/JS on GitHub](https://github.com/serenity-js/serenity-js) - Star Serenity/JS to help others discover the framework!
+
+## 💛 Support Serenity/JS
+
+Support our mission to make test automation collaborative and easier to scale. Become a Serenity/JS GitHub Sponsor today!
+
+[![GitHub Sponsors](https://img.shields.io/badge/Sponsor%20@serenity%2FJS-703EC8?style=for-the-badge&logo=github&logoColor=white)](https://github.com/sponsors/serenity-js)

package/esm/adapter/TestRunnerLoader.d.ts

@@ -0,0 +1,17 @@
+import type { TestRunnerAdapter } from '@serenity-js/core/lib/adapter/index.js';
+import type { ModuleLoader } from '@serenity-js/core/lib/io/index.js';
+import { Path } from '@serenity-js/core/lib/io/index.js';
+import type { WebdriverIOConfig } from '../config/index.js';
+export declare class TestRunnerLoader {
+    private readonly loader;
+    private readonly cwd;
+    private readonly cid;
+    private readonly fileSystem;
+    private readonly finder;
+    constructor(loader: ModuleLoader, cwd: Path, cid: string);
+    runnerAdapterFor(config: WebdriverIOConfig): TestRunnerAdapter;
+    private cucumberAdapter;
+    private jasmineAdapter;
+    private mochaAdapter;
+}
+//# sourceMappingURL=TestRunnerLoader.d.ts.map

package/esm/adapter/TestRunnerLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestRunnerLoader.d.ts","sourceRoot":"","sources":["../../src/adapter/TestRunnerLoader.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAChF,OAAO,KAAK,EAAE,YAAY,EAAC,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAkC,IAAI,EAAE,MAAM,mCAAmC,CAAC;AAEzF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAQ5D,qBAAa,gBAAgB;IAKrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,GAAG;IANxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;gBAGf,MAAM,EAAE,YAAY,EACpB,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,MAAM;IAMhC,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,GAAG,iBAAiB;IAiB9D,OAAO,CAAC,eAAe;IAoCvB,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,YAAY;CAKvB"}

package/esm/adapter/TestRunnerLoader.js

@@ -0,0 +1,63 @@
+import { ConfigurationError } from '@serenity-js/core';
+import { Config, FileFinder, FileSystem, Path } from '@serenity-js/core/lib/io/index.js';
+export class TestRunnerLoader {
+    loader;
+    cwd;
+    cid;
+    fileSystem;
+    finder;
+    constructor(loader, cwd, cid) {
+        this.loader = loader;
+        this.cwd = cwd;
+        this.cid = cid;
+        this.fileSystem = new FileSystem(cwd);
+        this.finder = new FileFinder(cwd);
+    }
+    runnerAdapterFor(config) {
+        switch (config?.serenity?.runner) {
+            case 'cucumber':
+                return this.cucumberAdapter(config?.cucumberOpts);
+            case 'jasmine':
+                return this.jasmineAdapter(config?.jasmineOpts);
+            case 'mocha':
+            case undefined:
+                return this.mochaAdapter(config?.mochaOpts);
+            default:
+                throw new ConfigurationError(`"${config?.serenity?.runner}" is not a supported test runner. Please use "mocha", "jasmine", or "cucumber"`);
+        }
+    }
+    cucumberAdapter(cucumberOptions) {
+        const { CucumberCLIAdapter, CucumberFormat, StandardOutput, TempFileOutput } = this.loader.require('@serenity-js/cucumber/lib/adapter/index.js');
+        delete cucumberOptions?.timeout; // todo: support setting a timeout via config?
+        delete cucumberOptions?.parallel; // WebdriverIO handles that already
+        const cleanedCucumberOptions = new Config(cucumberOptions)
+            .where('format', values => [].concat(values).map(value => {
+            const format = new CucumberFormat(value);
+            if (format.output === '') {
+                return format.value;
+            }
+            const basename = Path.from(format.output).basename();
+            const filenameParts = basename.split('.');
+            if (filenameParts[0] === basename) {
+                return `${format.formatter}:${format.output}.${this.cid}`;
+            }
+            filenameParts.splice(-1, 0, `${this.cid}`);
+            return `${format.formatter}:${format.output.replace(basename, filenameParts.join('.'))}`;
+        })).object();
+        // check if we need to free up stdout for any native reporters
+        const output = cleanedCucumberOptions?.format?.some(format => new CucumberFormat(format).output === '')
+            ? new TempFileOutput(this.fileSystem)
+            : new StandardOutput();
+        return new CucumberCLIAdapter(cleanedCucumberOptions, this.loader, this.fileSystem, output);
+    }
+    jasmineAdapter(jasmineOptions) {
+        const { JasmineAdapter } = this.loader.require('@serenity-js/jasmine/adapter');
+        return new JasmineAdapter(jasmineOptions, this.loader);
+    }
+    mochaAdapter(mochaOptions) {
+        // todo: update path to mocha adapter too
+        const { MochaAdapter } = this.loader.require('@serenity-js/mocha/lib/adapter/index.js');
+        return new MochaAdapter(mochaOptions, this.loader);
+    }
+}
+//# sourceMappingURL=TestRunnerLoader.js.map

package/esm/adapter/TestRunnerLoader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestRunnerLoader.js","sourceRoot":"","sources":["../../src/adapter/TestRunnerLoader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAGvD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,mCAAmC,CAAC;AAUzF,MAAM,OAAO,gBAAgB;IAKJ;IACA;IACA;IANJ,UAAU,CAAa;IACvB,MAAM,CAAa;IAEpC,YACqB,MAAoB,EACpB,GAAS,EACT,GAAW;QAFX,WAAM,GAAN,MAAM,CAAc;QACpB,QAAG,GAAH,GAAG,CAAM;QACT,QAAG,GAAH,GAAG,CAAQ;QAE5B,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,GAAO,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED,gBAAgB,CAAC,MAAyB;QACtC,QAAQ,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;YAC/B,KAAK,UAAU;gBACX,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YAEtD,KAAK,SAAS;gBACV,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAEpD,KAAK,OAAO,CAAC;YACb,KAAK,SAAS;gBACV,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAEhD;gBACI,MAAM,IAAI,kBAAkB,CAAC,IAAK,MAAM,EAAE,QAAQ,EAAE,MAAO,gFAAgF,CAAC,CAAC;QACrJ,CAAC;IACL,CAAC;IAEO,eAAe,CAAC,eAAmC;QACvD,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,4CAA4C,CAAC,CAAC;QAEjJ,OAAO,eAAe,EAAE,OAAO,CAAC,CAAG,8CAA8C;QACjF,OAAO,eAAe,EAAE,QAAQ,CAAC,CAAE,mCAAmC;QAEtE,MAAM,sBAAsB,GAAG,IAAI,MAAM,CAAC,eAAe,CAAC;aACrD,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CACtB,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YAC1B,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC;YAEzC,IAAI,MAAM,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;gBACvB,OAAO,MAAM,CAAC,KAAK,CAAC;YACxB,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YACrD,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAE1C,IAAI,aAAa,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAChC,OAAO,GAAI,MAAM,CAAC,SAAU,IAAK,MAAM,CAAC,MAAO,IAAK,IAAI,CAAC,GAAI,EAAE,CAAC;YACpE,CAAC;YAED,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAI,IAAI,CAAC,GAAI,EAAE,CAAC,CAAC;YAE7C,OAAO,GAAI,MAAM,CAAC,SAAU,IAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAE,EAAE,CAAC;QACjG,CAAC,CAAC,CACL,CAAC,MAAM,EAAE,CAAC;QAEf,8DAA8D;QAC9D,MAAM,MAAM,GAAG,sBAAsB,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC;YACnG,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC;YACrC,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC;QAE3B,OAAO,IAAI,kBAAkB,CAAC,sBAAsB,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAChG,CAAC;IAEO,cAAc,CAAC,cAAiC;QACpD,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,8BAA8B,CAAC,CAAA;QAC9E,OAAO,IAAI,cAAc,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;IAEO,YAAY,CAAC,YAA+B;QAChD,yCAAyC;QACzC,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,yCAAyC,CAAC,CAAA;QACvF,OAAO,IAAI,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACvD,CAAC;CACJ"}

package/esm/adapter/WebdriverIOFrameworkAdapter.d.ts

@@ -0,0 +1,25 @@
+import 'webdriverio';
+import type { Serenity } from '@serenity-js/core';
+import type { ModuleLoader } from '@serenity-js/core/lib/io/index.js';
+import { Path } from '@serenity-js/core/lib/io/index.js';
+import type { Capabilities } from '@wdio/types';
+import type { EventEmitter } from 'events';
+import type { WebdriverIOConfig } from '../config/index.js';
+import type { InitialisesReporters, ProvidesWriteStream } from './reporter/index.js';
+export declare class WebdriverIOFrameworkAdapter {
+    private readonly serenity;
+    private readonly loader;
+    private readonly cwd;
+    private readonly cid;
+    private readonly specs;
+    private readonly capabilities;
+    private readonly reporter;
+    private adapter;
+    private notifier;
+    constructor(serenity: Serenity, loader: ModuleLoader, cwd: Path, cid: string, webdriverIOConfig: WebdriverIOConfig, specs: string[], capabilities: Capabilities.RemoteCapability, reporter: EventEmitter & ProvidesWriteStream & InitialisesReporters);
+    init(): Promise<WebdriverIOFrameworkAdapter>;
+    hasTests(): boolean;
+    run(): Promise<number>;
+    private defaultConfig;
+}
+//# sourceMappingURL=WebdriverIOFrameworkAdapter.d.ts.map

package/esm/adapter/WebdriverIOFrameworkAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebdriverIOFrameworkAdapter.d.ts","sourceRoot":"","sources":["../../src/adapter/WebdriverIOFrameworkAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAC;AAErB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAGlD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,mCAAmC,CAAC;AAEzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAG3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAMrF,qBAAa,2BAA2B;IAMhC,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,GAAG;IAEpB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAX7B,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,QAAQ,CAAsB;gBAGjB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,YAAY,EACpB,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,MAAM,EAC5B,iBAAiB,EAAE,iBAAiB,EACnB,KAAK,EAAE,MAAM,EAAE,EACf,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAC3C,QAAQ,EAAE,YAAY,GAAG,mBAAmB,GAAG,oBAAoB;IAwDlF,IAAI,IAAI,OAAO,CAAC,2BAA2B,CAAC;IAqBlD,QAAQ,IAAI,OAAO;IAIb,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC;IAK5B,OAAO,CAAC,aAAa;CASxB"}

package/esm/adapter/WebdriverIOFrameworkAdapter.js

@@ -0,0 +1,90 @@
+import 'webdriverio';
+import { AnsiDiffFormatter, ArtifactArchiver, Cast, TakeNotes } from '@serenity-js/core';
+import { Path } from '@serenity-js/core/lib/io/index.js';
+import { CallAnApi } from '@serenity-js/rest';
+import * as deepmerge from 'deepmerge';
+import { isRecord } from 'tiny-types/lib/objects/isRecord.js';
+import { BrowseTheWebWithWebdriverIO } from '../screenplay/index.js';
+import { BrowserCapabilitiesReporter, OutputStreamBuffer } from './reporter/index.js';
+import { OutputStreamBufferPrinter } from './reporter/OutputStreamBufferPrinter.js';
+import { TestRunnerLoader } from './TestRunnerLoader.js';
+import { WebdriverIONotifier } from './WebdriverIONotifier.js';
+export class WebdriverIOFrameworkAdapter {
+    serenity;
+    loader;
+    cwd;
+    cid;
+    specs;
+    capabilities;
+    reporter;
+    adapter;
+    notifier;
+    constructor(serenity, loader, cwd, cid, webdriverIOConfig, specs, capabilities, reporter) {
+        this.serenity = serenity;
+        this.loader = loader;
+        this.cwd = cwd;
+        this.cid = cid;
+        this.specs = specs;
+        this.capabilities = capabilities;
+        this.reporter = reporter;
+        const config = deepmerge.default(this.defaultConfig(), webdriverIOConfig, {
+            isMergeableObject: isRecord,
+        });
+        // SauceLabs service serialises the config object for debugging.
+        // However, since Serenity/JS Stage is a pub/sub mechanism,
+        // it contains cyclic references which are not serialisable.
+        // We get rid of them from the config object to avoid confusing other services.
+        delete webdriverIOConfig.serenity;
+        this.adapter = new TestRunnerLoader(this.loader, this.cwd, this.cid)
+            .runnerAdapterFor(config);
+        this.notifier = new WebdriverIONotifier(config, capabilities, reporter, this.adapter.successThreshold(), cid, this.specs);
+        const outputStreamBuffer = new OutputStreamBuffer(`[${this.cid}]`);
+        const outputStreamBufferPrinter = new OutputStreamBufferPrinter(outputStreamBuffer, reporter.getWriteStreamObject('@serenity-js/webdriverio-8'));
+        this.serenity.configure({
+            outputStream: outputStreamBuffer,
+            cueTimeout: config.serenity.cueTimeout,
+            interactionTimeout: config.serenity.interactionTimeout,
+            diffFormatter: config.serenity.diffFormatter ?? new AnsiDiffFormatter(),
+            actors: config.serenity.actors || Cast.where(actor => actor.whoCan(BrowseTheWebWithWebdriverIO.using(global.browser), TakeNotes.usingAnEmptyNotepad(), CallAnApi.using({
+                baseURL: webdriverIOConfig.baseUrl,
+            }))),
+            crew: [
+                ...config.serenity.crew,
+                this.notifier,
+                outputStreamBufferPrinter,
+            ]
+        });
+    }
+    async init() {
+        // This is the only (hacky) way to register a fake reporter programmatically (as of @wdio/reporter 7.4.2)
+        //  - https://github.com/webdriverio/webdriverio/blob/365fb0ad79fcf4471f21f23e18afa6818986dbdb/packages/wdio-runner/src/index.ts#L147-L181
+        //  - https://github.com/webdriverio/webdriverio/blob/365fb0ad79fcf4471f21f23e18afa6818986dbdb/packages/wdio-runner/src/reporter.ts#L24
+        const browserCapabilitiesReporter = await (this.reporter._loadReporter([
+            BrowserCapabilitiesReporter, {
+                serenity: this.serenity
+            },
+        ]));
+        this.reporter._reporters.push(browserCapabilitiesReporter);
+        // WebdriverIO v8 represents paths to specs as file URIs, so they need to be converted to absolute paths to avoid confusing the test runners like Cucumber
+        const absolutePaths = this.specs.map(pathToSpec => Path.from(pathToSpec).value);
+        await this.adapter.load(absolutePaths);
+        return this;
+    }
+    hasTests() {
+        return this.adapter.scenarioCount() > 0;
+    }
+    async run() {
+        await this.adapter.run();
+        return this.notifier.failureCount();
+    }
+    defaultConfig() {
+        return {
+            serenity: {
+                crew: [
+                    ArtifactArchiver.storingArtifactsAt(this.cwd.value, 'target/site/serenity'),
+                ]
+            }
+        };
+    }
+}
+//# sourceMappingURL=WebdriverIOFrameworkAdapter.js.map