@serenity-js/web 3.0.0-rc.0

package/lib/screenplay/models/CookieData.d.ts

@@ -0,0 +1,89 @@
+import { Timestamp } from '@serenity-js/core';
+/**
+ * @desc
+ *  A data structure describing a {@link Cookie} to be set or that's been read.
+ *
+ * @public
+ */
+export interface CookieData {
+    /**
+     * @desc
+     *  The name of the cookie.
+     *
+     * @type {string}
+     * @public
+     */
+    name: string;
+    /**
+     * @desc
+     *  The value of the cookie.
+     *
+     * @type {string}
+     * @public
+     */
+    value: string;
+    /**
+     * @desc
+     *  The domain the cookie is visible to.
+     *  Defaults to the current browsing context's document's URL when setting a cookie.
+     *
+     * Optional.
+     *
+     * @type {string}
+     * @public
+     */
+    domain?: string;
+    /**
+     * @desc
+     *  The cookie path. Defaults to "/" when adding a cookie.
+     *
+     * Optional.
+     *
+     * @type {string}
+     * @public
+     */
+    path?: string;
+    /**
+     * @desc
+     *  The {@link @serenity-js/core/lib/model~Timestamp} of when the cookie expires.
+     *
+     * Optional.
+     *
+     * @type {@serenity-js/core/lib/model~Timestamp}
+     * @public
+     */
+    expiry?: Timestamp;
+    /**
+     * @desc
+     *  Whether the cookie is an HTTP-only cookie. Defaults to false when adding a new cookie.
+     *
+     * Optional.
+     *
+     * @type {boolean}
+     * @public
+     */
+    httpOnly?: boolean;
+    /**
+     * @desc
+     *  Whether the cookie is a secure cookie. Defaults to false when adding a new cookie.
+     *
+     *  Optional.
+     *
+     * @type {boolean}
+     * @public
+     */
+    secure?: boolean;
+    /**
+     * @desc
+     *  Whether the cookie applies to a SameSite policy.
+     *  Defaults to "None" if omitted when adding a cookie.
+     *
+     *  Can be set to either "Lax" or "Strict".
+     *
+     *  Optional.
+     *
+     * @type {string}
+     * @public
+     */
+    sameSite?: 'Lax' | 'Strict' | 'None';
+}

package/lib/screenplay/models/CookieData.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=CookieData.js.map

package/lib/screenplay/models/CookieData.js.map

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

package/lib/screenplay/models/ModalDialog.d.ts

@@ -0,0 +1,9 @@
+import { Adapter, Question } from '@serenity-js/core';
+export declare abstract class ModalDialog {
+    static window(): Question<Promise<ModalDialog>> & Adapter<ModalDialog>;
+    abstract accept(): Promise<void>;
+    abstract dismiss(): Promise<void>;
+    abstract text(): Promise<string>;
+    abstract enterValue(value: string | number | Array<string | number>): Promise<void>;
+    abstract isPresent(): Promise<boolean>;
+}

package/lib/screenplay/models/ModalDialog.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModalDialog = void 0;
+const core_1 = require("@serenity-js/core");
+const abilities_1 = require("../abilities");
+class ModalDialog {
+    static window() {
+        return core_1.Question.about('modal dialog', actor => {
+            return abilities_1.BrowseTheWeb.as(actor).modalDialog();
+        });
+    }
+}
+exports.ModalDialog = ModalDialog;
+//# sourceMappingURL=ModalDialog.js.map

package/lib/screenplay/models/ModalDialog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModalDialog.js","sourceRoot":"","sources":["../../../src/screenplay/models/ModalDialog.ts"],"names":[],"mappings":";;;AAAA,4CAAsD;AAEtD,4CAA4C;AAE5C,MAAsB,WAAW;IAC7B,MAAM,CAAC,MAAM;QACT,OAAO,eAAQ,CAAC,KAAK,CAAuB,cAAc,EAAE,KAAK,CAAC,EAAE;YAChE,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAChD,CAAC,CAAC,CAAC;IACP,CAAC;CASJ;AAdD,kCAcC"}

package/lib/screenplay/models/Page.d.ts

@@ -0,0 +1,83 @@
+/// <reference types="node" />
+import { Adapter, Expectation, Question } from '@serenity-js/core';
+import { URL } from 'url';
+export declare abstract class Page {
+    protected readonly handle: string;
+    static current(): Question<Promise<Page>> & Adapter<Page>;
+    static whichName(expectation: Expectation<any, string>): Question<Promise<Page>> & Adapter<Page>;
+    static whichTitle(expectation: Expectation<any, string>): Question<Promise<Page>> & Adapter<Page>;
+    static whichUrl(expectation: Expectation<any, string>): Question<Promise<Page>> & Adapter<Page>;
+    private static findMatchingPage;
+    constructor(handle: string);
+    /**
+     * @desc
+     *  Retrieves the document title of the current top-level browsing context, equivalent to calling `document.title`.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title
+     *
+     * @returns {Promise<string>}
+     */
+    abstract title(): Promise<string>;
+    /**
+     * @desc
+     *  Retrieves the URL of the current top-level browsing context.
+     *
+     * @returns {Promise<URL>}
+     */
+    abstract url(): Promise<URL>;
+    /**
+     * @desc
+     *  Retrieves the name of the current top-level browsing context.
+     *
+     * @returns {Promise<string>}
+     */
+    abstract name(): Promise<string>;
+    /**
+     * @desc
+     *  Checks if a given window / tab / page is open and can be switched to.
+     *
+     * @returns {Promise<string>}
+     */
+    abstract isPresent(): Promise<boolean>;
+    /**
+     * @desc
+     *  Returns the actual viewport size available for the given page,
+     *  excluding any scrollbars.
+     *
+     * @returns {Promise<{ width: number, height: number }>}
+     */
+    abstract viewportSize(): Promise<{
+        width: number;
+        height: number;
+    }>;
+    /**
+     *
+     * @param size
+     */
+    abstract setViewportSize(size: {
+        width: number;
+        height: number;
+    }): Promise<void>;
+    /**
+     * @desc
+     *  Switches the current top-level browsing context to the given page
+     *
+     * @returns {Promise<void>}
+     */
+    abstract switchTo(): Promise<void>;
+    /**
+     * @desc
+     *  Closes the given page.
+     *
+     * @returns {Promise<void>}
+     */
+    abstract close(): Promise<void>;
+    /**
+     * @desc
+     *  Closes any open pages, except for this one.
+     *
+     * @returns {Promise<void>}
+     */
+    abstract closeOthers(): Promise<void>;
+    toString(): string;
+}

package/lib/screenplay/models/Page.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Page = void 0;
+const core_1 = require("@serenity-js/core");
+const abilities_1 = require("../abilities");
+class Page {
+    constructor(handle) {
+        this.handle = handle;
+    }
+    static current() {
+        return core_1.Question.about('current page', actor => {
+            return abilities_1.BrowseTheWeb.as(actor).currentPage();
+        });
+    }
+    static whichName(expectation) {
+        return core_1.Question.about(`page which name does ${expectation}`, async (actor) => {
+            const pages = await abilities_1.BrowseTheWeb.as(actor).allPages();
+            const matcher = await actor.answer(expectation);
+            return Page.findMatchingPage(`name does ${expectation}`, pages, page => page.name().then(matcher));
+        });
+    }
+    static whichTitle(expectation) {
+        return core_1.Question.about(`page which title does ${expectation}`, async (actor) => {
+            const pages = await abilities_1.BrowseTheWeb.as(actor).allPages();
+            const matcher = await actor.answer(expectation);
+            return Page.findMatchingPage(`title does ${expectation}`, pages, page => page.title().then(title => {
+                return matcher(title);
+            }));
+        });
+    }
+    static whichUrl(expectation) {
+        return core_1.Question.about(`page which URL does ${expectation}`, async (actor) => {
+            const pages = await abilities_1.BrowseTheWeb.as(actor).allPages();
+            const matcher = await actor.answer(expectation);
+            return Page.findMatchingPage(`url does ${expectation}`, pages, page => page.url().then(url => matcher(url.toString())));
+        });
+    }
+    static async findMatchingPage(expectationDescription, pages, matcher) {
+        for (const page of pages) {
+            const outcome = await matcher(page);
+            if (outcome instanceof core_1.ExpectationMet) {
+                return page;
+            }
+        }
+        throw new core_1.LogicError(`Couldn't find a page which ${expectationDescription}`);
+    }
+    toString() {
+        return `page (handle=${this.handle})`;
+    }
+}
+exports.Page = Page;
+//# sourceMappingURL=Page.js.map

package/lib/screenplay/models/Page.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Page.js","sourceRoot":"","sources":["../../../src/screenplay/models/Page.ts"],"names":[],"mappings":";;;AAAA,4CAAmH;AAGnH,4CAA4C;AAE5C,MAAsB,IAAI;IA4DtB,YACuB,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAErC,CAAC;IA9DD,MAAM,CAAC,OAAO;QACV,OAAO,eAAQ,CAAC,KAAK,CAAgB,cAAc,EAAE,KAAK,CAAC,EAAE;YACzD,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAChD,CAAC,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,WAAqC;QAClD,OAAO,eAAQ,CAAC,KAAK,CAAC,wBAAyB,WAAY,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACzE,MAAM,KAAK,GAAO,MAAM,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC1D,MAAM,OAAO,GAAK,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAElD,OAAO,IAAI,CAAC,gBAAgB,CACxB,aAAc,WAAY,EAAE,EAC5B,KAAK,EACL,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CACpC,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,WAAqC;QACnD,OAAO,eAAQ,CAAC,KAAK,CAAC,yBAA0B,WAAY,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC1E,MAAM,KAAK,GAAO,MAAM,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC1D,MAAM,OAAO,GAAK,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAElD,OAAO,IAAI,CAAC,gBAAgB,CACxB,cAAe,WAAY,EAAE,EAC7B,KAAK,EACL,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAC9B,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC,CAAC,CACL,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,WAAqC;QACjD,OAAO,eAAQ,CAAC,KAAK,CAAC,uBAAwB,WAAY,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACxE,MAAM,KAAK,GAAO,MAAM,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC1D,MAAM,OAAO,GAAK,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAElD,OAAO,IAAI,CAAC,gBAAgB,CACxB,YAAa,WAAY,EAAE,EAC3B,KAAK,EACL,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAC1D,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,sBAA8B,EAAE,KAAa,EAAE,OAA8D;QAC/I,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACtB,MAAM,OAAO,GAAI,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YAErC,IAAI,OAAO,YAAY,qBAAc,EAAE;gBACnC,OAAO,IAAI,CAAC;aACf;SACJ;QAED,MAAM,IAAI,iBAAU,CAAC,8BAA+B,sBAAuB,EAAE,CAAC,CAAC;IACnF,CAAC;IAgFD,QAAQ;QACJ,OAAO,gBAAiB,IAAI,CAAC,MAAO,GAAG,CAAC;IAC5C,CAAC;CACJ;AA7ID,oBA6IC"}

package/lib/screenplay/models/PageElement.d.ts

@@ -0,0 +1,30 @@
+import { Adapter, Answerable, Question } from '@serenity-js/core';
+export declare abstract class PageElement<NativeElementContext = any, NativeElement = any> {
+    protected readonly context: () => Promise<NativeElementContext> | NativeElementContext;
+    protected readonly locator: (root: NativeElementContext) => Promise<NativeElement> | NativeElement;
+    static of(childElement: Answerable<PageElement>, parentElement: Answerable<PageElement>): Question<Promise<PageElement>> & Adapter<PageElement>;
+    static locatedByCss(selector: Answerable<string>): Question<Promise<PageElement>> & Adapter<PageElement>;
+    static locatedByCssContainingText(selector: Answerable<string>, text: Answerable<string>): Question<Promise<PageElement>> & Adapter<PageElement>;
+    static locatedById(selector: Answerable<string>): Question<Promise<PageElement>> & Adapter<PageElement>;
+    static locatedByTagName(tagName: Answerable<string>): Question<Promise<PageElement>> & Adapter<PageElement>;
+    static locatedByXPath(selector: Answerable<string>): Question<Promise<PageElement>> & Adapter<PageElement>;
+    constructor(context: () => Promise<NativeElementContext> | NativeElementContext, locator: (root: NativeElementContext) => Promise<NativeElement> | NativeElement);
+    abstract of(parent: PageElement): PageElement;
+    nativeElement(): Promise<NativeElement>;
+    abstract enterValue(value: string | number | Array<string | number>): Promise<void>;
+    abstract clearValue(): Promise<void>;
+    abstract click(): Promise<void>;
+    abstract doubleClick(): Promise<void>;
+    abstract scrollIntoView(): Promise<void>;
+    abstract hoverOver(): Promise<void>;
+    abstract rightClick(): Promise<void>;
+    abstract attribute(name: string): Promise<string>;
+    abstract text(): Promise<string>;
+    abstract value(): Promise<string>;
+    abstract isActive(): Promise<boolean>;
+    abstract isClickable(): Promise<boolean>;
+    abstract isDisplayed(): Promise<boolean>;
+    abstract isEnabled(): Promise<boolean>;
+    abstract isPresent(): Promise<boolean>;
+    abstract isSelected(): Promise<boolean>;
+}

package/lib/screenplay/models/PageElement.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageElement = void 0;
+const core_1 = require("@serenity-js/core");
+const abilities_1 = require("../abilities");
+const d = (0, core_1.format)({ markQuestions: false });
+const f = (0, core_1.format)({ markQuestions: true });
+class PageElement {
+    constructor(context, locator) {
+        this.context = context;
+        this.locator = locator;
+    }
+    static of(childElement, parentElement) {
+        return core_1.Question.about(d `${childElement} of ${parentElement})`, async (actor) => {
+            const child = await actor.answer(childElement);
+            const parent = await actor.answer(parentElement);
+            return child.of(parent);
+        });
+    }
+    static locatedByCss(selector) {
+        return core_1.Question.about(f `page element located by css (${selector})`, async (actor) => {
+            const cssSelector = await actor.answer(selector);
+            return abilities_1.BrowseTheWeb.as(actor).findByCss(cssSelector);
+        });
+    }
+    static locatedByCssContainingText(selector, text) {
+        return core_1.Question.about(f `page element located by css (${selector}) containing text ${text}`, async (actor) => {
+            const cssSelector = await actor.answer(selector);
+            const desiredText = await actor.answer(text);
+            return abilities_1.BrowseTheWeb.as(actor).findByCssContainingText(cssSelector, desiredText);
+        });
+    }
+    static locatedById(selector) {
+        return core_1.Question.about(f `page element located by id (${selector})`, async (actor) => {
+            const idSelector = await actor.answer(selector);
+            return abilities_1.BrowseTheWeb.as(actor).findById(idSelector);
+        });
+    }
+    static locatedByTagName(tagName) {
+        return core_1.Question.about(f `page element located by tag name (${tagName})`, async (actor) => {
+            const tagNameSelector = await actor.answer(tagName);
+            return abilities_1.BrowseTheWeb.as(actor).findByTagName(tagNameSelector);
+        });
+    }
+    static locatedByXPath(selector) {
+        return core_1.Question.about(f `page element located by xpath (${selector})`, async (actor) => {
+            const xpathSelector = await actor.answer(selector);
+            return abilities_1.BrowseTheWeb.as(actor).findByXPath(xpathSelector);
+        });
+    }
+    async nativeElement() {
+        try {
+            const context = await this.context();
+            return this.locator(context);
+        }
+        catch (error) {
+            throw new core_1.LogicError(`Couldn't find element`, error);
+        }
+    }
+}
+exports.PageElement = PageElement;
+//# sourceMappingURL=PageElement.js.map

package/lib/screenplay/models/PageElement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PageElement.js","sourceRoot":"","sources":["../../../src/screenplay/models/PageElement.ts"],"names":[],"mappings":";;;AAAA,4CAAsF;AAEtF,4CAA4C;AAE5C,MAAM,CAAC,GAAG,IAAA,aAAM,EAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;AAC3C,MAAM,CAAC,GAAG,IAAA,aAAM,EAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;AAE1C,MAAsB,WAAW;IAmD7B,YACuB,OAAmE,EACnE,OAA+E;QAD/E,YAAO,GAAP,OAAO,CAA4D;QACnE,YAAO,GAAP,OAAO,CAAwE;IAEtG,CAAC;IAtDD,MAAM,CAAC,EAAE,CAAC,YAAqC,EAAE,aAAsC;QACnF,OAAO,eAAQ,CAAC,KAAK,CAAC,CAAC,CAAA,GAAI,YAAa,OAAQ,aAAc,GAAG,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC7E,MAAM,KAAK,GAAO,MAAM,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YACnD,MAAM,MAAM,GAAM,MAAM,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAEpD,OAAO,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,QAA4B;QAC5C,OAAO,eAAQ,CAAC,KAAK,CAAC,CAAC,CAAA,gCAAgC,QAAQ,GAAG,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC9E,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAEjD,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,0BAA0B,CAAC,QAA4B,EAAE,IAAwB;QACpF,OAAO,eAAQ,CAAC,KAAK,CAAC,CAAC,CAAA,gCAAgC,QAAQ,qBAAsB,IAAK,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACxG,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACjD,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAE7C,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,uBAAuB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,QAA4B;QAC3C,OAAO,eAAQ,CAAC,KAAK,CAAC,CAAC,CAAA,+BAA+B,QAAQ,GAAG,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC7E,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAEhD,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,OAA2B;QAC/C,OAAO,eAAQ,CAAC,KAAK,CAAC,CAAC,CAAA,qCAAqC,OAAO,GAAG,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAClF,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAEpD,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,QAA4B;QAC9C,OAAO,eAAQ,CAAC,KAAK,CAAC,CAAC,CAAA,kCAAkC,QAAQ,GAAG,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAChF,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAEnD,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACP,CAAC;IAUD,KAAK,CAAC,aAAa;QACf,IAAI;YACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SAChC;QACD,OAAO,KAAK,EAAE;YACV,MAAM,IAAI,iBAAU,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;SACxD;IACL,CAAC;CAoBJ;AAvFD,kCAuFC"}

package/lib/screenplay/models/PageElements.d.ts

@@ -0,0 +1,20 @@
+import { Adapter, Answerable, Question } from '@serenity-js/core';
+import { PageElement } from './PageElement';
+export declare abstract class PageElements<NativeElementContext = any, NativeElementList = any, NativeElement = any> {
+    protected readonly context: () => Promise<NativeElementContext> | NativeElementContext;
+    protected readonly locator: (root: NativeElementContext) => Promise<NativeElementList> | NativeElementList;
+    static of(childElements: Answerable<PageElements>, parentElement: Answerable<PageElement>): Question<Promise<PageElements>> & Adapter<PageElements>;
+    static locatedByCss(selector: Answerable<string>): Question<Promise<PageElements>> & Adapter<PageElements>;
+    static locatedByTagName(selector: Answerable<string>): Question<Promise<PageElements>> & Adapter<PageElements>;
+    static locatedByXPath(selector: Answerable<string>): Question<Promise<PageElements>> & Adapter<PageElements>;
+    constructor(context: () => Promise<NativeElementContext> | NativeElementContext, locator: (root: NativeElementContext) => Promise<NativeElementList> | NativeElementList);
+    abstract of(parent: PageElement): PageElements;
+    nativeElementList(): Promise<NativeElementList>;
+    abstract count(): Promise<number>;
+    abstract first(): Promise<PageElement<NativeElementContext, NativeElement>>;
+    abstract last(): Promise<PageElement<NativeElementContext, NativeElement>>;
+    abstract get(index: number): Promise<PageElement<NativeElementContext, NativeElement>>;
+    abstract map<O>(fn: (element: PageElement, index?: number, elements?: PageElements) => Promise<O> | O): Promise<O[]>;
+    abstract filter(fn: (element: PageElement, index?: number) => Promise<boolean> | boolean): PageElements;
+    abstract forEach(fn: (element: PageElement, index?: number) => Promise<void> | void): Promise<void>;
+}

package/lib/screenplay/models/PageElements.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageElements = void 0;
+const core_1 = require("@serenity-js/core");
+const abilities_1 = require("../abilities");
+const d = (0, core_1.format)({ markQuestions: false });
+const f = (0, core_1.format)({ markQuestions: true });
+class PageElements {
+    constructor(context, locator) {
+        this.context = context;
+        this.locator = locator;
+    }
+    static of(childElements, parentElement) {
+        return core_1.Question.about(d `${childElements} of ${parentElement})`, async (actor) => {
+            const children = await actor.answer(childElements);
+            const parent = await actor.answer(parentElement);
+            return children.of(parent);
+        });
+    }
+    static locatedByCss(selector) {
+        return core_1.Question.about(f `page elements located by css (${selector})`, async (actor) => {
+            const value = await actor.answer(selector);
+            return abilities_1.BrowseTheWeb.as(actor).findAllByCss(value);
+        });
+    }
+    static locatedByTagName(selector) {
+        return core_1.Question.about(f `page elements located by tag name (${selector})`, async (actor) => {
+            const tagNameSelector = await actor.answer(selector);
+            return abilities_1.BrowseTheWeb.as(actor).findAllByTagName(tagNameSelector);
+        });
+    }
+    static locatedByXPath(selector) {
+        return core_1.Question.about(f `page elements located by xpath (${selector})`, async (actor) => {
+            const xpathSelector = await actor.answer(selector);
+            return abilities_1.BrowseTheWeb.as(actor).findAllByXPath(xpathSelector);
+        });
+    }
+    async nativeElementList() {
+        try {
+            const context = await this.context();
+            return this.locator(context);
+        }
+        catch (error) {
+            throw new core_1.LogicError(`Couldn't find elements`, error);
+        }
+    }
+}
+exports.PageElements = PageElements;
+//# sourceMappingURL=PageElements.js.map

package/lib/screenplay/models/PageElements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PageElements.js","sourceRoot":"","sources":["../../../src/screenplay/models/PageElements.ts"],"names":[],"mappings":";;;AAAA,4CAAsF;AAEtF,4CAA4C;AAG5C,MAAM,CAAC,GAAG,IAAA,aAAM,EAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;AAC3C,MAAM,CAAC,GAAG,IAAA,aAAM,EAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;AAE1C,MAAsB,YAAY;IAiC9B,YACuB,OAAmE,EACnE,OAAuF;QADvF,YAAO,GAAP,OAAO,CAA4D;QACnE,YAAO,GAAP,OAAO,CAAgF;IAE9G,CAAC;IAlCD,MAAM,CAAC,EAAE,CAAC,aAAuC,EAAE,aAAsC;QACrF,OAAO,eAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,GAAI,aAAc,OAAQ,aAAc,GAAG,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAC/E,MAAM,QAAQ,GAAI,MAAM,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YACpD,MAAM,MAAM,GAAM,MAAM,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAEpD,OAAO,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,QAA4B;QAC5C,OAAO,eAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,iCAAiC,QAAQ,GAAG,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAChF,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC3C,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,QAA4B;QAChD,OAAO,eAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,sCAAsC,QAAQ,GAAG,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACrF,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACrD,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,QAA4B;QAC9C,OAAO,eAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,mCAAmC,QAAQ,GAAG,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAClF,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACnD,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;IACP,CAAC;IAUD,KAAK,CAAC,iBAAiB;QACnB,IAAI;YACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SAChC;QACD,OAAO,KAAK,EAAE;YACV,MAAM,IAAI,iBAAU,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;SACzD;IACL,CAAC;CAYJ;AA7DD,oCA6DC"}

package/lib/screenplay/models/index.d.ts

@@ -0,0 +1,6 @@
+export * from './Cookie';
+export * from './CookieData';
+export * from './ModalDialog';
+export * from './Page';
+export * from './PageElement';
+export * from './PageElements';

package/lib/screenplay/models/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Cookie"), exports);
+__exportStar(require("./CookieData"), exports);
+__exportStar(require("./ModalDialog"), exports);
+__exportStar(require("./Page"), exports);
+__exportStar(require("./PageElement"), exports);
+__exportStar(require("./PageElements"), exports);
+//# sourceMappingURL=index.js.map

package/lib/screenplay/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAyB;AACzB,+CAA6B;AAC7B,gDAA8B;AAC9B,yCAAuB;AACvB,gDAA8B;AAC9B,iDAA+B"}

package/lib/screenplay/questions/Attribute.d.ts

@@ -0,0 +1,83 @@
+import { Answerable, AnswersQuestions, MetaQuestion, Question, UsesAbilities } from '@serenity-js/core';
+import { PageElement } from '../models';
+import { ElementQuestion } from './ElementQuestion';
+/**
+ * @desc
+ *  Returns the value of the given HTML attribute of a given {@link WebElement},
+ *  represented by Answerable<{@link @wdio/types~Element}>
+ *
+ * @example <caption>Example widget</caption>
+ *  <ul id="shopping-list" data-items-left="2">
+ *    <li data-state="bought">Coffee<li>
+ *    <li data-state="buy">Honey<li>
+ *    <li data-state="buy">Chocolate<li>
+ *  </ul>
+ *
+ * @example <caption>Retrieve a HTML attribute of a given WebElement</caption>
+ *  import { actorCalled } from '@serenity-js/core';
+ *  import { Ensure, equals } from '@serenity-js/assertions';
+ *  import { Attribute, by, BrowseTheWeb, Target } from '@serenity-js/webdriverio';
+ *
+ *  const shoppingList = () =>
+ *      Target.the('shopping list').located(by.id('shopping-list'))
+ *
+ *  actorCalled('Lisa')
+ *      .whoCan(BrowseTheWeb.using(browser))
+ *      .attemptsTo(
+ *          Ensure.that(Attribute.called('data-items-left').of(shoppingList()), equals('2')),
+ *      )
+ *
+ * @example <caption>Find WebElements with a given attribute</caption>
+ *  import { actorCalled } from '@serenity-js/core';
+ *  import { Ensure, includes } from '@serenity-js/assertions';
+ *  import { Attribute, BrowseTheWeb, by, Target } from '@serenity-js/webdriverio';
+ *
+ *  class ShoppingList {
+ *      static items = () =>
+ *          Target.all('items')
+ *              .located(by.css('#shopping-list li'))
+ *
+ *      static outstandingItems = () =>
+ *          ShoppingList.items
+ *              .where(Attribute.called('data-state'), includes('buy'))
+ *  }
+ *
+ *  actorCalled('Lisa')
+ *      .whoCan(BrowseTheWeb.using(browser))
+ *      .attemptsTo(
+ *          Ensure.that(
+ *              Text.ofAll(ShoppingList.outstandingItems()),
+ *              equals([ 'Honey', 'Chocolate' ])
+ *          ),
+ *      )
+ *
+ * @extends {ElementQuestion}
+ * @implements {@serenity-js/core/lib/screenplay/questions~MetaQuestion}
+ */
+export declare class Attribute extends ElementQuestion<Promise<string>> implements MetaQuestion<Answerable<PageElement>, Promise<string>> {
+    private readonly name;
+    private readonly element?;
+    /**
+     * @param {Answerable<string>} name
+     * @returns {Attribute}
+     */
+    static called(name: Answerable<string>): Attribute;
+    /**
+     * @param {Answerable<string>} name
+     * @param {@serenity-js/core/lib/screenplay~Answerable<Element>} [element]
+     */
+    constructor(name: Answerable<string>, element?: Answerable<PageElement>);
+    /**
+     * @desc
+     *  Resolves to the value of a HTML attribute of the `target` element,
+     *  located in the context of a `parent` element.
+     *
+     * @param {Answerable<PageElement>} parent
+     * @returns {Question<Promise<string[]>>}
+     *
+     * @see {@link Target.all}
+     * @see {@link @serenity-js/core/lib/screenplay/questions~MetaQuestion}
+     */
+    of(parent: Answerable<PageElement>): Question<Promise<string>>;
+    answeredBy(actor: AnswersQuestions & UsesAbilities): Promise<string>;
+}