@serenity-js/web 3.41.2 → 3.42.0

package/esm/screenplay/abilities/BrowseTheWeb.js

@@ -0,0 +1,106 @@
+import { Ability } from '@serenity-js/core';
+/**
+ * The [ability](https://serenity-js.org/api/core/class/Ability/) to `BrowseTheWeb` enables an [actor](https://serenity-js.org/api/core/class/Actor/)
+ * to [interact with](https://serenity-js.org/api/core/class/Interaction/) and [retrieve information from](https://serenity-js.org/api/core/class/Question/) Web-based user interfaces.
+ *
+ * `BrowseTheWeb` wraps test integration tools such as [Playwright](https://serenity-js.org/api/playwright),
+ * [Protractor](https://serenity-js.org/api/protractor), or [WebdriverIO](https://serenity-js.org/api/webdriverio),
+ * and together with Serenity/JS Web models, such as [`Page`](https://serenity-js.org/api/web/class/Page/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) - offers a standardised way
+ * to write Web-based tests following the Screenplay Pattern.
+ *
+ * The consistent and portable design of abstractions provided by the [`@serenity-js/web` module](https://serenity-js.org/api/web)
+ * also helps to make your tests portable across the various test integration tools and helps to make your test
+ * code easier to reuse across projects and teams.
+ *
+ * ## Giving the actors an ability to `BrowseTheWeb`
+ *
+ * To give an [actor](https://serenity-js.org/api/core/class/Actor/) an ability to `BrowseTheWeb`, provide the **integration tool-specific implementation**
+ * via [`Actor.whoCan`](https://serenity-js.org/api/core/class/Actor/#whoCan) in [`Cast.prepare`](https://serenity-js.org/api/core/class/Cast/#prepare), or via [`Cast.where`](https://serenity-js.org/api/core/class/Cast/#where).
+ *
+ * ```ts
+ * import { beforeEach } from 'mocha'
+ * import { engage, Actor, Cast } from '@serenity-js/core'
+ * import { BrowseTheWebWithPlaywright } from '@serenity-js/playwright'
+ * import { Browser, chromium } from 'playwright'
+ *
+ * beforeEach(async () => {
+ *   const browser = await chromium.launch({ headless: true })
+ *
+ *   engage(
+ *     BrowseTheWebWithPlaywright.using(browser),
+ *   )
+ * })
+ * ```
+ *
+ * ### Learn more
+ *
+ * To learn more about using Serenity/JS with your chosen test integration tool, follow their respective documentation:
+ *
+ * - [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
+ * - [`BrowseTheWebWithProtractor`](https://serenity-js.org/api/protractor/class/BrowseTheWebWithProtractor/)
+ * - [`BrowseTheWebWithWebdriverIO`](https://serenity-js.org/api/webdriverio/class/BrowseTheWebWithWebdriverIO/)
+ *
+ * ## Using the ability to `BrowseTheWeb`
+ *
+ * To use the ability to `BrowseTheWeb` in a custom [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
+ * or [`Question`](https://serenity-js.org/api/core/class/Question/), use the **generic** method [`BrowseTheWeb.as`](https://serenity-js.org/api/core/class/Ability/#as)
+ * to retrieve it.
+ *
+ * This generic method retrieves the integration tool-specific implementation of [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) present on the [`Actor`](https://serenity-js.org/api/core/class/Actor/),
+ * such as [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
+ * or [`BrowseTheWebWithWebdriverIO`](https://serenity-js.org/api/webdriverio/class/BrowseTheWebWithWebdriverIO/), using [`Actor.abilityTo`](https://serenity-js.org/api/core/class/Actor/#abilityTo).
+ *
+ * This decoupling mechanism helps to make your test code portable across test integration tools,
+ * since the only part of your test suite that needs to know about the test integration tool used are the actors.
+ * The rest of your test code, so [tasks](https://serenity-js.org/api/core/class/Task/), [interactions](https://serenity-js.org/api/core/class/Interaction/), and [questions](https://serenity-js.org/api/core/class/Question/),
+ * remain fully agnostic of the underlying tool.
+ *
+ * ```ts
+ * import { BrowseTheWeb, Question } from '@serenity-js/web'
+ *
+ * const BrowserDetails = () =>
+ *  Question.about('browser details', async actor => {
+ *    const capabilities = await BrowseTheWeb.as(actor).browserCapabilities();
+ *    return ${ capabilities.browserName } ${ capabilities.browserVersion }`;
+ *  })
+ * ```
+ *
+ * **Pro tip:** Use the specific `BrowseTheWebWith<test integration tool name>` to give the actor the ability,
+ * and generic `BrowseTheWeb.as(actor)` to retrieve it.
+ *
+ * ### Learn more
+ *
+ * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+ * - [`Actor.whoCan`](https://serenity-js.org/api/core/class/Actor/#whoCan)
+ * - [`Cast.where`](https://serenity-js.org/api/core/class/Cast/#where)
+ * - [`Cast.prepare`](https://serenity-js.org/api/core/class/Cast/#prepare)
+ *
+ * @group Abilities
+ */
+export class BrowseTheWeb extends Ability {
+    session;
+    constructor(session) {
+        super();
+        this.session = session;
+    }
+    /**
+     * Returns a [`Page`](https://serenity-js.org/api/web/class/Page/) representing the currently active browser tab.
+     */
+    async currentPage() {
+        return this.session.currentPage();
+    }
+    /**
+     * Returns an array of [pages](https://serenity-js.org/api/web/class/Page/) representing all the browser tabs
+     * available in the current [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
+     */
+    allPages() {
+        return this.session.allPages();
+    }
+    /**
+     * Returns [basic meta-data](https://serenity-js.org/api/web/interface/BrowserCapabilities/) about the browser associated with this ability.
+     */
+    async browserCapabilities() {
+        return this.session.browserCapabilities();
+    }
+}
+//# sourceMappingURL=BrowseTheWeb.js.map

package/esm/screenplay/abilities/BrowseTheWeb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowseTheWeb.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWeb.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAI5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG;AACH,MAAM,OAAgB,YAAwC,SAAQ,OAAO;IAE1C;IAA/B,YAA+B,OAAmD;QAC9E,KAAK,EAAE,CAAC;QADmB,YAAO,GAAP,OAAO,CAA4C;IAElF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,QAAQ;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAC9C,CAAC;CACJ"}

package/esm/screenplay/abilities/index.d.ts

@@ -0,0 +1,2 @@
+export * from './BrowseTheWeb.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/screenplay/abilities/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/esm/screenplay/abilities/index.js

@@ -0,0 +1,2 @@
+export * from './BrowseTheWeb.js';
+//# sourceMappingURL=index.js.map

package/esm/screenplay/abilities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/esm/screenplay/index.d.ts

@@ -0,0 +1,5 @@
+export * from './abilities/index.js';
+export * from './interactions/index.js';
+export * from './models/index.js';
+export * from './questions/index.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/screenplay/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/screenplay/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC"}

package/esm/screenplay/index.js

@@ -0,0 +1,5 @@
+export * from './abilities/index.js';
+export * from './interactions/index.js';
+export * from './models/index.js';
+export * from './questions/index.js';
+//# sourceMappingURL=index.js.map

package/esm/screenplay/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/screenplay/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC"}

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

@@ -0,0 +1,74 @@
+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 clear the `value` of a [form `input` field](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
+ *
+ * ## 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'
+ *
+ * const Form = {
+ *   exampleInput: () =>
+ *     PageElement.located(By.id('example'))
+ *      .describedAs('example input')
+ * }
+ * ```
+ *
+ * ## Clearing the value of an input field
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Clear, Enter, Value } from '@serenity-js/web'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Inés')
+ *   .whoCan(BrowseTheWeb.using(browser))
+ *   .attemptsTo(
+ *     Enter.theValue('Hello world!').into(Form.exampleInput()),
+ *     Ensure.that(Value.of(Form.exampleInput()), equals('Hello world!')),
+ *
+ *     Clear.theValueOf(Form.exampleInput()),
+ *     Ensure.that(Value.of(Form.exampleInput()), equals('')),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Enter`](https://serenity-js.org/api/web/class/Enter/)
+ * - [`Value`](https://serenity-js.org/api/web/class/Value/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ *
+ * @group Activities
+ */
+export declare class Clear extends PageElementInteraction {
+    private readonly field;
+    /**
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
+     * to clear the value of an input `field`,
+     *
+     * @param field
+     *  The field which value should be cleared
+     */
+    static theValueOf(field: Answerable<PageElement>): Interaction;
+    protected constructor(field: Answerable<PageElement>);
+    /**
+     * @inheritDoc
+     */
+    performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>;
+    private isClearable;
+    private capitaliseFirstLetter;
+}
+//# sourceMappingURL=Clear.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Clear.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/Clear.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAGlG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,qBAAa,KAAM,SAAQ,sBAAsB;IAcvB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAZ5C;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,WAAW;IAI9D,SAAS,aAA8B,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC;IAIrE;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;YAczD,WAAW;IAmBzB,OAAO,CAAC,qBAAqB;CAGhC"}

package/esm/screenplay/interactions/Clear.js

@@ -0,0 +1,101 @@
+import { d, LogicError, 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 clear the `value` of a [form `input` field](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
+ *
+ * ## 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'
+ *
+ * const Form = {
+ *   exampleInput: () =>
+ *     PageElement.located(By.id('example'))
+ *      .describedAs('example input')
+ * }
+ * ```
+ *
+ * ## Clearing the value of an input field
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Clear, Enter, Value } from '@serenity-js/web'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Inés')
+ *   .whoCan(BrowseTheWeb.using(browser))
+ *   .attemptsTo(
+ *     Enter.theValue('Hello world!').into(Form.exampleInput()),
+ *     Ensure.that(Value.of(Form.exampleInput()), equals('Hello world!')),
+ *
+ *     Clear.theValueOf(Form.exampleInput()),
+ *     Ensure.that(Value.of(Form.exampleInput()), equals('')),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Enter`](https://serenity-js.org/api/web/class/Enter/)
+ * - [`Value`](https://serenity-js.org/api/web/class/Value/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ *
+ * @group Activities
+ */
+export class Clear extends PageElementInteraction {
+    field;
+    /**
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
+     * to clear the value of an input `field`,
+     *
+     * @param field
+     *  The field which value should be cleared
+     */
+    static theValueOf(field) {
+        return new Clear(field);
+    }
+    constructor(field) {
+        super(the `#actor clears the value of ${field}`);
+        this.field = field;
+    }
+    /**
+     * @inheritDoc
+     */
+    async performAs(actor) {
+        const element = await this.resolve(actor, this.field);
+        const isClearable = await this.isClearable(element);
+        if (!isClearable) {
+            throw new LogicError(this.capitaliseFirstLetter(d `${this.field} doesn't seem like an element that could be cleared.`));
+        }
+        await element.clearValue();
+    }
+    async isClearable(element) {
+        const contentEditable = await element.attribute('contenteditable');
+        const hasContentEditableAttribute = contentEditable !== null && contentEditable !== undefined && contentEditable !== 'false'; // true or empty string mean content is editable
+        if (hasContentEditableAttribute) {
+            return true;
+        }
+        try {
+            const value = await element.value();
+            const hasValueAttribute = value !== null && value !== undefined;
+            return hasValueAttribute;
+        }
+        catch {
+            return false;
+        }
+    }
+    capitaliseFirstLetter(text) {
+        return text.charAt(0).toUpperCase() + text.slice(1);
+    }
+}
+//# sourceMappingURL=Clear.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Clear.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Clear.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAGvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,OAAO,KAAM,SAAQ,sBAAsB;IAcN;IAZvC;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CAAC,KAA8B;QAC5C,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,YAAuC,KAA8B;QACjE,KAAK,CAAC,GAAG,CAAA,8BAA+B,KAAM,EAAE,CAAC,CAAC;QADf,UAAK,GAAL,KAAK,CAAyB;IAErE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAEtD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEpD,IAAI,CAAC,WAAW,EAAE,CAAC;YACf,MAAM,IAAI,UAAU,CAChB,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAA,GAAI,IAAI,CAAC,KAAM,sDAAsD,CAAC,CACrG,CAAC;QACN,CAAC;QAED,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC;IAC/B,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,OAAoB;QAC1C,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QACnE,MAAM,2BAA2B,GAAG,eAAe,KAAK,IAAI,IAAI,eAAe,KAAK,SAAS,IAAI,eAAe,KAAK,OAAO,CAAC,CAAE,gDAAgD;QAE/K,IAAI,2BAA2B,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,IAAI,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;YACpC,MAAM,iBAAiB,GAAG,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;YAEhE,OAAO,iBAAiB,CAAC;QAC7B,CAAC;QACD,MAAM,CAAC;YACH,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IAEO,qBAAqB,CAAC,IAAY;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;CACJ"}

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

@@ -0,0 +1,64 @@
+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 scroll the given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) into view and then [click](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) on it.
+ *
+ * ## 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')
+ * }
+ * ```
+ *
+ * ## Clicking on an element
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Click, isSelected } from '@serenity-js/web'
+ * import { Ensure } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Chloé')
+ *   .attemptsTo(
+ *     Click.on(Form.exampleInput()),
+ *     Ensure.that(Form.exampleInput(), isSelected()),
+ *   )
+ * ```
+ *
+ * ## 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 Click extends PageElementInteraction {
+    private readonly element;
+    /**
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
+     *
+     * @param pageElement
+     *  The element to be clicked on
+     */
+    static on(pageElement: Answerable<PageElement>): Interaction;
+    protected constructor(element: Answerable<PageElement>);
+    /**
+     * @inheritDoc
+     */
+    performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>;
+}
+//# sourceMappingURL=Click.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Click.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/Click.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAGlG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,qBAAa,KAAM,SAAQ,sBAAsB;IAYvB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAV9C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,WAAW;IAI5D,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/esm/screenplay/interactions/Click.js

@@ -0,0 +1,72 @@
+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 scroll the given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) into view and then [click](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) on it.
+ *
+ * ## 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')
+ * }
+ * ```
+ *
+ * ## Clicking on an element
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Click, isSelected } from '@serenity-js/web'
+ * import { Ensure } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Chloé')
+ *   .attemptsTo(
+ *     Click.on(Form.exampleInput()),
+ *     Ensure.that(Form.exampleInput(), isSelected()),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ *
+ * @group Activities
+ */
+export class Click extends PageElementInteraction {
+    element;
+    /**
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
+     *
+     * @param pageElement
+     *  The element to be clicked on
+     */
+    static on(pageElement) {
+        return new Click(pageElement);
+    }
+    constructor(element) {
+        super(the `#actor clicks on ${element}`);
+        this.element = element;
+    }
+    /**
+     * @inheritDoc
+     */
+    async performAs(actor) {
+        const element = await this.resolve(actor, this.element);
+        await element.scrollIntoView();
+        await element.click();
+    }
+}
+//# sourceMappingURL=Click.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Click.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Click.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAGxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,OAAO,KAAM,SAAQ,sBAAsB;IAYN;IAVvC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,WAAoC;QAC1C,OAAO,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IAED,YAAuC,OAAgC;QACnE,KAAK,CAAC,GAAG,CAAC,oBAAqB,OAAQ,EAAE,CAAC,CAAC;QADR,YAAO,GAAP,OAAO,CAAyB;IAEvE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;QAC/B,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;CACJ"}

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

@@ -0,0 +1,87 @@
+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 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 declare class DoubleClick extends PageElementInteraction {
+    private readonly pageElement;
+    /**
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
+     *
+     * @param pageElement
+     *  The element to be double-clicked on
+     */
+    static on(pageElement: Answerable<PageElement>): Interaction;
+    protected constructor(pageElement: Answerable<PageElement>);
+    /**
+     * @inheritDoc
+     */
+    performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>;
+}
+//# sourceMappingURL=DoubleClick.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DoubleClick.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/DoubleClick.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAGlG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,qBAAa,WAAY,SAAQ,sBAAsB;IAY7B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAVlD;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,WAAW;IAI5D,SAAS,aAA8B,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAI3E;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAK1E"}