@serenity-js/webdriverio 2.33.1 → 3.0.0-rc.11

package/lib/stage/crew/photographer/strategies/TakePhotosBeforeAndAfterInteractions.d.ts

@@ -1,18 +0,0 @@
-import { DomainEvent, InteractionFinished, InteractionStarts } from '@serenity-js/core/lib/events';
-import { PhotoTakingStrategy } from './PhotoTakingStrategy';
-/**
- * @desc
- *  Configures the {@link Photographer} to take photos (a.k.a. screenshots) both before and after
- *  every single {@link @serenity-js/core/lib/screenplay~Interaction} performed
- *  by the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight.
- *
- *  *Please note* that this strategy will result in _a lot_ of screenshots being taken,
- *  which will seriously affect the performance of your tests.
- *  For this reason, it's best to use it only for debugging purposes.
- *
- * @extends {PhotoTakingStrategy}
- */
-export declare class TakePhotosBeforeAndAfterInteractions extends PhotoTakingStrategy {
-    protected shouldTakeAPhotoOf(event: DomainEvent): boolean;
-    protected photoNameFor(event: InteractionStarts | InteractionFinished): string;
-}

package/lib/stage/crew/photographer/strategies/TakePhotosBeforeAndAfterInteractions.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TakePhotosBeforeAndAfterInteractions = void 0;
-const events_1 = require("@serenity-js/core/lib/events");
-const PhotoTakingStrategy_1 = require("./PhotoTakingStrategy");
-/**
- * @desc
- *  Configures the {@link Photographer} to take photos (a.k.a. screenshots) both before and after
- *  every single {@link @serenity-js/core/lib/screenplay~Interaction} performed
- *  by the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight.
- *
- *  *Please note* that this strategy will result in _a lot_ of screenshots being taken,
- *  which will seriously affect the performance of your tests.
- *  For this reason, it's best to use it only for debugging purposes.
- *
- * @extends {PhotoTakingStrategy}
- */
-class TakePhotosBeforeAndAfterInteractions extends PhotoTakingStrategy_1.PhotoTakingStrategy {
-    shouldTakeAPhotoOf(event) {
-        return event instanceof events_1.InteractionStarts
-            || event instanceof events_1.InteractionFinished;
-    }
-    photoNameFor(event) {
-        return event instanceof events_1.InteractionStarts
-            ? `Before ${event.details.name.value}`
-            : `After ${event.details.name.value}`;
-    }
-}
-exports.TakePhotosBeforeAndAfterInteractions = TakePhotosBeforeAndAfterInteractions;
-//# sourceMappingURL=TakePhotosBeforeAndAfterInteractions.js.map

package/lib/stage/crew/photographer/strategies/TakePhotosBeforeAndAfterInteractions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TakePhotosBeforeAndAfterInteractions.js","sourceRoot":"","sources":["../../../../../src/stage/crew/photographer/strategies/TakePhotosBeforeAndAfterInteractions.ts"],"names":[],"mappings":";;;AAAA,yDAAmG;AAEnG,+DAA4D;AAE5D;;;;;;;;;;;GAWG;AACH,MAAa,oCAAqC,SAAQ,yCAAmB;IAC/D,kBAAkB,CAAC,KAAkB;QAC3C,OAAO,KAAK,YAAY,0BAAiB;eAClC,KAAK,YAAY,4BAAmB,CAAC;IAChD,CAAC;IAES,YAAY,CAAC,KAA8C;QACjE,OAAO,KAAK,YAAY,0BAAiB;YACrC,CAAC,CAAC,UAAW,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAM,EAAE;YACxC,CAAC,CAAC,SAAU,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAM,EAAE,CAAC;IAChD,CAAC;CACJ;AAXD,oFAWC"}

package/lib/stage/crew/photographer/strategies/TakePhotosOfFailures.d.ts

@@ -1,17 +0,0 @@
-import { DomainEvent, InteractionFinished } from '@serenity-js/core/lib/events';
-import { PhotoTakingStrategy } from './PhotoTakingStrategy';
-/**
- * @desc
- *  Configures the {@link Photographer} to take photos (a.k.a. screenshots) when
- *  the {@link @serenity-js/core/lib/screenplay~Interaction} performed
- *  by the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight results in an error.
- *
- *  This strategy works best when you are interested in the screenshots only when
- *  a scenario fails.
- *
- * @extends {PhotoTakingStrategy}
- */
-export declare class TakePhotosOfFailures extends PhotoTakingStrategy {
-    protected shouldTakeAPhotoOf(event: DomainEvent): boolean;
-    protected photoNameFor(event: InteractionFinished): string;
-}

package/lib/stage/crew/photographer/strategies/TakePhotosOfFailures.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TakePhotosOfFailures = void 0;
-const events_1 = require("@serenity-js/core/lib/events");
-const model_1 = require("@serenity-js/core/lib/model");
-const PhotoTakingStrategy_1 = require("./PhotoTakingStrategy");
-/**
- * @desc
- *  Configures the {@link Photographer} to take photos (a.k.a. screenshots) when
- *  the {@link @serenity-js/core/lib/screenplay~Interaction} performed
- *  by the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight results in an error.
- *
- *  This strategy works best when you are interested in the screenshots only when
- *  a scenario fails.
- *
- * @extends {PhotoTakingStrategy}
- */
-class TakePhotosOfFailures extends PhotoTakingStrategy_1.PhotoTakingStrategy {
-    shouldTakeAPhotoOf(event) {
-        return event instanceof events_1.InteractionFinished
-            && event.outcome.isWorseThan(model_1.ImplementationPending);
-    }
-    photoNameFor(event) {
-        return event.details.name.value;
-    }
-}
-exports.TakePhotosOfFailures = TakePhotosOfFailures;
-//# sourceMappingURL=TakePhotosOfFailures.js.map

package/lib/stage/crew/photographer/strategies/TakePhotosOfFailures.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TakePhotosOfFailures.js","sourceRoot":"","sources":["../../../../../src/stage/crew/photographer/strategies/TakePhotosOfFailures.ts"],"names":[],"mappings":";;;AAAA,yDAAgF;AAChF,uDAAoE;AAEpE,+DAA4D;AAE5D;;;;;;;;;;GAUG;AACH,MAAa,oBAAqB,SAAQ,yCAAmB;IAC/C,kBAAkB,CAAC,KAAkB;QAC3C,OAAO,KAAK,YAAY,4BAAmB;eACpC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,6BAAqB,CAAC,CAAC;IAC5D,CAAC;IAES,YAAY,CAAC,KAA0B;QAC7C,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;IACpC,CAAC;CACJ;AATD,oDASC"}

package/lib/stage/crew/photographer/strategies/TakePhotosOfInteractions.d.ts

@@ -1,19 +0,0 @@
-import { DomainEvent, InteractionFinished } from '@serenity-js/core/lib/events';
-import { PhotoTakingStrategy } from './PhotoTakingStrategy';
-/**
- * @desc
- *  Configures the {@link Photographer} to take photos (a.k.a. screenshots) when
- *  the the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight
- *  performs any {@link @serenity-js/core/lib/screenplay~Interaction}.
- *
- *  This strategy works best when you want the results of your automated tests
- *  to become comprehensive living documentation of your system.
- *
- *  *Please note* that taking screenshots affects the performance of your tests.
- *
- * @extends {PhotoTakingStrategy}
- */
-export declare class TakePhotosOfInteractions extends PhotoTakingStrategy {
-    protected shouldTakeAPhotoOf(event: DomainEvent): boolean;
-    protected photoNameFor(event: InteractionFinished): string;
-}

package/lib/stage/crew/photographer/strategies/TakePhotosOfInteractions.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TakePhotosOfInteractions = void 0;
-const events_1 = require("@serenity-js/core/lib/events");
-const PhotoTakingStrategy_1 = require("./PhotoTakingStrategy");
-/**
- * @desc
- *  Configures the {@link Photographer} to take photos (a.k.a. screenshots) when
- *  the the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight
- *  performs any {@link @serenity-js/core/lib/screenplay~Interaction}.
- *
- *  This strategy works best when you want the results of your automated tests
- *  to become comprehensive living documentation of your system.
- *
- *  *Please note* that taking screenshots affects the performance of your tests.
- *
- * @extends {PhotoTakingStrategy}
- */
-class TakePhotosOfInteractions extends PhotoTakingStrategy_1.PhotoTakingStrategy {
-    shouldTakeAPhotoOf(event) {
-        return event instanceof events_1.InteractionFinished;
-    }
-    photoNameFor(event) {
-        return event.details.name.value;
-    }
-}
-exports.TakePhotosOfInteractions = TakePhotosOfInteractions;
-//# sourceMappingURL=TakePhotosOfInteractions.js.map

package/lib/stage/crew/photographer/strategies/TakePhotosOfInteractions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TakePhotosOfInteractions.js","sourceRoot":"","sources":["../../../../../src/stage/crew/photographer/strategies/TakePhotosOfInteractions.ts"],"names":[],"mappings":";;;AAAA,yDAAgF;AAEhF,+DAA4D;AAE5D;;;;;;;;;;;;GAYG;AACH,MAAa,wBAAyB,SAAQ,yCAAmB;IACnD,kBAAkB,CAAC,KAAkB;QAC3C,OAAO,KAAK,YAAY,4BAAmB,CAAC;IAChD,CAAC;IAES,YAAY,CAAC,KAA0B;QAC7C,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;IACpC,CAAC;CACJ;AARD,4DAQC"}

package/lib/stage/crew/photographer/strategies/index.d.ts

@@ -1,4 +0,0 @@
-export * from './PhotoTakingStrategy';
-export * from './TakePhotosBeforeAndAfterInteractions';
-export * from './TakePhotosOfFailures';
-export * from './TakePhotosOfInteractions';

package/lib/stage/crew/photographer/strategies/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/stage/crew/photographer/strategies/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAAsC;AACtC,yEAAuD;AACvD,yDAAuC;AACvC,6DAA2C"}

package/lib/stage/index.d.ts

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

package/lib/stage/index.js

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

package/lib/stage/index.js.map

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

package/src/expectations/ElementExpectation.ts

@@ -1,31 +0,0 @@
-import { AnswersQuestions, Expectation, ExpectationMet, ExpectationNotMet, ExpectationOutcome } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-
-/**
- * @access private
- */
-export class ElementExpectation extends Expectation<any, Element<'async'>> {
-    static forElementTo(message: string, fn: (actual: Element<'async'>) => Promise<boolean>): Expectation<any, Element<'async'>> {
-        return new ElementExpectation(message, fn);
-    }
-
-    constructor(
-        subject: string,
-        private readonly fn: (actual: Element<'async'>) => Promise<boolean>,
-    ) {
-        super(subject);
-    }
-
-    answeredBy(actor: AnswersQuestions): (actual: Element<'async'>) => Promise<ExpectationOutcome<boolean, Element<'async'>>> {
-        return (actual: Element<'async'>) =>
-            this.fn(actual)
-                .then(expectationMet =>
-                    expectationMet
-                        ? new ExpectationMet(this.toString(), undefined, actual)
-                        : new ExpectationNotMet(this.toString(), undefined, actual),
-                )
-                .catch(error => {
-                    return new ExpectationNotMet(`${ this.toString() } (${ error.message })`, undefined, actual);
-                });
-    }
-}

package/src/expectations/index.ts

@@ -1,6 +0,0 @@
-export * from './isActive';
-export * from './isClickable';
-export * from './isEnabled';
-export * from './isPresent';
-export * from './isSelected';
-export * from './isVisible';

package/src/expectations/isActive.ts

@@ -1,21 +0,0 @@
-import { Expectation } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-
-import { ElementExpectation } from './ElementExpectation';
-
-/**
- * @desc
- *  Expectation that the element is active (has focus).
- *  If the selector matches multiple elements, it will return true if one of the elements has focus.
- *
- * @returns {@serenity-js/core/lib/screenplay/questions~Expectation<boolean, Element<'async'>>}
- *
- * @see https://webdriver.io/docs/api/element/isFocused/
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link @serenity-js/core/lib/screenplay/questions~Check}
- * @see {@link Wait}
- */
-export function isActive(): Expectation<boolean, Element<'async'>> {
-    return ElementExpectation.forElementTo('become active', actual => actual.isFocused());
-}
-

package/src/expectations/isClickable.ts

@@ -1,26 +0,0 @@
-import { Expectation } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-
-import { ElementExpectation } from './ElementExpectation';
-
-/**
- * @desc
- *  Expectation that an element is clickable, which means:
- *  - it exists
- *  - it is visible
- *  - it is within viewport (if not, try to scroll to it)
- *  - its center is not overlapped with another element
- *  - it is not disabled
- *  otherwise return false.
- *
- * @returns {@serenity-js/core/lib/screenplay/questions~Expectation<boolean, Element<'async'>>}
- *
- * @see https://webdriver.io/docs/api/element/isClickable/
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link @serenity-js/core/lib/screenplay/questions~Check}
- * @see {@link Wait}
- */
-export function isClickable(): Expectation<boolean, Element<'async'>> {
-    return ElementExpectation.forElementTo('become clickable', actual => actual.isClickable());
-}
-

package/src/expectations/isEnabled.ts

@@ -1,19 +0,0 @@
-import { Expectation } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-
-import { ElementExpectation } from './ElementExpectation';
-
-/**
- * @desc
- *  Expectation that the element is enabled.
- *
- * @returns {@serenity-js/core/lib/screenplay/questions~Expectation<boolean, Element<'async'>>}
- *
- * @see https://webdriver.io/docs/api/element/isEnabled/
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link @serenity-js/core/lib/screenplay/questions~Check}
- * @see {@link Wait}
- */
-export function isEnabled(): Expectation<boolean, Element<'async'>> {
-    return ElementExpectation.forElementTo('become enabled', actual => actual.isEnabled());
-}

package/src/expectations/isPresent.ts

@@ -1,20 +0,0 @@
-import { Expectation } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-
-import { ElementExpectation } from './ElementExpectation';
-
-/**
- * @desc
- *  Expectation that the element is present in the DOM of a page.
- *  Please note that this does not necessarily mean that the element is visible.
- *
- * @returns {@serenity-js/core/lib/screenplay/questions~Expectation<boolean, Element<'async'>>}
- *
- * @see https://webdriver.io/docs/api/element/isExisting/
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link @serenity-js/core/lib/screenplay/questions~Check}
- * @see {@link Wait}
- */
-export function isPresent(): Expectation<boolean, Element<'async'>> {
-    return ElementExpectation.forElementTo('become present', actual => actual.isExisting());
-}

package/src/expectations/isSelected.ts

@@ -1,19 +0,0 @@
-import { Expectation } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-
-import { ElementExpectation } from './ElementExpectation';
-
-/**
- * @desc
- *  Expectation that an `<option>` or `<input>` element of type checkbox or radio is currently selected.
- *
- * @returns {@serenity-js/core/lib/screenplay/questions~Expectation<boolean, Element<'async'>>}
- *
- * @see https://webdriver.io/docs/api/element/isSelected/
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link @serenity-js/core/lib/screenplay/questions~Check}
- * @see {@link Wait}
- */
-export function isSelected(): Expectation<boolean, Element<'async'>> {
-    return ElementExpectation.forElementTo('become selected', actual => actual.isSelected());
-}

package/src/expectations/isVisible.ts

@@ -1,19 +0,0 @@
-import { Expectation } from '@serenity-js/core';
-import { Element } from 'webdriverio';
-
-import { ElementExpectation } from './ElementExpectation';
-
-/**
- * @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 function isVisible(): Expectation<boolean, Element<'async'>> {
-    return ElementExpectation.forElementTo('become visible', actual => actual.isDisplayed());
-}

package/src/input/Key.ts

@@ -1,83 +0,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
- */
-export class Key {
-    public static Alt = new Key('Alt', '\uE00A', true);
-    public static ArrowDown = new Key('ArrowDown', '\uE015');
-    public static ArrowLeft = new Key('ArrowLeft', '\uE012');
-    public static ArrowRight = new Key('ArrowRight', '\uE014');
-    public static ArrowUp = new Key('ArrowUp', '\uE013');
-    public static Backspace = new Key('Backspace', '\uE003');
-    public static Cancel = new Key('Cancel', '\uE001');
-    public static Clear = new Key('Clear', '\uE005');
-    public static Control = new Key('Control', '\uE009', true);
-    public static Delete = new Key('Delete', '\uE017');
-    public static End = new Key('End', '\uE010');
-    public static Enter = new Key('Enter', '\uE007');
-    public static Escape = new Key('Escape', '\uE00C');
-    public static F1 = new Key('F1', '\uE031');
-    public static F2 = new Key('F2', '\uE032');
-    public static F3 = new Key('F3', '\uE033');
-    public static F4 = new Key('F4', '\uE034');
-    public static F5 = new Key('F5', '\uE035');
-    public static F6 = new Key('F6', '\uE036');
-    public static F7 = new Key('F7', '\uE037');
-    public static F8 = new Key('F8', '\uE038');
-    public static F9 = new Key('F9', '\uE039');
-    public static F10 = new Key('F10', '\uE03A');
-    public static F11 = new Key('F11', '\uE03B');
-    public static F12 = new Key('F12', '\uE03C');
-    public static Help = new Key('Help', '\uE002');
-    public static Home = new Key('Home', '\uE011');
-    public static Insert = new Key('Insert', '\uE016');
-    public static Meta = new Key('Meta', '\uE03D', true);
-    public static Numpad0 = new Key('Numpad0', '\uE01A');
-    public static Numpad1 = new Key('Numpad1', '\uE01B');
-    public static Numpad2 = new Key('Numpad2', '\uE01C');
-    public static Numpad3 = new Key('Numpad3', '\uE01D');
-    public static Numpad4 = new Key('Numpad4', '\uE01E');
-    public static Numpad5 = new Key('Numpad5', '\uE01F');
-    public static Numpad6 = new Key('Numpad6', '\uE020');
-    public static Numpad7 = new Key('Numpad7', '\uE021');
-    public static Numpad8 = new Key('Numpad8', '\uE022');
-    public static Numpad9 = new Key('Numpad9', '\uE023');
-    public static NumpadAdd = new Key('NumpadAdd', '\uE025');
-    public static NumpadDecimal = new Key('NumpadDecimal', '\uE028');
-    public static NumpadDivide = new Key('NumpadDivide', '\uE029');
-    public static NumpadEqual = new Key('NumpadEqual', '\uE019');
-    public static NumpadMultiply = new Key('NumpadMultiply', '\uE024');
-    public static NumpadSubtract = new Key('NumpadSubtract', '\uE027');
-    public static PageDown = new Key('PageDown', '\uE00F');
-    public static PageUp = new Key('PageUp', '\uE00E');
-    public static Pause = new Key('Pause', '\uE00B');
-    public static Semicolon = new Key('Semicolon', '\uE018');
-    public static Shift = new Key('Shift', '\uE008', true);
-    public static Space = new Key('Space', '\uE00D');
-    public static Tab = new Key('Tab', '\uE004');
-
-    public static isKey(maybeKey: unknown): maybeKey is Key {
-        return !! maybeKey
-            && maybeKey instanceof Key;
-    }
-
-    constructor(
-        public readonly devtoolsName: string,
-        public readonly utf16codePoint: string,
-        public readonly isModifier: boolean = false,
-    ) {
-    }
-
-    toString(): string {
-        return this.devtoolsName;
-    }
-}

package/src/input/index.ts

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

package/src/screenplay/interactions/Clear.ts

@@ -1,102 +0,0 @@
-import { Answerable, AnswersQuestions, Interaction, LogicError, UsesAbilities } from '@serenity-js/core';
-import { formatted } from '@serenity-js/core/lib/io';
-import { Element } from 'webdriverio';
-
-import { WebElementInteraction } from './WebElementInteraction';
-
-/**
- * @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 class Clear extends WebElementInteraction {
-
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Answerable<Element<'async'>>} field
-     *  The field to be cleared
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static theValueOf(field: Answerable<Element<'async'>>): Interaction {
-        return new Clear(field);
-    }
-
-    /**
-     * @param {Answerable<Element<'async'>>} field
-     *  The element to be clicked on
-     */
-    constructor(private readonly field: Answerable<Element<'async'>>) {
-        super(formatted `#actor clears the value of ${ 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: UsesAbilities & AnswersQuestions): Promise<void> {
-        const element   = await this.resolve(actor, this.field);
-        const value     = await element.getValue();
-
-        if (value === undefined) {
-            throw new LogicError(
-                this.capitaliseFirstLetter(formatted `${ this.field } doesn't seem to have a 'value' attribute that could be cleared.`),
-            );
-        }
-
-        return element.clearValue();
-    }
-
-    private capitaliseFirstLetter(text: string) {
-        return text.charAt(0).toUpperCase() + text.slice(1);
-    }
-}

package/src/screenplay/interactions/Click.ts

@@ -1,85 +0,0 @@
-import { Answerable, AnswersQuestions, Interaction, UsesAbilities } from '@serenity-js/core';
-import { formatted } from '@serenity-js/core/lib/io';
-import { Element } from 'webdriverio';
-
-import { WebElementInteraction } from './WebElementInteraction';
-
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  [click](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) on a given Web element.
- *
- * @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>Clicking on an element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Click, isSelected } from '@serenity-js/webdriverio';
- *  import { Ensure } from '@serenity-js/assertions';
- *
- *  actorCalled('Chloé')
- *      .whoCan(BrowseTheWeb.using(browser))
- *      .attemptsTo(
- *          Click.on(Form.exampleInput),
- *          Ensure.that(Form.exampleInput, isSelected()),
- *      );
- *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link isSelected}
- *
- * @extends {WebElementInteraction}
- */
-export class Click extends WebElementInteraction {
-
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be clicked on
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static on(target: Answerable<Element<'async'>>): Interaction {
-        return new Click(target);
-    }
-
-    /**
-     * @param {Answerable<Element<'async'>>} target
-     *  The element to be clicked on
-     */
-    constructor(private readonly target: Answerable<Element<'async'>>) {
-        super(formatted `#actor clicks on ${ target }`);
-    }
-
-    /**
-     * @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: UsesAbilities & AnswersQuestions): Promise<void> {
-        const element = await this.resolve(actor, this.target);
-        return element.click();
-    }
-}