@serenity-js/web 3.41.1 → 3.42.0

package/esm/screenplay/interactions/DoubleClick.js

@@ -0,0 +1,95 @@
+import { the } from '@serenity-js/core';
+import { PageElementInteraction } from './PageElementInteraction.js';
+/**
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to perform a double click on a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+ *
+ * ## Example widget
+ * ```html
+ * <!--
+ *     The editor shows up when the user double-clicks
+ *     on one of the properties of their profile
+ *     and lets 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>
+ * ```
+ *
+ * ## Lean Page Object describing the widget
+ *
+ * ```ts
+ * import { By, PageElement } from '@serenity-js/web'
+ *
+ * class UserProfile {
+ *   static displayName = () =>
+ *     PageElement.located(By.id('display-name'))
+ *       .describedAs('display name')
+ *
+ *   static emailAddress = () =>
+ *     PageElement.located(By.id('email-address'))
+ *       .describedAs('email address')
+ *
+ *   static editor = () =>
+ *     PageElement.located(By.id('editor'))
+ *       .describedAs('editor')
+ * }
+ * ```
+ *
+ * ## Double-clicking on an element
+ * ```ts
+ * import { actorCalled, Wait } from '@serenity-js/core'
+ * import { DoubleClick, isVisible, Enter, Text } from '@serenity-js/web'
+ * import { Ensure, equals, not } from '@serenity-js/assertions'
+ *
+ * await 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()))
+ *   )
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ *
+ * @group Activities
+ */
+export class DoubleClick extends PageElementInteraction {
+    pageElement;
+    /**
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
+     *
+     * @param pageElement
+     *  The element to be double-clicked on
+     */
+    static on(pageElement) {
+        return new DoubleClick(pageElement);
+    }
+    constructor(pageElement) {
+        super(the `#actor double-clicks on ${pageElement}`);
+        this.pageElement = pageElement;
+    }
+    /**
+     * @inheritDoc
+     */
+    async performAs(actor) {
+        const element = await this.resolve(actor, this.pageElement);
+        await element.scrollIntoView();
+        await element.doubleClick();
+    }
+}
+//# sourceMappingURL=DoubleClick.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DoubleClick.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/DoubleClick.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAGxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,MAAM,OAAO,WAAY,SAAQ,sBAAsB;IAYZ;IAVvC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,WAAoC;QAC1C,OAAO,IAAI,WAAW,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC;IAED,YAAuC,WAAoC;QACvE,KAAK,CAAC,GAAG,CAAC,2BAA4B,WAAY,EAAE,CAAC,CAAC;QADnB,gBAAW,GAAX,WAAW,CAAyB;IAE3E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5D,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;QAC/B,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;CACJ"}

package/esm/screenplay/interactions/Drag.d.ts

@@ -0,0 +1,95 @@
+import type { Answerable } from '@serenity-js/core';
+import { Interaction } from '@serenity-js/core';
+import type { PageElement } from '../models/index.js';
+/**
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to drag a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) and drop it on another [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+ *
+ * ## Example HTML with draggable element and drop zone
+ *
+ * ```html
+ * <p id="draggable" draggable="true">
+ *   This element is draggable.
+ * </p>
+ * <div id="droppable">
+ *   Drop Zone
+ * </div>
+ *
+ * <script>
+ *   const draggable = document.getElementById('draggable');
+ *   const droppable = document.getElementById('droppable');
+ *
+ *   draggable.addEventListener('dragstart', (event) => {
+ *     event.dataTransfer.setData('text/plain', event.target.id);
+ *     event.dataTransfer.effectAllowed = 'move';
+ *   });
+ *
+ *   droppable.addEventListener('dragover', (event) => {
+ *     event.preventDefault();
+ *   });
+ *
+ *   droppable.addEventListener('drop', (event) => {
+ *     event.preventDefault();
+ *     const id = event.dataTransfer.getData('text/plain');
+ *     event.target.appendChild(document.getElementById(id));
+ *   });
+ * </script>
+ * ```
+ *
+ * ## Page Elements for draggable and drop zone
+ *
+ * ```ts
+ * import { By, PageElement } from '@serenity-js/web';
+ *
+ * const draggable = () =>
+ *   PageElement.located(By.id('draggable')).describedAs('draggable element');
+ *
+ * const dropZone = () =>
+ *   PageElement.located(By.id('droppable')).describedAs('drop zone');
+ * ```
+ *
+ * ## Dragging and dropping the element
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Ensure, isPresent } from '@serenity-js/assertions'
+ * import { Drag, Navigate } from '@serenity-js/web'
+ *
+ * await actorCalled('Doug')
+ *   .attemptsTo(
+ *     Navigate.to('/drag-and-drop-example.html'),
+ *     Drag.the(draggable()).to(dropZone()),
+ *     Ensure.that(draggable().of(dropZone()), isPresent()),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [HTML Drag and Drop API](https://developer.mozilla.org/en-US/docs/Web/API/HTML_Drag_and_Drop_API) on MDN
+ *
+ * @group Activities
+ */
+export declare class Drag {
+    private readonly draggable;
+    /**
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+     * to drag a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) and drop it on another [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+     *
+     * Call [`.to(...)`](https://serenity-js.org/api/web/class/Drag/#to) to specify the destination.
+     *
+     * @param draggable
+     *  The element that will be dragged
+     */
+    static the(draggable: Answerable<PageElement>): Drag;
+    private constructor();
+    /**
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+     * to drag a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) and drop it on another [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+     *
+     * @param destination
+     *  The element to drop it on
+     */
+    to(destination: Answerable<PageElement>): Interaction;
+}
+//# sourceMappingURL=Drag.d.ts.map

package/esm/screenplay/interactions/Drag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Drag.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/Drag.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAS,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAO,MAAM,mBAAmB,CAAC;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,IAAI;IAeO,OAAO,CAAC,QAAQ,CAAC,SAAS;IAb9C;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,IAAI;IAIpD,OAAO;IAGP;;;;;;OAMG;IACH,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,WAAW;CAGxD"}

package/esm/screenplay/interactions/Drag.js

@@ -0,0 +1,119 @@
+import { Interaction, the } from '@serenity-js/core';
+/**
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to drag a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) and drop it on another [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+ *
+ * ## Example HTML with draggable element and drop zone
+ *
+ * ```html
+ * <p id="draggable" draggable="true">
+ *   This element is draggable.
+ * </p>
+ * <div id="droppable">
+ *   Drop Zone
+ * </div>
+ *
+ * <script>
+ *   const draggable = document.getElementById('draggable');
+ *   const droppable = document.getElementById('droppable');
+ *
+ *   draggable.addEventListener('dragstart', (event) => {
+ *     event.dataTransfer.setData('text/plain', event.target.id);
+ *     event.dataTransfer.effectAllowed = 'move';
+ *   });
+ *
+ *   droppable.addEventListener('dragover', (event) => {
+ *     event.preventDefault();
+ *   });
+ *
+ *   droppable.addEventListener('drop', (event) => {
+ *     event.preventDefault();
+ *     const id = event.dataTransfer.getData('text/plain');
+ *     event.target.appendChild(document.getElementById(id));
+ *   });
+ * </script>
+ * ```
+ *
+ * ## Page Elements for draggable and drop zone
+ *
+ * ```ts
+ * import { By, PageElement } from '@serenity-js/web';
+ *
+ * const draggable = () =>
+ *   PageElement.located(By.id('draggable')).describedAs('draggable element');
+ *
+ * const dropZone = () =>
+ *   PageElement.located(By.id('droppable')).describedAs('drop zone');
+ * ```
+ *
+ * ## Dragging and dropping the element
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Ensure, isPresent } from '@serenity-js/assertions'
+ * import { Drag, Navigate } from '@serenity-js/web'
+ *
+ * await actorCalled('Doug')
+ *   .attemptsTo(
+ *     Navigate.to('/drag-and-drop-example.html'),
+ *     Drag.the(draggable()).to(dropZone()),
+ *     Ensure.that(draggable().of(dropZone()), isPresent()),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [HTML Drag and Drop API](https://developer.mozilla.org/en-US/docs/Web/API/HTML_Drag_and_Drop_API) on MDN
+ *
+ * @group Activities
+ */
+export class Drag {
+    draggable;
+    /**
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+     * to drag a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) and drop it on another [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+     *
+     * Call [`.to(...)`](https://serenity-js.org/api/web/class/Drag/#to) to specify the destination.
+     *
+     * @param draggable
+     *  The element that will be dragged
+     */
+    static the(draggable) {
+        return new Drag(draggable);
+    }
+    constructor(draggable) {
+        this.draggable = draggable;
+    }
+    /**
+     * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+     * to drag a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) and drop it on another [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+     *
+     * @param destination
+     *  The element to drop it on
+     */
+    to(destination) {
+        return new DragAndDrop(this.draggable, destination);
+    }
+}
+/**
+ * @package
+ */
+class DragAndDrop extends Interaction {
+    draggable;
+    destination;
+    constructor(draggable, destination) {
+        super(the `#actor drags ${draggable} and drops it on ${destination}`);
+        this.draggable = draggable;
+        this.destination = destination;
+    }
+    /**
+     * @inheritDoc
+     */
+    async performAs(actor) {
+        const draggable = await actor.answer(this.draggable);
+        const destination = await actor.answer(this.destination);
+        await draggable.dragTo(destination);
+    }
+}
+//# sourceMappingURL=Drag.js.map

package/esm/screenplay/interactions/Drag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Drag.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Drag.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAIrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,MAAM,OAAO,IAAI;IAewB;IAbrC;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAC,SAAkC;QACzC,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED,YAAqC,SAAkC;QAAlC,cAAS,GAAT,SAAS,CAAyB;IACvE,CAAC;IAED;;;;;;OAMG;IACH,EAAE,CAAC,WAAoC;QACnC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,WAAY,SAAQ,WAAW;IAEZ;IACA;IAFrB,YACqB,SAAkC,EAClC,WAAoC;QAErD,KAAK,CAAC,GAAG,CAAA,gBAAiB,SAAU,oBAAqB,WAAY,EAAE,CAAC,CAAC;QAHxD,cAAS,GAAT,SAAS,CAAyB;QAClC,gBAAW,GAAX,WAAW,CAAyB;IAGzD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAY;QACxB,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEzD,MAAM,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC;CACJ"}

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

@@ -0,0 +1,81 @@
+import type { Answerable, AnswersQuestions, Interaction, UsesAbilities } from '@serenity-js/core';
+import type { PageElement } from '../models/index.js';
+import { PageElementInteraction } from './PageElementInteraction.js';
+/**
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to enter a value into a [form `input`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) field.
+ *
+ * ## Example widget
+ * ```html
+ * <form>
+ *  <input type="text" name="example" id="example" />
+ * </form>
+ * ```
+ *
+ * ## Lean Page Object describing the widget
+ *
+ * ```ts
+ * import { By, PageElement } from '@serenity-js/web'
+ *
+ * class Form {
+ *   static exampleInput = () =>
+ *     PageElement.located(By.id('example'))
+ *       .describedAs('example input')
+ *  }
+ * ```
+ *
+ * ## Entering the value into a form field
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core';
+ * import { Enter } from '@serenity-js/web';
+ *
+ * await actorCalled('Esme')
+ *   .attemptsTo(
+ *     Enter.theValue('Hello world!').into(Form.exampleInput()),
+ *   )
+ * ```
+ *
+ * ## Handling sensitive information
+ *
+ * By design, any data handled by an actor appears in Serenity/JS reports.
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use [`Masked`](https://serenity-js.org/api/core/class/Masked/).
+ *
+ * ```ts
+ * import { actorCalled, Masked } from '@serenity-js/core'
+ * import { Enter } from '@serenity-js/web'
+ *
+ * await actorCalled('Esme')
+ *   .attemptsTo(
+ *     Enter.theValue(Masked.valueOf('your little secret').into(Form.exampleInputField()),
+ *   )
+ *
+ *   // Gets reported as: "Esme enters [a masked value] into the example input field"
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ *
+ * @group Activities
+ */
+export declare class Enter extends PageElementInteraction {
+    private readonly values;
+    private readonly field;
+    /**
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
+     *
+     * @param values
+     *  The text value to be entered
+     */
+    static theValue(...values: Array<Answerable<string | number | string[] | number[]>>): {
+        into: (field: Answerable<PageElement>) => Interaction;
+    };
+    protected constructor(values: Array<Answerable<string | number | string[] | number[]>>, field: Answerable<PageElement>);
+    /**
+     * @inheritDoc
+     */
+    performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>;
+}
+//# sourceMappingURL=Enter.d.ts.map

package/esm/screenplay/interactions/Enter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Enter.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/Enter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAIlG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,qBAAa,KAAM,SAAQ,sBAAsB;IAgBzC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAf1B;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,KAAK,WAAW,CAAA;KAAE;IAO/I,SAAS,aACY,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,EAChE,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC;IASnD;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1E"}

package/esm/screenplay/interactions/Enter.js

@@ -0,0 +1,93 @@
+import { Question, the } from '@serenity-js/core';
+import { asyncMap } from '@serenity-js/core/io';
+import { PageElementInteraction } from './PageElementInteraction.js';
+/**
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to enter a value into a [form `input`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) field.
+ *
+ * ## Example widget
+ * ```html
+ * <form>
+ *  <input type="text" name="example" id="example" />
+ * </form>
+ * ```
+ *
+ * ## Lean Page Object describing the widget
+ *
+ * ```ts
+ * import { By, PageElement } from '@serenity-js/web'
+ *
+ * class Form {
+ *   static exampleInput = () =>
+ *     PageElement.located(By.id('example'))
+ *       .describedAs('example input')
+ *  }
+ * ```
+ *
+ * ## Entering the value into a form field
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core';
+ * import { Enter } from '@serenity-js/web';
+ *
+ * await actorCalled('Esme')
+ *   .attemptsTo(
+ *     Enter.theValue('Hello world!').into(Form.exampleInput()),
+ *   )
+ * ```
+ *
+ * ## Handling sensitive information
+ *
+ * By design, any data handled by an actor appears in Serenity/JS reports.
+ * To prevent the exposure of any sensitive information, such as passwords or tokens, you should use [`Masked`](https://serenity-js.org/api/core/class/Masked/).
+ *
+ * ```ts
+ * import { actorCalled, Masked } from '@serenity-js/core'
+ * import { Enter } from '@serenity-js/web'
+ *
+ * await actorCalled('Esme')
+ *   .attemptsTo(
+ *     Enter.theValue(Masked.valueOf('your little secret').into(Form.exampleInputField()),
+ *   )
+ *
+ *   // Gets reported as: "Esme enters [a masked value] into the example input field"
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ *
+ * @group Activities
+ */
+export class Enter extends PageElementInteraction {
+    values;
+    field;
+    /**
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
+     *
+     * @param values
+     *  The text value to be entered
+     */
+    static theValue(...values) {
+        return {
+            into: (field /* todo Question<AlertPromise> | AlertPromise */) => new Enter(values, field),
+        };
+    }
+    constructor(values, field /* todo | Question<AlertPromise> | AlertPromise */) {
+        super(values.length === 1
+            ? the `#actor enters ${values[0]} into ${field}`
+            : the `#actor enters ${Question.fromArray(values)} into ${field}`);
+        this.values = values;
+        this.field = field;
+    }
+    /**
+     * @inheritDoc
+     */
+    async performAs(actor) {
+        const field = await this.resolve(actor, this.field);
+        const valuesToEnter = await asyncMap(this.values, value => actor.answer(value));
+        return field.enterValue(valuesToEnter.flat());
+    }
+}
+//# sourceMappingURL=Enter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Enter.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Enter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGhD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,MAAM,OAAO,KAAM,SAAQ,sBAAsB;IAgBxB;IACA;IAfrB;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAgE;QAC/E,OAAO;YACH,IAAI,EAAE,CAAC,KAA8B,CAAE,gDAAgD,EAAE,EAAE,CACvF,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC;SAC/B,CAAC;IACN,CAAC;IAED,YACqB,MAAgE,EAChE,KAA8B,CAAC,kDAAkD;QAElG,KAAK,CACD,MAAM,CAAC,MAAM,KAAK,CAAC;YACf,CAAC,CAAC,GAAG,CAAC,iBAAkB,MAAM,CAAC,CAAC,CAAE,SAAU,KAAM,EAAE;YACpD,CAAC,CAAC,GAAG,CAAC,iBAAkB,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAE,SAAU,KAAM,EAAE,CAC5E,CAAC;QAPe,WAAM,GAAN,MAAM,CAA0D;QAChE,UAAK,GAAL,KAAK,CAAyB;IAOnD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,KAAK,GAAI,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAErD,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;QAE/E,OAAO,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;IAClD,CAAC;CACJ"}