@serenity-js/webdriverio 2.33.1 → 3.0.0-rc.11

package/lib/screenplay/interactions/Hover.js

@@ -1,89 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Hover = void 0;
-const io_1 = require("@serenity-js/core/lib/io");
-const WebElementInteraction_1 = require("./WebElementInteraction");
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  hover the mouse pointer over a given Web element.
- *
- * @example <caption>Example widget</caption>
- *  <a data-test="example-link"
- *      class="off"
- *      onmouseover="this.className='on';"
- *      onmouseout="this.className='off';"
- *      href="/">hover over me</a>
- *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { by, Target } from '@serenity-js/webdriverio';
- *
- *  class Example {
- *      static link = Target.the('example link')
- *          .located(by.css('[data-test="example-link"]'));
- *  }
- *
- * @example <caption>Hovering over an element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Hover, CSSClasses } from '@serenity-js/webdriverio';
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *
- *  actorCalled('Hank')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Ensure.that(CSSClasses.of(Example.link), equals([ 'off' ])),
- *
- *          Hover.over(Example.link),
- *          Ensure.that(CSSClasses.of(Example.link), equals([ 'on' ])),
- *      );
- *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link CSSClasses}
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link @serenity-js/assertions/lib/expectations~equals}
- *
- * @extends {WebElementInteraction}
- */
-class Hover extends WebElementInteraction_1.WebElementInteraction {
-    /**
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be hovered over
-     */
-    constructor(target) {
-        super((0, io_1.formatted) `#actor hovers the mouse over ${target}`);
-        this.target = target;
-    }
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be hovered over
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static over(target) {
-        return new Hover(target);
-    }
-    /**
-     * @desc
-     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  perform this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {UsesAbilities & AnswersQuestions} actor
-     *  An {@link @serenity-js/core/lib/screenplay/actor~Actor} to perform this {@link @serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @returns {PromiseLike<void>}
-     *
-     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
-     */
-    async performAs(actor) {
-        const element = await this.resolve(actor, this.target);
-        return element.moveTo();
-    }
-}
-exports.Hover = Hover;
-//# sourceMappingURL=Hover.js.map

package/lib/screenplay/interactions/Hover.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Hover.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Hover.ts"],"names":[],"mappings":";;;AACA,iDAAqD;AAGrD,mEAAgE;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAa,KAAM,SAAQ,6CAAqB;IAe5C;;;OAGG;IACH,YAA6B,MAAoC;QAC7D,KAAK,CAAC,IAAA,cAAS,EAAC,gCAAiC,MAAO,EAAE,CAAC,CAAC;QADnC,WAAM,GAAN,MAAM,CAA8B;IAEjE,CAAC;IAnBD;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,CAAC,MAAoC;QAC5C,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAUD;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACvD,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;IAC5B,CAAC;CACJ;AAzCD,sBAyCC"}

package/lib/screenplay/interactions/Navigate.d.ts

@@ -1,141 +0,0 @@
-import { Answerable, Interaction } from '@serenity-js/core';
-/**
- * @desc
- *  Allows the {@link @serenity-js/core/lib/screenplay/actor~Actor} to navigate
- *  to a specific destination, as well as back and forth in the browser history,
- *  or reload the current page.
- */
-export declare class Navigate {
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  to navigate to a given URL.
-     *
-     *  The URL can be:
-     *  - absolute, i.e. `https://example.org/search`
-     *  - relative, i.e. `/search`
-     *
-     *  If the URL is relative, WebdriverIO will append it to `baseUrl` specified in
-     *  the [configuration file](https://webdriver.io/docs/configurationfile/).
-     *
-     * @example <caption>wdio.conf.ts</caption>
-     *  export const config = {
-     *      baseUrl: 'https://example.org',
-     *      // ...
-     *  }
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/webdriverio';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(browser))
-     *      .attemptsTo(
-     *          Navigate.to('/search'),
-     *      );
-     *
-     * @example <caption>Navigate to an absolute URL (overrides baseUrl)</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/webdriverio';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(browser))
-     *      .attemptsTo(
-     *          Navigate.to('https://mycompany.org/login'),
-     *      );
-     *
-     * @param {Answerable<string>} url
-     *  An absolute URL or path an {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  should navigate to
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link BrowseTheWeb}
-     */
-    static to(url: Answerable<string>): Interaction;
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
-     *  navigate back one page in the joint session history of the current top-level browsing context.
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { Ensure, endsWith } from '@serenity-js/assertions';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/webdriverio';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(browser))
-     *      .attemptsTo(
-     *          Navigate.to('/first'),
-     *          Navigate.to('/second'),
-     *
-     *          Navigate.back(),
-     *
-     *          Ensure.that(Website.url(), endsWith('/first')),
-     *      );
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see https://webdriver.io/docs/api/webdriver/#back
-     * @see {@link BrowseTheWeb}
-     * @see {@link @serenity-js/assertions~Ensure}
-     * @see {@link @serenity-js/assertions/lib/expectations~endsWith}
-     */
-    static back(): Interaction;
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
-     *  navigate forward one page in the session history.
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { Ensure, endsWith } from '@serenity-js/assertions';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/webdriverio';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(browser))
-     *      .attemptsTo(
-     *          Navigate.to('/first'),
-     *          Navigate.to('/second'),
-     *
-     *          Navigate.back(),
-     *          Navigate.forward(),
-     *
-     *          Ensure.that(Website.url(), endsWith('/second')),
-     *      );
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link BrowseTheWeb}
-     * @see {@link @serenity-js/assertions~Ensure}
-     * @see {@link @serenity-js/assertions/lib/expectations~endsWith}
-     * @see https://webdriver.io/docs/api/webdriver/#forward
-     */
-    static forward(): Interaction;
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
-     *  reload the current page.
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { Ensure, endsWith } from '@serenity-js/assertions';
-     *  import { Navigate, BrowseTheWeb, DeleteCookies } from '@serenity-js/webdriverio';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(browser))
-     *      .attemptsTo(
-     *          Navigate.to('/login'),
-     *          DeleteCookies.called('session_id'),
-     *          Navigate.reloadPage(),
-     *      );
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link BrowseTheWeb}
-     * @see {@link DeleteCookies}
-     * @see {@link @serenity-js/assertions~Ensure}
-     * @see {@link @serenity-js/assertions/lib/expectations~endsWith}
-     */
-    static reloadPage(): Interaction;
-}

package/lib/screenplay/interactions/Navigate.js

@@ -1,197 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Navigate = void 0;
-const core_1 = require("@serenity-js/core");
-const io_1 = require("@serenity-js/core/lib/io");
-const __1 = require("../");
-/**
- * @desc
- *  Allows the {@link @serenity-js/core/lib/screenplay/actor~Actor} to navigate
- *  to a specific destination, as well as back and forth in the browser history,
- *  or reload the current page.
- */
-class Navigate {
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  to navigate to a given URL.
-     *
-     *  The URL can be:
-     *  - absolute, i.e. `https://example.org/search`
-     *  - relative, i.e. `/search`
-     *
-     *  If the URL is relative, WebdriverIO will append it to `baseUrl` specified in
-     *  the [configuration file](https://webdriver.io/docs/configurationfile/).
-     *
-     * @example <caption>wdio.conf.ts</caption>
-     *  export const config = {
-     *      baseUrl: 'https://example.org',
-     *      // ...
-     *  }
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/webdriverio';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(browser))
-     *      .attemptsTo(
-     *          Navigate.to('/search'),
-     *      );
-     *
-     * @example <caption>Navigate to an absolute URL (overrides baseUrl)</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/webdriverio';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(browser))
-     *      .attemptsTo(
-     *          Navigate.to('https://mycompany.org/login'),
-     *      );
-     *
-     * @param {Answerable<string>} url
-     *  An absolute URL or path an {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  should navigate to
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link BrowseTheWeb}
-     */
-    static to(url) {
-        return new NavigateToUrl(url);
-    }
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
-     *  navigate back one page in the joint session history of the current top-level browsing context.
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { Ensure, endsWith } from '@serenity-js/assertions';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/webdriverio';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(browser))
-     *      .attemptsTo(
-     *          Navigate.to('/first'),
-     *          Navigate.to('/second'),
-     *
-     *          Navigate.back(),
-     *
-     *          Ensure.that(Website.url(), endsWith('/first')),
-     *      );
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see https://webdriver.io/docs/api/webdriver/#back
-     * @see {@link BrowseTheWeb}
-     * @see {@link @serenity-js/assertions~Ensure}
-     * @see {@link @serenity-js/assertions/lib/expectations~endsWith}
-     */
-    static back() {
-        return core_1.Interaction.where(`#actor navigates back in the browser history`, actor => __1.BrowseTheWeb.as(actor).browser.back());
-    }
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
-     *  navigate forward one page in the session history.
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { Ensure, endsWith } from '@serenity-js/assertions';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/webdriverio';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(browser))
-     *      .attemptsTo(
-     *          Navigate.to('/first'),
-     *          Navigate.to('/second'),
-     *
-     *          Navigate.back(),
-     *          Navigate.forward(),
-     *
-     *          Ensure.that(Website.url(), endsWith('/second')),
-     *      );
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link BrowseTheWeb}
-     * @see {@link @serenity-js/assertions~Ensure}
-     * @see {@link @serenity-js/assertions/lib/expectations~endsWith}
-     * @see https://webdriver.io/docs/api/webdriver/#forward
-     */
-    static forward() {
-        return core_1.Interaction.where(`#actor navigates forward in the browser history`, actor => __1.BrowseTheWeb.as(actor).browser.forward());
-    }
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
-     *  reload the current page.
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { Ensure, endsWith } from '@serenity-js/assertions';
-     *  import { Navigate, BrowseTheWeb, DeleteCookies } from '@serenity-js/webdriverio';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(browser))
-     *      .attemptsTo(
-     *          Navigate.to('/login'),
-     *          DeleteCookies.called('session_id'),
-     *          Navigate.reloadPage(),
-     *      );
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link BrowseTheWeb}
-     * @see {@link DeleteCookies}
-     * @see {@link @serenity-js/assertions~Ensure}
-     * @see {@link @serenity-js/assertions/lib/expectations~endsWith}
-     */
-    static reloadPage() {
-        return core_1.Interaction.where(`#actor reloads the page`, actor => __1.BrowseTheWeb.as(actor).browser.refresh());
-    }
-}
-exports.Navigate = Navigate;
-/**
- * @package
- */
-class NavigateToUrl extends core_1.Interaction {
-    constructor(url) {
-        super();
-        this.url = url;
-    }
-    /**
-     * @desc
-     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  perform this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {UsesAbilities & AnswersQuestions} actor
-     *  An {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  to perform this {@link @serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @returns {PromiseLike<void>}
-     *
-     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
-     */
-    performAs(actor) {
-        return actor.answer(this.url)
-            .then(url => __1.BrowseTheWeb.as(actor)
-            .get(url)
-            .catch(error => {
-            throw new core_1.TestCompromisedError(`Couldn't navigate to ${url}`, error);
-        }));
-    }
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString() {
-        return (0, io_1.formatted) `#actor navigates to ${this.url}`;
-    }
-}
-//# sourceMappingURL=Navigate.js.map

package/lib/screenplay/interactions/Navigate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Navigate.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Navigate.ts"],"names":[],"mappings":";;;AAAA,4CAAmH;AACnH,iDAAqD;AAErD,2BAAmC;AAEnC;;;;;GAKG;AACH,MAAa,QAAQ;IAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,MAAM,CAAC,EAAE,CAAC,GAAuB;QAC7B,OAAO,IAAI,aAAa,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,IAAI;QACP,OAAO,kBAAW,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,CAAC,EAAE,CAC7E,gBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CACxC,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,OAAO;QACV,OAAO,kBAAW,CAAC,KAAK,CAAC,iDAAiD,EAAE,KAAK,CAAC,EAAE,CAChF,gBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAC3C,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,UAAU;QACb,OAAO,kBAAW,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,EAAE,CACxD,gBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAC3C,CAAC;IACN,CAAC;CACJ;AAvJD,4BAuJC;AAED;;GAEG;AACH,MAAM,aAAc,SAAQ,kBAAW;IACnC,YAA6B,GAAuB;QAChD,KAAK,EAAE,CAAC;QADiB,QAAG,GAAH,GAAG,CAAoB;IAEpD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,KAAuC;QAC7C,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;aACxB,IAAI,CAAC,GAAG,CAAC,EAAE,CACR,gBAAY,CAAC,EAAE,CAAC,KAAK,CAAC;aACjB,GAAG,CAAC,GAAG,CAAC;aACR,KAAK,CAAC,KAAK,CAAC,EAAE;YACX,MAAM,IAAI,2BAAoB,CAAC,wBAAyB,GAAI,EAAE,EAAE,KAAK,CAAC,CAAC;QAC3E,CAAC,CAAC,CACT,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAA,cAAS,EAAC,uBAAwB,IAAI,CAAC,GAAI,EAAE,CAAC;IACzD,CAAC;CACJ"}

package/lib/screenplay/interactions/Press.d.ts

@@ -1,84 +0,0 @@
-import { Activity, Answerable, AnswersQuestions, Interaction, UsesAbilities } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-import { Key } from '../../input';
-import { PressBuilder } from './PressBuilder';
-import { WebElementInteraction } from './WebElementInteraction';
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  send a key press or a sequence of keys to a Web element.
- *
- *  *Please note*: On macOS, some keyboard shortcuts might not work with the [`devtools` protocol](https://webdriver.io/docs/automationProtocols/#devtools-protocol).
- *
- *  For example:
- *  - to *copy*, instead of `Meta+C`, use `Control+Insert`
- *  - to *cut*, instead of `Meta+X`, use `Control+Delete`
- *  - to *paste*, instead of `Meta+V`, use `Shift+Insert`
- *
- * @example <caption>Example widget</caption>
- *  <form>
- *    <input type="text" name="example" id="example" />
- *  </form>
- *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { by, Target } from '@serenity-js/webdriverio';
- *
- *  class Form {
- *      static exampleInput = Target.the('example input')
- *          .located(by.id('example'));
- *  }
- *
- * @example <caption>Pressing keys</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Key, Press, Value } from '@serenity-js/webdriverio';
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *
- *  actorCalled('Priyanka')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Press.the('H', 'i', '!', Key.ENTER).in(Form.exampleInput),
- *          Ensure.that(Value.of(Form.exampleInput), equals('Hi!')),
- *      );
- *
- * @see {@link Key}
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link @serenity-js/assertions/lib/expectations~equals}
- *
- * @extends {WebElementInteraction}
- */
-export declare class Press extends WebElementInteraction {
-    private readonly keys;
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {...keys: Array<Answerable<Key | string | Key[] | string[]>>} keys
-     *  A sequence of one or more keys to press
-     *
-     * @returns {PressBuilder}
-     */
-    static the(...keys: Array<Answerable<Key | string | Key[] | string[]>>): Activity & PressBuilder;
-    in(field: Answerable<Element<'async'>>): Interaction;
-    /**
-     * @param {Answerable<Array<Key | string>>} keys
-     *  A sequence of one or more keys to press
-     */
-    constructor(keys: Answerable<Array<Key | string>>);
-    /**
-     * @desc
-     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  perform this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {UsesAbilities & AnswersQuestions} actor
-     *  An {@link @serenity-js/core/lib/screenplay/actor~Actor} to perform this {@link @serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @returns {PromiseLike<void>}
-     *
-     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
-     */
-    performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>;
-}

package/lib/screenplay/interactions/Press.js

@@ -1,152 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Press = void 0;
-const core_1 = require("@serenity-js/core");
-const io_1 = require("@serenity-js/core/lib/io");
-const input_1 = require("../../input");
-const abilities_1 = require("../abilities");
-const WebElementInteraction_1 = require("./WebElementInteraction");
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  send a key press or a sequence of keys to a Web element.
- *
- *  *Please note*: On macOS, some keyboard shortcuts might not work with the [`devtools` protocol](https://webdriver.io/docs/automationProtocols/#devtools-protocol).
- *
- *  For example:
- *  - to *copy*, instead of `Meta+C`, use `Control+Insert`
- *  - to *cut*, instead of `Meta+X`, use `Control+Delete`
- *  - to *paste*, instead of `Meta+V`, use `Shift+Insert`
- *
- * @example <caption>Example widget</caption>
- *  <form>
- *    <input type="text" name="example" id="example" />
- *  </form>
- *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { by, Target } from '@serenity-js/webdriverio';
- *
- *  class Form {
- *      static exampleInput = Target.the('example input')
- *          .located(by.id('example'));
- *  }
- *
- * @example <caption>Pressing keys</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Key, Press, Value } from '@serenity-js/webdriverio';
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *
- *  actorCalled('Priyanka')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Press.the('H', 'i', '!', Key.ENTER).in(Form.exampleInput),
- *          Ensure.that(Value.of(Form.exampleInput), equals('Hi!')),
- *      );
- *
- * @see {@link Key}
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link @serenity-js/assertions/lib/expectations~equals}
- *
- * @extends {WebElementInteraction}
- */
-class Press extends WebElementInteraction_1.WebElementInteraction {
-    /**
-     * @param {Answerable<Array<Key | string>>} keys
-     *  A sequence of one or more keys to press
-     */
-    constructor(keys) {
-        super((0, io_1.formatted) `#actor presses ${keys}`);
-        this.keys = keys;
-    }
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {...keys: Array<Answerable<Key | string | Key[] | string[]>>} keys
-     *  A sequence of one or more keys to press
-     *
-     * @returns {PressBuilder}
-     */
-    static the(...keys) {
-        return new Press(KeySequence.of(keys));
-    }
-    in(field /* | Question<AlertPromise> | AlertPromise */) {
-        return new PressKeyInField(this.keys, field);
-    }
-    /**
-     * @desc
-     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  perform this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {UsesAbilities & AnswersQuestions} actor
-     *  An {@link @serenity-js/core/lib/screenplay/actor~Actor} to perform this {@link @serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @returns {PromiseLike<void>}
-     *
-     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
-     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
-     */
-    async performAs(actor) {
-        const keys = await actor.answer(this.keys);
-        return abilities_1.BrowseTheWeb.as(actor).sendKeys(keys);
-    }
-}
-exports.Press = Press;
-class PressKeyInField extends WebElementInteraction_1.WebElementInteraction {
-    /**
-     * @param {Answerable<Array<Key | string>>} keys
-     *  A sequence of one or more keys to press
-     *
-     * @param {Answerable<Element<'async'>>} field
-     *  Web element to send the keys to
-     */
-    constructor(keys, field /* todo | Question<AlertPromise> | AlertPromise */) {
-        super((0, io_1.formatted) `#actor presses ${keys} in ${field}`);
-        this.keys = keys;
-        this.field = field;
-    }
-    async performAs(actor) {
-        const field = await this.resolve(actor, this.field);
-        const keys = await actor.answer(this.keys);
-        await abilities_1.BrowseTheWeb.as(actor).browser.execute(
-        /* istanbul ignore next */
-        function focus(element) {
-            element.focus();
-        }, field);
-        return abilities_1.BrowseTheWeb.as(actor).sendKeys(keys);
-    }
-}
-/**
- * @package
- */
-class KeySequence extends core_1.Question {
-    constructor(keys) {
-        super(KeySequence.describe(keys));
-        this.keys = keys;
-    }
-    static of(keys) {
-        return new KeySequence(keys);
-    }
-    answeredBy(actor) {
-        return Promise.all(this.keys.map(part => actor.answer(part))).then(keys => keys.flat().filter(key => !!key));
-    }
-    static describe(keys) {
-        const prefix = keys.length === 1 ? 'key' : 'keys';
-        const description = keys.reduce((acc, key, index) => {
-            const separator = input_1.Key.isKey(key) && key.isModifier
-                ? '-'
-                : acc.separator;
-            return {
-                description: index === 0
-                    ? `${key}`
-                    : `${acc.description}${acc.separator}${key}`,
-                separator,
-            };
-        }, { description: '', separator: ', ' }).description;
-        return `${prefix} ${description}`;
-    }
-}
-//# sourceMappingURL=Press.js.map

package/lib/screenplay/interactions/Press.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Press.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Press.ts"],"names":[],"mappings":";;;AAAA,4CAAiH;AACjH,iDAAqD;AAGrD,uCAAkC;AAClC,4CAA4C;AAE5C,mEAAgE;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAa,KAAM,SAAQ,6CAAqB;IAmB5C;;;OAGG;IACH,YACqB,IAAqC;QAEtD,KAAK,CAAC,IAAA,cAAS,EAAC,kBAAmB,IAAK,EAAE,CAAC,CAAC;QAF3B,SAAI,GAAJ,IAAI,CAAiC;IAG1D,CAAC;IAzBD;;;;;;;;OAQG;IACH,MAAM,CAAE,GAAG,CAAC,GAAG,IAAwD;QACnE,OAAO,IAAI,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,EAAE,CAAC,KAAmC,CAAC,6CAA6C;QAChF,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IAChD,CAAC;IAYD;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,IAAI,GAAI,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE5C,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;CACJ;AAhDD,sBAgDC;AAED,MAAM,eAAgB,SAAQ,6CAAqB;IAC/C;;;;;;OAMG;IACH,YACqB,IAAqC,EACrC,KAAmC,CAAC,kDAAkD;QAEvG,KAAK,CAAC,IAAA,cAAS,EAAC,kBAAmB,IAAK,OAAQ,KAAM,EAAE,CAAC,CAAC;QAHzC,SAAI,GAAJ,IAAI,CAAiC;QACrC,UAAK,GAAL,KAAK,CAA8B;IAGxD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACpD,MAAM,IAAI,GAAI,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE5C,MAAM,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,OAAO;QACxC,0BAA0B;QAC1B,SAAS,KAAK,CAAC,OAAY;YACvB,OAAO,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC,EACD,KAAK,CACR,CAAC;QAEF,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,WAAY,SAAQ,eAAsC;IAK5D,YAA6B,IAAwD;QACjF,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QADT,SAAI,GAAJ,IAAI,CAAoD;IAErF,CAAC;IAND,MAAM,CAAC,EAAE,CAAC,IAAwD;QAC9D,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAMD,UAAU,CAAC,KAAuC;QAC9C,OAAO,OAAO,CAAC,GAAG,CACd,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAC5C,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAE,GAAG,CAAC,CAAC,CAAA;IACrD,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,IAAwD;QAC5E,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;QAElD,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YAChD,MAAM,SAAS,GAAG,WAAG,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,UAAU;gBAC9C,CAAC,CAAC,GAAG;gBACL,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC;YAEpB,OAAO;gBACH,WAAW,EAAE,KAAK,KAAK,CAAC;oBACpB,CAAC,CAAC,GAAI,GAAI,EAAE;oBACZ,CAAC,CAAC,GAAI,GAAG,CAAC,WAAY,GAAG,GAAG,CAAC,SAAS,GAAI,GAAI,EAAE;gBACpD,SAAS;aACZ,CAAA;QACL,CAAC,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC;QAErD,OAAO,GAAI,MAAO,IAAK,WAAY,EAAE,CAAC;IAC1C,CAAC;CACJ"}