@serenity-js/webdriverio 3.4.2 → 3.6.0

package/src/adapter/WebdriverIONotifier.ts

@@ -1,5 +1,10 @@
-import { LogicError, Stage, StageCrewMember } from '@serenity-js/core';
-import { AsyncOperationAttempted, AsyncOperationCompleted, DomainEvent, SceneFinished, SceneStarts, TestRunFinishes, TestSuiteFinished, TestSuiteStarts } from '@serenity-js/core/lib/events/index.js';
+import type { Stage, StageCrewMember } from '@serenity-js/core';
+import { LogicError } from '@serenity-js/core';
+import type { DomainEvent} from '@serenity-js/core/lib/events/index.js';
+import { AsyncOperationAttempted, AsyncOperationCompleted, SceneFinished, SceneStarts, TestRunFinishes, TestSuiteFinished, TestSuiteStarts } from '@serenity-js/core/lib/events/index.js';
+import type {
+    Outcome,
+    TestSuiteDetails} from '@serenity-js/core/lib/model/index.js';
 import {
     CorrelationId,
     Description,
@@ -9,16 +14,14 @@ import {
     ExecutionIgnored,
     ExecutionSkipped,
     ImplementationPending, Name,
-    Outcome,
-    ProblemIndication,
-    TestSuiteDetails,
+    ProblemIndication
 } 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 '../config/index.js';
+import type { WebdriverIOConfig } from '../config/index.js';
 
 // interface Argument {
 //     rows?: {

package/src/adapter/reporter/BrowserCapabilitiesReporter.ts

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

package/src/adapter/reporter/OutputStreamBuffer.ts

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

package/src/adapter/reporter/OutputStreamBufferPrinter.ts

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

package/src/adapter/reporter/ProvidesWriteStream.ts

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

package/src/adapter/reporter/TagPrinter.ts

@@ -1,4 +1,5 @@
-import { BrowserTag, PlatformTag, Tag } from '@serenity-js/core/lib/model/index.js';
+import type { Tag } from '@serenity-js/core/lib/model/index.js';
+import { BrowserTag, PlatformTag } from '@serenity-js/core/lib/model/index.js';
 import type { Capabilities } from '@wdio/types';
 
 /**

package/src/config/WebdriverIOConfig.ts

@@ -1,4 +1,4 @@
-import { SerenityConfig } from '@serenity-js/core';
+import type { SerenityConfig } from '@serenity-js/core';
 import type { Options } from '@wdio/types';
 
 /**

package/src/index.ts

@@ -1,10 +1,10 @@
 import { serenity } from '@serenity-js/core';
 import { ModuleLoader, Path } from '@serenity-js/core/lib/io/index.js';
-import { Capabilities } from '@wdio/types';
-import { EventEmitter } from 'events';
+import type { Capabilities } from '@wdio/types';
+import type { EventEmitter } from 'events';
 
-import { InitialisesReporters, ProvidesWriteStream } from './adapter/reporter/index.js';
-import { WebdriverIOConfig } from './config/index.js';
+import type { InitialisesReporters, ProvidesWriteStream } from './adapter/reporter/index.js';
+import type { WebdriverIOConfig } from './config/index.js';
 
 /**
  * WebdriverIO Framework Adapter integrates WebdriverIO with Serenity/JS

package/src/screenplay/abilities/BrowseTheWebWithWebdriverIO.ts

@@ -1,4 +1,4 @@
-import { BrowserCapabilities, BrowseTheWeb } from '@serenity-js/web';
+import { BrowseTheWeb } from '@serenity-js/web';
 import type { Browser, Element } from 'webdriverio';
 
 import { WebdriverIOBrowsingSession } from '../models/index.js';
@@ -39,14 +39,6 @@ import { WebdriverIOBrowsingSession } from '../models/index.js';
 export class BrowseTheWebWithWebdriverIO extends BrowseTheWeb<Element> {
 
     static using(browserInstance: Browser): BrowseTheWebWithWebdriverIO {
-        return new BrowseTheWebWithWebdriverIO(browserInstance);
-    }
-
-    constructor(protected readonly browser: Browser) {
-        super(new WebdriverIOBrowsingSession(browser));
-    }
-
-    browserCapabilities(): Promise<BrowserCapabilities> {
-        return Promise.resolve(this.browser.capabilities as BrowserCapabilities);
+        return new BrowseTheWebWithWebdriverIO(new WebdriverIOBrowsingSession(browserInstance));
     }
 }

package/src/screenplay/models/WebdriverIOBrowsingSession.ts

@@ -1,6 +1,7 @@
 import { LogicError } from '@serenity-js/core';
 import { CorrelationId } from '@serenity-js/core/lib/model/index.js';
-import { BrowsingSession, ModalDialogHandler } from '@serenity-js/web';
+import type { BrowserCapabilities, ModalDialogHandler } from '@serenity-js/web';
+import { BrowsingSession } from '@serenity-js/web';
 import type { Page } from 'puppeteer-core';
 import type { Browser } from 'webdriverio';
 
@@ -24,7 +25,7 @@ export class WebdriverIOBrowsingSession extends BrowsingSession<WebdriverIOPage>
         }
     }
 
-    async allPages(): Promise<Array<WebdriverIOPage>> {
+    override async allPages(): Promise<Array<WebdriverIOPage>> {
         // scan all the active window handles and add any newly opened windows if needed
         const windowHandles: string[] = await this.browser.getWindowHandles();
 
@@ -55,10 +56,9 @@ export class WebdriverIOBrowsingSession extends BrowsingSession<WebdriverIOPage>
     }
 
     /**
-     * @override
      * @param page
      */
-    async changeCurrentPageTo(page: WebdriverIOPage): Promise<void> {
+    override async changeCurrentPageTo(page: WebdriverIOPage): Promise<void> {
         const currentPage = await this.currentPage();
 
         // are we already on this page?
@@ -121,7 +121,7 @@ export class WebdriverIOBrowsingSession extends BrowsingSession<WebdriverIOPage>
         return this.currentBrowserPage;
     }
 
-    protected async registerCurrentPage(): Promise<WebdriverIOPage> {
+    protected override async registerCurrentPage(): Promise<WebdriverIOPage> {
         const windowHandle = await this.browser.getWindowHandle();
 
         const errorHandler = new WebdriverIOErrorHandler();
@@ -168,4 +168,8 @@ export class WebdriverIOBrowsingSession extends BrowsingSession<WebdriverIOPage>
 
         return page;
     }
+
+    override browserCapabilities(): Promise<BrowserCapabilities> {
+        return Promise.resolve(this.browser.capabilities as BrowserCapabilities);
+    }
 }

package/src/screenplay/models/WebdriverIOCookie.ts

@@ -1,5 +1,6 @@
 import { Timestamp } from '@serenity-js/core';
-import { Cookie, CookieData, CookieMissingError } from '@serenity-js/web';
+import type { CookieData} from '@serenity-js/web';
+import { Cookie, CookieMissingError } from '@serenity-js/web';
 import { ensure, isDefined } from 'tiny-types';
 import type { Browser } from 'webdriverio';
 

package/src/screenplay/models/WebdriverIOErrorHandler.ts

@@ -1,4 +1,4 @@
-import { WebdriverProtocolErrorCode } from './WebdriverProtocolErrorCode.js';
+import type { WebdriverProtocolErrorCode } from './WebdriverProtocolErrorCode.js';
 
 export class WebdriverIOErrorHandler {
 

package/src/screenplay/models/WebdriverIOModalDialogHandler.ts

@@ -1,7 +1,8 @@
-import { AbsentModalDialog, AcceptedModalDialog, DismissedModalDialog, ModalDialog, ModalDialogHandler } from '@serenity-js/web';
+import type { ModalDialog} from '@serenity-js/web';
+import { AbsentModalDialog, AcceptedModalDialog, DismissedModalDialog, ModalDialogHandler } from '@serenity-js/web';
 import type { Browser } from 'webdriverio';
 
-import { WebdriverIOErrorHandler } from './WebdriverIOErrorHandler.js';
+import type { WebdriverIOErrorHandler } from './WebdriverIOErrorHandler.js';
 import { WebdriverProtocolErrorCode } from './WebdriverProtocolErrorCode.js';
 
 /**

package/src/screenplay/models/WebdriverIOPage.ts

@@ -1,13 +1,14 @@
 import { LogicError } from '@serenity-js/core';
-import { CorrelationId } from '@serenity-js/core/lib/model/index.js';
-import { BrowserWindowClosedError, Cookie, CookieData, Key, ModalDialogHandler, Page, PageElement, PageElements, Selector } from '@serenity-js/web';
+import type { CorrelationId } from '@serenity-js/core/lib/model/index.js';
+import type { Cookie, CookieData, ModalDialogHandler, PageElement, Selector } from '@serenity-js/web';
+import { BrowserWindowClosedError, ByCss, Key, Page, PageElements } from '@serenity-js/web';
 import { URL } from 'url';
 import type { Browser, Element } from 'webdriverio';
 
-import { WebdriverIOLocator, WebdriverIORootLocator } from './locators/index.js';
-import { WebdriverIOBrowsingSession } from './WebdriverIOBrowsingSession.js';
+import { WebdriverIOExistingElementLocator, WebdriverIOLocator, WebdriverIORootLocator } from './locators/index.js';
+import type { WebdriverIOBrowsingSession } from './WebdriverIOBrowsingSession.js';
 import { WebdriverIOCookie } from './WebdriverIOCookie.js';
-import { WebdriverIOErrorHandler } from './WebdriverIOErrorHandler.js';
+import type { WebdriverIOErrorHandler } from './WebdriverIOErrorHandler.js';
 import { WebdriverIOPageElement } from './WebdriverIOPageElement.js';
 
 /**
@@ -34,6 +35,17 @@ export class WebdriverIOPage extends Page<Element> {
         );
     }
 
+    createPageElement(nativeElement: Element): PageElement<Element> {
+        return new WebdriverIOPageElement(
+            new WebdriverIOExistingElementLocator(
+                this.rootLocator,
+                new ByCss(String(nativeElement.selector)),
+                this.errorHandler,
+                nativeElement
+            )
+        );
+    }
+
     locate(selector: Selector): PageElement<Element> {
         return new WebdriverIOPageElement(
             new WebdriverIOLocator(this.rootLocator, selector, this.errorHandler)

package/src/screenplay/models/WebdriverIOPageElement.ts

@@ -1,9 +1,10 @@
 import { LogicError } from '@serenity-js/core';
-import { Key, PageElement, SelectOption, SwitchableOrigin } from '@serenity-js/web';
+import type { SwitchableOrigin } from '@serenity-js/web';
+import { Key, PageElement, SelectOption } from '@serenity-js/web';
 import * as scripts from '@serenity-js/web/lib/scripts/index.js';
 import type { Browser, Element } from 'webdriverio';
 
-import { WebdriverIOLocator } from './locators/index.js';
+import type { WebdriverIOLocator } from './locators/index.js';
 import { WebdriverProtocolErrorCode } from './WebdriverProtocolErrorCode.js';
 
 /**

package/src/screenplay/models/WebdriverIOPuppeteerModalDialogHandler.ts

@@ -1,8 +1,9 @@
+import type {
+    ModalDialog} from '@serenity-js/web';
 import {
     AbsentModalDialog,
     AcceptedModalDialog,
     DismissedModalDialog,
-    ModalDialog,
     ModalDialogHandler
 } from '@serenity-js/web';
 import type { Dialog, Page } from 'puppeteer-core';

package/src/screenplay/models/locators/WebdriverIOLocator.ts

@@ -1,10 +1,11 @@
 import { f, LogicError } from '@serenity-js/core';
-import { ByCss, ByCssContainingText, ByDeepCss, ById, ByTagName, ByXPath, Locator, PageElement, RootLocator, Selector } from '@serenity-js/web';
+import type { PageElement, RootLocator, Selector } from '@serenity-js/web';
+import { ByCss, ByCssContainingText, ByDeepCss, ById, ByTagName, ByXPath, Locator } from '@serenity-js/web';
 import type { Element } from 'webdriverio';
 
-import { WebdriverIOErrorHandler } from '../WebdriverIOErrorHandler.js';
+import type { WebdriverIOErrorHandler } from '../WebdriverIOErrorHandler.js';
 import { WebdriverIOPageElement } from '../WebdriverIOPageElement.js';
-import { WebdriverIORootLocator } from './WebdriverIORootLocator.js';
+import type { WebdriverIORootLocator } from './WebdriverIORootLocator.js';
 
 /**
  * WebdriverIO-specific implementation of {@apilink Locator}.
@@ -107,7 +108,7 @@ export class WebdriverIOLocator extends Locator<Element, string> {
 
         return elements.map(childElement =>
             new WebdriverIOPageElement(
-                new ExistingElementLocator(
+                new WebdriverIOExistingElementLocator(
                     this.parent as WebdriverIORootLocator,
                     this.selector,
                     this.errorHandler,
@@ -119,9 +120,9 @@ export class WebdriverIOLocator extends Locator<Element, string> {
 }
 
 /**
- * @private
+ * @internal
  */
-class ExistingElementLocator extends WebdriverIOLocator {
+export class WebdriverIOExistingElementLocator extends WebdriverIOLocator {
     constructor(
         parentRoot: RootLocator<Element>,
         selector: Selector,