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

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

@@ -1,26 +0,0 @@
-import { Answerable } from '@serenity-js/core';
-import { Interaction } from '@serenity-js/core/lib/screenplay';
-import { Element } from 'webdriverio';
-/**
- * @desc
- *  Fluent interface to make the instantiation of
- *  the {@link @serenity-js/core/lib/screenplay~Interaction}
- *  to {@link Press} more readable.
- *
- * @see {@link Press}
- *
- * @interface
- */
-export interface PressBuilder {
-    /**
-     * @desc
-     *  Instantiates an {@link @serenity-js/core/lib/screenplay~Interaction}
-     *  to {@link Press}.
-     *
-     * @param {Question<ElementFinder> | ElementFinder | Question<AlertPromise> | AlertPromise} field
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link Target}
-     */
-    in: (field: Answerable<Element<'async'>>) => Interaction;
-}

package/lib/screenplay/interactions/PressBuilder.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=PressBuilder.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"PressBuilder.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/PressBuilder.ts"],"names":[],"mappings":""}

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

@@ -1,89 +0,0 @@
-import { Answerable, AnswersQuestions, Interaction, UsesAbilities } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-import { WebElementInteraction } from './WebElementInteraction';
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  perfom a right click on a given Web element.
- *
- *  This is typically used to open a [custom context menu](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event)
- *  on a given Web element, since it's not possible to interact with the standard context menu offered by your browser
- *
- * @example <caption>Example widget</caption>
- *  <form>
- *    <input type="text" id="field"
- *      oncontextmenu="showMenu(); return false;" />
- *
- *    <div id="context-menu" style="display:none">
- *      Custom context menu
- *    </div>
- *  </form>
- *
- *  <script>
- *    function showMenu() {
- *      document.getElementById("context-menu").style.display = 'block';
- *    }
- *  </script>
- *
- * @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'));
- *      static exampleContextMenu = Target.the('example context menu')
- *          .located(by.id('context-menu'));
- *  }
- *
- * @example <caption>Right-click on an element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, RightClick, isVisible } from '@serenity-js/webdriverio';
- *  import { Ensure } from '@serenity-js/assertions';
- *
- *  actorCalled('Chloé')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          RightClick.on(Form.exampleInput),
- *          Ensure.that(Form.exampleContextMenu, isVisible()),
- *      );
- *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link isVisible}
- *
- * @extends {WebElementInteraction}
- */
-export declare class RightClick extends WebElementInteraction {
-    private readonly target;
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be right-clicked on
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static on(target: Answerable<Element<'async'>>): Interaction;
-    /**
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be right-clicked on
-     */
-    constructor(target: Answerable<Element<'async'>>);
-    /**
-     * @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/RightClick.js

@@ -1,100 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RightClick = 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
- *  perfom a right click on a given Web element.
- *
- *  This is typically used to open a [custom context menu](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event)
- *  on a given Web element, since it's not possible to interact with the standard context menu offered by your browser
- *
- * @example <caption>Example widget</caption>
- *  <form>
- *    <input type="text" id="field"
- *      oncontextmenu="showMenu(); return false;" />
- *
- *    <div id="context-menu" style="display:none">
- *      Custom context menu
- *    </div>
- *  </form>
- *
- *  <script>
- *    function showMenu() {
- *      document.getElementById("context-menu").style.display = 'block';
- *    }
- *  </script>
- *
- * @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'));
- *      static exampleContextMenu = Target.the('example context menu')
- *          .located(by.id('context-menu'));
- *  }
- *
- * @example <caption>Right-click on an element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, RightClick, isVisible } from '@serenity-js/webdriverio';
- *  import { Ensure } from '@serenity-js/assertions';
- *
- *  actorCalled('Chloé')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          RightClick.on(Form.exampleInput),
- *          Ensure.that(Form.exampleContextMenu, isVisible()),
- *      );
- *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link isVisible}
- *
- * @extends {WebElementInteraction}
- */
-class RightClick extends WebElementInteraction_1.WebElementInteraction {
-    /**
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be right-clicked on
-     */
-    constructor(target) {
-        super((0, io_1.formatted) `#actor right-clicks on ${target}`);
-        this.target = target;
-    }
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be right-clicked on
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static on(target) {
-        return new RightClick(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.click({ button: 'right' });
-    }
-}
-exports.RightClick = RightClick;
-//# sourceMappingURL=RightClick.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"RightClick.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/RightClick.ts"],"names":[],"mappings":";;;AACA,iDAAqD;AAGrD,mEAAgE;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAa,UAAW,SAAQ,6CAAqB;IAcjD;;;OAGG;IACH,YAA6B,MAAoC;QAC7D,KAAK,CAAC,IAAA,cAAS,EAAC,0BAA2B,MAAO,EAAE,CAAC,CAAC;QAD7B,WAAM,GAAN,MAAM,CAA8B;IAEjE,CAAC;IAnBD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,CAAC,MAAoC;QAC1C,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAClC,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,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IAC9C,CAAC;CACJ;AAxCD,gCAwCC"}

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

@@ -1,75 +0,0 @@
-import { Answerable, AnswersQuestions, Interaction, UsesAbilities } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-import { WebElementInteraction } from './WebElementInteraction';
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  scroll until a given Web element comes into view.
- *
- * @example <caption>Example widget</caption>
- *  <!--
- *      an element somewhere at the bottom of the page,
- *      outside of the visible area
- *  -->
- *  <input type="submit" id="submit" />
- *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { by, Target } from '@serenity-js/webdriverio';
- *
- *  class Form {
- *      static submitButton = Target.the('submit button')
- *          .located(by.id('submit'));
- *  }
- *
- * @example <caption>Scrolling to element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { Ensure } from '@serenity-js/assertions';
- *  import { BrowseTheWeb, Scroll, isVisible } from '@serenity-js/webdriverio';
- *
- *  actorCalled('Sara')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Scroll.to(Form.submitButton),
- *          Ensure.that(Form.submitButton, isVisible()),
- *      );
- *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link isVisible}
- * @see {@link @serenity-js/assertions~Ensure}
- *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
- */
-export declare class Scroll extends WebElementInteraction {
-    private readonly target;
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be scrolled to
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static to(target: Answerable<Element<'async'>>): Interaction;
-    /**
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be scrolled to
-     */
-    constructor(target: Answerable<Element<'async'>>);
-    /**
-     * @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/Scroll.js

@@ -1,86 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Scroll = 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
- *  scroll until a given Web element comes into view.
- *
- * @example <caption>Example widget</caption>
- *  <!--
- *      an element somewhere at the bottom of the page,
- *      outside of the visible area
- *  -->
- *  <input type="submit" id="submit" />
- *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { by, Target } from '@serenity-js/webdriverio';
- *
- *  class Form {
- *      static submitButton = Target.the('submit button')
- *          .located(by.id('submit'));
- *  }
- *
- * @example <caption>Scrolling to element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { Ensure } from '@serenity-js/assertions';
- *  import { BrowseTheWeb, Scroll, isVisible } from '@serenity-js/webdriverio';
- *
- *  actorCalled('Sara')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Scroll.to(Form.submitButton),
- *          Ensure.that(Form.submitButton, isVisible()),
- *      );
- *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link isVisible}
- * @see {@link @serenity-js/assertions~Ensure}
- *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
- */
-class Scroll extends WebElementInteraction_1.WebElementInteraction {
-    /**
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be scrolled to
-     */
-    constructor(target) {
-        super((0, io_1.formatted) `#actor scrolls to ${target}`);
-        this.target = target;
-    }
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be scrolled to
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static to(target) {
-        return new Scroll(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.scrollIntoView();
-    }
-}
-exports.Scroll = Scroll;
-//# sourceMappingURL=Scroll.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Scroll.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Scroll.ts"],"names":[],"mappings":";;;AACA,iDAAqD;AAGrD,mEAAgE;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAa,MAAO,SAAQ,6CAAqB;IAe7C;;;OAGG;IACH,YAA6B,MAAoC;QAC7D,KAAK,CAAC,IAAA,cAAS,EAAC,qBAAsB,MAAO,EAAE,CAAC,CAAC;QADxB,WAAM,GAAN,MAAM,CAA8B;IAEjE,CAAC;IAnBD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,CAAC,MAAoC;QAC1C,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9B,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,cAAc,EAAE,CAAC;IACpC,CAAC;CACJ;AAzCD,wBAyCC"}

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

@@ -1,143 +0,0 @@
-import { Answerable, Duration, Expectation, Interaction } from '@serenity-js/core';
-import { WaitBuilder } from './WaitBuilder';
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  wait before proceeding either for a set {@link @serenity-js/core/lib/model~Duration}
- *  or until a given {@link @serenity-js/core/lib/screenplay/questions~Expectation} is met.
- *
- *  Under the hood, `Wait` uses WebdriverIO ["explicit waiting"](https://webdriver.io/docs/autowait/)
- *  mechanism.
- *
- * @example <caption>Example widget</caption>
- *  <!--
- *      After about 1 second, the text will change from 'Loading...' to 'Ready!'
- *  -->
- *  <h1 id="status">Loading...</h1>
- *  <script>
- *      (function () {
- *          setTimeout(function () {
- *              document.getElementById('status').textContent = 'Ready!'
- *          }, 1000);
- *      })();
- *  </script>
- *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { by, Target } from '@serenity-js/webdriverio';
- *
- *  class App {
- *      static status = Target.the('status widget')
- *          .located(by.id('status'));
- *  }
- *
- * @example <caption>Waiting for a set amount of time</caption>
- *  import { actorCalled, Duration } from '@serenity-js/core';
- *  import { BrowseTheWeb, Wait } from '@serenity-js/webdriverio';
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *
- *  actorCalled('Wendy')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Wait.for(Duration.ofSeconds(1.5)),
- *          Ensure.that(App.status, equals('Ready!')),
- *      );
- *
- *  // Please note that while the above implementation works,
- *  // this approach is inefficient because at best
- *  // the actor might wait too long and at worst the test
- *  // might become "flaky" if any external interference
- *  // (like network glitches, animations taking a bit too long etc.)
- *  // makes the actor wait not long enough.
- *
- * @example <caption>Waiting until a condition is met</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Wait, Text } from '@serenity-js/webdriverio';
- *  import { equals } from '@serenity-js/assertions';
- *
- *  actorCalled('Wendy')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Wait.until(Text.of(App.status), equals('Ready!')),
- *          // app is ready, proceed with the scenario
- *      );
- *
- *  // Wait.until makes the Actor keep asking a Question,
- *  // in this case Text.of(App.status), until the answer meets
- *  // the expectation, or a timeout expires (default: 5s).
- *  //
- *  // Please note that both Ensure and Wait can be used with
- *  // the same expectations, like `equals`.
- *
- * @example <caption>Changing the default timeout</caption>
- *  import { actorCalled, Duration } from '@serenity-js/core';
- *  import { BrowseTheWeb, Wait, Text } from '@serenity-js/webdriverio';
- *  import { equals } from '@serenity-js/assertions';
- *
- *  actorCalled('Wendy')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Wait.upTo(Duration.ofSeconds(3))
- *              .until(Text.of(App.status), equals('Ready!')),
- *          // app is ready, proceed with the scenario
- *      );
- *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link Text}
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link @serenity-js/assertions/lib/expectations~equals}
- * @see {@link @serenity-js/core/lib/model~Duration}
- *
- * @see {@link @serenity-js/core/lib/screenplay~Interaction}
- */
-export declare class Wait {
-    /**
-     * @desc
-     *  Default timeout of 5 seconds used with {@link Wait.until}.
-     *
-     * @type {@serenity-js/core~Duration}
-     */
-    static readonly Default_Timeout: Duration;
-    /**
-     * @desc
-     *  Instantiates a version of this {@link @serenity-js/core/lib/screenplay~Interaction}
-     *  configured to wait for a set duration.
-     *
-     * @param {Answerable<Duration>} duration
-     *  A set duration the {@link @serenity-js/core/lib/screenplay/actor~Actor} should wait for
-     *  before proceeding
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static for(duration: Answerable<Duration>): Interaction;
-    /**
-     * @desc
-     *  Instantiates a version of this {@link @serenity-js/core/lib/screenplay~Interaction}
-     *  configured to wait until the answer to the question (`actual`) meets the `expectation`,
-     *  or a custom timeout expires.
-     *
-     * @param {Duration} duration
-     *  Custom timeout to override {@link Wait.Default_Timeout}
-     *
-     * @returns {WaitBuilder}
-     */
-    static upTo(duration: Duration): WaitBuilder;
-    /**
-     * @desc
-     *  Instantiates a version of this {@link @serenity-js/core/lib/screenplay~Interaction}
-     *  configured to wait until the answer to the question (`actual`) meets the `expectation`,
-     *  or a {@link Wait.Default_Timeout} expires.
-     *
-     * @param {Answerable<Actual>} actual
-     *  A {@link @serenity-js/core/lib/screenplay~Question}
-     *  that the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  will keep asking until the answer meets
-     *  the {@link @serenity-js/core/lib/screenplay/questions~Expectation} provided
-     *
-     * @param {@serenity-js/core/lib/screenplay/questions~<any,Actual>} expectation
-     *  An {@link @serenity-js/core/lib/screenplay/questions~Expectation} to be met before proceeding
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static until<Actual>(actual: Answerable<Actual>, expectation: Expectation<any, Actual>): Interaction;
-}