@serenity-js/web 3.41.1 → 3.42.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"ExecuteScript.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/ExecuteScript.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;;;;;;;;;GAUG;AACH,MAAM,OAAO,aAAa;IAEtB;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,SAA6B;QACrC,OAAO,IAAI,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4IG;IACH,MAAM,CAAC,KAAK,CAAC,MAAyB;QAClC,OAAO,IAAI,yBAAyB,CAChC,wCAAwC,EACxC,MAAM,CACT,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwGG;IACH,MAAM,CAAC,IAAI,CAAC,MAAyB;QACjC,OAAO,IAAI,wBAAwB,CAC/B,sCAAsC,EACtC,MAAM,CACT,CAAC;IACN,CAAC;CACJ;AAED;;;;;;;GAOG;AACH,MAAM,OAAgB,0BAA2B,SAAQ,WAAW;IAIzC;IACA;IAHvB,YACI,WAA+B,EACZ,MAAyB,EACzB,OAA+B,EAAE;QAEpD,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAH/B,WAAM,GAAN,MAAM,CAAmB;QACzB,SAAI,GAAJ,IAAI,CAA6B;IAGxD,CAAC;IAUD;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAA2D;QACvE,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QAEjE,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAElC,KAAK,CAAC,OAAO,CACT,QAAQ,CAAC,QAAQ,CAAC;YACd,WAAW,EAAK,+BAA+B;YAC/C,IAAI,EAAY,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;SACzC,CAAC,EACF,IAAI,IAAI,CAAC,eAAe,CAAC,CAC5B,CAAC;IACN,CAAC;CAGJ;AAED;;GAEG;AACH,MAAM,yBAA0B,SAAQ,0BAA0B;IAC9D,aAAa,CAAC,GAAG,IAA4B;QACzC,OAAO,IAAI,yBAAyB,CAChC,IAAI,CAAC,MAAM,GAAG,CAAC;YACX,CAAC,CAAC,GAAG,CAAC,0DAA2D,IAAK,EAAE;YACxE,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,EACrB,IAAI,CAAC,MAAM,EACX,IAAI,CACP,CAAC;IACN,CAAC;IAES,KAAK,CAAC,SAAS,CAAC,KAAuC,EAAE,IAAW;QAC1E,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QACxD,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAwB,EAAE,GAAG,IAAI,CAAC,CAAC,CAAG,kBAAkB;IAChG,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,oBAAqB,SAAQ,WAAW;IACb;IAA7B,YAA6B,SAA6B;QACtD,KAAK,CAAC,GAAG,CAAA,iCAAkC,SAAU,EAAE,CAAC,CAAC;QADhC,cAAS,GAAT,SAAS,CAAoB;IAE1D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,IAAI,GAAQ,MAAM,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7D,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAErD,OAAO,IAAI,CAAC,kBAAkB;QAC1B,qBAAqB;QACrB,SAAS,oBAAoB,CAAC,SAAiB,EAAE,QAAoC;YACjF,MAAM,oBAAoB,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK;iBACzC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;iBACzC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAEnC,IAAI,CAAE,oBAAoB,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC5C,OAAO,QAAQ,CAAC,cAAc,GAAG,SAAS,GAAG,0BAA0B,CAAC,CAAC;YAC7E,CAAC;YAED,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAChD,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE;gBAC5B,QAAQ,EAAE,CAAC;YACf,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE;gBAC7B,OAAO,QAAQ,CAAC,6BAA8B,SAAU,EAAE,CAAC,CAAC;YAChE,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;YACvB,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;YACpB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC,EACD,SAAS;QACT,oBAAoB;SACvB;aACA,IAAI,CAAC,YAAY,CAAC,EAAE;YACjB,IAAI,YAAY,EAAE,CAAC;gBACf,MAAM,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC;YACvC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,wBAAyB,SAAQ,0BAA0B;IAE7D,aAAa,CAAC,GAAG,IAA4B;QACzC,OAAO,IAAI,wBAAwB,CAC/B,IAAI,CAAC,MAAM,GAAG,CAAC;YACX,CAAC,CAAC,GAAG,CAAC,wDAAyD,IAAK,EAAE;YACtE,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,EACrB,IAAI,CAAC,MAAM,EACX,IAAI,CACP,CAAC;IACN,CAAC;IAES,KAAK,CAAC,SAAS,CAAC,KAAuC,EAAE,IAAW;QAC1E,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QACxD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAwB,EAAE,GAAG,IAAI,CAAC,CAAC,CAAI,gBAAgB;IAC1F,CAAC;CACJ"}

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

@@ -0,0 +1,68 @@
+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 hover the mouse pointer over a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+ *
+ * ## Example widget
+ * ```html
+ *  <a data-test="example-link"
+ *      class="off"
+ *      onmouseover="this.className='on';"
+ *      onmouseout="this.className='off';"
+ *      href="/">hover over me</a>
+ * ```
+ *
+ * ## Lean Page Object describing the widget
+ *
+ * ```ts
+ * import { By, PageElement } from '@serenity-js/web'
+ *
+ * class Example {
+ *   static link = () =>
+ *     PageElement.located(By.css('[data-test="example-link"]'))
+ *       .describedAs('example link')
+ *  }
+ * ```
+ *
+ * ## Hovering over an element
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Hover, CssClasses } from '@serenity-js/web'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Hank')
+ *   .whoCan(BrowseTheWeb.using(browser))
+ *   .attemptsTo(
+ *      Ensure.that(CssClasses.of(Example.link()), equals([ 'off' ])),
+ *
+ *     Hover.over(Example.link),
+ *     Ensure.that(CssClasses.of(Example.link()), equals([ 'on' ])),
+ *   )
+ * ```
+ *
+ * ## 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 Hover extends PageElementInteraction {
+    private readonly element;
+    /**
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
+     *
+     * @param pageElement
+     *  The element to be hovered over
+     */
+    static over(pageElement: Answerable<PageElement>): Interaction;
+    protected constructor(element: Answerable<PageElement>);
+    /**
+     * @inheritDoc
+     */
+    performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>;
+}
+//# sourceMappingURL=Hover.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Hover.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/Hover.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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,qBAAa,KAAM,SAAQ,sBAAsB;IAYvB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAV9C;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,WAAW;IAI9D,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/Hover.js

@@ -0,0 +1,76 @@
+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 hover the mouse pointer over a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+ *
+ * ## Example widget
+ * ```html
+ *  <a data-test="example-link"
+ *      class="off"
+ *      onmouseover="this.className='on';"
+ *      onmouseout="this.className='off';"
+ *      href="/">hover over me</a>
+ * ```
+ *
+ * ## Lean Page Object describing the widget
+ *
+ * ```ts
+ * import { By, PageElement } from '@serenity-js/web'
+ *
+ * class Example {
+ *   static link = () =>
+ *     PageElement.located(By.css('[data-test="example-link"]'))
+ *       .describedAs('example link')
+ *  }
+ * ```
+ *
+ * ## Hovering over an element
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Hover, CssClasses } from '@serenity-js/web'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Hank')
+ *   .whoCan(BrowseTheWeb.using(browser))
+ *   .attemptsTo(
+ *      Ensure.that(CssClasses.of(Example.link()), equals([ 'off' ])),
+ *
+ *     Hover.over(Example.link),
+ *     Ensure.that(CssClasses.of(Example.link()), equals([ 'on' ])),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ *
+ * @group Activities
+ */
+export class Hover extends PageElementInteraction {
+    element;
+    /**
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
+     *
+     * @param pageElement
+     *  The element to be hovered over
+     */
+    static over(pageElement) {
+        return new Hover(pageElement);
+    }
+    constructor(element) {
+        super(the `#actor hovers the mouse over ${element}`);
+        this.element = element;
+    }
+    /**
+     * @inheritDoc
+     */
+    async performAs(actor) {
+        const element = await this.resolve(actor, this.element);
+        await element.scrollIntoView();
+        await element.hoverOver();
+    }
+}
+//# sourceMappingURL=Hover.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Hover.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Hover.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAGxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,OAAO,KAAM,SAAQ,sBAAsB;IAYN;IAVvC;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,WAAoC;QAC5C,OAAO,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IAED,YAAuC,OAAgC;QACnE,KAAK,CAAC,GAAG,CAAC,gCAAiC,OAAQ,EAAE,CAAC,CAAC;QADpB,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,SAAS,EAAE,CAAC;IAC9B,CAAC;CACJ"}

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

@@ -0,0 +1,137 @@
+import type { Answerable } from '@serenity-js/core';
+import { Interaction } 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 navigate to a specific destination, as well as back and forth in the browser history,
+ * or reload the current page.
+ *
+ * ## Learn more
+ *
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ *
+ * @group Activities
+ */
+export declare class Navigate {
+    /**
+     * 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 navigate to a given URL.
+     *
+     * The URL can be:
+     * - absolute, e.g. `https://example.org/search`
+     * - relative, e.g. `/search`
+     *
+     * If the URL is relative, your Web test integration tool will append it to any base URL
+     * specified in its respective configuration file.
+     *
+     *
+     * #### Navigate to path relative to baseUrl
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Navigate } from '@serenity-js/web'
+     *
+     * await actorCalled('Hannu')
+     *   .attemptsTo(
+     *     Navigate.to('/search'),
+     *   )
+     * ```
+     *
+     * ## Navigate to an absolute URL (overrides baseUrl)
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Navigate } from '@serenity-js/web'
+     *
+     * await actorCalled('Hannu')
+     *   .whoCan(BrowseTheWeb.using(browser))
+     *   .attemptsTo(
+     *     Navigate.to('https://mycompany.org/login'),
+     *   )
+     * ```
+     *
+     * #### Learn more
+     *
+     * - [`Page.navigateTo`](https://serenity-js.org/api/web/class/Page/#navigateTo)
+     * - [WebdriverIO: Configuration Options](https://webdriver.io/docs/options/#baseurl)
+     * - [Playwright: Browser](https://playwright.dev/docs/api/class-browser#browser-new-context)
+     * - [Playwright: Test Options](https://playwright.dev/docs/api/class-testoptions#test-options-base-url)
+     * - [Protractor: Configuration](https://github.com/angular/protractor/blob/master/lib/config.ts)
+     *
+     * @param url
+     *  An absolute URL or path an [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should navigate to
+     */
+    static to(url: Answerable<string>): Interaction;
+    /**
+     * 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 navigate back one page in the joint session history of the current top-level browsing context.
+     *
+     * #### Navigate back in browsing history
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Ensure, endsWith } from '@serenity-js/assertions'
+     * import { Navigate, Page } from '@serenity-js/web'
+     *
+     * await actorCalled('Hannu')
+     *   .whoCan(BrowseTheWeb.using(browser))
+     *   .attemptsTo(
+     *     Navigate.to('/first'),
+     *     Navigate.to('/second'),
+     *
+     *     Navigate.back(),
+     *
+     *     Ensure.that(Page.current().url().href, endsWith('/first')),
+     *   )
+     * ```
+     */
+    static back(): Interaction;
+    /**
+     * 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 navigate forward one page in the joint session history of the current top-level browsing context.
+     *
+     * #### Navigate forward in browsing history
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Ensure, endsWith } from '@serenity-js/assertions'
+     * import { Navigate, Page } from '@serenity-js/web'
+     *
+     * await actorCalled('Hannu')
+     *   .whoCan(BrowseTheWeb.using(browser))
+     *   .attemptsTo(
+     *     Navigate.to('/first'),
+     *     Navigate.to('/second'),
+     *
+     *     Navigate.back(),
+     *     Navigate.forward(),
+     *
+     *     Ensure.that(Page.current().url().href, endsWith('/second')),
+     *   )
+     * ```
+     */
+    static forward(): Interaction;
+    /**
+     * 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 reload the current page.
+     *
+     * #### Navigate to path relative to baseUrl
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Ensure, endsWith } from '@serenity-js/assertions'
+     * import { Navigate, Cookie } from '@serenity-js/web'
+     * import { browser } from '@wdio/globals'
+     *
+     * await actorCalled('Hannu')
+     *   .whoCan(BrowseTheWebWithWebdriverIO.using(browser))
+     *   .attemptsTo(
+     *     Navigate.to('/login'),
+     *     Cookie.called('session_id').delete(),
+     *     Navigate.reloadPage(),
+     *   )
+     * ```
+     */
+    static reloadPage(): Interaction;
+}
+//# sourceMappingURL=Navigate.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Navigate.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/Navigate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAmC,MAAM,mBAAmB,CAAC;AACrF,OAAO,EAAE,WAAW,EAA6B,MAAM,mBAAmB,CAAC;AAI3E;;;;;;;;;;GAUG;AACH,qBAAa,QAAQ;IAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW;IAI/C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAI,IAAI,WAAW;IAQ1B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,OAAO,IAAI,WAAW;IAQ7B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,UAAU,IAAI,WAAW;CAOnC"}

package/esm/screenplay/interactions/Navigate.js

@@ -0,0 +1,174 @@
+import { Interaction, TestCompromisedError, the } from '@serenity-js/core';
+import { BrowseTheWeb } from '../abilities/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 navigate to a specific destination, as well as back and forth in the browser history,
+ * or reload the current page.
+ *
+ * ## Learn more
+ *
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ *
+ * @group Activities
+ */
+export class Navigate {
+    /**
+     * 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 navigate to a given URL.
+     *
+     * The URL can be:
+     * - absolute, e.g. `https://example.org/search`
+     * - relative, e.g. `/search`
+     *
+     * If the URL is relative, your Web test integration tool will append it to any base URL
+     * specified in its respective configuration file.
+     *
+     *
+     * #### Navigate to path relative to baseUrl
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Navigate } from '@serenity-js/web'
+     *
+     * await actorCalled('Hannu')
+     *   .attemptsTo(
+     *     Navigate.to('/search'),
+     *   )
+     * ```
+     *
+     * ## Navigate to an absolute URL (overrides baseUrl)
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Navigate } from '@serenity-js/web'
+     *
+     * await actorCalled('Hannu')
+     *   .whoCan(BrowseTheWeb.using(browser))
+     *   .attemptsTo(
+     *     Navigate.to('https://mycompany.org/login'),
+     *   )
+     * ```
+     *
+     * #### Learn more
+     *
+     * - [`Page.navigateTo`](https://serenity-js.org/api/web/class/Page/#navigateTo)
+     * - [WebdriverIO: Configuration Options](https://webdriver.io/docs/options/#baseurl)
+     * - [Playwright: Browser](https://playwright.dev/docs/api/class-browser#browser-new-context)
+     * - [Playwright: Test Options](https://playwright.dev/docs/api/class-testoptions#test-options-base-url)
+     * - [Protractor: Configuration](https://github.com/angular/protractor/blob/master/lib/config.ts)
+     *
+     * @param url
+     *  An absolute URL or path an [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     *  should navigate to
+     */
+    static to(url) {
+        return new NavigateToUrl(url);
+    }
+    /**
+     * 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 navigate back one page in the joint session history of the current top-level browsing context.
+     *
+     * #### Navigate back in browsing history
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Ensure, endsWith } from '@serenity-js/assertions'
+     * import { Navigate, Page } from '@serenity-js/web'
+     *
+     * await actorCalled('Hannu')
+     *   .whoCan(BrowseTheWeb.using(browser))
+     *   .attemptsTo(
+     *     Navigate.to('/first'),
+     *     Navigate.to('/second'),
+     *
+     *     Navigate.back(),
+     *
+     *     Ensure.that(Page.current().url().href, endsWith('/first')),
+     *   )
+     * ```
+     */
+    static back() {
+        return Interaction.where(`#actor navigates back in the browser history`, async (actor) => {
+            const page = await BrowseTheWeb.as(actor).currentPage();
+            await page.navigateBack();
+        });
+    }
+    /**
+     * 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 navigate forward one page in the joint session history of the current top-level browsing context.
+     *
+     * #### Navigate forward in browsing history
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Ensure, endsWith } from '@serenity-js/assertions'
+     * import { Navigate, Page } from '@serenity-js/web'
+     *
+     * await actorCalled('Hannu')
+     *   .whoCan(BrowseTheWeb.using(browser))
+     *   .attemptsTo(
+     *     Navigate.to('/first'),
+     *     Navigate.to('/second'),
+     *
+     *     Navigate.back(),
+     *     Navigate.forward(),
+     *
+     *     Ensure.that(Page.current().url().href, endsWith('/second')),
+     *   )
+     * ```
+     */
+    static forward() {
+        return Interaction.where(`#actor navigates forward in the browser history`, async (actor) => {
+            const page = await BrowseTheWeb.as(actor).currentPage();
+            await page.navigateForward();
+        });
+    }
+    /**
+     * 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 reload the current page.
+     *
+     * #### Navigate to path relative to baseUrl
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Ensure, endsWith } from '@serenity-js/assertions'
+     * import { Navigate, Cookie } from '@serenity-js/web'
+     * import { browser } from '@wdio/globals'
+     *
+     * await actorCalled('Hannu')
+     *   .whoCan(BrowseTheWebWithWebdriverIO.using(browser))
+     *   .attemptsTo(
+     *     Navigate.to('/login'),
+     *     Cookie.called('session_id').delete(),
+     *     Navigate.reloadPage(),
+     *   )
+     * ```
+     */
+    static reloadPage() {
+        return Interaction.where(`#actor reloads the page`, async (actor) => {
+            const page = await BrowseTheWeb.as(actor).currentPage();
+            await page.reload();
+        });
+    }
+}
+/**
+ * @package
+ */
+class NavigateToUrl extends Interaction {
+    url;
+    constructor(url) {
+        super(the `#actor navigates to ${url}`);
+        this.url = url;
+    }
+    /**
+     * @inheritDoc
+     */
+    async performAs(actor) {
+        const url = await actor.answer(this.url);
+        const page = await BrowseTheWeb.as(actor).currentPage();
+        return page.navigateTo(url).catch(error => {
+            throw new TestCompromisedError(`Couldn't navigate to ${url}`, error);
+        });
+    }
+}
+//# sourceMappingURL=Navigate.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Navigate.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Navigate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAE3E,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;;;;;;;;;GAUG;AACH,MAAM,OAAO,QAAQ;IAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,MAAM,CAAC,EAAE,CAAC,GAAuB;QAC7B,OAAO,IAAI,aAAa,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAI;QACP,OAAO,WAAW,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACnF,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAExD,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,OAAO;QACV,OAAO,WAAW,CAAC,KAAK,CAAC,iDAAiD,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACtF,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAExD,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QACjC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,UAAU;QACb,OAAO,WAAW,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC9D,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAExD,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,aAAc,SAAQ,WAAW;IACN;IAA7B,YAA6B,GAAuB;QAChD,KAAK,CAAC,GAAG,CAAA,uBAAwB,GAAI,EAAE,CAAC,CAAC;QADhB,QAAG,GAAH,GAAG,CAAoB;IAEpD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAExD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;YACtC,MAAM,IAAI,oBAAoB,CAAC,wBAAyB,GAAI,EAAE,EAAE,KAAK,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;IACP,CAAC;CACJ"}

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

@@ -0,0 +1,24 @@
+import type { Answerable, AnswersQuestions } from '@serenity-js/core';
+import { Interaction } from '@serenity-js/core';
+import type { FileSystemLocation } from '@serenity-js/core/io';
+import type { PageElement } from '../models/index.js';
+/**
+ * A base class for interactions with [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) objects.
+ *
+ * **Note:** The recommended way to implement custom interactions
+ * in your code is to use the [`Interaction.where`](https://serenity-js.org/api/core/class/Interaction/#where) factory method.
+ *
+ * @group Activities
+ */
+export declare abstract class PageElementInteraction extends Interaction {
+    protected constructor(description: Answerable<string>, location?: FileSystemLocation);
+    /**
+     * Returns the resolved [`PageElement`](https://serenity-js.org/api/web/class/PageElement/), or throws a [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
+     * if the element is `undefined`.
+     *
+     * @param actor
+     * @param element
+     */
+    protected resolve(actor: AnswersQuestions, element: Answerable<PageElement>): Promise<PageElement>;
+}
+//# sourceMappingURL=PageElementInteraction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PageElementInteraction.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/PageElementInteraction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAC,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAK,WAAW,EAAc,MAAM,mBAAmB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;;;;GAOG;AACH,8BAAsB,sBAAuB,SAAQ,WAAW;IAE5D,SAAS,aAAa,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAE,kBAAkD;IAInH;;;;;;OAMG;cACa,OAAO,CACnB,KAAK,EAAE,gBAAgB,EACvB,OAAO,EAAE,UAAU,CAAC,WAAW,CAAC,GACjC,OAAO,CAAC,WAAW,CAAC;CAS1B"}

package/esm/screenplay/interactions/PageElementInteraction.js

@@ -0,0 +1,29 @@
+import { d, Interaction, LogicError } from '@serenity-js/core';
+/**
+ * A base class for interactions with [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) objects.
+ *
+ * **Note:** The recommended way to implement custom interactions
+ * in your code is to use the [`Interaction.where`](https://serenity-js.org/api/core/class/Interaction/#where) factory method.
+ *
+ * @group Activities
+ */
+export class PageElementInteraction extends Interaction {
+    constructor(description, location = Interaction.callerLocation(4)) {
+        super(description, location);
+    }
+    /**
+     * Returns the resolved [`PageElement`](https://serenity-js.org/api/web/class/PageElement/), or throws a [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
+     * if the element is `undefined`.
+     *
+     * @param actor
+     * @param element
+     */
+    async resolve(actor, element) {
+        const resolved = await actor.answer(element);
+        if (!resolved) {
+            throw new LogicError(d `Couldn't find ${element}`);
+        }
+        return resolved;
+    }
+}
+//# sourceMappingURL=PageElementInteraction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PageElementInteraction.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/PageElementInteraction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAK/D;;;;;;;GAOG;AACH,MAAM,OAAgB,sBAAuB,SAAQ,WAAW;IAE5D,YAAsB,WAA+B,EAAE,WAA+B,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;QAC/G,KAAK,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,OAAO,CACnB,KAAuB,EACvB,OAAgC;QAEhC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,CAAE,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,UAAU,CAAC,CAAC,CAAC,iBAAkB,OAAQ,EAAE,CAAC,CAAC;QACzD,CAAC;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ"}

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

@@ -0,0 +1,92 @@
+import type { Activity, Answerable, AnswersQuestions, UsesAbilities } from '@serenity-js/core';
+import { Interaction } from '@serenity-js/core';
+import type { PageElement } from '../models/index.js';
+import { Key } 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 send a key press or a sequence of keys to a Web element.
+ *
+ * **Note:** On macOS, some keyboard shortcuts might not work
+ * with the [`devtools` protocol](https://webdriver.io/docs/automationProtocols/#devtools-protocol).
+ *
+ *  For example:
+ *  - to *copy*, instead of [`Key.Meta`](https://serenity-js.org/api/web/class/Key/#Meta)+`C`, use [`Key.Control`](https://serenity-js.org/api/web/class/Key/#Control)+[`Key.Insert`](https://serenity-js.org/api/web/class/Key/#Insert)
+ *  - to *cut*, instead of [`Key.Meta`](https://serenity-js.org/api/web/class/Key/#Meta)+`X`, use [`Key.Control`](https://serenity-js.org/api/web/class/Key/#Control)+[`Key.Delete`](https://serenity-js.org/api/web/class/Key/#Delete)
+ *  - to *paste*, instead of [`Key.Meta`](https://serenity-js.org/api/web/class/Key/#Meta)+`V`, use [`Key.Shift`](https://serenity-js.org/api/web/class/Key/#Shift)+[`Key.Insert`](https://serenity-js.org/api/web/class/Key/#Insert)
+ *
+ * ## 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')
+ * }
+ * ```
+ *
+ * ## Pressing keys
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Key, Press, Value } from '@serenity-js/web'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Priyanka')
+ *   .attemptsTo(
+ *     Press.the('H', 'i', '!', Key.ENTER).in(Form.exampleInput()),
+ *     Ensure.that(Value.of(Form.exampleInput), equals('Hi!')),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`Key`](https://serenity-js.org/api/web/class/Key/)
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ *
+ * @group Activities
+ */
+export declare class Press extends PageElementInteraction {
+    private readonly keys;
+    /**
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
+     * to press a sequence of [keys](https://serenity-js.org/api/web/class/Key/),
+     *
+     * When no `field` is specified, the key sequence will be sent to the currently focused element,
+     * and if no element is focused - to the `document.body` to handle.
+     *
+     * @param keys
+     *  A sequence of one or more keys to press
+     */
+    static the(...keys: Array<Answerable<Key | string | Key[] | string[]>>): Activity & {
+        in: (field: Answerable<PageElement>) => Interaction;
+    };
+    /**
+     * Send the key sequence to a specific element.
+     *
+     * @param field
+     */
+    in(field: Answerable<PageElement>): Interaction;
+    /**
+     * @param keys
+     *  A sequence of one or more keys to press
+     */
+    protected constructor(keys: Answerable<Array<Key | string>>);
+    /**
+     * @inheritDoc
+     */
+    performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>;
+}
+//# sourceMappingURL=Press.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Press.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/Press.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC/F,OAAO,EAAE,WAAW,EAAiB,MAAM,mBAAmB,CAAC;AAI/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AACzC,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,qBAAa,KAAM,SAAQ,sBAAsB;IA+BzC,OAAO,CAAC,QAAQ,CAAC,IAAI;IA7BzB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,GAAG,MAAM,GAAG,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,GAAG,QAAQ,GAAG;QAAE,EAAE,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,KAAK,WAAW,CAAA;KAAE;IAI3I;;;;OAIG;IACH,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,WAAW;IAI/C;;;OAGG;IACH,SAAS,aACY,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC;IAK1D;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAK1E"}