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

package/lib/screenplay/interactions/Wait.js

@@ -1,247 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Wait = void 0;
-const core_1 = require("@serenity-js/core");
-const io_1 = require("@serenity-js/core/lib/io");
-const abilities_1 = require("../abilities");
-/**
- * @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}
- */
-class Wait {
-    /**
-     * @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) {
-        return new WaitFor(duration);
-    }
-    /**
-     * @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) {
-        return {
-            until: (actual, expectation) => new WaitUntil(actual, expectation, duration),
-        };
-    }
-    /**
-     * @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, expectation) {
-        return new WaitUntil(actual, expectation, Wait.Default_Timeout);
-    }
-}
-exports.Wait = Wait;
-/**
- * @desc
- *  Default timeout of 5 seconds used with {@link Wait.until}.
- *
- * @type {@serenity-js/core~Duration}
- */
-Wait.Default_Timeout = core_1.Duration.ofSeconds(5);
-/**
- * @package
- */
-class WaitFor extends core_1.Interaction {
-    constructor(duration) {
-        super();
-        this.duration = duration;
-    }
-    /**
-     * @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
-     * @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) {
-        return actor.answer(this.duration)
-            .then(duration => abilities_1.BrowseTheWeb.as(actor).browser.pause(duration.inMilliseconds()));
-    }
-    /**
-     * @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 waits for ${this.duration}`;
-    }
-}
-/**
- * @package
- */
-class WaitUntil extends core_1.Interaction {
-    constructor(actual, expectation, timeout) {
-        super();
-        this.actual = actual;
-        this.expectation = expectation;
-        this.timeout = timeout;
-    }
-    /**
-     * @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
-     * @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) {
-        const actual = this.actual, expectation = this.expectation.answeredBy(actor);
-        let expectationOutcome;
-        return abilities_1.BrowseTheWeb.as(actor)
-            .browser
-            .waitUntil(function () {
-            return actor.answer(actual)
-                .then(act => expectation(act))
-                .then(outcome => {
-                expectationOutcome = outcome;
-                return outcome instanceof core_1.ExpectationMet;
-            });
-        }, {
-            timeout: this.timeout.inMilliseconds(),
-            timeoutMsg: `Wait timed out after ${this.timeout}`,
-        })
-            .then(_ => void 0)
-            .catch(error => {
-            if (expectationOutcome) {
-                throw new core_1.AssertionError(`Waited ${this.timeout.toString()} for ${(0, io_1.formatted) `${this.actual}`} to ${this.expectation.toString()}`, expectationOutcome.expected, expectationOutcome.actual, error);
-            }
-            throw 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 waits up to ${this.timeout} until ${this.actual} does ${this.expectation}`;
-    }
-}
-//# sourceMappingURL=Wait.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Wait.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Wait.ts"],"names":[],"mappings":";;;AAAA,4CAAwK;AACxK,iDAAqD;AAErD,4CAA4C;AAG5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AACH,MAAa,IAAI;IAUb;;;;;;;;;;OAUG;IACH,MAAM,CAAC,GAAG,CAAC,QAA8B;QACrC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,CAAC,QAAkB;QAC1B,OAAO;YACH,KAAK,EAAE,CAAS,MAA0B,EAAE,WAAqC,EAAe,EAAE,CAC9F,IAAI,SAAS,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,CAAC;SACnD,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,KAAK,CAAS,MAA0B,EAAE,WAAqC;QAClF,OAAO,IAAI,SAAS,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IACpE,CAAC;;AA9DL,oBA+DC;AA7DG;;;;;GAKG;AACa,oBAAe,GAAG,eAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAyD5D;;GAEG;AACH,MAAM,OAAQ,SAAQ,kBAAW;IAC7B,YAA6B,QAA8B;QACvD,KAAK,EAAE,CAAC;QADiB,aAAQ,GAAR,QAAQ,CAAsB;IAE3D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;aAC7B,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAkB,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAA,cAAS,EAAA,oBAAqB,IAAI,CAAC,QAAS,EAAE,CAAC;IAC1D,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,SAAkB,SAAQ,kBAAW;IACvC,YACqB,MAA0B,EAC1B,WAAqC,EACrC,OAAiB;QAElC,KAAK,EAAE,CAAC;QAJS,WAAM,GAAN,MAAM,CAAoB;QAC1B,gBAAW,GAAX,WAAW,CAA0B;QACrC,YAAO,GAAP,OAAO,CAAU;IAGtC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,KAAuC;QAC7C,MACI,MAAM,GAAQ,IAAI,CAAC,MAAM,EACzB,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAErD,IAAI,kBAAmD,CAAC;QAExD,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC;aACxB,OAAO;aACP,SAAS,CAAC;YACP,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;iBACtB,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;iBAC7B,IAAI,CAAC,OAAO,CAAC,EAAE;gBACZ,kBAAkB,GAAG,OAAO,CAAC;gBAE7B,OAAO,OAAO,YAAY,qBAAc,CAAC;YAC7C,CAAC,CAAC,CAAC;QACX,CAAC,EAAE;YACC,OAAO,EAAK,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;YACzC,UAAU,EAAE,wBAAyB,IAAI,CAAC,OAAQ,EAAE;SACvD,CAAC;aACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;aACjB,KAAK,CAAC,KAAK,CAAC,EAAE;YACX,IAAI,kBAAkB,EAAE;gBACpB,MAAM,IAAI,qBAAc,CACpB,UAAW,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAG,QAAS,IAAA,cAAS,EAAC,GAAI,IAAI,CAAC,MAAO,EAAG,OAAQ,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAG,EAAE,EAC/G,kBAAkB,CAAC,QAAQ,EAC3B,kBAAkB,CAAC,MAAM,EACzB,KAAK,CACR,CAAC;aACL;YAED,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAA,cAAS,EAAA,sBAAuB,IAAI,CAAC,OAAQ,UAAW,IAAI,CAAC,MAAO,SAAU,IAAI,CAAC,WAAY,EAAE,CAAC;IAC7G,CAAC;CACJ"}

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

@@ -1,32 +0,0 @@
-/**
- * @desc
- *  Fluent interface to make the instantiation of
- *  the {@link @serenity-js/core/lib/screenplay~Interaction}
- *  to {@link Wait} more readable.
- *
- * @see {@link Wait}
- *
- * @interface
- */
-import { Answerable, Expectation, Interaction } from '@serenity-js/core';
-export interface WaitBuilder {
-    /**
-     * @desc
-     *  Instantiates an {@link @serenity-js/core/lib/screenplay~Interaction}
-     *  to {@link Wait}.
-     *
-     * @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~Expectation<any,Actual>} expectation
-     *  An {@link @serenity-js/assertions~Expectation} to be met before proceeding
-     *
-     * @returns {Interaction}
-     *
-     * @see {@link Target}
-     */
-    until: <Actual>(actual: Answerable<Actual>, expectation: Expectation<any, Actual>) => Interaction;
-}

package/lib/screenplay/interactions/WaitBuilder.js

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

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

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

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

@@ -1,37 +0,0 @@
-import { Answerable, AnswersQuestions, Interaction } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-/**
- * @desc
- *  A base class for WebdriverIO-specific interactions
- *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
- */
-export declare abstract class WebElementInteraction extends Interaction {
-    private readonly description;
-    /**
-     * @param {string} description
-     *  A human-readable description to be used when reporting
-     *  this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     */
-    constructor(description: string);
-    /**
-     * @desc
-     *  Returns the resolved {@link @wdio/types~Element}, or throws a {@link @serenity-js/core/lib/errors~LogicError}
-     *  if the element is `undefined`.
-     *
-     * @param {@serenity-js/core/lib/screenplay/actor~AnswersQuestions} actor
-     * @param {@serenity-js/core/lib/screenplay~Answerable<Element<'async'>>} element
-     *
-     * @returns {Promise<Element<'async'>>}
-     *
-     * @protected
-     */
-    protected resolve(actor: AnswersQuestions, element: Answerable<Element<'async'>>): Promise<Element<'async'>>;
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString(): string;
-}

package/lib/screenplay/interactions/WebElementInteraction.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebElementInteraction = void 0;
-const core_1 = require("@serenity-js/core");
-const io_1 = require("@serenity-js/core/lib/io");
-/**
- * @desc
- *  A base class for WebdriverIO-specific interactions
- *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
- */
-class WebElementInteraction extends core_1.Interaction {
-    /**
-     * @param {string} description
-     *  A human-readable description to be used when reporting
-     *  this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     */
-    constructor(description) {
-        super();
-        this.description = description;
-    }
-    /**
-     * @desc
-     *  Returns the resolved {@link @wdio/types~Element}, or throws a {@link @serenity-js/core/lib/errors~LogicError}
-     *  if the element is `undefined`.
-     *
-     * @param {@serenity-js/core/lib/screenplay/actor~AnswersQuestions} actor
-     * @param {@serenity-js/core/lib/screenplay~Answerable<Element<'async'>>} element
-     *
-     * @returns {Promise<Element<'async'>>}
-     *
-     * @protected
-     */
-    async resolve(actor, element) {
-        const resolved = await actor.answer(element);
-        if (!resolved) {
-            throw new core_1.LogicError((0, io_1.formatted) `Couldn't find ${element}`);
-        }
-        return resolved;
-    }
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString() {
-        return this.description;
-    }
-}
-exports.WebElementInteraction = WebElementInteraction;
-//# sourceMappingURL=WebElementInteraction.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"WebElementInteraction.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/WebElementInteraction.ts"],"names":[],"mappings":";;;AAAA,4CAA0F;AAC1F,iDAAqD;AAGrD;;;;;GAKG;AACH,MAAsB,qBAAsB,SAAQ,kBAAW;IAE3D;;;;OAIG;IACH,YAA6B,WAAmB;QAC5C,KAAK,EAAE,CAAC;QADiB,gBAAW,GAAX,WAAW,CAAQ;IAEhD,CAAC;IAED;;;;;;;;;;;OAWG;IACO,KAAK,CAAC,OAAO,CACnB,KAAuB,EACvB,OAAqC;QAErC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,CAAE,QAAQ,EAAE;YACZ,MAAM,IAAI,iBAAU,CAAC,IAAA,cAAS,EAAC,iBAAkB,OAAQ,EAAE,CAAC,CAAC;SAChE;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;CACJ;AA7CD,sDA6CC"}

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

@@ -1,13 +0,0 @@
-export * from './Clear';
-export * from './Click';
-export * from './DoubleClick';
-export * from './Enter';
-export * from './ExecuteScript';
-export * from './Hover';
-export * from './Navigate';
-export * from './Press';
-export * from './PressBuilder';
-export * from './RightClick';
-export * from './Scroll';
-export * from './Wait';
-export * from './WebElementInteraction';

package/lib/screenplay/interactions/index.js

@@ -1,26 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-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("./Clear"), exports);
-__exportStar(require("./Click"), exports);
-__exportStar(require("./DoubleClick"), exports);
-__exportStar(require("./Enter"), exports);
-__exportStar(require("./ExecuteScript"), exports);
-__exportStar(require("./Hover"), exports);
-__exportStar(require("./Navigate"), exports);
-__exportStar(require("./Press"), exports);
-__exportStar(require("./PressBuilder"), exports);
-__exportStar(require("./RightClick"), exports);
-__exportStar(require("./Scroll"), exports);
-__exportStar(require("./Wait"), exports);
-__exportStar(require("./WebElementInteraction"), exports);
-//# sourceMappingURL=index.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAAwB;AACxB,0CAAwB;AACxB,gDAA8B;AAC9B,0CAAwB;AACxB,kDAAgC;AAChC,0CAAwB;AACxB,6CAA2B;AAC3B,0CAAwB;AACxB,iDAA+B;AAC/B,+CAA6B;AAC7B,2CAAyB;AACzB,yCAAuB;AACvB,0DAAwC"}

package/lib/screenplay/questions/Attribute.d.ts

@@ -1,82 +0,0 @@
-import { Answerable, AnswersQuestions, MetaQuestion, Question, UsesAbilities } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-/**
- * @desc
- *  Returns the value of the given HTML attribute of a given {@link WebElement},
- *  represented by Answerable<{@link @wdio/types~Element}>
- *
- * @example <caption>Example widget</caption>
- *  <ul id="shopping-list" data-items-left="2">
- *    <li data-state="bought">Coffee<li>
- *    <li data-state="buy">Honey<li>
- *    <li data-state="buy">Chocolate<li>
- *  </ul>
- *
- * @example <caption>Retrieve a HTML attribute of a given WebElement</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *  import { Attribute, by, BrowseTheWeb, Target } from '@serenity-js/webdriverio';
- *
- *  const shoppingList = () =>
- *      Target.the('shopping list').located(by.id('shopping-list'))
- *
- *  actorCalled('Lisa')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Ensure.that(Attribute.called('data-items-left').of(shoppingList()), equals('2')),
- *      )
- *
- * @example <caption>Find WebElements with a given attribute</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { Ensure, includes } from '@serenity-js/assertions';
- *  import { Attribute, BrowseTheWeb, by, Target } from '@serenity-js/webdriverio';
- *
- *  class ShoppingList {
- *      static items = () =>
- *          Target.all('items')
- *              .located(by.css('#shopping-list li'))
- *
- *      static outstandingItems = () =>
- *          ShoppingList.items
- *              .where(Attribute.called('data-state'), includes('buy'))
- *  }
- *
- *  actorCalled('Lisa')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Ensure.that(
- *              Text.ofAll(ShoppingList.outstandingItems()),
- *              equals([ 'Honey', 'Chocolate' ])
- *          ),
- *      )
- *
- * @extends {@serenity-js/core/lib/screenplay~Question}
- * @implements {@serenity-js/core/lib/screenplay/questions~MetaQuestion}
- */
-export declare class Attribute extends Question<Promise<string>> implements MetaQuestion<Answerable<Element<'async'>>, Promise<string>> {
-    private readonly name;
-    private readonly element?;
-    /**
-     * @param {Answerable<string>} name
-     * @returns {Attribute}
-     */
-    static called(name: Answerable<string>): Attribute;
-    /**
-     * @param {Answerable<string>} name
-     * @param {@serenity-js/core/lib/screenplay~Answerable<Element<'async'>>} [element]
-     */
-    constructor(name: Answerable<string>, element?: Answerable<Element<'async'>>);
-    /**
-     * @desc
-     *  Resolves to the value of a HTML attribute of the `target` element,
-     *  located in the context of a `parent` element.
-     *
-     * @param {Answerable<Element<'async'>>} parent
-     * @returns {Question<Promise<string[]>>}
-     *
-     * @see {@link Target.all}
-     * @see {@link @serenity-js/core/lib/screenplay/questions~MetaQuestion}
-     */
-    of(parent: Answerable<Element<'async'>>): Question<Promise<string>>;
-    answeredBy(actor: AnswersQuestions & UsesAbilities): Promise<string>;
-}

package/lib/screenplay/questions/Attribute.js

@@ -1,102 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Attribute = void 0;
-const core_1 = require("@serenity-js/core");
-const targets_1 = require("./targets");
-/**
- * @desc
- *  Returns the value of the given HTML attribute of a given {@link WebElement},
- *  represented by Answerable<{@link @wdio/types~Element}>
- *
- * @example <caption>Example widget</caption>
- *  <ul id="shopping-list" data-items-left="2">
- *    <li data-state="bought">Coffee<li>
- *    <li data-state="buy">Honey<li>
- *    <li data-state="buy">Chocolate<li>
- *  </ul>
- *
- * @example <caption>Retrieve a HTML attribute of a given WebElement</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *  import { Attribute, by, BrowseTheWeb, Target } from '@serenity-js/webdriverio';
- *
- *  const shoppingList = () =>
- *      Target.the('shopping list').located(by.id('shopping-list'))
- *
- *  actorCalled('Lisa')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Ensure.that(Attribute.called('data-items-left').of(shoppingList()), equals('2')),
- *      )
- *
- * @example <caption>Find WebElements with a given attribute</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { Ensure, includes } from '@serenity-js/assertions';
- *  import { Attribute, BrowseTheWeb, by, Target } from '@serenity-js/webdriverio';
- *
- *  class ShoppingList {
- *      static items = () =>
- *          Target.all('items')
- *              .located(by.css('#shopping-list li'))
- *
- *      static outstandingItems = () =>
- *          ShoppingList.items
- *              .where(Attribute.called('data-state'), includes('buy'))
- *  }
- *
- *  actorCalled('Lisa')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Ensure.that(
- *              Text.ofAll(ShoppingList.outstandingItems()),
- *              equals([ 'Honey', 'Chocolate' ])
- *          ),
- *      )
- *
- * @extends {@serenity-js/core/lib/screenplay~Question}
- * @implements {@serenity-js/core/lib/screenplay/questions~MetaQuestion}
- */
-class Attribute extends core_1.Question {
-    /**
-     * @param {Answerable<string>} name
-     * @param {@serenity-js/core/lib/screenplay~Answerable<Element<'async'>>} [element]
-     */
-    constructor(name, element) {
-        super(`"${name}" attribute of ${element}`);
-        this.name = name;
-        this.element = element;
-    }
-    /**
-     * @param {Answerable<string>} name
-     * @returns {Attribute}
-     */
-    static called(name) {
-        return new Attribute(name);
-    }
-    /**
-     * @desc
-     *  Resolves to the value of a HTML attribute of the `target` element,
-     *  located in the context of a `parent` element.
-     *
-     * @param {Answerable<Element<'async'>>} parent
-     * @returns {Question<Promise<string[]>>}
-     *
-     * @see {@link Target.all}
-     * @see {@link @serenity-js/core/lib/screenplay/questions~MetaQuestion}
-     */
-    of(parent) {
-        return new Attribute(this.name, this.element
-            ? new targets_1.TargetNestedElement(parent, this.element)
-            : parent);
-    }
-    async answeredBy(actor) {
-        if (!this.element) {
-            throw new core_1.LogicError(`Target not specified`); // todo: better error message?
-        }
-        const element = await actor.answer(this.element);
-        const name = await actor.answer(this.name);
-        return element.getAttribute(name);
-    }
-}
-exports.Attribute = Attribute;
-//# sourceMappingURL=Attribute.js.map

package/lib/screenplay/questions/Attribute.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Attribute.js","sourceRoot":"","sources":["../../../src/screenplay/questions/Attribute.ts"],"names":[],"mappings":";;;AAAA,4CAAoH;AAGpH,uCAAgD;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAa,SACT,SAAQ,eAAyB;IAWjC;;;OAGG;IACH,YACqB,IAAwB,EACxB,OAAsC;QAEvD,KAAK,CAAC,IAAK,IAAK,kBAAmB,OAAQ,EAAE,CAAC,CAAC;QAH9B,SAAI,GAAJ,IAAI,CAAoB;QACxB,YAAO,GAAP,OAAO,CAA+B;IAG3D,CAAC;IAjBD;;;OAGG;IACH,MAAM,CAAC,MAAM,CAAC,IAAwB;QAClC,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAaD;;;;;;;;;;OAUG;IACH,EAAE,CAAC,MAAoC;QACnC,OAAO,IAAI,SAAS,CAChB,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO;YACR,CAAC,CAAC,IAAI,6BAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC;YAC/C,CAAC,CAAC,MAAM,CACf,CAAC;IACN,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAuC;QACpD,IAAI,CAAE,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,IAAI,iBAAU,CAAC,sBAAsB,CAAC,CAAC,CAAG,8BAA8B;SACjF;QAED,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,MAAM,IAAI,GAAM,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9C,OAAO,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACJ;AArDD,8BAqDC"}