@serenity-js/webdriverio 3.1.6 → 3.2.0

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

@@ -1,3 +1,3 @@
-export * from './WebdriverIOLocator';
-export * from './WebdriverIORootLocator';
+export * from './WebdriverIOLocator.js';
+export * from './WebdriverIORootLocator.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/models/locators/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/models/locators/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC"}

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

@@ -14,6 +14,6 @@ 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("./WebdriverIOLocator"), exports);
-__exportStar(require("./WebdriverIORootLocator"), exports);
+__exportStar(require("./WebdriverIOLocator.js"), exports);
+__exportStar(require("./WebdriverIORootLocator.js"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/screenplay/models/locators/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,2DAAyC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/screenplay/models/locators/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,8DAA4C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/webdriverio",
-  "version": "3.1.6",
+  "version": "3.2.0",
   "description": "Serenity/JS reporter and Screenplay Pattern library for WebdriverIO",
   "author": {
     "name": "Jan Molak",
@@ -15,8 +15,21 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "type": "module",
+  "module": "./esm/index.js",
+  "exports": {
+    ".": [
+      {
+        "types": "./esm/index.d.ts",
+        "import": "./esm/index.js",
+        "require": "./lib/index.js"
+      },
+      "./lib/index.js"
+    ],
+    "./package.json": "./package.json"
+  },
   "keywords": [
     "serenity-js",
     "ui",
@@ -31,8 +44,13 @@
   ],
   "scripts": {
     "clean": "rimraf target",
-    "test": "nyc mocha --config ../../.mocharc.yml 'spec/adapter/**/*.spec.*'",
-    "compile": "rimraf lib && tsc --project tsconfig.build.json"
+    "test": "c8 npm run test:no-coverage",
+    "test:no-coverage": "mocha --config .mocharc.yml 'spec/**/*.spec.*'",
+    "compile": "npm run compile:clean && npm run compile:esm && npm run compile:cjs && npm run compile:cjs-package",
+    "compile:clean": "rimraf lib esm",
+    "compile:esm": "tsc --project tsconfig-esm.build.json",
+    "compile:cjs": "tsc --project tsconfig-cjs.build.json",
+    "compile:cjs-package": "node -e \"require('fs').writeFileSync('lib/package.json', '{ \\\"type\\\": \\\"commonjs\\\" }')\""
   },
   "repository": {
     "type": "git",
@@ -43,14 +61,12 @@
     "url": "https://github.com/serenity-js/serenity-js/issues"
   },
   "engines": {
-    "node": "^14 || ^16 || ^18",
-    "npm": "^6 || ^7 || ^8 || ^9"
+    "node": "^16.13 || ^18.12 || ^20"
   },
   "dependencies": {
-    "@serenity-js/core": "3.1.6",
-    "@serenity-js/web": "3.1.6",
-    "@wdio/reporter": "^7.31.1",
-    "@wdio/types": "^7.30.2",
+    "@serenity-js/core": "3.2.0",
+    "@serenity-js/web": "3.2.0",
+    "@wdio/reporter": "^8.8.7",
     "deepmerge": "^4.3.1",
     "tiny-types": "^1.19.1"
   },
@@ -58,8 +74,8 @@
     "@serenity-js/cucumber": "^3.0.0",
     "@serenity-js/jasmine": "^3.0.0",
     "@serenity-js/mocha": "^3.0.0",
-    "@wdio/cli": "^7.31.1",
-    "webdriverio": "^7.31.1"
+    "@wdio/cli": "^8.10.0",
+    "webdriverio": "^8.10.0"
   },
   "peerDependenciesMeta": {
     "@serenity-js/cucumber": {
@@ -75,40 +91,21 @@
   "devDependencies": {
     "@integration/testing-tools": "3.0.0",
     "@types/mocha": "^10.0.1",
-    "@wdio/cli": "7.31.1",
-    "@wdio/devtools-service": "7.31.1",
-    "@wdio/dot-reporter": "7.31.1",
-    "@wdio/local-runner": "7.31.1",
-    "@wdio/spec-reporter": "7.31.1",
+    "@wdio/cli": "8.10.0",
+    "@wdio/devtools-service": "8.10.0",
+    "@wdio/dot-reporter": "8.10.0",
+    "@wdio/local-runner": "8.10.0",
+    "@wdio/spec-reporter": "8.10.0",
+    "@wdio/types": "8.10.0",
     "axios": "^1.3.5",
+    "c8": "7.13.0",
     "cross-env": "^7.0.3",
     "mocha": "^10.2.0",
     "mocha-multi": "^1.1.7",
     "mocha-testdata": "^1.2.0",
-    "nyc": "15.1.0",
-    "puppeteer-core": "^19.9.1",
+    "puppeteer-core": "^19.11.1",
     "start-server-and-test": "^2.0.0",
-    "webdriverio": "7.31.1"
-  },
-  "nyc": {
-    "include": [
-      "src/**/*.ts"
-    ],
-    "exclude": [
-      "src/**/*.d.ts",
-      "lib",
-      "node_modules",
-      "spec"
-    ],
-    "extension": [
-      ".ts"
-    ],
-    "require": [],
-    "reporter": [
-      "json"
-    ],
-    "cache": true,
-    "all": false
+    "webdriverio": "8.10.0"
   },
-  "gitHead": "825ecf4f0dd507e78da8b0634f659ecd3ddfb976"
+  "gitHead": "e69cea764f50991c3ad742f28926b4345b3e2422"
 }

package/src/adapter/TestRunnerLoader.ts

@@ -1,9 +1,14 @@
 import { ConfigurationError } from '@serenity-js/core';
-import { TestRunnerAdapter } from '@serenity-js/core/lib/adapter';
-import { Config, FileFinder, FileSystem, ModuleLoader, Path } from '@serenity-js/core/lib/io';
-import { WebdriverIO } from '@wdio/types/build/Options';
+import { TestRunnerAdapter } from '@serenity-js/core/lib/adapter/index.js';
+import { Config, FileFinder, FileSystem, ModuleLoader, Path } from '@serenity-js/core/lib/io/index.js';
 
-import { WebdriverIOConfig } from './WebdriverIOConfig';
+import { WebdriverIOConfig } from '../config/index.js';
+
+// We define TestRunnerOptions to avoid importing the global WebdriverIO namespace.
+// WebdriverIO v8 doesn't offer any more precise type declarations anyway.
+interface TestRunnerOptions {
+    [key: string]: any;
+}
 
 export class TestRunnerLoader {
     private readonly fileSystem: FileSystem;
@@ -35,8 +40,8 @@ export class TestRunnerLoader {
         }
     }
 
-    private cucumberAdapter(cucumberOptions?: WebdriverIO.CucumberOpts): TestRunnerAdapter {
-        const { CucumberCLIAdapter, CucumberFormat, StandardOutput, TempFileOutput } = this.loader.require('@serenity-js/cucumber/lib/adapter');
+    private cucumberAdapter(cucumberOptions?: TestRunnerOptions): TestRunnerAdapter {
+        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
@@ -74,13 +79,13 @@ export class TestRunnerLoader {
         return new CucumberCLIAdapter(cleanedCucumberOptions, this.loader, this.fileSystem, output);
     }
 
-    private jasmineAdapter(jasmineOptions: WebdriverIO.JasmineOpts): TestRunnerAdapter {
-        const { JasmineAdapter } = this.loader.require('@serenity-js/jasmine/lib/adapter')
+    private jasmineAdapter(jasmineOptions: TestRunnerOptions): TestRunnerAdapter {
+        const { JasmineAdapter } = this.loader.require('@serenity-js/jasmine/lib/adapter/index.js')
         return new JasmineAdapter(jasmineOptions, this.loader);
     }
 
-    private mochaAdapter(mochaOptions: WebdriverIO.MochaOpts): TestRunnerAdapter {
-        const { MochaAdapter } = this.loader.require('@serenity-js/mocha/lib/adapter')
+    private mochaAdapter(mochaOptions: TestRunnerOptions): TestRunnerAdapter {
+        const { MochaAdapter } = this.loader.require('@serenity-js/mocha/lib/adapter/index.js')
         return new MochaAdapter(mochaOptions, this.loader);
     }
 }

package/src/adapter/WebdriverIOFrameworkAdapter.ts

@@ -1,17 +1,23 @@
 import { AnsiDiffFormatter, ArtifactArchiver, Cast, Serenity, TakeNotes } from '@serenity-js/core';
-import { TestRunnerAdapter } from '@serenity-js/core/lib/adapter';
-import { ModuleLoader, Path } from '@serenity-js/core/lib/io';
+import { TestRunnerAdapter } from '@serenity-js/core/lib/adapter/index.js';
+import { ModuleLoader, Path } from '@serenity-js/core/lib/io/index.js';
 import type { Capabilities } from '@wdio/types';
+import * as deepmerge from 'deepmerge';
 import type { EventEmitter } from 'events';
-import { isRecord } from 'tiny-types/lib/objects';
-
-import { BrowseTheWebWithWebdriverIO } from '../screenplay';
-import { BrowserCapabilitiesReporter, InitialisesReporters, OutputStreamBuffer, ProvidesWriteStream } from './reporter';
-import { OutputStreamBufferPrinter } from './reporter/OutputStreamBufferPrinter';
-import { TestRunnerLoader } from './TestRunnerLoader';
-import { WebdriverIOConfig } from './WebdriverIOConfig';
-import { WebdriverIONotifier } from './WebdriverIONotifier';
-import deepmerge = require('deepmerge');
+import { isRecord } from 'tiny-types/lib/objects/isRecord.js';
+import type { Browser } from 'webdriverio';
+
+import { WebdriverIOConfig } from '../config/index.js';
+import { BrowseTheWebWithWebdriverIO } from '../screenplay/index.js';
+import {
+    BrowserCapabilitiesReporter,
+    InitialisesReporters,
+    OutputStreamBuffer,
+    ProvidesWriteStream
+} from './reporter/index.js';
+import { OutputStreamBufferPrinter } from './reporter/OutputStreamBufferPrinter.js';
+import { TestRunnerLoader } from './TestRunnerLoader.js';
+import { WebdriverIONotifier } from './WebdriverIONotifier.js';
 
 export class WebdriverIOFrameworkAdapter {
 
@@ -26,9 +32,9 @@ export class WebdriverIOFrameworkAdapter {
         webdriverIOConfig: WebdriverIOConfig,
         private readonly specs: string[],
         private readonly capabilities: Capabilities.RemoteCapability,
-        reporter: EventEmitter & ProvidesWriteStream & InitialisesReporters
+        private readonly reporter: EventEmitter & ProvidesWriteStream & InitialisesReporters
     ) {
-        const config = deepmerge<WebdriverIOConfig>(this.defaultConfig(), webdriverIOConfig, {
+        const config = deepmerge.default<WebdriverIOConfig>(this.defaultConfig(), webdriverIOConfig, {
             isMergeableObject: isRecord,
         });
 
@@ -41,13 +47,6 @@ export class WebdriverIOFrameworkAdapter {
         this.adapter = new TestRunnerLoader(this.loader, this.cwd, this.cid)
             .runnerAdapterFor(config);
 
-        // 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
-        (reporter as any)._reporters.push(reporter.initReporter([
-            BrowserCapabilitiesReporter, { serenity: this.serenity },
-        ]));
-
         this.notifier = new WebdriverIONotifier(
             config,
             capabilities,
@@ -58,7 +57,7 @@ export class WebdriverIOFrameworkAdapter {
         );
 
         const outputStreamBuffer = new OutputStreamBuffer(
-            `[${this.cid}]`,
+            `[${ this.cid }]`,
         );
 
         const outputStreamBufferPrinter = new OutputStreamBufferPrinter(
@@ -67,14 +66,14 @@ export class WebdriverIOFrameworkAdapter {
         );
 
         this.serenity.configure({
-            outputStream:       outputStreamBuffer,
-            cueTimeout:         config.serenity.cueTimeout,
+            outputStream: outputStreamBuffer,
+            cueTimeout: config.serenity.cueTimeout,
             interactionTimeout: config.serenity.interactionTimeout,
 
-            diffFormatter:  config.serenity.diffFormatter ?? new AnsiDiffFormatter(),
+            diffFormatter: config.serenity.diffFormatter ?? new AnsiDiffFormatter(),
 
             actors: config.serenity.actors || Cast.where(actor => actor.whoCan(
-                BrowseTheWebWithWebdriverIO.using(browser),
+                BrowseTheWebWithWebdriverIO.using(global.browser as unknown as Browser),
                 TakeNotes.usingAnEmptyNotepad(),
             )),
 
@@ -88,7 +87,21 @@ export class WebdriverIOFrameworkAdapter {
 
     async init(): Promise<WebdriverIOFrameworkAdapter> {
 
-        await this.adapter.load(this.specs);
+        // 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 as any)._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.fromURI(pathToSpec).value);
+
+        await this.adapter.load(absolutePaths);
 
         return this;
     }

package/src/adapter/WebdriverIOFrameworkAdapterFactory.ts

@@ -1,11 +1,11 @@
 import { Serenity } from '@serenity-js/core';
-import { ModuleLoader, Path } from '@serenity-js/core/lib/io';
+import { ModuleLoader, Path } from '@serenity-js/core/lib/io/index.js';
 import type { Capabilities } from '@wdio/types';
 import type { EventEmitter } from 'events';
 
-import { InitialisesReporters, ProvidesWriteStream } from './reporter';
-import { WebdriverIOConfig } from './WebdriverIOConfig';
-import { WebdriverIOFrameworkAdapter } from './WebdriverIOFrameworkAdapter';
+import { WebdriverIOConfig } from '../config/index.js';
+import { InitialisesReporters, ProvidesWriteStream } from './reporter/index.js';
+import { WebdriverIOFrameworkAdapter } from './WebdriverIOFrameworkAdapter.js';
 
 /**
  * @group Test Runner Adapter

package/src/adapter/WebdriverIONotifier.ts

@@ -1,5 +1,5 @@
 import { LogicError, Stage, StageCrewMember } from '@serenity-js/core';
-import { AsyncOperationAttempted, AsyncOperationCompleted, DomainEvent, SceneFinished, SceneStarts, TestRunFinishes, TestSuiteFinished, TestSuiteStarts } from '@serenity-js/core/lib/events';
+import { AsyncOperationAttempted, AsyncOperationCompleted, DomainEvent, SceneFinished, SceneStarts, TestRunFinishes, TestSuiteFinished, TestSuiteStarts } from '@serenity-js/core/lib/events/index.js';
 import {
     CorrelationId,
     Description,
@@ -12,15 +12,38 @@ import {
     Outcome,
     ProblemIndication,
     TestSuiteDetails,
-} from '@serenity-js/core/lib/model';
-import { Suite as suiteStats } from '@wdio/reporter/build/stats/suite';
-import { Test as testStats } from '@wdio/reporter/build/stats/test';
-import { RemoteCapability } from '@wdio/types/build/Capabilities';
-import * as frameworks from '@wdio/types/build/Frameworks';
+} from '@serenity-js/core/lib/model/index.js';
+import type { Test as testStats } from '@wdio/reporter';
+import type { Capabilities, Frameworks } from '@wdio/types';
 import type { EventEmitter } from 'events';
 import { match } from 'tiny-types';
 
-import { WebdriverIOConfig } from './WebdriverIOConfig';
+import { WebdriverIOConfig } from '../config/index.js';
+
+// interface Argument {
+//     rows?: {
+//         cells: string[];
+//     }[];
+// }
+//
+// export interface testStats {
+//     type: 'test:start' | 'test:pass' | 'test:fail' | 'test:retry' | 'test:pending' | 'test:end' | 'test:skip';
+//     title: string;
+//     parent: string;
+//     fullTitle: string;
+//     pending: boolean;
+//     file?: string;
+//     duration?: number;
+//     cid: string;
+//     specs: string[];
+//     uid: string;
+//     pendingReason?: string;
+//     error?: Error;
+//     errors?: Error[];
+//     retries?: number;
+//     argument?: string | Argument;
+// }
+//
 
 /**
  * @package
@@ -41,7 +64,7 @@ export class WebdriverIONotifier implements StageCrewMember {
 
     constructor(
         private readonly config: WebdriverIOConfig,
-        private readonly capabilities: RemoteCapability,
+        private readonly capabilities: Capabilities.RemoteCapability,
         private readonly reporter: EventEmitter,
         private readonly successThreshold: Outcome | { Code: number },
         private readonly cid: string,
@@ -97,7 +120,7 @@ export class WebdriverIONotifier implements StageCrewMember {
         return this.invokeHooks('afterSuite', this.config.afterSuite, [suite as any]);  // todo: correct types
     }
 
-    private suiteStartEventFrom(started: TestSuiteStarts): suiteStats & frameworks.Suite {
+    private suiteStartEventFrom(started: TestSuiteStarts): { uid: string, cid: string, specs: string[] } & Frameworks.Suite {
         return {
             type:       'suite:start',
             uid:        started.details.correlationId.value,
@@ -105,7 +128,7 @@ export class WebdriverIONotifier implements StageCrewMember {
             title:      started.details.name.value,
             fullTitle:  this.suiteNamesConcatenatedWith(started.details.name.value),
             parent:     this.parentSuiteName(),
-            file:       started.details.location.path.value,
+            file:        started.details.location.path.value,
             specs:      this.specs,
             pending:    false,
         }
@@ -115,7 +138,7 @@ export class WebdriverIONotifier implements StageCrewMember {
         return this.suites.map(suite => suite.name.value).concat(name).join(' ');
     }
 
-    private suiteEndEventFrom(started: TestSuiteStarts, finished: TestSuiteFinished): suiteStats & frameworks.Suite {
+    private suiteEndEventFrom(started: TestSuiteStarts, finished: TestSuiteFinished): Frameworks.Suite {
         return {
             ...this.suiteStartEventFrom(started),
             type:       'suite:end',
@@ -175,7 +198,7 @@ export class WebdriverIONotifier implements StageCrewMember {
             .trim();
     }
 
-    private testFrom(started: SceneStarts): frameworks.Test {
+    private testFrom(started: SceneStarts): Frameworks.Test {
         const
             title           = this.testShortTitleFrom(started);
 
@@ -219,14 +242,14 @@ export class WebdriverIONotifier implements StageCrewMember {
      * @param finished
      * @private
      */
-    private testResultFrom(started: SceneStarts, finished: SceneFinished): frameworks.TestResult {
+    private testResultFrom(started: SceneStarts, finished: SceneFinished): Frameworks.TestResult {
         const duration = finished.timestamp.diff(started.timestamp).inMilliseconds();
         const defaultRetries = { attempts: 0, limit: 0 };
 
         const passedOrFailed = (outcome: Outcome): boolean =>
             this.whenSuccessful<boolean>(outcome, true, false);
 
-        return match<Outcome, frameworks.TestResult>(finished.outcome)
+        return match<Outcome, Frameworks.TestResult>(finished.outcome)
             .when(ExecutionCompromised, (outcome: ExecutionCompromised) => {
                 const error = this.errorFrom(outcome);
                 return {

package/src/adapter/index.ts

@@ -1,2 +1 @@
-export * from './WebdriverIOConfig';
-export * from './WebdriverIOFrameworkAdapterFactory';
+export * from './WebdriverIOFrameworkAdapterFactory.js';

package/src/adapter/reporter/BrowserCapabilitiesReporter.ts

@@ -1,10 +1,10 @@
 import { Serenity } from '@serenity-js/core';
-import { SceneTagged } from '@serenity-js/core/lib/events';
-import { Tag } from '@serenity-js/core/lib/model';
+import { SceneTagged } from '@serenity-js/core/lib/events/index.js';
+import { Tag } from '@serenity-js/core/lib/model/index.js';
 import Reporter from '@wdio/reporter';
-import { Capabilities, Options, Reporters } from '@wdio/types';
+import type { Capabilities, Options, Reporters } from '@wdio/types';
 
-import { TagPrinter } from './TagPrinter';
+import { TagPrinter } from './TagPrinter.js';
 
 /**
  * @package

package/src/adapter/reporter/InitialisesReporters.ts

@@ -1,8 +1,8 @@
-import { Reporters } from '@wdio/types';
+import type { Reporters } from '@wdio/types';
 
 /**
  * @package
  */
 export interface InitialisesReporters {
-    initReporter(reporter: Reporters.ReporterEntry): void;
+    _loadReporter(reporter: Reporters.ReporterEntry): Promise<void>;
 }

package/src/adapter/reporter/OutputStreamBuffer.ts

@@ -1,4 +1,4 @@
-import { OutputStream } from '@serenity-js/core/lib/adapter';
+import { OutputStream } from '@serenity-js/core/lib/adapter/index.js';
 
 /**
  * @package

package/src/adapter/reporter/OutputStreamBufferPrinter.ts

@@ -1,8 +1,8 @@
 import { Stage, StageCrewMember } from '@serenity-js/core';
-import { OutputStream } from '@serenity-js/core/lib/adapter';
-import { DomainEvent, SceneFinished } from '@serenity-js/core/lib/events';
+import { OutputStream } from '@serenity-js/core/lib/adapter/index.js';
+import { DomainEvent, SceneFinished } from '@serenity-js/core/lib/events/index.js';
 
-import { OutputStreamBuffer } from './OutputStreamBuffer';
+import { OutputStreamBuffer } from './OutputStreamBuffer.js';
 
 /**
  * @package

package/src/adapter/reporter/ProvidesWriteStream.ts

@@ -1,4 +1,4 @@
-import { OutputStream } from '@serenity-js/core/lib/adapter';
+import { OutputStream } from '@serenity-js/core/lib/adapter/index.js';
 
 /**
  * @package

package/src/adapter/reporter/TagPrinter.ts

@@ -1,5 +1,5 @@
-import { BrowserTag, PlatformTag, Tag } from '@serenity-js/core/lib/model';
-import { Capabilities } from '@wdio/types';
+import { BrowserTag, PlatformTag, Tag } from '@serenity-js/core/lib/model/index.js';
+import type { Capabilities } from '@wdio/types';
 
 /**
  * @package
@@ -31,12 +31,13 @@ export class TagPrinter {
     private browserNameFrom(capabilities: Capabilities.DesiredCapabilities): string {
         return capabilities.browserName
             || capabilities.browser
-            || (capabilities.app && capabilities.app.replace('sauce-storage:', ''))
+            || (capabilities['appium:app'] && capabilities['appium:app'].replace('sauce-storage:', ''))
             || 'unknown';
     }
 
     private browserVersionFrom(capabilities: Capabilities.DesiredCapabilities): string | undefined {
         return capabilities.deviceName          // mobile web
+            || capabilities['appium:deviceName']
             || capabilities.browserVersion      // W3C format
             || capabilities.version             // JSONWP format
             || capabilities.browser_version;    // BrowserStack
@@ -44,13 +45,14 @@ export class TagPrinter {
 
     private platformNameFrom(capabilities: Capabilities.DesiredCapabilities): string {
         return capabilities.platformName
+            || capabilities['appium:platformName']
             || capabilities.platform
             || capabilities.os
             || 'unknown';
     }
 
     private platformVersionFrom(capabilities: Capabilities.DesiredCapabilities): string | undefined {
-        return capabilities.platformVersion
+        return capabilities['appium:platformVersion']
             || capabilities.os_version;
     }
 

package/src/adapter/reporter/index.ts

@@ -1,5 +1,5 @@
-export * from './BrowserCapabilitiesReporter';
-export * from './InitialisesReporters';
-export * from './OutputStreamBuffer';
-export * from './ProvidesWriteStream';
-export * from './TagPrinter';
+export * from './BrowserCapabilitiesReporter.js';
+export * from './InitialisesReporters.js';
+export * from './OutputStreamBuffer.js';
+export * from './ProvidesWriteStream.js';
+export * from './TagPrinter.js';

package/src/api.ts

@@ -0,0 +1,2 @@
+export { WebdriverIOConfig } from './config/index.js';
+export * from './screenplay/index.js';

package/src/config/index.ts

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

package/src/index.ts

@@ -1,15 +1,32 @@
 import { serenity } from '@serenity-js/core';
-import { ModuleLoader, Path } from '@serenity-js/core/lib/io';
+import { ModuleLoader, Path } from '@serenity-js/core/lib/io/index.js';
+import { Capabilities } from '@wdio/types';
+import { EventEmitter } from 'events';
 
-import { WebdriverIOFrameworkAdapterFactory } from './adapter';
+import { InitialisesReporters, ProvidesWriteStream } from './adapter/reporter/index.js';
+import { WebdriverIOConfig } from './config/index.js';
 
-const adapterFactory = new WebdriverIOFrameworkAdapterFactory(
-    serenity,
-    new ModuleLoader(process.cwd()),
-    Path.from(process.cwd()),
-);
+/**
+ * WebdriverIO Framework Adapter integrates WebdriverIO with Serenity/JS
+ */
+export default {
+    async init(
+        cid: string,
+        config: WebdriverIOConfig,
+        specs: string[],
+        capabilities: Capabilities.RemoteCapability,
+        reporter: EventEmitter & ProvidesWriteStream & InitialisesReporters
+    ): Promise<{ hasTests: () => boolean, run: () => Promise<number> }> {
+        const { WebdriverIOFrameworkAdapterFactory } = await import('./adapter/index.js');
 
-export default adapterFactory;
+        const adapterFactory = new WebdriverIOFrameworkAdapterFactory(
+            serenity,
+            new ModuleLoader(process.cwd()),
+            Path.from(process.cwd()),
+        );
 
-export { WebdriverIOConfig } from './adapter';
-export * from './screenplay';
+        return adapterFactory.init(cid, config, specs, capabilities, reporter);
+    }
+};
+
+export * from './api.js';

package/src/screenplay/abilities/BrowseTheWebWithWebdriverIO.ts

@@ -1,7 +1,7 @@
 import { BrowserCapabilities, BrowseTheWeb } from '@serenity-js/web';
-import type * as wdio from 'webdriverio';
+import type { Browser, Element } from 'webdriverio';
 
-import { WebdriverIOBrowsingSession } from '../models';
+import { WebdriverIOBrowsingSession } from '../models/index.js';
 
 /**
  * This implementation of the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
@@ -36,13 +36,13 @@ import { WebdriverIOBrowsingSession } from '../models';
  *
  * @group Abilities
  */
-export class BrowseTheWebWithWebdriverIO extends BrowseTheWeb<wdio.Element<'async'>> {
+export class BrowseTheWebWithWebdriverIO extends BrowseTheWeb<Element> {
 
-    static using(browserInstance: wdio.Browser<'async'>): BrowseTheWebWithWebdriverIO {
+    static using(browserInstance: Browser): BrowseTheWebWithWebdriverIO {
         return new BrowseTheWebWithWebdriverIO(browserInstance);
     }
 
-    constructor(protected readonly browser: wdio.Browser<'async'>) {
+    constructor(protected readonly browser: Browser) {
         super(new WebdriverIOBrowsingSession(browser));
     }
 

package/src/screenplay/abilities/index.ts

@@ -1 +1 @@
-export * from './BrowseTheWebWithWebdriverIO';
+export * from './BrowseTheWebWithWebdriverIO.js';