@serenity-js/webdriverio 2.32.7 → 3.0.0-rc.10

package/lib/screenplay/abilities/{BrowseTheWeb.js → BrowseTheWebWithWebdriverIO.js}

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BrowseTheWeb = void 0;
+exports.BrowseTheWebWithWebdriverIO = void 0;
 const core_1 = require("@serenity-js/core");
-const input_1 = require("../../input");
+const web_1 = require("@serenity-js/web");
+const models_1 = require("../models");
+const locators_1 = require("../models/locators");
 /**
  * @desc
  *  An {@link @serenity-js/core/lib/screenplay~Ability} that enables the {@link @serenity-js/core/lib/screenplay/actor~Actor}
@@ -12,8 +14,6 @@ const input_1 = require("../../input");
  *  This means that its interface can change without affecting the major version of Serenity/JS itself.
  *  In particular, please don't rely on the `browser` field to remain `public` in future releases.
  *
- * @experimental
- *
  * @example <caption>Using the WebdriverIO browser</caption>
  *  import { Actor } from '@serenity-js/core';
  *  import { BrowseTheWeb, by, Navigate, Target } from '@serenity-js/webdriverio'
@@ -38,31 +38,51 @@ const input_1 = require("../../input");
  * @implements {@serenity-js/core/lib/screenplay~Ability}
  * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
  */
-class BrowseTheWeb {
+class BrowseTheWebWithWebdriverIO extends web_1.BrowseTheWeb {
     /**
      * @param {@wdio/types~Browser} browser
      */
     constructor(browser) {
+        super(new Map()
+            .set(web_1.ByCss, (selector) => locators_1.WebdriverIOLocator.createRootLocator(this.browser, selector, selector.value))
+            .set(web_1.ByCssContainingText, (selector) => locators_1.WebdriverIOLocator.createRootLocator(this.browser, selector, `${selector.value}*=${selector.text}`))
+            .set(web_1.ById, (selector) => locators_1.WebdriverIOLocator.createRootLocator(this.browser, selector, `#${selector.value}`))
+            .set(web_1.ByTagName, (selector) => locators_1.WebdriverIOLocator.createRootLocator(this.browser, selector, `<${selector.value} />`))
+            .set(web_1.ByXPath, (selector) => locators_1.WebdriverIOLocator.createRootLocator(this.browser, selector, selector.value)));
         this.browser = browser;
+        if (!this.browser.$ || !this.browser.$$) {
+            throw new core_1.LogicError(`WebdriverIO browser object is not initialised yet, so can't be assigned to an actor. Are you trying to instantiate an actor outside of a test or a test hook?`);
+        }
     }
     /**
      * @param {@wdio/types~Browser} browserInstance
-     * @returns {BrowseTheWeb}
+     * @returns {BrowseTheWebWithWebdriverIO}
      */
     static using(browserInstance) {
-        return new BrowseTheWeb(browserInstance);
+        return new BrowseTheWebWithWebdriverIO(browserInstance);
     }
-    /**
-     * @desc
-     *  Used to access the Actor's ability to {@link BrowseTheWeb}
-     *  from within the {@link @serenity-js/core/lib/screenplay~Interaction} classes,
-     *  such as {@link Navigate}.
-     *
-     * @param {@serenity-js/core/lib/screenplay/actor~UsesAbilities} actor
-     * @return {BrowseTheWeb}
-     */
-    static as(actor) {
-        return actor.abilityTo(BrowseTheWeb);
+    browserCapabilities() {
+        return Promise.resolve(this.browser.capabilities);
+    }
+    async cookie(name) {
+        return new models_1.WebdriverIOCookie(this.browser, name);
+    }
+    async setCookie(cookieData) {
+        return this.browser.setCookies({
+            name: cookieData.name,
+            value: cookieData.value,
+            path: cookieData.path,
+            domain: cookieData.domain,
+            secure: cookieData.secure,
+            httpOnly: cookieData.httpOnly,
+            expiry: cookieData.expiry
+                ? cookieData.expiry.toSeconds()
+                : undefined,
+            sameSite: cookieData.sameSite,
+        });
+    }
+    deleteAllCookies() {
+        return this.browser.deleteCookies();
     }
     /**
      * @desc
@@ -72,9 +92,54 @@ class BrowseTheWeb {
      * @param {string} destination
      * @returns {Promise<void>}
      */
-    get(destination) {
+    navigateTo(destination) {
         return this.browser.url(destination); // todo: check if this returns a string or is mistyped
     }
+    navigateBack() {
+        return this.browser.back();
+    }
+    navigateForward() {
+        return this.browser.forward();
+    }
+    reloadPage() {
+        return this.browser.refresh();
+    }
+    /**
+     * @desc
+     *  Returns a {@link Page} representing the currently active top-level browsing context.
+     *
+     * @returns {Promise<Page>}
+     */
+    async currentPage() {
+        const windowHandle = await this.browser.getWindowHandle();
+        return new models_1.WebdriverIOPage(this.browser, windowHandle);
+    }
+    /**
+     * @desc
+     *  Returns an array of {@link Page} objects representing all the available
+     *  top-level browsing context, e.g. all the open browser tabs.
+     *
+     * @returns {Promise<Array<Page>>}
+     */
+    async allPages() {
+        const windowHandles = await this.browser.getWindowHandles();
+        return windowHandles.map(windowHandle => new models_1.WebdriverIOPage(this.browser, windowHandle));
+    }
+    async modalDialog() {
+        return new models_1.WebdriverIOModalDialog(this.browser);
+    }
+    // todo: remove
+    switchToFrame(targetOrIndex) {
+        throw new Error('Not implemented, yet');
+    }
+    // todo: remove
+    switchToParentFrame() {
+        throw new Error('Not implemented, yet');
+    }
+    // todo: remove
+    switchToDefaultContent() {
+        throw new Error('Not implemented, yet');
+    }
     /**
      * @desc
      *  Send a sequence of {@link Key} strokes to the active element.
@@ -88,10 +153,10 @@ class BrowseTheWeb {
      */
     sendKeys(keys) {
         const keySequence = keys.map(key => {
-            if (!input_1.Key.isKey(key)) {
+            if (!web_1.Key.isKey(key)) {
                 return key;
             }
-            if (browser.isDevTools) {
+            if (this.browser.isDevTools) {
                 return key.devtoolsName;
             }
             return key.utf16codePoint;
@@ -148,8 +213,9 @@ class BrowseTheWeb {
      *
      * @see {@link BrowseTheWeb#getLastScriptExecutionResult}
      */
-    executeScript(script, ...args) {
-        return this.browser.execute(script, ...args)
+    async executeScript(script, ...args) {
+        const nativeArguments = await Promise.all(args.map(arg => arg instanceof models_1.WebdriverIOPageElement ? arg.nativeElement() : arg));
+        return this.browser.execute(script, ...nativeArguments)
             .then(result => {
             this.lastScriptExecutionSummary = new LastScriptExecutionSummary(result);
             return result;
@@ -167,7 +233,7 @@ class BrowseTheWeb {
      *  Arrays and objects may also be used as script arguments as long as each item adheres
      *  to the types previously mentioned.
      *
-     *  Unlike executing synchronous JavaScript with {@link BrowseTheWeb#executeScript},
+     *  Unlike executing synchronous JavaScript with {@link BrowseTheWebWithWebdriverIO#executeScript},
      *  scripts executed with this function must explicitly signal they are finished by invoking the provided callback.
      *
      *  This callback will always be injected into the executed function as the last argument,
@@ -206,8 +272,9 @@ class BrowseTheWeb {
      *
      * @see {@link BrowseTheWeb#getLastScriptExecutionResult}
      */
-    executeAsyncScript(script, ...args) {
-        return this.browser.executeAsync(script, ...args)
+    async executeAsyncScript(script, ...args) {
+        const nativeArguments = await Promise.all(args.map(arg => arg instanceof models_1.WebdriverIOPageElement ? arg.nativeElement() : arg));
+        return this.browser.executeAsync(script, ...nativeArguments)
             .then(result => {
             this.lastScriptExecutionSummary = new LastScriptExecutionSummary(result);
             return result;
@@ -215,19 +282,32 @@ class BrowseTheWeb {
     }
     /**
      * @desc
-     *  Returns the last result of calling {@link BrowseTheWeb#executeAsyncScript}
-     *  or {@link BrowseTheWeb#executeScript}
+     *  Returns the last result of calling {@link BrowseTheWebWithWebdriverIO#executeAsyncScript}
+     *  or {@link BrowseTheWebWithWebdriverIO#executeScript}
      *
      * @returns {any}
      */
-    getLastScriptExecutionResult() {
+    lastScriptExecutionResult() {
         if (!this.lastScriptExecutionSummary) {
             throw new core_1.LogicError(`Make sure to execute a script before checking on the result`);
         }
-        return this.lastScriptExecutionSummary.result;
+        // Selenium returns `null` when the script it executed returns `undefined`
+        // so we're mapping the result back.
+        return this.lastScriptExecutionSummary.result !== null
+            ? this.lastScriptExecutionSummary.result
+            : undefined;
+    }
+    waitFor(duration) {
+        return this.browser.pause(duration.inMilliseconds());
+    }
+    waitUntil(condition, timeout) {
+        return this.browser.waitUntil(condition, {
+            timeout: timeout.inMilliseconds(),
+            timeoutMsg: `Wait timed out after ${timeout}`,
+        });
     }
 }
-exports.BrowseTheWeb = BrowseTheWeb;
+exports.BrowseTheWebWithWebdriverIO = BrowseTheWebWithWebdriverIO;
 /**
  * @package
  */
@@ -236,4 +316,4 @@ class LastScriptExecutionSummary {
         this.result = result;
     }
 }
-//# sourceMappingURL=BrowseTheWeb.js.map
+//# sourceMappingURL=BrowseTheWebWithWebdriverIO.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BrowseTheWebWithWebdriverIO.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWebWithWebdriverIO.ts"],"names":[],"mappings":";;;AAAA,4CAAyD;AACzD,0CAAoL;AAGpL,sCAA+G;AAC/G,iDAAsF;AAEtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAa,2BAA4B,SAAQ,kBAAiE;IAe9G;;OAEG;IACH,YAA+B,OAA8B;QACzD,KAAK,CAAC,IAAI,GAAG,EAAE;aACV,GAAG,CAAC,WAAK,EAAkB,CAAC,QAAe,EAAgB,EAAE,CAAC,6BAAkB,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;aAC3I,GAAG,CAAC,yBAAmB,EAAI,CAAC,QAA6B,EAAE,EAAE,CAAC,6BAAkB,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAI,QAAQ,CAAC,KAAM,KAAM,QAAQ,CAAC,IAAK,EAAE,CAAC,CAAC;aACtK,GAAG,CAAC,UAAI,EAAmB,CAAC,QAAc,EAAiB,EAAE,CAAC,6BAAkB,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAK,QAAQ,CAAC,KAAM,EAAE,CAAC,CAAC;aACnJ,GAAG,CAAC,eAAS,EAAc,CAAC,QAAmB,EAAY,EAAE,CAAC,6BAAkB,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAK,QAAQ,CAAC,KAAM,KAAK,CAAC,CAAC;aACtJ,GAAG,CAAC,aAAO,EAAgB,CAAC,QAAiB,EAAc,EAAE,CAAC,6BAAkB,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAC/I,CAAC;QAPyB,YAAO,GAAP,OAAO,CAAuB;QASzD,IAAI,CAAE,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAE,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;YACvC,MAAM,IAAI,iBAAU,CAAC,+JAA+J,CAAC,CAAA;SACxL;IACL,CAAC;IA5BD;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,eAAsC;QAC/C,OAAO,IAAI,2BAA2B,CAAC,eAAe,CAAC,CAAC;IAC5D,CAAC;IAwBD,mBAAmB;QACf,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,YAAmC,CAAC,CAAC;IAC7E,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAY;QACrB,OAAO,IAAI,0BAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,UAAsB;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;YAC3B,IAAI,EAAQ,UAAU,CAAC,IAAI;YAC3B,KAAK,EAAO,UAAU,CAAC,KAAK;YAC5B,IAAI,EAAQ,UAAU,CAAC,IAAI;YAC3B,MAAM,EAAM,UAAU,CAAC,MAAM;YAC7B,MAAM,EAAM,UAAU,CAAC,MAAM;YAC7B,QAAQ,EAAI,UAAU,CAAC,QAAQ;YAC/B,MAAM,EAAM,UAAU,CAAC,MAAM;gBACzB,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,EAAE;gBAC/B,CAAC,CAAC,SAAS;YACf,QAAQ,EAAI,UAAU,CAAC,QAAQ;SAClC,CAAC,CAAC;IACP,CAAC;IAED,gBAAgB;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,EAAmB,CAAC;IACzD,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,WAAmB;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAQ,CAAC,CAAE,sDAAsD;IACxG,CAAC;IAED,YAAY;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAED,eAAe;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAClC,CAAC;IAED,UAAU;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW;QAEb,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;QAE1D,OAAO,IAAI,wBAAe,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ;QACV,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAE5D,OAAO,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,wBAAe,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;IAC9F,CAAC;IAED,KAAK,CAAC,WAAW;QACb,OAAO,IAAI,+BAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,eAAe;IACf,aAAa,CAAC,aAA4C;QACtD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC5C,CAAC;IACD,eAAe;IACf,mBAAmB;QACf,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC5C,CAAC;IACD,eAAe;IACf,sBAAsB;QAClB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAyB;QAC9B,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC/B,IAAI,CAAE,SAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBAClB,OAAO,GAAG,CAAC;aACd;YAED,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;gBACzB,OAAO,GAAG,CAAC,YAAY,CAAC;aAC3B;YAED,OAAO,GAAG,CAAC,cAAc,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACH,cAAc;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,KAAK,CAAC,aAAa,CACf,MAA4D,EAC5D,GAAG,IAAoB;QAEvB,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,+BAAsB,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAmB,CAAC;QAEhJ,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,eAAe,CAAC;aAClD,IAAI,CAAC,MAAM,CAAC,EAAE;YACX,IAAI,CAAC,0BAA0B,GAAG,IAAI,0BAA0B,CAC5D,MAAM,CACT,CAAC;YACF,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC,CAAC;IACX,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,KAAK,CAAC,kBAAkB,CACpB,MAAqG,EACrG,GAAG,IAAgB;QAEnB,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,+BAAsB,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAe,CAAC;QAE5I,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAqB,MAAM,EAAE,GAAG,eAAe,CAAC;aAC3E,IAAI,CAAC,MAAM,CAAC,EAAE;YACX,IAAI,CAAC,0BAA0B,GAAG,IAAI,0BAA0B,CAC5D,MAAM,CACT,CAAC;YACF,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC,CAAC;IACX,CAAC;IAED;;;;;;OAMG;IACH,yBAAyB;QACrB,IAAI,CAAE,IAAI,CAAC,0BAA0B,EAAE;YACnC,MAAM,IAAI,iBAAU,CAAC,6DAA6D,CAAC,CAAC;SACvF;QAED,0EAA0E;QAC1E,oCAAoC;QACpC,OAAO,IAAI,CAAC,0BAA0B,CAAC,MAAM,KAAK,IAAI;YAClD,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,MAAgB;YAClD,CAAC,CAAC,SAAS,CAAC;IACpB,CAAC;IAED,OAAO,CAAC,QAAkB;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAkB,CAAC;IAC1E,CAAC;IAED,SAAS,CAAC,SAA2C,EAAE,OAAiB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE;YACrC,OAAO,EAAK,OAAO,CAAC,cAAc,EAAE;YACpC,UAAU,EAAE,wBAAyB,OAAQ,EAAE;SAClD,CAAkB,CAAC;IACxB,CAAC;CACJ;AA1TD,kEA0TC;AAED;;GAEG;AACH,MAAM,0BAA0B;IAC5B,YAA4B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;CACjD"}

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

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

package/lib/screenplay/abilities/index.js

@@ -10,5 +10,5 @@ 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("./BrowseTheWeb"), exports);
+__exportStar(require("./BrowseTheWebWithWebdriverIO"), exports);
 //# sourceMappingURL=index.js.map

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

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

package/lib/screenplay/index.d.ts

@@ -1,3 +1,2 @@
 export * from './abilities';
-export * from './interactions';
-export * from './questions';
+export * from './models';

package/lib/screenplay/index.js

@@ -11,6 +11,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./abilities"), exports);
-__exportStar(require("./interactions"), exports);
-__exportStar(require("./questions"), exports);
+__exportStar(require("./models"), exports);
 //# sourceMappingURL=index.js.map

package/lib/screenplay/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/screenplay/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/screenplay/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,2CAAyB"}

package/lib/screenplay/models/WebdriverIOCookie.d.ts

@@ -0,0 +1,8 @@
+import { Cookie, CookieData } from '@serenity-js/web';
+import * as wdio from 'webdriverio';
+export declare class WebdriverIOCookie extends Cookie {
+    private readonly browser;
+    constructor(browser: wdio.Browser<'async'>, cookieName: string);
+    delete(): Promise<void>;
+    protected read(): Promise<CookieData>;
+}

package/lib/screenplay/models/WebdriverIOCookie.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebdriverIOCookie = void 0;
+const core_1 = require("@serenity-js/core");
+const web_1 = require("@serenity-js/web");
+const tiny_types_1 = require("tiny-types");
+class WebdriverIOCookie extends web_1.Cookie {
+    constructor(browser, cookieName) {
+        super(cookieName);
+        this.browser = browser;
+        (0, tiny_types_1.ensure)('browser', browser, (0, tiny_types_1.isDefined)());
+    }
+    async delete() {
+        return this.browser.deleteCookies(this.cookieName);
+    }
+    async read() {
+        const [cookie] = await this.browser.getCookies(this.cookieName);
+        if (!cookie) {
+            throw new web_1.CookieMissingError(`Cookie '${this.cookieName}' not set`);
+        }
+        // There _might_ be a bug in WDIO where the expiry date is set on "expires" rather than the "expiry" key
+        // and possibly another one around deserialising the timestamp, since WDIO seems to add several hundred milliseconds
+        // to the original expiry date
+        const expiry = cookie.expiry || cookie.expires;
+        return {
+            name: cookie.name,
+            value: cookie.value,
+            domain: cookie.domain,
+            path: cookie.path,
+            expiry: expiry !== undefined
+                ? core_1.Timestamp.fromTimestampInSeconds(Math.round(expiry))
+                : undefined,
+            httpOnly: cookie.httpOnly,
+            secure: cookie.secure,
+        };
+    }
+}
+exports.WebdriverIOCookie = WebdriverIOCookie;
+//# sourceMappingURL=WebdriverIOCookie.js.map

package/lib/screenplay/models/WebdriverIOCookie.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebdriverIOCookie.js","sourceRoot":"","sources":["../../../src/screenplay/models/WebdriverIOCookie.ts"],"names":[],"mappings":";;;AAAA,4CAA8C;AAC9C,0CAA0E;AAC1E,2CAA+C;AAG/C,MAAa,iBAAkB,SAAQ,YAAM;IAEzC,YACqB,OAA8B,EAC/C,UAAkB;QAElB,KAAK,CAAC,UAAU,CAAC,CAAC;QAHD,YAAO,GAAP,OAAO,CAAuB;QAI/C,IAAA,mBAAM,EAAC,SAAS,EAAE,OAAO,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAkB,CAAC;IACxE,CAAC;IAES,KAAK,CAAC,IAAI;QAChB,MAAM,CAAE,MAAM,CAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAElE,IAAI,CAAE,MAAM,EAAE;YACV,MAAM,IAAI,wBAAkB,CAAC,WAAY,IAAI,CAAC,UAAW,WAAW,CAAC,CAAC;SACzE;QAED,wGAAwG;QACxG,oHAAoH;QACpH,8BAA8B;QAC9B,MAAM,MAAM,GAAuB,MAAM,CAAC,MAAM,IAAK,MAAc,CAAC,OAAO,CAAC;QAE5E,OAAO;YACH,IAAI,EAAQ,MAAM,CAAC,IAAI;YACvB,KAAK,EAAO,MAAM,CAAC,KAAK;YACxB,MAAM,EAAM,MAAM,CAAC,MAAM;YACzB,IAAI,EAAQ,MAAM,CAAC,IAAI;YACvB,MAAM,EAAM,MAAM,KAAK,SAAS;gBAC5B,CAAC,CAAC,gBAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACtD,CAAC,CAAC,SAAS;YACf,QAAQ,EAAI,MAAM,CAAC,QAAQ;YAC3B,MAAM,EAAM,MAAM,CAAC,MAAM;SAC5B,CAAA;IACL,CAAC;CACJ;AAtCD,8CAsCC"}

package/lib/screenplay/models/WebdriverIOModalDialog.d.ts

@@ -0,0 +1,11 @@
+import { ModalDialog } from '@serenity-js/web';
+import { Browser } from 'webdriverio';
+export declare class WebdriverIOModalDialog extends ModalDialog {
+    private readonly browser;
+    constructor(browser: Browser<'async'>);
+    accept(): Promise<void>;
+    dismiss(): Promise<void>;
+    text(): Promise<string>;
+    enterValue(value: string | number | (string | number)[]): Promise<void>;
+    isPresent(): Promise<boolean>;
+}

package/lib/screenplay/models/WebdriverIOModalDialog.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebdriverIOModalDialog = void 0;
+const web_1 = require("@serenity-js/web");
+class WebdriverIOModalDialog extends web_1.ModalDialog {
+    constructor(browser) {
+        super();
+        this.browser = browser;
+    }
+    accept() {
+        return this.browser.acceptAlert();
+    }
+    dismiss() {
+        return this.browser.dismissAlert();
+    }
+    text() {
+        return this.browser.getAlertText();
+    }
+    async enterValue(value) {
+        const text = [].concat(value).join('');
+        await this.browser.sendAlertText(text);
+        // Puppeteer auto-accepts the dialog upon sendAlertText
+        // other implementations require the dialog to be closed
+        if (!this.browser.isDevTools) {
+            await this.browser.acceptAlert();
+        }
+    }
+    isPresent() {
+        return this.browser.getAlertText()
+            .then(() => true, error => {
+            if (error && (error.name === 'no such alert'
+                || error.message.startsWith('no such alert'))) {
+                return false;
+            }
+            throw error;
+        });
+    }
+}
+exports.WebdriverIOModalDialog = WebdriverIOModalDialog;
+//# sourceMappingURL=WebdriverIOModalDialog.js.map

package/lib/screenplay/models/WebdriverIOModalDialog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebdriverIOModalDialog.js","sourceRoot":"","sources":["../../../src/screenplay/models/WebdriverIOModalDialog.ts"],"names":[],"mappings":";;;AAAA,0CAA+C;AAG/C,MAAa,sBAAuB,SAAQ,iBAAW;IACnD,YAA6B,OAAyB;QAClD,KAAK,EAAE,CAAC;QADiB,YAAO,GAAP,OAAO,CAAkB;IAEtD,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;IACvC,CAAC;IACD,IAAI;QACA,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAA4C;QACzD,MAAM,IAAI,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEvC,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAEvC,uDAAuD;QACvD,wDAAwD;QACxD,IAAI,CAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC3B,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;SACpC;IACL,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;aAC7B,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;YACtB,IAAI,KAAK,IAAI,CACT,KAAK,CAAC,IAAI,KAAK,eAAe;mBAC3B,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAC/C,EAAE;gBACC,OAAO,KAAK,CAAC;aAChB;YAED,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;IACX,CAAC;CACJ;AAzCD,wDAyCC"}

package/lib/screenplay/models/WebdriverIOPage.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+import { Page } from '@serenity-js/web';
+import { URL } from 'url';
+import * as wdio from 'webdriverio';
+export declare class WebdriverIOPage extends Page {
+    private readonly browser;
+    constructor(browser: wdio.Browser<'async'>, handle: string);
+    title(): Promise<string>;
+    name(): Promise<string>;
+    url(): Promise<URL>;
+    viewportSize(): Promise<{
+        width: number;
+        height: number;
+    }>;
+    setViewportSize(size: {
+        width: number;
+        height: number;
+    }): Promise<void>;
+    close(): Promise<void>;
+    closeOthers(): Promise<void>;
+    isPresent(): Promise<boolean>;
+    switchTo(): Promise<void>;
+    private switchToAndPerform;
+}

package/lib/screenplay/models/WebdriverIOPage.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebdriverIOPage = void 0;
+const web_1 = require("@serenity-js/web");
+const url_1 = require("url");
+class WebdriverIOPage extends web_1.Page {
+    constructor(browser, handle) {
+        super(handle);
+        this.browser = browser;
+    }
+    title() {
+        return this.switchToAndPerform(async (browser) => {
+            return browser.getTitle();
+        });
+    }
+    name() {
+        return this.switchToAndPerform(async (browser) => {
+            return browser.execute(`return window.name`);
+        });
+    }
+    async url() {
+        return this.switchToAndPerform(async (browser) => {
+            return new url_1.URL(await browser.getUrl());
+        });
+    }
+    async viewportSize() {
+        return this.switchToAndPerform(async (browser) => {
+            if (!browser.isDevTools) {
+                const calculatedViewportSize = await browser.execute(`
+                    return {
+                        width:  Math.max(document.documentElement.clientWidth,  window.innerWidth || 0),
+                        height: Math.max(document.documentElement.clientHeight, window.innerHeight || 0),
+                    }
+                `);
+                // Chrome headless hard-codes window.innerWidth and window.innerHeight to 0
+                if (calculatedViewportSize.width > 0 && calculatedViewportSize.height > 0) {
+                    return calculatedViewportSize;
+                }
+            }
+            return browser.getWindowSize();
+        });
+    }
+    setViewportSize(size) {
+        return this.switchToAndPerform(async (browser) => {
+            let desiredWindowSize = size;
+            if (!browser.isDevTools) {
+                desiredWindowSize = await browser.execute(`
+                var currentViewportWidth  = Math.max(document.documentElement.clientWidth, window.innerWidth || 0)
+                var currentViewportHeight = Math.max(document.documentElement.clientHeight, window.innerHeight || 0)
+                
+                return {
+                    width:  Math.max(window.outerWidth  - currentViewportWidth  + ${size.width},  ${size.width}),
+                    height: Math.max(window.outerHeight - currentViewportHeight + ${size.height}, ${size.height}),
+                };
+            `);
+            }
+            return browser.setWindowSize(desiredWindowSize.width, desiredWindowSize.height);
+        });
+    }
+    async close() {
+        return this.switchToAndPerform(browser => browser.closeWindow());
+    }
+    async closeOthers() {
+        const windowHandles = await this.browser.getWindowHandles();
+        for (const handle of windowHandles) {
+            if (handle !== this.handle) {
+                await this.browser.switchToWindow(handle);
+                await this.browser.closeWindow();
+            }
+        }
+        await this.browser.switchToWindow(this.handle);
+    }
+    async isPresent() {
+        const currentPageHandle = await this.browser.getWindowHandle();
+        const desiredPageHandle = this.handle;
+        const isOpen = await this.browser.switchToWindow(desiredPageHandle).then(() => true, _error => false);
+        await this.browser.switchToWindow(currentPageHandle);
+        return isOpen;
+    }
+    async switchTo() {
+        await this.browser.switchToWindow(this.handle);
+    }
+    async switchToAndPerform(action) {
+        const currentPageHandle = await this.browser.getWindowHandle();
+        const desiredPageHandle = this.handle;
+        const shouldSwitch = currentPageHandle !== desiredPageHandle;
+        if (shouldSwitch) {
+            await this.browser.switchToWindow(desiredPageHandle);
+        }
+        const result = await action(this.browser);
+        if (shouldSwitch) {
+            await this.browser.switchToWindow(currentPageHandle);
+        }
+        return result;
+    }
+}
+exports.WebdriverIOPage = WebdriverIOPage;
+//# sourceMappingURL=WebdriverIOPage.js.map

package/lib/screenplay/models/WebdriverIOPage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebdriverIOPage.js","sourceRoot":"","sources":["../../../src/screenplay/models/WebdriverIOPage.ts"],"names":[],"mappings":";;;AAAA,0CAAwC;AACxC,6BAA0B;AAG1B,MAAa,eAAgB,SAAQ,UAAI;IACrC,YACqB,OAA8B,EAC/C,MAAc;QAEd,KAAK,CAAC,MAAM,CAAC,CAAC;QAHG,YAAO,GAAP,OAAO,CAAuB;IAInD,CAAC;IAED,KAAK;QACD,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;YAC3C,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;YAC3C,OAAO,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,GAAG;QACL,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;YAC3C,OAAO,IAAI,SAAG,CAAC,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,YAAY;QACd,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;YAC3C,IAAI,CAAE,OAAO,CAAC,UAAU,EAAE;gBACtB,MAAM,sBAAsB,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC;;;;;iBAKpD,CAAsC,CAAC;gBAExC,2EAA2E;gBAC3E,IAAI,sBAAsB,CAAC,KAAK,GAAG,CAAC,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;oBACvE,OAAO,sBAAsB,CAAC;iBACjC;aACJ;YAED,OAAO,OAAO,CAAC,aAAa,EAAE,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC;IAED,eAAe,CAAC,IAAuC;QACnD,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;YAC3C,IAAI,iBAAiB,GAAG,IAAI,CAAC;YAE7B,IAAI,CAAE,OAAO,CAAC,UAAU,EAAE;gBACtB,iBAAiB,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC;;;;;oFAK2B,IAAI,CAAC,KAAM,MAAO,IAAI,CAAC,KAAM;oFAC7B,IAAI,CAAC,MAAO,KAAM,IAAI,CAAC,MAAO;;aAEtG,CAAC,CAAC;aACF;YAED,OAAO,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC,KAAK,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,KAAK;QACP,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,WAAW;QACb,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAE5D,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE;YAChC,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE;gBACxB,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBAC1C,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;aACpC;SACJ;QAED,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,SAAS;QACX,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;QAC/D,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC;QAEtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAEtG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;QAErD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,QAAQ;QACV,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAI,MAA0D;QAC1F,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;QAC/D,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC;QACtC,MAAM,YAAY,GAAQ,iBAAiB,KAAK,iBAAiB,CAAC;QAElE,IAAI,YAAY,EAAE;YACd,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;SACxD;QAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE1C,IAAI,YAAY,EAAE;YACd,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;SACxD;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAnHD,0CAmHC"}

package/lib/screenplay/models/WebdriverIOPageElement.d.ts

@@ -0,0 +1,31 @@
+import { PageElement } from '@serenity-js/web';
+import * as wdio from 'webdriverio';
+export declare class WebdriverIOPageElement extends PageElement<wdio.Element<'async'>> {
+    of(parent: WebdriverIOPageElement): WebdriverIOPageElement;
+    clearValue(): Promise<void>;
+    click(): Promise<void>;
+    doubleClick(): Promise<void>;
+    enterValue(value: string | number | Array<string | number>): Promise<void>;
+    scrollIntoView(): Promise<void>;
+    hoverOver(): Promise<void>;
+    rightClick(): Promise<void>;
+    attribute(name: string): Promise<string>;
+    text(): Promise<string>;
+    value(): Promise<string>;
+    isActive(): Promise<boolean>;
+    isClickable(): Promise<boolean>;
+    isEnabled(): Promise<boolean>;
+    isPresent(): Promise<boolean>;
+    isSelected(): Promise<boolean>;
+    /**
+     * @desc
+     *  Checks if the PageElement:
+     *  - is displayed,
+     *  - is visible within the browser viewport,
+     *  - has not its center covered by other elements
+     *
+     * @see https://webdriver.io/docs/api/element/isDisplayedInViewport/
+     */
+    isVisible(): Promise<boolean>;
+    private browserFor;
+}