@serenity-js/web 3.0.0-rc.0

package/lib/expectations/isVisible.d.ts

@@ -0,0 +1,14 @@
+import { Expectation } from '@serenity-js/core';
+import { PageElement } from '../screenplay';
+/**
+ * @desc
+ *  Expectation that the element is present in the DOM of the page and visible.
+ *
+ * @returns {@serenity-js/core/lib/screenplay/questions~Expectation<boolean, Element<'async'>>}
+ *
+ * @see https://webdriver.io/docs/api/element/isDisplayed/
+ * @see {@link @serenity-js/assertions~Ensure}
+ * @see {@link @serenity-js/core/lib/screenplay/questions~Check}
+ * @see {@link Wait}
+ */
+export declare function isVisible(): Expectation<boolean, PageElement>;

package/lib/expectations/isVisible.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isVisible = void 0;
+const assertions_1 = require("@serenity-js/assertions");
+const core_1 = require("@serenity-js/core");
+const ElementExpectation_1 = require("./ElementExpectation");
+const isPresent_1 = require("./isPresent");
+/**
+ * @desc
+ *  Expectation that the element is present in the DOM of the page and visible.
+ *
+ * @returns {@serenity-js/core/lib/screenplay/questions~Expectation<boolean, Element<'async'>>}
+ *
+ * @see https://webdriver.io/docs/api/element/isDisplayed/
+ * @see {@link @serenity-js/assertions~Ensure}
+ * @see {@link @serenity-js/core/lib/screenplay/questions~Check}
+ * @see {@link Wait}
+ */
+function isVisible() {
+    return core_1.Expectation.to('become visible').soThatActual((0, assertions_1.and)((0, isPresent_1.isPresent)(), isDisplayed()));
+}
+exports.isVisible = isVisible;
+function isDisplayed() {
+    return ElementExpectation_1.ElementExpectation.forElementTo('become displayed', actual => actual.isDisplayed());
+}
+//# sourceMappingURL=isVisible.js.map

package/lib/expectations/isVisible.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isVisible.js","sourceRoot":"","sources":["../../src/expectations/isVisible.ts"],"names":[],"mappings":";;;AAAA,wDAA8C;AAC9C,4CAAgD;AAGhD,6DAA0D;AAC1D,2CAAwC;AAExC;;;;;;;;;;GAUG;AACH,SAAgB,SAAS;IACrB,OAAO,kBAAW,CAAC,EAAE,CAAc,gBAAgB,CAAC,CAAC,YAAY,CAAC,IAAA,gBAAG,EACjE,IAAA,qBAAS,GAAE,EACX,WAAW,EAAE,CAChB,CAAC,CAAC;AACP,CAAC;AALD,8BAKC;AAED,SAAS,WAAW;IAChB,OAAO,uCAAkB,CAAC,YAAY,CAAC,kBAAkB,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;AAC/F,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+export * from './errors';
+export * from './expectations';
+export * from './input';
+export * from './screenplay';
+export * from './stage';

package/lib/index.js

@@ -0,0 +1,18 @@
+"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("./errors"), exports);
+__exportStar(require("./expectations"), exports);
+__exportStar(require("./input"), exports);
+__exportStar(require("./screenplay"), exports);
+__exportStar(require("./stage"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAyB;AACzB,iDAA+B;AAC/B,0CAAwB;AACxB,+CAA6B;AAC7B,0CAAwB"}

package/lib/input/Key.d.ts

@@ -0,0 +1,73 @@
+/**
+ * @desc
+ *  Represents pressable keys that aren't text to be used with {@link Press}.
+ *
+ *  Note that modifier like Shift, Alt and Meta (a.k.a. Command on Mac) will stay pressed
+ *
+ * @enum {string}
+ * @see {@link Press}
+ * @see https://w3c.github.io/webdriver/webdriver-spec.html#keyboard-actions
+ * @see https://github.com/puppeteer/puppeteer/blob/v7.1.0/src/common/USKeyboardLayout.ts
+ * @see https://github.com/SeleniumHQ/selenium/blob/trunk/javascript/node/selenium-webdriver/lib/input.js#L46
+ * @see https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-utils/src/constants.ts#L5
+ */
+export declare class Key {
+    readonly devtoolsName: string;
+    readonly utf16codePoint: string;
+    readonly isModifier: boolean;
+    static Alt: Key;
+    static ArrowDown: Key;
+    static ArrowLeft: Key;
+    static ArrowRight: Key;
+    static ArrowUp: Key;
+    static Backspace: Key;
+    static Cancel: Key;
+    static Clear: Key;
+    static Control: Key;
+    static Delete: Key;
+    static End: Key;
+    static Enter: Key;
+    static Escape: Key;
+    static F1: Key;
+    static F2: Key;
+    static F3: Key;
+    static F4: Key;
+    static F5: Key;
+    static F6: Key;
+    static F7: Key;
+    static F8: Key;
+    static F9: Key;
+    static F10: Key;
+    static F11: Key;
+    static F12: Key;
+    static Help: Key;
+    static Home: Key;
+    static Insert: Key;
+    static Meta: Key;
+    static Numpad0: Key;
+    static Numpad1: Key;
+    static Numpad2: Key;
+    static Numpad3: Key;
+    static Numpad4: Key;
+    static Numpad5: Key;
+    static Numpad6: Key;
+    static Numpad7: Key;
+    static Numpad8: Key;
+    static Numpad9: Key;
+    static NumpadAdd: Key;
+    static NumpadDecimal: Key;
+    static NumpadDivide: Key;
+    static NumpadEqual: Key;
+    static NumpadMultiply: Key;
+    static NumpadSubtract: Key;
+    static PageDown: Key;
+    static PageUp: Key;
+    static Pause: Key;
+    static Semicolon: Key;
+    static Shift: Key;
+    static Space: Key;
+    static Tab: Key;
+    static isKey(maybeKey: unknown): maybeKey is Key;
+    constructor(devtoolsName: string, utf16codePoint: string, isModifier?: boolean);
+    toString(): string;
+}

package/lib/input/Key.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Key = void 0;
+/**
+ * @desc
+ *  Represents pressable keys that aren't text to be used with {@link Press}.
+ *
+ *  Note that modifier like Shift, Alt and Meta (a.k.a. Command on Mac) will stay pressed
+ *
+ * @enum {string}
+ * @see {@link Press}
+ * @see https://w3c.github.io/webdriver/webdriver-spec.html#keyboard-actions
+ * @see https://github.com/puppeteer/puppeteer/blob/v7.1.0/src/common/USKeyboardLayout.ts
+ * @see https://github.com/SeleniumHQ/selenium/blob/trunk/javascript/node/selenium-webdriver/lib/input.js#L46
+ * @see https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-utils/src/constants.ts#L5
+ */
+class Key {
+    constructor(devtoolsName, utf16codePoint, isModifier = false) {
+        this.devtoolsName = devtoolsName;
+        this.utf16codePoint = utf16codePoint;
+        this.isModifier = isModifier;
+    }
+    static isKey(maybeKey) {
+        return !!maybeKey
+            && maybeKey instanceof Key;
+    }
+    toString() {
+        return this.devtoolsName.replace(/([a-z])([\dA-Z])/g, '$1 $2');
+    }
+}
+exports.Key = Key;
+Key.Alt = new Key('Alt', '\uE00A', true);
+Key.ArrowDown = new Key('ArrowDown', '\uE015');
+Key.ArrowLeft = new Key('ArrowLeft', '\uE012');
+Key.ArrowRight = new Key('ArrowRight', '\uE014');
+Key.ArrowUp = new Key('ArrowUp', '\uE013');
+Key.Backspace = new Key('Backspace', '\uE003');
+Key.Cancel = new Key('Cancel', '\uE001');
+Key.Clear = new Key('Clear', '\uE005');
+Key.Control = new Key('Control', '\uE009', true);
+Key.Delete = new Key('Delete', '\uE017');
+Key.End = new Key('End', '\uE010');
+Key.Enter = new Key('Enter', '\uE007');
+Key.Escape = new Key('Escape', '\uE00C');
+Key.F1 = new Key('F1', '\uE031');
+Key.F2 = new Key('F2', '\uE032');
+Key.F3 = new Key('F3', '\uE033');
+Key.F4 = new Key('F4', '\uE034');
+Key.F5 = new Key('F5', '\uE035');
+Key.F6 = new Key('F6', '\uE036');
+Key.F7 = new Key('F7', '\uE037');
+Key.F8 = new Key('F8', '\uE038');
+Key.F9 = new Key('F9', '\uE039');
+Key.F10 = new Key('F10', '\uE03A');
+Key.F11 = new Key('F11', '\uE03B');
+Key.F12 = new Key('F12', '\uE03C');
+Key.Help = new Key('Help', '\uE002');
+Key.Home = new Key('Home', '\uE011');
+Key.Insert = new Key('Insert', '\uE016');
+Key.Meta = new Key('Meta', '\uE03D', true);
+Key.Numpad0 = new Key('Numpad0', '\uE01A');
+Key.Numpad1 = new Key('Numpad1', '\uE01B');
+Key.Numpad2 = new Key('Numpad2', '\uE01C');
+Key.Numpad3 = new Key('Numpad3', '\uE01D');
+Key.Numpad4 = new Key('Numpad4', '\uE01E');
+Key.Numpad5 = new Key('Numpad5', '\uE01F');
+Key.Numpad6 = new Key('Numpad6', '\uE020');
+Key.Numpad7 = new Key('Numpad7', '\uE021');
+Key.Numpad8 = new Key('Numpad8', '\uE022');
+Key.Numpad9 = new Key('Numpad9', '\uE023');
+Key.NumpadAdd = new Key('NumpadAdd', '\uE025');
+Key.NumpadDecimal = new Key('NumpadDecimal', '\uE028');
+Key.NumpadDivide = new Key('NumpadDivide', '\uE029');
+Key.NumpadEqual = new Key('NumpadEqual', '\uE019');
+Key.NumpadMultiply = new Key('NumpadMultiply', '\uE024');
+Key.NumpadSubtract = new Key('NumpadSubtract', '\uE027');
+Key.PageDown = new Key('PageDown', '\uE00F');
+Key.PageUp = new Key('PageUp', '\uE00E');
+Key.Pause = new Key('Pause', '\uE00B');
+Key.Semicolon = new Key('Semicolon', '\uE018');
+Key.Shift = new Key('Shift', '\uE008', true);
+Key.Space = new Key('Space', '\uE00D');
+Key.Tab = new Key('Tab', '\uE004');
+//# sourceMappingURL=Key.js.map

package/lib/input/Key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Key.js","sourceRoot":"","sources":["../../src/input/Key.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;GAYG;AACH,MAAa,GAAG;IA2DZ,YACoB,YAAoB,EACpB,cAAsB,EACtB,aAAsB,KAAK;QAF3B,iBAAY,GAAZ,YAAY,CAAQ;QACpB,mBAAc,GAAd,cAAc,CAAQ;QACtB,eAAU,GAAV,UAAU,CAAiB;IAE/C,CAAC;IAVM,MAAM,CAAC,KAAK,CAAC,QAAiB;QACjC,OAAO,CAAC,CAAE,QAAQ;eACX,QAAQ,YAAY,GAAG,CAAC;IACnC,CAAC;IASD,QAAQ;QACJ,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;;AApEL,kBAqEC;AApEiB,OAAG,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;AACrC,aAAS,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;AAC3C,aAAS,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;AAC3C,cAAU,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;AAC7C,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvC,aAAS,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;AAC3C,UAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACrC,SAAK,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACnC,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;AAC7C,UAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACrC,OAAG,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAC/B,SAAK,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACnC,UAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACrC,MAAE,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,MAAE,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,MAAE,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,MAAE,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,MAAE,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,MAAE,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,MAAE,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,MAAE,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,MAAE,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,OAAG,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAC/B,OAAG,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAC/B,OAAG,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAC/B,QAAI,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACjC,QAAI,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACjC,UAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACrC,QAAI,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;AACvC,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvC,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvC,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvC,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvC,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvC,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvC,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvC,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvC,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvC,WAAO,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AACvC,aAAS,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;AAC3C,iBAAa,GAAG,IAAI,GAAG,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;AACnD,gBAAY,GAAG,IAAI,GAAG,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;AACjD,eAAW,GAAG,IAAI,GAAG,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AAC/C,kBAAc,GAAG,IAAI,GAAG,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;AACrD,kBAAc,GAAG,IAAI,GAAG,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;AACrD,YAAQ,GAAG,IAAI,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AACzC,UAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACrC,SAAK,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACnC,aAAS,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;AAC3C,SAAK,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;AACzC,SAAK,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACnC,OAAG,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC"}

package/lib/input/index.d.ts

@@ -0,0 +1 @@
+export * from './Key';

package/lib/input/index.js

@@ -0,0 +1,14 @@
+"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("./Key"), exports);
+//# sourceMappingURL=index.js.map

package/lib/input/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/input/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wCAAsB"}

package/lib/screenplay/abilities/BrowseTheWeb.d.ts

@@ -0,0 +1,58 @@
+import { Ability, Duration, UsesAbilities } from '@serenity-js/core';
+import { Key } from '../../input';
+import { Cookie, CookieData, ModalDialog, Page, PageElement, PageElements } from '../models';
+import { BrowserCapabilities } from './BrowserCapabilities';
+export declare abstract class BrowseTheWeb implements Ability {
+    /**
+     * @desc
+     *  Used to access the Actor's ability to {@link BrowseTheWeb}
+     *  from within the {@link @serenity-js/core/lib/screenplay~Interaction} classes,
+     *  such as {@link Click}.
+     *
+     * @param {@serenity-js/core/lib/screenplay/actor~UsesAbilities} actor
+     * @return {BrowseTheWeb}
+     */
+    static as(actor: UsesAbilities): BrowseTheWeb;
+    abstract navigateTo(destination: string): Promise<void>;
+    abstract navigateBack(): Promise<void>;
+    abstract navigateForward(): Promise<void>;
+    abstract reloadPage(): Promise<void>;
+    abstract waitFor(duration: Duration): Promise<void>;
+    abstract waitUntil(condition: () => boolean | Promise<boolean>, timeout: Duration): Promise<void>;
+    abstract findByCss(selector: string): PageElement;
+    abstract findByCssContainingText(selector: string, text: string): PageElement;
+    abstract findById(selector: string): PageElement;
+    abstract findByTagName(selector: string): PageElement;
+    abstract findByXPath(selector: string): PageElement;
+    abstract findAllByCss(selector: string): PageElements;
+    abstract findAllByTagName(selector: string): PageElements;
+    abstract findAllByXPath(selector: string): PageElements;
+    abstract browserCapabilities(): Promise<BrowserCapabilities>;
+    abstract sendKeys(keys: Array<Key | string>): Promise<void>;
+    abstract executeScript<Result, InnerArguments extends any[]>(script: string | ((...parameters: InnerArguments) => Result), ...args: InnerArguments): Promise<Result>;
+    abstract executeAsyncScript<Result, Parameters extends any[]>(script: string | ((...args: [...parameters: Parameters, callback: (result: Result) => void]) => void), ...args: Parameters): Promise<Result>;
+    abstract lastScriptExecutionResult<R = any>(): R;
+    abstract takeScreenshot(): Promise<string>;
+    /**
+     * @desc
+     *  Returns a {@link Page} representing the currently active top-level browsing context.
+     *
+     * @returns {Promise<Page>}
+     */
+    abstract currentPage(): Promise<Page>;
+    /**
+     * @desc
+     *  Returns an array of {@link Page} objects representing all the available
+     *  top-level browsing context, e.g. all the open browser tabs.
+     *
+     * @returns {Promise<Array<Page>>}
+     */
+    abstract allPages(): Promise<Array<Page>>;
+    abstract cookie(name: string): Promise<Cookie>;
+    abstract setCookie(cookieData: CookieData): Promise<void>;
+    abstract deleteAllCookies(): Promise<void>;
+    abstract modalDialog(): Promise<ModalDialog>;
+    abstract switchToFrame(targetOrIndex: PageElement | number | string): Promise<void>;
+    abstract switchToParentFrame(): Promise<void>;
+    abstract switchToDefaultContent(): Promise<void>;
+}

package/lib/screenplay/abilities/BrowseTheWeb.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowseTheWeb = void 0;
+class BrowseTheWeb {
+    /**
+     * @desc
+     *  Used to access the Actor's ability to {@link BrowseTheWeb}
+     *  from within the {@link @serenity-js/core/lib/screenplay~Interaction} classes,
+     *  such as {@link Click}.
+     *
+     * @param {@serenity-js/core/lib/screenplay/actor~UsesAbilities} actor
+     * @return {BrowseTheWeb}
+     */
+    static as(actor) {
+        return actor.abilityTo(BrowseTheWeb);
+    }
+}
+exports.BrowseTheWeb = BrowseTheWeb;
+//# sourceMappingURL=BrowseTheWeb.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BrowseTheWeb.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWeb.ts"],"names":[],"mappings":";;;AAMA,MAAsB,YAAY;IAC9B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,CAAC,KAAoB;QAC1B,OAAO,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IACzC,CAAC;CAqEJ;AAjFD,oCAiFC"}

package/lib/screenplay/abilities/BrowserCapabilities.d.ts

@@ -0,0 +1,5 @@
+export interface BrowserCapabilities {
+    platformName?: string;
+    browserName?: string;
+    browserVersion?: string;
+}

package/lib/screenplay/abilities/BrowserCapabilities.js

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

package/lib/screenplay/abilities/BrowserCapabilities.js.map

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

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

@@ -0,0 +1,2 @@
+export * from './BrowserCapabilities';
+export * from './BrowseTheWeb';

package/lib/screenplay/abilities/index.js

@@ -0,0 +1,15 @@
+"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("./BrowserCapabilities"), exports);
+__exportStar(require("./BrowseTheWeb"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAAsC;AACtC,iDAA+B"}

package/lib/screenplay/index.d.ts

@@ -0,0 +1,4 @@
+export * from './abilities';
+export * from './interactions';
+export * from './models';
+export * from './questions';

package/lib/screenplay/index.js

@@ -0,0 +1,17 @@
+"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("./abilities"), exports);
+__exportStar(require("./interactions"), exports);
+__exportStar(require("./models"), exports);
+__exportStar(require("./questions"), exports);
+//# sourceMappingURL=index.js.map

package/lib/screenplay/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/screenplay/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,2CAAyB;AACzB,8CAA4B"}

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

@@ -0,0 +1,79 @@
+import { Answerable, AnswersQuestions, Interaction, UsesAbilities } from '@serenity-js/core';
+import { PageElement } from '../models';
+import { PageElementInteraction } from './PageElementInteraction';
+/**
+ * @desc
+ *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
+ *  clear the `value` of a [form `input`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
+ *
+ * @example <caption>Example widget</caption>
+ *  <form>
+ *    <input type="text" name="example" id="example" />
+ *  </form>
+ *
+ * @example <caption>Lean Page Object describing the widget</caption>
+ *  import { by, Target } from '@serenity-js/webdriverio';
+ *
+ *  class Form {
+ *      static exampleInput = Target.the('example input')
+ *          .located(by.id('example'));
+ *  }
+ *
+ * @example <caption>Clearing the value of an input field</caption>
+ *  import { actorCalled } from '@serenity-js/core';
+ *  import { BrowseTheWeb, Clear, Enter, Value } from '@serenity-js/webdriverio';
+ *  import { Ensure, equals } from '@serenity-js/assertions';
+ *
+ *  actorCalled('Inés')
+ *      .whoCan(BrowseTheWeb.using(browser))
+ *      .attemptsTo(
+ *          Enter.theValue('Hello world!').into(Form.exampleInput),
+ *          Ensure.that(Value.of(Form.exampleInput), equals('Hello world!')),
+ *
+ *          Clear.theValueOf(Form.exampleInput),
+ *          Ensure.that(Value.of(Form.exampleInput), equals('')),
+ *      );
+ *
+ * @see {@link BrowseTheWeb}
+ * @see {@link Enter}
+ * @see {@link Value}
+ * @see {@link Target}
+ * @see {@link @serenity-js/assertions~Ensure}
+ * @see {@link @serenity-js/assertions/lib/expectations~equals}
+ *
+ * @extends {@serenity-js/core/lib/screenplay~Interaction}
+ */
+export declare class Clear extends PageElementInteraction {
+    private readonly field;
+    /**
+     * @desc
+     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
+     *
+     * @param {Answerable<PageElement>} field
+     *  The field to be cleared
+     *
+     * @returns {@serenity-js/core/lib/screenplay~Interaction}
+     */
+    static theValueOf(field: Answerable<PageElement>): Interaction;
+    /**
+     * @param {Answerable<PageElement>} field
+     *  The element to be clicked on
+     */
+    constructor(field: Answerable<PageElement>);
+    /**
+     * @desc
+     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
+     *  perform this {@link @serenity-js/core/lib/screenplay~Interaction}.
+     *
+     * @param {UsesAbilities & AnswersQuestions} actor
+     *  An {@link @serenity-js/core/lib/screenplay/actor~Actor} to perform this {@link @serenity-js/core/lib/screenplay~Interaction}
+     *
+     * @returns {PromiseLike<void>}
+     *
+     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
+     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
+     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
+     */
+    performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>;
+    private capitaliseFirstLetter;
+}

package/lib/screenplay/interactions/Clear.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Clear = void 0;
+const core_1 = require("@serenity-js/core");
+const io_1 = require("@serenity-js/core/lib/io");
+const PageElementInteraction_1 = require("./PageElementInteraction");
+/**
+ * @desc
+ *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
+ *  clear the `value` of a [form `input`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
+ *
+ * @example <caption>Example widget</caption>
+ *  <form>
+ *    <input type="text" name="example" id="example" />
+ *  </form>
+ *
+ * @example <caption>Lean Page Object describing the widget</caption>
+ *  import { by, Target } from '@serenity-js/webdriverio';
+ *
+ *  class Form {
+ *      static exampleInput = Target.the('example input')
+ *          .located(by.id('example'));
+ *  }
+ *
+ * @example <caption>Clearing the value of an input field</caption>
+ *  import { actorCalled } from '@serenity-js/core';
+ *  import { BrowseTheWeb, Clear, Enter, Value } from '@serenity-js/webdriverio';
+ *  import { Ensure, equals } from '@serenity-js/assertions';
+ *
+ *  actorCalled('Inés')
+ *      .whoCan(BrowseTheWeb.using(browser))
+ *      .attemptsTo(
+ *          Enter.theValue('Hello world!').into(Form.exampleInput),
+ *          Ensure.that(Value.of(Form.exampleInput), equals('Hello world!')),
+ *
+ *          Clear.theValueOf(Form.exampleInput),
+ *          Ensure.that(Value.of(Form.exampleInput), equals('')),
+ *      );
+ *
+ * @see {@link BrowseTheWeb}
+ * @see {@link Enter}
+ * @see {@link Value}
+ * @see {@link Target}
+ * @see {@link @serenity-js/assertions~Ensure}
+ * @see {@link @serenity-js/assertions/lib/expectations~equals}
+ *
+ * @extends {@serenity-js/core/lib/screenplay~Interaction}
+ */
+class Clear extends PageElementInteraction_1.PageElementInteraction {
+    /**
+     * @param {Answerable<PageElement>} field
+     *  The element to be clicked on
+     */
+    constructor(field) {
+        super((0, io_1.formatted) `#actor clears the value of ${field}`);
+        this.field = field;
+    }
+    /**
+     * @desc
+     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
+     *
+     * @param {Answerable<PageElement>} field
+     *  The field to be cleared
+     *
+     * @returns {@serenity-js/core/lib/screenplay~Interaction}
+     */
+    static theValueOf(field) {
+        return new Clear(field);
+    }
+    /**
+     * @desc
+     *  Makes the provided {@link @serenity-js/core/lib/screenplay/actor~Actor}
+     *  perform this {@link @serenity-js/core/lib/screenplay~Interaction}.
+     *
+     * @param {UsesAbilities & AnswersQuestions} actor
+     *  An {@link @serenity-js/core/lib/screenplay/actor~Actor} to perform this {@link @serenity-js/core/lib/screenplay~Interaction}
+     *
+     * @returns {PromiseLike<void>}
+     *
+     * @see {@link @serenity-js/core/lib/screenplay/actor~Actor}
+     * @see {@link @serenity-js/core/lib/screenplay/actor~UsesAbilities}
+     * @see {@link @serenity-js/core/lib/screenplay/actor~AnswersQuestions}
+     */
+    async performAs(actor) {
+        const element = await this.resolve(actor, this.field);
+        const value = await element.value();
+        if (value === null || value === undefined) {
+            throw new core_1.LogicError(this.capitaliseFirstLetter((0, io_1.formatted) `${this.field} doesn't seem to have a 'value' attribute that could be cleared.`));
+        }
+        return element.clearValue();
+    }
+    capitaliseFirstLetter(text) {
+        return text.charAt(0).toUpperCase() + text.slice(1);
+    }
+}
+exports.Clear = Clear;
+//# sourceMappingURL=Clear.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Clear.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Clear.ts"],"names":[],"mappings":";;;AAAA,4CAAyG;AACzG,iDAAqD;AAGrD,qEAAkE;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAa,KAAM,SAAQ,+CAAsB;IAe7C;;;OAGG;IACH,YAA6B,KAA8B;QACvD,KAAK,CAAC,IAAA,cAAS,EAAC,8BAA+B,KAAM,EAAE,CAAC,CAAC;QADhC,UAAK,GAAL,KAAK,CAAyB;IAE3D,CAAC;IAnBD;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CAAC,KAA8B;QAC5C,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAUD;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,OAAO,GAAK,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACxD,MAAM,KAAK,GAAO,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QAExC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;YACvC,MAAM,IAAI,iBAAU,CAChB,IAAI,CAAC,qBAAqB,CAAC,IAAA,cAAS,EAAC,GAAI,IAAI,CAAC,KAAM,kEAAkE,CAAC,CAC1H,CAAC;SACL;QAED,OAAO,OAAO,CAAC,UAAU,EAAE,CAAC;IAChC,CAAC;IAEO,qBAAqB,CAAC,IAAY;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;CACJ;AArDD,sBAqDC"}