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

package/lib/screenplay/interactions/Navigate.js

@@ -1,345 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Navigate = void 0;
-const core_1 = require("@serenity-js/core");
-const io_1 = require("@serenity-js/core/lib/io");
-const promiseOf_1 = require("../../promiseOf");
-const abilities_1 = require("../abilities");
-/**
- * @desc
- *  Allows the {@link @serenity-js/core/lib/screenplay/actor~Actor} to navigate to a specific destination,
- *  as well as back and forth in the browser history, or reload the current page.
- */
-class Navigate {
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
-     *  navigate to a given URL.
-     *
-     *  The URL can be:
-     *  - absolute, i.e. `https://example.org/search`
-     *  - relative, i.e. `/search`
-     *
-     *  If the URL is relative, Protractor will append it to `baseUrl` configured in [`protractor.conf.js`](https://github.com/angular/protractor/blob/master/lib/config.ts).
-     *
-     * @example <caption>protractor.conf.js</caption>
-     *  exports.config = {
-     *      baseUrl: 'https://example.org',
-     *      // ...
-     *  }
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/protractor';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(protractor.browser))
-     *      .attemptsTo(
-     *          Navigate.to('/search'),
-     *      );
-     *
-     * @example <caption>Navigate to an absolute URL (overrides baseUrl)</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/protractor';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(protractor.browser))
-     *      .attemptsTo(
-     *          Navigate.to('https://mycompany.org/login'),
-     *      );
-     *
-     * @example <caption>Navigate to URL with timeout</caption>
-     *  import { actorCalled, Duration } from '@serenity-js/core';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/protractor';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(protractor.browser))
-     *      .attemptsTo(
-     *          Navigate.to('/search').withTimeout(Duration.ofSeconds(2)),
-     *      );
-     *
-     * @param {Answerable<string>} url
-     *  An absolute URL or path an {@link @serenity-js/core/lib/screenplay/actor~Actor} should navigate to
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction & { withTimeout: (duration: Answerable<Duration>) => Interaction }}
-     *
-     * @see {@link BrowseTheWeb}
-     * @see {@link @serenity-js/core~Duration}
-     */
-    static to(url) {
-        return new NavigateToUrl(url);
-    }
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
-     *  navigate back one page in the session history.
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { Ensure, endsWith } from '@serenity-js/assertions';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/protractor';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(protractor.browser))
-     *      .attemptsTo(
-     *          Navigate.to('/first'),
-     *          Navigate.to('/second'),
-     *
-     *          Navigate.back(),
-     *
-     *          Ensure.that(Website.url(), endsWith('/first')),
-     *      );
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link BrowseTheWeb}
-     * @see {@link @serenity-js/assertions~Ensure}
-     * @see {@link @serenity-js/assertions/lib/expectations~endsWith}
-     */
-    static back() {
-        return new NavigateBack();
-    }
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
-     *  navigate forward one page in the session history.
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { Ensure, endsWith } from '@serenity-js/assertions';
-     *  import { BrowseTheWeb, Navigate } from '@serenity-js/protractor';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(protractor.browser))
-     *      .attemptsTo(
-     *          Navigate.to('/first'),
-     *          Navigate.to('/second'),
-     *
-     *          Navigate.back(),
-     *          Navigate.forward(),
-     *
-     *          Ensure.that(Website.url(), endsWith('/second')),
-     *      );
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link BrowseTheWeb}
-     * @see {@link @serenity-js/assertions~Ensure}
-     * @see {@link @serenity-js/assertions/lib/expectations~endsWith}
-     */
-    static forward() {
-        return new NavigateForward();
-    }
-    /**
-     * @desc
-     *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
-     *  reload the current page.
-     *
-     * @example <caption>Navigate to path relative to baseUrl</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { Ensure, endsWith } from '@serenity-js/assertions';
-     *  import { Navigate, BrowseTheWeb, DeleteCookies } from '@serenity-js/protractor';
-     *
-     *  actorCalled('Hannu')
-     *      .whoCan(BrowseTheWeb.using(protractor.browser))
-     *      .attemptsTo(
-     *          Navigate.to('/login'),
-     *          DeleteCookies.called('session_id'),
-     *          Navigate.reloadPage(),
-     *      );
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link BrowseTheWeb}
-     * @see {@link DeleteCookies}
-     * @see {@link @serenity-js/assertions~Ensure}
-     * @see {@link @serenity-js/assertions/lib/expectations~endsWith}
-     */
-    static reloadPage() {
-        return new ReloadPage();
-    }
-}
-exports.Navigate = Navigate;
-/**
- * @package
- */
-class NavigateToUrl extends core_1.Interaction {
-    constructor(url) {
-        super();
-        this.url = url;
-    }
-    /**
-     * @desc
-     *  Specifies timeout to wait for an Angular app to load.
-     *  Please note that the timeout is ignored if you disable
-     *  synchronisation with Angular.
-     *
-     * @param {Answerable<Duration>} duration
-     */
-    withTimeout(duration) {
-        return new NavigateToUrlWithTimeout(this.url, duration);
-    }
-    /**
-     * @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) {
-        return actor.answer(this.url)
-            .then(url => abilities_1.BrowseTheWeb.as(actor).get(url)
-            .catch(error => {
-            throw new core_1.TestCompromisedError(`Couldn't navigate to ${url}`, error);
-        }));
-    }
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString() {
-        return (0, io_1.formatted) `#actor navigates to ${this.url}`;
-    }
-}
-/**
- * @package
- */
-class NavigateToUrlWithTimeout extends core_1.Interaction {
-    constructor(url, timeout) {
-        super();
-        this.url = url;
-        this.timeout = timeout;
-    }
-    /**
-     * @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) {
-        return Promise.all([
-            actor.answer(this.url),
-            actor.answer(this.timeout),
-        ]).then(([url, timeout]) => abilities_1.BrowseTheWeb.as(actor).get(url, timeout.inMilliseconds()));
-    }
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString() {
-        return (0, io_1.formatted) `#actor navigates to ${this.url} waiting up to ${this.timeout} for Angular to load`;
-    }
-}
-/**
- * @package
- */
-class NavigateBack extends core_1.Interaction {
-    /**
-     * @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) {
-        return (0, promiseOf_1.promiseOf)(abilities_1.BrowseTheWeb.as(actor).navigate().back());
-    }
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString() {
-        return (0, io_1.formatted) `#actor navigates back in the browser history`;
-    }
-}
-/**
- * @package
- */
-class NavigateForward extends core_1.Interaction {
-    /**
-     * @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) {
-        return (0, promiseOf_1.promiseOf)(abilities_1.BrowseTheWeb.as(actor).navigate().forward());
-    }
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString() {
-        return (0, io_1.formatted) `#actor navigates forward in the browser history`;
-    }
-}
-/**
- * @package
- */
-class ReloadPage extends core_1.Interaction {
-    /**
-     * @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) {
-        return (0, promiseOf_1.promiseOf)(abilities_1.BrowseTheWeb.as(actor).navigate().refresh());
-    }
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString() {
-        return (0, io_1.formatted) `#actor reloads the page`;
-    }
-}
-//# sourceMappingURL=Navigate.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Navigate.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Navigate.ts"],"names":[],"mappings":";;;AAAA,4CAA6H;AAC7H,iDAAqD;AAErD,+CAA4C;AAC5C,4CAA4C;AAE5C;;;;GAIG;AACH,MAAa,QAAQ;IAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,MAAM,CAAC,EAAE,CAAC,GAAuB;QAC7B,OAAO,IAAI,aAAa,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,IAAI;QACP,OAAO,IAAI,YAAY,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,OAAO;QACV,OAAO,IAAI,eAAe,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,UAAU;QACb,OAAO,IAAI,UAAU,EAAE,CAAC;IAC5B,CAAC;CACJ;AAxJD,4BAwJC;AAED;;GAEG;AACH,MAAM,aAAc,SAAQ,kBAAW;IACnC,YAA6B,GAAuB;QAChD,KAAK,EAAE,CAAC;QADiB,QAAG,GAAH,GAAG,CAAoB;IAEpD,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,QAA8B;QACtC,OAAO,IAAI,wBAAwB,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,KAAuC;QAC7C,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;aACxB,IAAI,CAAC,GAAG,CAAC,EAAE,CACR,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;aAC1B,KAAK,CAAC,KAAK,CAAC,EAAE;YACX,MAAM,IAAI,2BAAoB,CAAC,wBAAyB,GAAI,EAAE,EAAE,KAAK,CAAC,CAAC;QAC3E,CAAC,CAAC,CACT,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAA,cAAS,EAAC,uBAAwB,IAAI,CAAC,GAAI,EAAE,CAAC;IACzD,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,wBAAyB,SAAQ,kBAAW;IAC9C,YAA6B,GAAuB,EAAmB,OAA6B;QAChG,KAAK,EAAE,CAAC;QADiB,QAAG,GAAH,GAAG,CAAoB;QAAmB,YAAO,GAAP,OAAO,CAAsB;IAEpG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,KAAuC;QAC7C,OAAO,OAAO,CAAC,GAAG,CAAC;YACf,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;YACtB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;SAC7B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,EAAE,CACvB,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,CAC5D,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAA,cAAS,EAAC,uBAAwB,IAAI,CAAC,GAAI,kBAAmB,IAAI,CAAC,OAAQ,sBAAsB,CAAC;IAC7G,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,YAAa,SAAQ,kBAAW;IAElC;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,KAAuC;QAC7C,OAAO,IAAA,qBAAS,EAAC,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAA,cAAS,EAAC,8CAA8C,CAAC;IACpE,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,eAAgB,SAAQ,kBAAW;IAErC;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,KAAuC;QAC7C,OAAO,IAAA,qBAAS,EAAC,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAA,cAAS,EAAC,iDAAiD,CAAC;IACvE,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,UAAW,SAAQ,kBAAW;IAEhC;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,KAAuC;QAC7C,OAAO,IAAA,qBAAS,EAAC,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAA,cAAS,EAAC,yBAAyB,CAAC;IAC/C,CAAC;CACJ"}

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

@@ -1,90 +0,0 @@
-import { AnswersQuestions, Interaction, Question, UsesAbilities } from '@serenity-js/core';
-import { ElementFinder } from 'protractor';
-import { AlertPromise } from 'selenium-webdriver';
-import { PressBuilder } from './PressBuilder';
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  send a key press or a sequence of keys to a Web element.
- *
- *  **Please note** that modifier keys, such as Command ⌘, [won't work on Mac](https://github.com/angular/protractor/issues/690)
- *
- * @example <caption>Example widget</caption>
- *  <form>
- *    <input type="text" name="example" id="example" />
- *  </form>
- *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { Target } from '@serenity-js/protractor';
- *  import { by } from 'protractor';
- *
- *  class Form {
- *      static exampleInput = Target.the('example input')
- *          .located(by.id('example'));
- *  }
- *
- * @example <caption>Pressing keys</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Press, Value } from '@serenity-js/protractor';
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *  import { protractor, Key } from 'protractor';
- *
- *  actorCalled('Priyanka')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Press.the('H', 'i', '!', Key.ENTER).in(Form.exampleInput),
- *          Ensure.that(Value.of(Form.exampleInput), equals('Hi!')),
- *      );
- *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link @serenity-js/assertions/lib/expectations~equals}
- * @see {@link selenium-webdriver~Key}
- *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
- */
-export declare class Press extends Interaction {
-    private readonly keys;
-    private readonly field;
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {...keys: string[]} keys
-     *  A sequence of one or more keys to press
-     *
-     * @returns {PressBuilder}
-     */
-    static the(...keys: string[]): PressBuilder;
-    /**
-     * @param {string[]} keys
-     *  A sequence of one or more keys to press
-     *
-     * @param {Question<ElementFinder> | ElementFinder} field
-     *  Web element to send the keys to
-     */
-    constructor(keys: string[], field: Question<ElementFinder> | ElementFinder | Question<AlertPromise> | AlertPromise);
-    /**
-     * @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): PromiseLike<any>;
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString(): string;
-}

package/lib/screenplay/interactions/Press.js

@@ -1,127 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Press = void 0;
-const core_1 = require("@serenity-js/core");
-const protractor_1 = require("protractor");
-const withAnswerOf_1 = require("../withAnswerOf");
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  send a key press or a sequence of keys to a Web element.
- *
- *  **Please note** that modifier keys, such as Command ⌘, [won't work on Mac](https://github.com/angular/protractor/issues/690)
- *
- * @example <caption>Example widget</caption>
- *  <form>
- *    <input type="text" name="example" id="example" />
- *  </form>
- *
- * @example <caption>Lean Page Object describing the widget</caption>
- *  import { Target } from '@serenity-js/protractor';
- *  import { by } from 'protractor';
- *
- *  class Form {
- *      static exampleInput = Target.the('example input')
- *          .located(by.id('example'));
- *  }
- *
- * @example <caption>Pressing keys</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Press, Value } from '@serenity-js/protractor';
- *  import { Ensure, equals } from '@serenity-js/assertions';
- *  import { protractor, Key } from 'protractor';
- *
- *  actorCalled('Priyanka')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Press.the('H', 'i', '!', Key.ENTER).in(Form.exampleInput),
- *          Ensure.that(Value.of(Form.exampleInput), equals('Hi!')),
- *      );
- *
- * @see {@link BrowseTheWeb}
- * @see {@link Target}
- * @see {@link @serenity-js/assertions~Ensure}
- * @see {@link @serenity-js/assertions/lib/expectations~equals}
- * @see {@link selenium-webdriver~Key}
- *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
- */
-class Press extends core_1.Interaction {
-    /**
-     * @param {string[]} keys
-     *  A sequence of one or more keys to press
-     *
-     * @param {Question<ElementFinder> | ElementFinder} field
-     *  Web element to send the keys to
-     */
-    constructor(keys, field) {
-        super();
-        this.keys = keys;
-        this.field = field;
-    }
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {...keys: string[]} keys
-     *  A sequence of one or more keys to press
-     *
-     * @returns {PressBuilder}
-     */
-    static the(...keys) {
-        return {
-            in: (field) => new Press(keys, 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}
-     */
-    performAs(actor) {
-        return (0, withAnswerOf_1.withAnswerOf)(actor, this.field, (elf) => elf.sendKeys(...this.keys));
-    }
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString() {
-        return `#actor presses ${describeSequenceOf(this.keys)} in ${this.field.toString()}`;
-    }
-}
-exports.Press = Press;
-function describeSequenceOf(keys) {
-    return keys.map(key => [
-        capitalised(nameOf(key)),
-        isModifier(key) ? '-' : ', ',
-    ]).
-        reduce((acc, current) => acc.concat(current), []).
-        slice(0, keys.length * 2 - 1).
-        join('');
-}
-function isModifier(key) {
-    return !!~[protractor_1.Key.ALT, protractor_1.Key.COMMAND, protractor_1.Key.CONTROL, protractor_1.Key.SHIFT].indexOf(key);
-}
-function nameOf(key) {
-    for (const candidate in protractor_1.Key) {
-        if (Object.prototype.hasOwnProperty.call(protractor_1.Key, candidate) && protractor_1.Key[candidate] === key) {
-            return candidate;
-        }
-    }
-    return key;
-}
-function capitalised(name) {
-    return name.charAt(0).toLocaleUpperCase() + name.slice(1).toLocaleLowerCase();
-}
-//# sourceMappingURL=Press.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Press.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/Press.ts"],"names":[],"mappings":";;;AAAA,4CAA2F;AAC3F,2CAAgD;AAGhD,kDAA+C;AAG/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAa,KAAM,SAAQ,kBAAW;IAiBlC;;;;;;OAMG;IACH,YACqB,IAAc,EACd,KAAsF;QAEvG,KAAK,EAAE,CAAC;QAHS,SAAI,GAAJ,IAAI,CAAU;QACd,UAAK,GAAL,KAAK,CAAiF;IAG3G,CAAC;IA3BD;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAC,GAAG,IAAc;QACxB,OAAO;YACH,EAAE,EAAE,CAAC,KAAsF,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC;SACzH,CAAC;IACN,CAAC;IAgBD;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,KAAuC;QAC7C,OAAO,IAAA,2BAAY,EAAC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,GAAkB,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,kBAAmB,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAE,OAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAG,EAAE,CAAC;IAC7F,CAAC;CACJ;AA1DD,sBA0DC;AAED,SAAS,kBAAkB,CAAC,IAAc;IACtC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACnB,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACxB,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI;KAC/B,CAAC;QACF,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QACjD,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,EAAE,CAAC,CAAC;AACb,CAAC;AAED,SAAS,UAAU,CAAC,GAAW;IAC3B,OAAO,CAAC,CAAE,CAAE,CAAE,gBAAG,CAAC,GAAG,EAAE,gBAAG,CAAC,OAAO,EAAE,gBAAG,CAAC,OAAO,EAAE,gBAAG,CAAC,KAAK,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,MAAM,CAAC,GAAW;IAEvB,KAAK,MAAM,SAAS,IAAI,gBAAG,EAAE;QACzB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAG,EAAE,SAAS,CAAC,IAAI,gBAAG,CAAE,SAAS,CAAE,KAAK,GAAG,EAAE;YAClF,OAAO,SAAS,CAAC;SACpB;KACJ;IAED,OAAO,GAAG,CAAC;AACf,CAAC;AAED,SAAS,WAAW,CAAC,IAAY;IAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;AAClF,CAAC"}

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

@@ -1,27 +0,0 @@
-import { Question } from '@serenity-js/core';
-import { Interaction } from '@serenity-js/core/lib/screenplay';
-import { ElementFinder } from 'protractor';
-import { AlertPromise } from 'selenium-webdriver';
-/**
- * @desc
- *  Fluent interface to make the instantiation of
- *  the {@link @serenity-js/core/lib/screenplay~Interaction}
- *  to {@link Press} more readable.
- *
- * @see {@link Press}
- *
- * @interface
- */
-export interface PressBuilder {
-    /**
-     * @desc
-     *  Instantiates an {@link @serenity-js/core/lib/screenplay~Interaction}
-     *  to {@link Press}.
-     *
-     * @param {Question<ElementFinder> | ElementFinder | Question<AlertPromise> | AlertPromise} field
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link Target}
-     */
-    in: (field: Question<ElementFinder> | ElementFinder | Question<AlertPromise> | AlertPromise) => Interaction;
-}

package/lib/screenplay/interactions/PressBuilder.js

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

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

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

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

@@ -1,69 +0,0 @@
-import { Interaction } from '@serenity-js/core';
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  resize the browser window.
- *
- *  **Please note** that another way to set the size of the browser window
- *  is to configure it in [`protractor.conf.js`](https://github.com/angular/protractor/blob/master/lib/config.ts).
- *
- * @see {@link Window}
- */
-export declare class ResizeBrowserWindow {
-    /**
-     * @desc
-     *  Instantiates a version of this {@link @serenity-js/core/lib/screenplay~Interaction}
-     *  setting the size of the browser window to maximum.
-     *
-     * @example <caption>Maximising browser window</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { BrowseTheWeb, Navigate, ResizeBrowserWindow, Window } from '@serenity-js/protractor';
-     *  import { Ensure, isGreaterThan } from '@serenity-js/assertions';
-     *  import { protractor } from 'protractor';
-     *
-     *  actorCalled('Ventana')
-     *      .whoCan(BrowseTheWeb.using(protractor.browser))
-     *      .attemptsTo(
-     *          Navigate.to('/app'),
-     *          ResizeBrowserWindow.toMaximum(),
-     *          Ensure.that(Window.size(), property('width', isGreaterThan(1024))),
-     *      );
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link BrowseTheWeb}
-     * @see {@link Window.size}
-     * @see {@link @serenity-js/assertions~Ensure}
-     * @see {@link @serenity-js/assertions/lib/expectations~property}
-     * @see {@link @serenity-js/assertions/lib/expectations~isGreaterThan}
-     */
-    static toMaximum(): Interaction;
-    /**
-     * @desc
-     *  Instantiates a version of this {@link @serenity-js/core/lib/screenplay~Interaction}
-     *  setting the size of the browser window to given `width` and `height`
-     *
-     * @example <caption>Setting specific window size</caption>
-     *  import { actorCalled } from '@serenity-js/core';
-     *  import { BrowseTheWeb, Navigate, ResizeBrowserWindow } from '@serenity-js/protractor';
-     *  import { protractor } from 'protractor';
-     *
-     *  actorCalled('Ventana')
-     *      .whoCan(BrowseTheWeb.using(protractor.browser))
-     *      .attemptsTo(
-     *          Navigate.to('/app'),
-     *          ResizeBrowserWindow.to(828, 1792),
-     *      );
-     *
-     * @see {@link BrowseTheWeb}
-     *
-     * @param {number} width
-     *  Desired new width of the browser window
-     *
-     * @param {number} height
-     *  Desired new height of the browser window
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static to(width: number, height: number): Interaction;
-}