@serenity-js/web 3.41.1 → 3.42.0

package/esm/screenplay/models/PageElementsLocator.js

@@ -0,0 +1,31 @@
+import { Question, the } from '@serenity-js/core';
+import { BrowseTheWeb } from '../abilities/index.js';
+/**
+ * @group Models
+ */
+export class PageElementsLocator extends Question {
+    locator;
+    static fromDocumentRoot(selector) {
+        return new PageElementsLocator(Question.about(the `page elements located ${selector}`, async (actor) => {
+            const bySelector = await actor.answer(selector);
+            const currentPage = await BrowseTheWeb.as(actor).currentPage();
+            return currentPage.locate(bySelector).locator;
+        }));
+    }
+    constructor(locator) {
+        super(the `${locator}`);
+        this.locator = locator;
+    }
+    of(parent) {
+        return new PageElementsLocator(Question.about(the `${this} of ${parent}`, async (actor) => {
+            const locator = await actor.answer(this.locator);
+            const parentElement = await actor.answer(parent);
+            return locator.of(parentElement.locator);
+        }));
+    }
+    async answeredBy(actor) {
+        const resolved = await actor.answer(this.locator);
+        return resolved.allElements();
+    }
+}
+//# sourceMappingURL=PageElementsLocator.js.map

package/esm/screenplay/models/PageElementsLocator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PageElementsLocator.js","sourceRoot":"","sources":["../../../src/screenplay/models/PageElementsLocator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAKrD;;GAEG;AACH,MAAM,OAAO,mBACT,SAAQ,QAA0D;IAcrC;IAX7B,MAAM,CAAC,gBAAgB,CAAM,QAA8B;QACvD,OAAO,IAAI,mBAAmB,CAC1B,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAA,yBAA0B,QAAS,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACnE,MAAM,UAAU,GAAI,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACjD,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,EAAE,CAAoB,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAElF,OAAO,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC;QAClD,CAAC,CAAC,CACL,CAAC;IACN,CAAC;IAED,YAA6B,OAAiD;QAC1E,KAAK,CAAC,GAAG,CAAA,GAAI,OAAQ,EAAE,CAAC,CAAC;QADA,YAAO,GAAP,OAAO,CAA0C;IAE9E,CAAC;IAED,EAAE,CAAC,MAAoD;QACnD,OAAO,IAAI,mBAAmB,CAC1B,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAA,GAAI,IAAK,OAAQ,MAAO,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACxD,MAAM,OAAO,GAA6C,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3F,MAAM,aAAa,GAAuC,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAErF,OAAO,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC7C,CAAC,CAAC,CACL,CAAC;IACN,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAuC;QACpD,MAAM,QAAQ,GAAiC,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChF,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;IAClC,CAAC;CACJ"}

package/esm/screenplay/models/RootLocator.d.ts

@@ -0,0 +1,24 @@
+import util from 'node:util';
+import type { Optional } from '@serenity-js/core';
+/**
+ * [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/) represents the context in which [`Locator`](https://serenity-js.org/api/web/class/Locator/) looks for [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElements/).
+ * This context is either a parent element, or some representation of the top-level browsing context.
+ *
+ * ## Learn more
+ * - [`Locator`](https://serenity-js.org/api/web/class/Locator/)
+ * - [`Page.locate`](https://serenity-js.org/api/web/class/Page/#locate)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
+ *
+ * @group Models
+ */
+export declare abstract class RootLocator<Native_Element_Type> implements Optional {
+    abstract switchToFrame(element: Native_Element_Type): Promise<void>;
+    abstract switchToParentFrame(): Promise<void>;
+    abstract switchToMainFrame(): Promise<void>;
+    abstract isPresent(): Promise<boolean>;
+    abstract nativeElement(): Promise<Partial<Native_Element_Type>>;
+    toString(): string;
+    [util.inspect.custom]: (depth: number, options: util.InspectOptionsStylized, inspect: typeof util.inspect) => string;
+}
+//# sourceMappingURL=RootLocator.d.ts.map

package/esm/screenplay/models/RootLocator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RootLocator.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/RootLocator.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAGlD;;;;;;;;;;;GAWG;AACH,8BAAsB,WAAW,CAAC,mBAAmB,CAAE,YAAW,QAAQ;aACtD,aAAa,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;aAC1D,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;aACpC,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;aAClC,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;aAE7B,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEtE,QAAQ,IAAI,MAAM;IAIlB,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,gGAA6B;CACrD"}

package/esm/screenplay/models/RootLocator.js

@@ -0,0 +1,21 @@
+import util from 'node:util';
+import { inspectedObject } from '@serenity-js/core/io';
+/**
+ * [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/) represents the context in which [`Locator`](https://serenity-js.org/api/web/class/Locator/) looks for [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElements/).
+ * This context is either a parent element, or some representation of the top-level browsing context.
+ *
+ * ## Learn more
+ * - [`Locator`](https://serenity-js.org/api/web/class/Locator/)
+ * - [`Page.locate`](https://serenity-js.org/api/web/class/Page/#locate)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
+ *
+ * @group Models
+ */
+export class RootLocator {
+    toString() {
+        return 'root locator';
+    }
+    [util.inspect.custom] = inspectedObject(this, []);
+}
+//# sourceMappingURL=RootLocator.js.map

package/esm/screenplay/models/RootLocator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RootLocator.js","sourceRoot":"","sources":["../../../src/screenplay/models/RootLocator.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;;;;;;;;GAWG;AACH,MAAM,OAAgB,WAAW;IAQ7B,QAAQ;QACJ,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,IAAI,EAAE,EAAG,CAAC,CAAA;CACrD"}

package/esm/screenplay/models/SelectOption.d.ts

@@ -0,0 +1,25 @@
+import { TinyType } from 'tiny-types';
+/**
+ * Describes the [`<option />`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
+ * elements to select.
+ *
+ * ## Learn more
+ *
+ * - [`Select`](https://serenity-js.org/api/web/class/Select/)
+ * - [`Selected`](https://serenity-js.org/api/web/class/Selected/)
+ * - [`PageElement.selectOptions`](https://serenity-js.org/api/web/class/PageElement/#selectOptions)
+ * - [`PageElement.selectedOptions`](https://serenity-js.org/api/web/class/PageElement/#selectedOptions)
+ *
+ * @group Models
+ */
+export declare class SelectOption extends TinyType {
+    readonly label?: string;
+    readonly value?: string;
+    readonly selected?: boolean;
+    readonly disabled?: boolean;
+    static withLabel(label: string): SelectOption;
+    static withValue(value: string): SelectOption;
+    constructor(label?: string, value?: string, selected?: boolean, disabled?: boolean);
+    toString(): string;
+}
+//# sourceMappingURL=SelectOption.d.ts.map

package/esm/screenplay/models/SelectOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SelectOption.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/SelectOption.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;GAYG;AACH,qBAAa,YAAa,SAAQ,QAAQ;aAWlB,KAAK,CAAC,EAAE,MAAM;aACd,KAAK,CAAC,EAAE,MAAM;aACd,QAAQ,CAAC,EAAE,OAAO;aAClB,QAAQ,CAAC,EAAE,OAAO;IAZtC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAI7C,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;gBAKzB,KAAK,CAAC,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,OAAO;IAKtC,QAAQ,IAAI,MAAM;CAGrB"}

package/esm/screenplay/models/SelectOption.js

@@ -0,0 +1,37 @@
+import { TinyType } from 'tiny-types';
+/**
+ * Describes the [`<option />`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
+ * elements to select.
+ *
+ * ## Learn more
+ *
+ * - [`Select`](https://serenity-js.org/api/web/class/Select/)
+ * - [`Selected`](https://serenity-js.org/api/web/class/Selected/)
+ * - [`PageElement.selectOptions`](https://serenity-js.org/api/web/class/PageElement/#selectOptions)
+ * - [`PageElement.selectedOptions`](https://serenity-js.org/api/web/class/PageElement/#selectedOptions)
+ *
+ * @group Models
+ */
+export class SelectOption extends TinyType {
+    label;
+    value;
+    selected;
+    disabled;
+    static withLabel(label) {
+        return new SelectOption(label);
+    }
+    static withValue(value) {
+        return new SelectOption(undefined, value);
+    }
+    constructor(label, value, selected, disabled) {
+        super();
+        this.label = label;
+        this.value = value;
+        this.selected = selected;
+        this.disabled = disabled;
+    }
+    toString() {
+        return `<option /> element with label: ${this.label}, value: ${this.value}`;
+    }
+}
+//# sourceMappingURL=SelectOption.js.map

package/esm/screenplay/models/SelectOption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SelectOption.js","sourceRoot":"","sources":["../../../src/screenplay/models/SelectOption.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,YAAa,SAAQ,QAAQ;IAWlB;IACA;IACA;IACA;IAZpB,MAAM,CAAC,SAAS,CAAC,KAAa;QAC1B,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,KAAa;QAC1B,OAAO,IAAI,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED,YACoB,KAAc,EACd,KAAc,EACd,QAAkB,EAClB,QAAkB;QAElC,KAAK,EAAE,CAAC;QALQ,UAAK,GAAL,KAAK,CAAS;QACd,UAAK,GAAL,KAAK,CAAS;QACd,aAAQ,GAAR,QAAQ,CAAU;QAClB,aAAQ,GAAR,QAAQ,CAAU;IAGtC,CAAC;IAED,QAAQ;QACJ,OAAO,kCAAmC,IAAI,CAAC,KAAM,YAAa,IAAI,CAAC,KAAM,EAAE,CAAC;IACpF,CAAC;CACJ"}

package/esm/screenplay/models/Switchable.d.ts

@@ -0,0 +1,23 @@
+import type { SwitchableOrigin } from './SwitchableOrigin.js';
+/**
+ * Describes a Serenity/JS model object that can be switched _to_ and switched back _from_
+ * using the [task](https://serenity-js.org/api/core/class/Task/) to [`Switch`](https://serenity-js.org/api/web/class/Switch/).
+ *
+ * Examples of switchable models include a [`Page`](https://serenity-js.org/api/web/class/Page/) and [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+ *
+ * ## Learn more
+ * - [`Page`](https://serenity-js.org/api/web/class/Page/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`Switch`](https://serenity-js.org/api/web/class/Switch/)
+ *
+ * @group Models
+ */
+export interface Switchable {
+    /**
+     * Switches the context to the object implementing this interface
+     * and returns [`SwitchableOrigin`](https://serenity-js.org/api/web/interface/SwitchableOrigin/) that allows for the context to be switched
+     * back when needed.
+     */
+    switchTo(): Promise<SwitchableOrigin>;
+}
+//# sourceMappingURL=Switchable.d.ts.map

package/esm/screenplay/models/Switchable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Switchable.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/Switchable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,UAAU;IAEvB;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;CACzC"}

package/esm/screenplay/models/Switchable.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Switchable.js.map

package/esm/screenplay/models/Switchable.js.map

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

package/esm/screenplay/models/SwitchableOrigin.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Enables the [`Task`](https://serenity-js.org/api/core/class/Task/) to [`Switch`](https://serenity-js.org/api/web/class/Switch/) to perform a sequence of activities
+ * and switch back to the original context afterwards.
+ *
+ * ## Learn more
+ *
+ * - [`Switch`](https://serenity-js.org/api/web/class/Switch/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
+ *
+ * @group Models
+ */
+export interface SwitchableOrigin {
+    /**
+     * Switches the context back to the original [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
+     */
+    switchBack(): Promise<void>;
+}
+//# sourceMappingURL=SwitchableOrigin.d.ts.map

package/esm/screenplay/models/SwitchableOrigin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwitchableOrigin.d.ts","sourceRoot":"","sources":["../../../src/screenplay/models/SwitchableOrigin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,WAAW,gBAAgB;IAE7B;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/B"}

package/esm/screenplay/models/SwitchableOrigin.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SwitchableOrigin.js.map

package/esm/screenplay/models/SwitchableOrigin.js.map

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

package/esm/screenplay/models/dialogs/AbsentModalDialog.d.ts

@@ -0,0 +1,15 @@
+import { ModalDialog } from './ModalDialog.js';
+/**
+ * `AbsentModalDialog` is a [null object](https://en.wikipedia.org/wiki/Null_object_pattern)
+ * representing a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that hasn't appeared yet.
+ *
+ * ## Learn more
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
+ *
+ * @group Models
+ */
+export declare class AbsentModalDialog extends ModalDialog {
+    isPresent(): Promise<boolean>;
+    message(): Promise<string>;
+}
+//# sourceMappingURL=AbsentModalDialog.d.ts.map

package/esm/screenplay/models/dialogs/AbsentModalDialog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbsentModalDialog.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/models/dialogs/AbsentModalDialog.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;GAQG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IACxC,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAI7B,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;CAGnC"}

package/esm/screenplay/models/dialogs/AbsentModalDialog.js

@@ -0,0 +1,20 @@
+import { LogicError } from '@serenity-js/core';
+import { ModalDialog } from './ModalDialog.js';
+/**
+ * `AbsentModalDialog` is a [null object](https://en.wikipedia.org/wiki/Null_object_pattern)
+ * representing a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that hasn't appeared yet.
+ *
+ * ## Learn more
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
+ *
+ * @group Models
+ */
+export class AbsentModalDialog extends ModalDialog {
+    async isPresent() {
+        return false;
+    }
+    async message() {
+        throw new LogicError(`Can't retrieve the message of a modal dialog that hasn't been handled yet`);
+    }
+}
+//# sourceMappingURL=AbsentModalDialog.js.map

package/esm/screenplay/models/dialogs/AbsentModalDialog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbsentModalDialog.js","sourceRoot":"","sources":["../../../../src/screenplay/models/dialogs/AbsentModalDialog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;GAQG;AACH,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAC9C,KAAK,CAAC,SAAS;QACX,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,OAAO;QACT,MAAM,IAAI,UAAU,CAAC,2EAA2E,CAAC,CAAC;IACtG,CAAC;CACJ"}

package/esm/screenplay/models/dialogs/AcceptedModalDialog.d.ts

@@ -0,0 +1,17 @@
+import { ModalDialog } from './ModalDialog.js';
+/**
+ * `AcceptedModalDialog` represents a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that has been accepted
+ * via [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext).
+ *
+ * ## Learn more
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
+ *
+ * @group Models
+ */
+export declare class AcceptedModalDialog extends ModalDialog {
+    private readonly dialogMessage;
+    constructor(dialogMessage: string);
+    isPresent(): Promise<boolean>;
+    message(): Promise<string>;
+}
+//# sourceMappingURL=AcceptedModalDialog.d.ts.map

package/esm/screenplay/models/dialogs/AcceptedModalDialog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AcceptedModalDialog.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/models/dialogs/AcceptedModalDialog.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;GAQG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,aAAa;gBAAb,aAAa,EAAE,MAAM;IAK5C,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAI7B,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;CAGnC"}

package/esm/screenplay/models/dialogs/AcceptedModalDialog.js

@@ -0,0 +1,26 @@
+import { ensure, isDefined } from 'tiny-types';
+import { ModalDialog } from './ModalDialog.js';
+/**
+ * `AcceptedModalDialog` represents a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that has been accepted
+ * via [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext).
+ *
+ * ## Learn more
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
+ *
+ * @group Models
+ */
+export class AcceptedModalDialog extends ModalDialog {
+    dialogMessage;
+    constructor(dialogMessage) {
+        super();
+        this.dialogMessage = dialogMessage;
+        ensure('dialogMessage', dialogMessage, isDefined());
+    }
+    async isPresent() {
+        return true;
+    }
+    async message() {
+        return this.dialogMessage;
+    }
+}
+//# sourceMappingURL=AcceptedModalDialog.js.map

package/esm/screenplay/models/dialogs/AcceptedModalDialog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AcceptedModalDialog.js","sourceRoot":"","sources":["../../../../src/screenplay/models/dialogs/AcceptedModalDialog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;GAQG;AACH,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IACnB;IAA7B,YAA6B,aAAqB;QAC9C,KAAK,EAAE,CAAC;QADiB,kBAAa,GAAb,aAAa,CAAQ;QAE9C,MAAM,CAAC,eAAe,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,SAAS;QACX,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,OAAO;QACT,OAAO,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;CACJ"}

package/esm/screenplay/models/dialogs/DismissedModalDialog.d.ts

@@ -0,0 +1,17 @@
+import { ModalDialog } from './ModalDialog.js';
+/**
+ * `DismissedModalDialog` represents a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that has been dismissed
+ * via [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext).
+ *
+ * ## Learn more
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
+ *
+ * @group Models
+ */
+export declare class DismissedModalDialog extends ModalDialog {
+    private readonly dialogMessage;
+    constructor(dialogMessage: string);
+    isPresent(): Promise<boolean>;
+    message(): Promise<string>;
+}
+//# sourceMappingURL=DismissedModalDialog.d.ts.map

package/esm/screenplay/models/dialogs/DismissedModalDialog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DismissedModalDialog.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/models/dialogs/DismissedModalDialog.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;GAQG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,aAAa;gBAAb,aAAa,EAAE,MAAM;IAK5C,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAI7B,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;CAGnC"}

package/esm/screenplay/models/dialogs/DismissedModalDialog.js

@@ -0,0 +1,26 @@
+import { ensure, isDefined } from 'tiny-types';
+import { ModalDialog } from './ModalDialog.js';
+/**
+ * `DismissedModalDialog` represents a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that has been dismissed
+ * via [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext).
+ *
+ * ## Learn more
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
+ *
+ * @group Models
+ */
+export class DismissedModalDialog extends ModalDialog {
+    dialogMessage;
+    constructor(dialogMessage) {
+        super();
+        this.dialogMessage = dialogMessage;
+        ensure('dialogMessage', dialogMessage, isDefined());
+    }
+    async isPresent() {
+        return true;
+    }
+    async message() {
+        return this.dialogMessage;
+    }
+}
+//# sourceMappingURL=DismissedModalDialog.js.map

package/esm/screenplay/models/dialogs/DismissedModalDialog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DismissedModalDialog.js","sourceRoot":"","sources":["../../../../src/screenplay/models/dialogs/DismissedModalDialog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;GAQG;AACH,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACpB;IAA7B,YAA6B,aAAqB;QAC9C,KAAK,EAAE,CAAC;QADiB,kBAAa,GAAb,aAAa,CAAQ;QAE9C,MAAM,CAAC,eAAe,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,SAAS;QACX,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,OAAO;QACT,OAAO,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;CACJ"}

package/esm/screenplay/models/dialogs/ModalDialog.d.ts

@@ -0,0 +1,171 @@
+import type { Answerable, Interaction, Optional, Question, QuestionAdapter } from '@serenity-js/core';
+/**
+ * Manages interactions with JavaScript modal dialog windows,
+ * triggered by [window.alert](https://developer.mozilla.org/en-US/docs/Web/API/Window/alert),
+ * [window.confirm](https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm),
+ * or [`window.prompt`](https://developer.mozilla.org/en-US/docs/Web/API/Window/prompt),
+ * and stores their `message` so that it can be asserted on once the dialog is handled.
+ *
+ * Note that in order to make handling modal windows
+ * consistent across the various Web integration tools (such as Playwright, Puppeteer,
+ * WebdriverIO or Selenium), Serenity/JS works as follows:
+ * - Serenity/JS dismisses any modal dialogs by default and stores their message so that it can be asserted on.
+ * - This behaviour can be changed by invoking [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext),
+ *   [`ModalDialog.acceptNextWithValue`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNextWithValue),
+ *   or [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext)
+ *   before the dialog is triggered, as per the below examples.
+ * - Serenity/JS also allows you to `Wait.until(ModalDialog, isPresent())` so that you can synchronise your tests
+ *   with modal dialogs that appear after a delay.
+ *
+ * ## Example HTML widget
+ *
+ * In the below example widget, clicking on the button results in a [confirmation dialog](https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm)
+ * appearing.
+ *
+ * ```html
+ * <button id="trigger" onclick="trigger()">Trigger Alert</button>
+ * <p id="result"></p>
+ *
+ * <script>
+ *   function trigger() {
+ *     document.getElementById("result").innerHTML = (
+ *       function () {
+ *         return confirm('Continue?')
+ *           ? 'accepted'
+ *           : 'dismissed';
+ *       }
+ *     )();
+ *   }
+ * </script>
+ * ```
+ *
+ * ## Modal dialog gets dismissed by default
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { By, Click, Text, PageElement, ModalDialog } from '@serenity-js/web'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * const Example = {
+ *   trigger: () =>
+ *     PageElement.located(By.id('trigger')).describedAs('the modal dialog trigger'),
+ *
+ *   result: () =>
+ *     PageElement.located(By.id('result')).describedAs('result'),
+ * }
+ *
+ * await actorCalled('Nick').attemptsTo(
+ *   Click.on(Example.trigger()),
+ *
+ *   Ensure.that(ModalDialog.lastDialogState(), equals('dismissed')),
+ *
+ *   Ensure.that(Text.of(Example.result()), equals('dismissed')),
+ * )
+ * ```
+ *
+ * ## Changing modal dialog handler
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { By, Click, Text, PageElement, ModalDialog } from '@serenity-js/web'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ *
+ * const Example = {
+ *   trigger: () =>
+ *     PageElement.located(By.id('trigger')).describedAs('the modal dialog trigger'),
+ *
+ *   result: () =>
+ *     PageElement.located(By.id('result')).describedAs('result'),
+ * }
+ *
+ * await actorCalled('Nick').attemptsTo(
+ *   ModalDialog.acceptNext(),
+ *   // or: ModalDialog.acceptNextWithValue('some value'),
+ *   // or: ModalDialog.dismissNext(),
+ *
+ *   Click.on(Example.trigger),
+ *
+ *   Ensure.that(ModalDialog.lastDialogState(), equals('accepted')),
+ *
+ *   Ensure.that(Text.of(Example.result), equals('accepted')),
+ * )
+ * ```
+ *
+ * ## Learn more
+ * - [`Optional`](https://serenity-js.org/api/core/interface/Optional/)
+ *
+ * @group Models
+ */
+export declare abstract class ModalDialog implements Optional {
+    /**
+     * Returns a promise that resolves to `true`
+     * when a modal dialog has been handled, so accepted or dismissed.
+     * Returns `false` for dialogs that haven't been handled yet.
+     *
+     * Useful when a JavaScript modal dialog is generated after a delay,
+     * e.g. triggered by `setTimeout`.
+     *
+     * #### Example usage
+     *
+     * ```ts
+     * import { actorCalled, Wait } from '@serenity-js/core'
+     * import { Ensure, equals, isPresent } from '@serenity-js/assertions'
+     * import { ModalDialog } from '@serenity-js/web'
+     *
+     * await actorCalled('Nick').attemptsTo(
+     *   ModalDialog.acceptNext(),
+     *   Wait.until(ModalDialog, isPresent()),
+     *   Ensure.that(ModalDialog.lastDialogState(), equals('accepted')),
+     * )
+     * ```
+     */
+    static isPresent(): Question<Promise<boolean>>;
+    /**
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext).
+     */
+    static acceptNext(): Interaction;
+    /**
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.acceptNextWithValue`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNextWithValue).
+     *
+     * @param value
+     */
+    static acceptNextWithValue(value: Answerable<string | number>): Interaction;
+    /**
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext).
+     */
+    static dismissNext(): Interaction;
+    /**
+     * [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`ModalDialog.message`](https://serenity-js.org/api/web/class/ModalDialog/#message) for the current [`Page`](https://serenity-js.org/api/web/class/Page/).
+     */
+    static lastDialogMessage(): QuestionAdapter<string>;
+    /**
+     * [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`ModalDialog.state`](https://serenity-js.org/api/web/class/ModalDialog/#state) for the current [`Page`](https://serenity-js.org/api/web/class/Page/).
+     */
+    static lastDialogState(): QuestionAdapter<string>;
+    /**
+     * Returns the message of the last modal dialog handled,
+     * or rejects the promise with a [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
+     * when no modal dialogs have been observed yet.
+     *
+     * @returns
+     *  Message of the last handled dialog, or a `Promise`
+     *  rejected with a [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
+     *  when no dialog has been handled yet.
+     */
+    abstract message(): Promise<string>;
+    /**
+     * Returns a promise that resolves to `true`
+     * when a modal dialog has been handled, so either accepted or dismissed.
+     * Returns `false` for dialogs that haven't been handled yet.
+     *
+     * Useful when a JavaScript modal dialog is generated after a delay,
+     * e.g. triggered by `setTimeout`.
+     */
+    abstract isPresent(): Promise<boolean>;
+    /**
+     * Returns `accepted` or `dismissed` for dialogs that have been handled,
+     * or `absent` for those that haven't been handled yet.
+     */
+    state(): string;
+}
+//# sourceMappingURL=ModalDialog.d.ts.map

package/esm/screenplay/models/dialogs/ModalDialog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModalDialog.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/models/dialogs/ModalDialog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAKtG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgGG;AACH,8BAAsB,WAAY,YAAW,QAAQ;IAEjD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,SAAS,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAI9C;;OAEG;IACH,MAAM,CAAC,UAAU,IAAI,WAAW;IAKhC;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,WAAW;IAK3E;;OAEG;IACH,MAAM,CAAC,WAAW,IAAI,WAAW;IAKjC;;OAEG;IACH,MAAM,CAAC,iBAAiB,IAAI,eAAe,CAAC,MAAM,CAAC;IAKnD;;OAEG;IACH,MAAM,CAAC,eAAe,IAAI,eAAe,CAAC,MAAM,CAAC;IAKjD;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAEnC;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAEtC;;;OAGG;IACH,KAAK,IAAI,MAAM;CAKlB"}