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

package/lib/screenplay/interactions/Click.js

@@ -1,84 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Click = 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
- *  [click](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) on a given Web element.
- *
- * @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>Clicking on an element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Click, isSelected } from '@serenity-js/webdriverio';
- *  import { Ensure } from '@serenity-js/assertions';
- *
- *  actorCalled('Chloé')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Click.on(Form.exampleInput),
- *          Ensure.that(Form.exampleInput, isSelected()),
- *      );
- *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link isSelected}
- *
- * @extends {WebElementInteraction}
- */
-class Click extends WebElementInteraction_1.WebElementInteraction {
-    /**
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be clicked on
-     */
-    constructor(target) {
-        super((0, io_1.formatted) `#actor 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 clicked on
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static on(target) {
-        return new Click(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();
-    }
-}
-exports.Click = Click;
-//# sourceMappingURL=Click.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Click.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Click.ts"],"names":[],"mappings":";;;AACA,iDAAqD;AAGrD,mEAAgE;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAa,KAAM,SAAQ,6CAAqB;IAe5C;;;OAGG;IACH,YAA6B,MAAoC;QAC7D,KAAK,CAAC,IAAA,cAAS,EAAC,oBAAqB,MAAO,EAAE,CAAC,CAAC;QADvB,WAAM,GAAN,MAAM,CAA8B;IAEjE,CAAC;IAnBD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,CAAC,MAAoC;QAC1C,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,KAAK,EAAE,CAAC;IAC3B,CAAC;CACJ;AAzCD,sBAyCC"}

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

@@ -1,90 +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
- *  perform a double-click on a given Web element.
- *
- * @example <caption>Example widget</caption>
- *  <!--
- *      The editor shows up when the user double-clicks
- *      on one of the properties of their profile
- *      and let's them change the value of that property.
- *  -->
- *  <div id="user-profile">
- *      <ul>
- *          <li id="display-name" ondblclick="edit(this)">User12345</li>
- *          <li id="email-address" ondblclick="edit(this)">tester@example.org</li>
- *      </ul>
- *      <form id="editor" class="hidden">
- *          <input type="text" value="" />
- *      </form>
- *  </div>
- *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { by, Target } from '@serenity-js/webdriverio';
- *
- *  class UserProfile {
- *      static displayName = Target.the('display name')
- *          .located(by.id('display-name'));
- *      static emailAddress = Target.the('email address')
- *          .located(by.id('email-address'));
- *      static editor = Target.the('editor')
- *          .located(by.id('editor'));
- *  }
- *
- * @example <caption>Double-clicking on an element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, DoubleClick, isVisible, Enter, Text, Wait } from '@serenity-js/webdriverio';
- *  import { Ensure, equals, not } from '@serenity-js/assertions';
- *
- *  actorCalled('Dorothy')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          DoubleClick.on(UserProfile.displayName),
- *          Wait.until(UserProfile.editor, isVisible()),
- *
- *          Enter.theValue('New username').into(UserProfile.editor),
- *
- *          Ensure.that(Text.of(UserProfile.displayName), equals('New username')),
- *          Ensure.that(UserProfile.editor, not(isVisible()))
- *      );
- *
- * @see {@link Target}
- *
- * @extends {WebElementInteraction}
- */
-export declare class DoubleClick extends WebElementInteraction {
-    private readonly target;
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be double-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 double-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/DoubleClick.js

@@ -1,101 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DoubleClick = 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
- *  perform a double-click on a given Web element.
- *
- * @example <caption>Example widget</caption>
- *  <!--
- *      The editor shows up when the user double-clicks
- *      on one of the properties of their profile
- *      and let's them change the value of that property.
- *  -->
- *  <div id="user-profile">
- *      <ul>
- *          <li id="display-name" ondblclick="edit(this)">User12345</li>
- *          <li id="email-address" ondblclick="edit(this)">tester@example.org</li>
- *      </ul>
- *      <form id="editor" class="hidden">
- *          <input type="text" value="" />
- *      </form>
- *  </div>
- *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { by, Target } from '@serenity-js/webdriverio';
- *
- *  class UserProfile {
- *      static displayName = Target.the('display name')
- *          .located(by.id('display-name'));
- *      static emailAddress = Target.the('email address')
- *          .located(by.id('email-address'));
- *      static editor = Target.the('editor')
- *          .located(by.id('editor'));
- *  }
- *
- * @example <caption>Double-clicking on an element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, DoubleClick, isVisible, Enter, Text, Wait } from '@serenity-js/webdriverio';
- *  import { Ensure, equals, not } from '@serenity-js/assertions';
- *
- *  actorCalled('Dorothy')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          DoubleClick.on(UserProfile.displayName),
- *          Wait.until(UserProfile.editor, isVisible()),
- *
- *          Enter.theValue('New username').into(UserProfile.editor),
- *
- *          Ensure.that(Text.of(UserProfile.displayName), equals('New username')),
- *          Ensure.that(UserProfile.editor, not(isVisible()))
- *      );
- *
- * @see {@link Target}
- *
- * @extends {WebElementInteraction}
- */
-class DoubleClick extends WebElementInteraction_1.WebElementInteraction {
-    /**
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be double-clicked on
-     */
-    constructor(target) {
-        super((0, io_1.formatted) `#actor double-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 double-clicked on
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static on(target) {
-        return new DoubleClick(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.doubleClick();
-    }
-}
-exports.DoubleClick = DoubleClick;
-//# sourceMappingURL=DoubleClick.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"DoubleClick.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/DoubleClick.ts"],"names":[],"mappings":";;;AACA,iDAAqD;AAGrD,mEAAgE;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAa,WAAY,SAAQ,6CAAqB;IAelD;;;OAGG;IACH,YAA6B,MAAoC;QAC7D,KAAK,CAAC,IAAA,cAAS,EAAC,2BAA4B,MAAO,EAAE,CAAC,CAAC;QAD9B,WAAM,GAAN,MAAM,CAA8B;IAEjE,CAAC;IAnBD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,CAAC,MAAoC;QAC1C,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IACnC,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,WAAW,EAAE,CAAC;IACjC,CAAC;CACJ;AAzCD,kCAyCC"}

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

@@ -1,73 +0,0 @@
-import { Answerable, AnswersQuestions, UsesAbilities } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-import { EnterBuilder } from './EnterBuilder';
-import { WebElementInteraction } from './WebElementInteraction';
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  enter a value into a [form `input`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) field.
- *
- * @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>Entering the value into a form field</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Enter } from '@serenity-js/webdriverio';
- *
- *  actorCalled('Esme')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Enter.theValue('Hello world!').into(Form.exampleInput),
- *      );
- *
- * @see {@link Target}
- *
- * @extends {WebElementInteraction}
- */
-export declare class Enter extends WebElementInteraction {
-    private readonly value;
-    private readonly field;
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Array<Answerable<string | number | string[] | number[]>>} value
-     *  The value to be entered
-     *
-     * @returns {EnterBuilder}
-     */
-    static theValue(...value: Array<Answerable<string | number | string[] | number[]>>): EnterBuilder;
-    /**
-     * @param {Array<Answerable<string | number | string[] | number[]>>} value
-     *  The value to be entered
-     *
-     * @param {Answerable<Element<'async'>>} field
-     *  The field to enter the value into
-     */
-    constructor(value: Array<Answerable<string | number | string[] | number[]>>, field: 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 {Promise<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/Enter.js

@@ -1,87 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Enter = 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
- *  enter a value into a [form `input`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) field.
- *
- * @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>Entering the value into a form field</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Enter } from '@serenity-js/webdriverio';
- *
- *  actorCalled('Esme')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Enter.theValue('Hello world!').into(Form.exampleInput),
- *      );
- *
- * @see {@link Target}
- *
- * @extends {WebElementInteraction}
- */
-class Enter extends WebElementInteraction_1.WebElementInteraction {
-    /**
-     * @param {Array<Answerable<string | number | string[] | number[]>>} value
-     *  The value to be entered
-     *
-     * @param {Answerable<Element<'async'>>} field
-     *  The field to enter the value into
-     */
-    constructor(value, field /* todo | Question<AlertPromise> | AlertPromise */) {
-        super((0, io_1.formatted) `#actor enters ${value.join(', ')} into ${field}`);
-        this.value = value;
-        this.field = field;
-    }
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Array<Answerable<string | number | string[] | number[]>>} value
-     *  The value to be entered
-     *
-     * @returns {EnterBuilder}
-     */
-    static theValue(...value) {
-        return {
-            into: (field /* todo Question<AlertPromise> | AlertPromise */) => new Enter(value, 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 {Promise<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 values = await Promise.all(this.value.map(part => actor.answer(part)));
-        const field = await this.resolve(actor, this.field);
-        // addValue rather than setValue so that the behaviour is consistent with Selenium sendKeys
-        return field.addValue(values.flat());
-    }
-}
-exports.Enter = Enter;
-//# sourceMappingURL=Enter.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Enter.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Enter.ts"],"names":[],"mappings":";;;AACA,iDAAqD;AAIrD,mEAAgE;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAa,KAAM,SAAQ,6CAAqB;IAkB5C;;;;;;OAMG;IACH,YACqB,KAA+D,EAC/D,KAAmC,CAAC,kDAAkD;QAEvG,KAAK,CAAC,IAAA,cAAS,EAAC,iBAAkB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAE,SAAU,KAAM,EAAE,CAAC,CAAC;QAHtD,UAAK,GAAL,KAAK,CAA0D;QAC/D,UAAK,GAAL,KAAK,CAA8B;IAGxD,CAAC;IA5BD;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,KAA+D;QAC9E,OAAO;YACH,IAAI,EAAE,CAAC,KAAmC,CAAE,gDAAgD,EAAE,EAAE,CAC5F,IAAI,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC;SAC9B,CAAC;IACN,CAAC;IAgBD;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7E,MAAM,KAAK,GAAI,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAErD,2FAA2F;QAC3F,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;CACJ;AArDD,sBAqDC"}

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

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

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

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