@serenity-js/web 3.0.0-rc.9 → 3.0.1

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

@@ -1,83 +1,65 @@
 import { Answerable, AnswersQuestions, Interaction, UsesAbilities } from '@serenity-js/core';
 import { PageElement } from '../models';
 /**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  scroll until a given Web element comes into view.
+ * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * 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 widget
  *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { Target } from '@serenity-js/protractor';
- *  import { by } from 'protractor';
+ * ```html
+ * <!--
+ *   an element somewhere at the bottom of the page,
+ *   outside of the visible area
+ * -->
+ * <input type="submit" id="submit" />
+ * ```
  *
- *  class Form {
- *      static submitButton = Target.the('submit button')
- *          .located(by.id('submit'));
- *  }
+ * ## Lean Page Object describing the widget
  *
- * @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/protractor';
- *  import { protractor } from 'protractor';
+ * ```ts
+ * import { By, PageElement } from '@serenity-js/web'
  *
- *  actorCalled('Sara')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Scroll.to(Form.submitButton),
- *          Ensure.that(Form.submitButton, isVisible()),
- *      );
+ * class Form {
+ *   static submitButton = () => {
+ *     PageElement.located(By.id('submit'))
+ *       .describedAs('submit button')
+ * }
+ * ```
  *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link isVisible}
- * @see {@link @serenity-js/assertions~Ensure}
+ * ## Scrolling to element
  *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Ensure } from '@serenity-js/assertions'
+ * import { Scroll, isVisible } from '@serenity-js/web'
+ *
+ * await actorCalled('Sara')
+ *   .attemptsTo(
+ *     Scroll.to(Form.submitButton()),
+ *     Ensure.that(Form.submitButton(), isVisible()),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ *
+ * - {@apilink BrowseTheWeb}
+ * - {@apilink PageElement}
+ *
+ * @group Activities
  */
 export declare class Scroll extends Interaction {
-    private readonly target;
+    private readonly element;
     /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
+     * Instantiates this {@apilink Interaction}.
      *
-     * @param {Answerable<PageElement>} target
-     *  The element to be scroll to
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
+     * @param pageElement
+     *  The element to scroll to
      */
-    static to(target: Answerable<PageElement>): Scroll;
+    static to(pageElement: Answerable<PageElement>): Scroll;
+    protected constructor(element: Answerable<PageElement>);
     /**
-     * @param {Answerable<PageElement>} target
-     *  The element to be scroll to
-     */
-    constructor(target: Answerable<PageElement>);
-    /**
-     * @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}
+     * @inheritDoc
      */
     performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>;
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString(): string;
 }
+//# sourceMappingURL=Scroll.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Scroll.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/Scroll.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAK,WAAW,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEhG,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,qBAAa,MAAO,SAAQ,WAAW;IAYb,OAAO,CAAC,QAAQ,CAAC,OAAO;IAV9C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,MAAM;IAIvD,SAAS,aAA8B,OAAO,EAAE,UAAU,CAAC,WAAW,CAAC;IAIvE;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAK1E"}

package/lib/screenplay/interactions/Scroll.js

@@ -2,96 +2,74 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Scroll = void 0;
 const core_1 = require("@serenity-js/core");
-const io_1 = require("@serenity-js/core/lib/io");
 /**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  scroll until a given Web element comes into view.
+ * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * 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 widget
  *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { Target } from '@serenity-js/protractor';
- *  import { by } from 'protractor';
+ * ```html
+ * <!--
+ *   an element somewhere at the bottom of the page,
+ *   outside of the visible area
+ * -->
+ * <input type="submit" id="submit" />
+ * ```
  *
- *  class Form {
- *      static submitButton = Target.the('submit button')
- *          .located(by.id('submit'));
- *  }
+ * ## Lean Page Object describing the widget
  *
- * @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/protractor';
- *  import { protractor } from 'protractor';
+ * ```ts
+ * import { By, PageElement } from '@serenity-js/web'
  *
- *  actorCalled('Sara')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Scroll.to(Form.submitButton),
- *          Ensure.that(Form.submitButton, isVisible()),
- *      );
+ * class Form {
+ *   static submitButton = () => {
+ *     PageElement.located(By.id('submit'))
+ *       .describedAs('submit button')
+ * }
+ * ```
  *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link isVisible}
- * @see {@link @serenity-js/assertions~Ensure}
+ * ## Scrolling to element
  *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Ensure } from '@serenity-js/assertions'
+ * import { Scroll, isVisible } from '@serenity-js/web'
+ *
+ * await actorCalled('Sara')
+ *   .attemptsTo(
+ *     Scroll.to(Form.submitButton()),
+ *     Ensure.that(Form.submitButton(), isVisible()),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ *
+ * - {@apilink BrowseTheWeb}
+ * - {@apilink PageElement}
+ *
+ * @group Activities
  */
 class Scroll extends core_1.Interaction {
     /**
-     * @param {Answerable<PageElement>} target
-     *  The element to be scroll to
-     */
-    constructor(target) {
-        super();
-        this.target = target;
-    }
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Answerable<PageElement>} target
-     *  The element to be scroll to
+     * Instantiates this {@apilink Interaction}.
      *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
+     * @param pageElement
+     *  The element to scroll to
      */
-    static to(target) {
-        return new Scroll(target);
+    static to(pageElement) {
+        return new Scroll(pageElement);
+    }
+    constructor(element) {
+        super((0, core_1.d) `#actor scrolls to ${element}`);
+        this.element = element;
     }
     /**
-     * @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}
+     * @inheritDoc
      */
     async performAs(actor) {
-        const target = await actor.answer(this.target);
+        const target = await actor.answer(this.element);
         return target.scrollIntoView();
     }
-    /**
-     * @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 scrolls to ${this.target}`;
-    }
 }
 exports.Scroll = Scroll;
 //# sourceMappingURL=Scroll.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"Scroll.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Scroll.ts"],"names":[],"mappings":";;;AAAA,4CAA6F;AAC7F,iDAAqD;AAIrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAa,MAAO,SAAQ,kBAAW;IAenC;;;OAGG;IACH,YAA6B,MAA+B;QACxD,KAAK,EAAE,CAAC;QADiB,WAAM,GAAN,MAAM,CAAyB;IAE5D,CAAC;IAnBD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,CAAC,MAA+B;QACrC,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAUD;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE/C,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAA,cAAS,EAAC,qBAAsB,IAAI,CAAC,MAAO,EAAE,CAAC;IAC1D,CAAC;CACJ;AApDD,wBAoDC"}
+{"version":3,"file":"Scroll.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Scroll.ts"],"names":[],"mappings":";;;AAAA,4CAAgG;AAIhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAa,MAAO,SAAQ,kBAAW;IAEnC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,WAAoC;QAC1C,OAAO,IAAI,MAAM,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IAED,YAAuC,OAAgC;QACnE,KAAK,CAAC,IAAA,QAAC,EAAA,qBAAsB,OAAQ,EAAE,CAAC,CAAC;QADN,YAAO,GAAP,OAAO,CAAyB;IAEvE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEhD,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;CACJ;AAxBD,wBAwBC"}