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

package/src/screenplay/interactions/Switch.ts

@@ -1,393 +0,0 @@
-import { Activity, Answerable, AnswersQuestions, Interaction, LogicError, PerformsActivities, Task, UsesAbilities } from '@serenity-js/core';
-import { ElementFinder } from 'protractor';
-import { WebElementPromise } from 'selenium-webdriver';
-
-import { BrowseTheWeb } from '../abilities';
-
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor}
- *  to switch to a different [frame](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/frame),
- *  [inline frame](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe),
- *  or browser window/tab.
- *
- * @example <caption>Lean Page Object describing a login form, embedded in an iframe</caption>
- *
- *  import { Target } from '@serenity-js/protractor';
- *  import { by } from 'protractor';
- *
- *  class LoginForm {
- *      static iframe           = Target.the('login form').located(by.tagName('iframe'));
- *      static usernameField    = Target.the('username field').located(by.css('[data-test="username"]'));
- *      static passwordField    = Target.the('password field').located(by.css('[data-test="password"]'));
- *      static submitButton     = Target.the('submit button').located(by.css(`button[type='submit']`));
- *  }
- *
- * @example <caption>Switch to an iframe and back</caption>
- *
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Switch, Enter, Click } from '@serenity-js/protractor';
- *  import { protractor } from 'protractor';
- *
- *  actorCalled('Francesca')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Switch.toFrame(LoginForm.iframe),
- *
- *          Enter.theValue('francesca@example.org').into(LoginForm.usernameField),
- *          Enter.theValue('correct-horse-battery-staple').into(LoginForm.passwordField),
- *          Click.on(LoginForm.submitButton),
- *
- *          Switch.toParentFrame(),
- *      );
- *
- * @example <caption>Perform activities in the context of an iframe</caption>
- *
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Switch, Enter, Click } from '@serenity-js/protractor';
- *  import { protractor } from 'protractor';
- *
- *  actorCalled('Francesca')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Switch.toFrame(LoginForm.iframe).and(
- *              Enter.theValue('francesca@example.org').into(LoginForm.usernameField),
- *              Enter.theValue('correct-horse-battery-staple').into(LoginForm.passwordField),
- *              Click.on(LoginForm.submitButton),
- *          ),
- *          // Note that Switch.toParentFrame() is invoked automatically
- *      );
- *
- * @example <caption>Switch to a new window/tab and back</caption>
- *
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Switch, Close } from '@serenity-js/protractor';
- *  import { protractor } from 'protractor';
- *
- *  actorCalled('Francesca')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Switch.toNewWindow(), // or: Switch.toWindow(...)
- *
- *          // perform some activities in the context of the new window
- *
- *          Close.currentWindow(),
- *
- *          Switch.toOriginalWindow(),
- *      );
- *
- * @example <caption>Perform activities in the context of a different window/tab</caption>
- *
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Switch, Close } from '@serenity-js/protractor';
- *  import { protractor } from 'protractor';
- *
- *  actorCalled('Francesca')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Switch.toNewWindow().and(
- *              // perform some activities in the context of the new window
- *
- *              Close.currentWindow()
- *          ),
- *
- *          // Note that Switch.toOriginalWindow() is invoked automatically
- *      );
- *
- * @see {@link Close}
- * @see {@link BrowseTheWeb}
- */
-export class Switch {
-
-    /**
-     * @desc
-     *  Switches the current [browsing context](https://w3c.github.io/webdriver/#dfn-current-browsing-context)
-     *  for future commands to a [frame](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/frame)
-     *  or an [inline frame](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe)
-     *  identified by its name, index or `Question<ElementFinder>`.
-     *
-     * @param {Answerable<ElementFinder | number | string>} targetOrIndex
-     *
-     * @returns {SwitchToFrame}
-     *
-     * @see {@link Switch.toParentFrame}
-     * @see {@link Switch.toDefaultContent}
-     * @see {@link Target}
-     */
-    static toFrame(targetOrIndex: Answerable<ElementFinder | number | string>): SwitchToFrame {
-        return new SwitchToFrame(targetOrIndex);
-    }
-
-    /**
-     * @desc
-     *  Sets the current [browsing context](https://w3c.github.io/webdriver/#dfn-current-browsing-context)
-     *  for future commands to the parent of the current browsing context,
-     *  i.e. an `iframe` in which the current `iframe` is nested.
-     *
-     *  If the current context is the top-level browsing context, the context remains unchanged.
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link Switch.toFrame}
-     * @see https://w3c.github.io/webdriver/#switch-to-parent-frame
-     * @see https://w3c.github.io/webdriver/#dfn-current-browsing-context
-     */
-    static toParentFrame(): Interaction {
-        return new SwitchToParentFrame();
-    }
-
-    /**
-     * @desc
-     *  Switches the current [browsing context](https://w3c.github.io/webdriver/#dfn-current-browsing-context)
-     *  for future commands to the first frame on the page, or the main document
-     *  when a page contains [`iframe`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe)s.
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     *
-     * @see {@link Switch.toFrame}
-     */
-    static toDefaultContent(): Interaction {
-        return new SwitchToDefaultContent();
-    }
-
-    /**
-     * @desc
-     *  Switches the current [browsing context](https://w3c.github.io/webdriver/#dfn-current-browsing-context)
-     *  for future commands to a browser tab/window identified by its
-     *  name, index or [window handle](https://developer.mozilla.org/en-US/docs/Web/WebDriver/Commands/GetWindowHandles).
-     *
-     * @param {Answerable<string | number>} nameOrHandleOrIndex
-     * @returns {SwitchToWindow}
-     */
-    static toWindow(nameOrHandleOrIndex: Answerable<string | number>): SwitchToWindow {
-        return new SwitchToWindow(nameOrHandleOrIndex);
-    }
-
-    /**
-     * @desc
-     *  Switches the current [browsing context](https://w3c.github.io/webdriver/#dfn-current-browsing-context)
-     *  for future commands to the most recently opened browser tab/window.
-     *
-     *  **Please note** that this behaviour might vary in some browsers if there are more than two windows opened
-     *  at the same time.
-     *
-     * @returns {SwitchToNewWindow}
-     */
-    static toNewWindow(): SwitchToNewWindow {
-        return new SwitchToNewWindow();
-    }
-
-    /**
-     * @desc
-     *  Switches the current [browsing context](https://w3c.github.io/webdriver/#dfn-current-browsing-context)
-     *  for future commands to the original window used when the {@link @serenity-js/core/lib/screenplay/actor~Actor}
-     *  performed an interaction to {@link Navigate}.
-     *
-     *  **Please note** that this behaviour might vary in some browsers if there are more than two windows opened
-     *  at the same time, as window handles might be ordered alphabetically instead of the order in which they were created.
-     *
-     * @returns {SwitchToOriginalWindow}
-     */
-    static toOriginalWindow(): SwitchToOriginalWindow {
-        return new SwitchToOriginalWindow();
-    }
-}
-
-/**
- * @package
- */
-class SwitchToFrame extends Interaction {
-    constructor(private readonly targetOrIndex: Answerable<ElementFinder | number | string>) {
-        super();
-    }
-
-    and(...activities: Activity[]): Task {
-        return new SwitchToFrameAndPerformActivities(this.targetOrIndex, activities);
-    }
-
-    performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike<void> {
-        return actor.answer(this.targetOrIndex)
-            .then((targetOrIndex: ElementFinder) =>
-                BrowseTheWeb.as(actor).switchToFrame(
-                    targetOrIndex instanceof ElementFinder
-                        ? targetOrIndex.getWebElement() as unknown as WebElementPromise // https://github.com/angular/protractor/issues/1846#issuecomment-82634739
-                        : targetOrIndex,
-                ),
-            );
-    }
-
-    toString(): string {
-        return `#actor switches to frame: ${ this.targetOrIndex }`;
-    }
-}
-
-/**
- * @package
- */
-class SwitchToFrameAndPerformActivities extends Task {
-    constructor(
-        private readonly targetOrIndex: Answerable<ElementFinder | number | string>,
-        private readonly activities: Activity[]
-    ) {
-        super();
-    }
-
-    performAs(actor: PerformsActivities): PromiseLike<void> {
-        return actor.attemptsTo(
-            new SwitchToFrame(this.targetOrIndex),
-            ...this.activities,
-            new SwitchToParentFrame()
-        )
-    }
-
-    toString(): string {
-        return `#actor switches to frame: ${ this.targetOrIndex }`;
-    }
-}
-
-/**
- * @package
- */
-class SwitchToParentFrame extends Interaction {
-    performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike<void> {
-        return BrowseTheWeb.as(actor).switchToParentFrame();
-    }
-
-    toString(): string {
-        return `#actor switches to parent frame`;
-    }
-}
-
-/**
- * @package
- */
-class SwitchToDefaultContent extends Interaction {
-    performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike<void> {
-        return BrowseTheWeb.as(actor).switchToDefaultContent();
-    }
-
-    toString(): string {
-        return `#actor switches to default content`;
-    }
-}
-
-/**
- * @package
- */
-class SwitchToWindow extends Interaction {
-    constructor(private readonly nameOrHandleOrIndex: Answerable<string | number>) {
-        super();
-    }
-
-    and(...activities: Activity[]): Task {
-        return new SwitchToWindowAndPerformActivities(this.nameOrHandleOrIndex, activities);
-    }
-
-    performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike<void> {
-        return actor.answer(this.nameOrHandleOrIndex).then(index => BrowseTheWeb.as(actor).switchToWindow(index));
-    }
-
-    toString(): string {
-        return `#actor switches to window: ${this.nameOrHandleOrIndex}`;
-    }
-}
-
-/**
- * @package
- */
-class SwitchToWindowAndPerformActivities extends Task {
-    constructor(
-        private readonly nameOrHandleOrIndex: Answerable<string | number>,
-        private readonly activities: Activity[],
-    ) {
-        super();
-    }
-
-    performAs(actor: PerformsActivities & UsesAbilities): PromiseLike<void> {
-        return BrowseTheWeb.as(actor).getCurrentWindowHandle()
-            .then(currentWindow => {
-                return actor.attemptsTo(
-                    new SwitchToWindow(this.nameOrHandleOrIndex),
-                    ...this.activities,
-                    new SwitchToWindow(currentWindow),
-                );
-            });
-    }
-
-    toString(): string {
-        return `#actor switches to window: ${ this.nameOrHandleOrIndex }`;
-    }
-}
-
-/**
- * @package
- */
-class SwitchToNewWindow extends Interaction {
-    constructor() {
-        super();
-    }
-
-    and(...activities: Activity[]): Task {
-        return new SwitchToNewWindowAndPerformActivities(activities);
-    }
-
-    performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike<void> {
-        return Promise.all([
-            BrowseTheWeb.as(actor).getCurrentWindowHandle(),
-            BrowseTheWeb.as(actor).getAllWindowHandles(),
-        ])
-        .then(([ currentHandle, handles ]: [ string, string[] ]) => handles.filter(handle => handle !== currentHandle))
-        .then(handles => {
-            if (handles.length === 0) {
-                throw new LogicError(`No new window has been opened to switch to`)
-            }
-
-            return BrowseTheWeb.as(actor).switchToWindow(handles[handles.length - 1]);
-        });
-    }
-
-    toString(): string {
-        return `#actor switches to the new browser window`;
-    }
-}
-
-/**
- * @package
- */
-class SwitchToNewWindowAndPerformActivities extends Task {
-    constructor(private readonly activities: Activity[]) {
-        super();
-    }
-
-    performAs(actor: PerformsActivities & UsesAbilities): PromiseLike<void> {
-        return BrowseTheWeb.as(actor).getCurrentWindowHandle()
-            .then(currentWindow => {
-                return actor.attemptsTo(
-                    new SwitchToNewWindow(),
-                    ...this.activities,
-                    new SwitchToWindow(currentWindow),
-                );
-            });
-    }
-
-    toString(): string {
-        return `#actor switches to the new window`;
-    }
-}
-
-/**
- * @package
- */
-class SwitchToOriginalWindow extends Interaction {
-    constructor() {
-        super();
-    }
-
-    performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike<void> {
-        return BrowseTheWeb.as(actor).switchToOriginalWindow();
-    }
-
-    toString(): string {
-        return `#actor switches back to the original browser window`;
-    }
-}

package/src/screenplay/interactions/TakeScreenshot.ts

@@ -1,89 +0,0 @@
-import { Answerable, AnswersQuestions, CollectsArtifacts, Interaction, UsesAbilities } from '@serenity-js/core';
-import { formatted } from '@serenity-js/core/lib/io';
-import { Name, Photo } from '@serenity-js/core/lib/model';
-
-import { BrowseTheWeb } from '../abilities';
-
-/**
- * @desc
- *  Instructs the {@link @serenity-js/core/lib/screenplay/actor~Actor} to
- *  take a screenshot and emit an {@link @serenity-js/core/lib/model~Artifact},
- *  which can then be persisted by {@link @serenity-js/core/lib/stage/crew/artifact-archiver~ArtifactArchiver}
- *  and reported by [Serenity BDD reporter](/modules/serenity-bdd).
- *
- * @example <caption>Clicking on an element</caption>
- *  import { actorCalled } from '@serenity-js/core';
- *  import { BrowseTheWeb, Navigate, TakeScreenshot } from '@serenity-js/protractor';
- *  import { protractor } from 'protractor';
- *
- *  actorCalled('Tania')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Navigate.to('/app'),
- *          TakeScreenshot.of('my app'),
- *      );
- *
- * @see {@link BrowseTheWeb}
- * @see {@link @serenity-js/core/lib/screenplay/actor~CollectsArtifacts}
- * @see {@link @serenity-js/core/lib/model~Artifact}
- * @see {@link @serenity-js/core/lib/stage/crew/artifact-archiver~ArtifactArchiver}
- *
- * @extends {@serenity-js/core/lib/screenplay~Interaction}
- */
-export class TakeScreenshot extends Interaction {
-
-    /**
-     * @desc
-     *  Instantiates this {@link @serenity-js/core/lib/screenplay~Interaction}.
-     *
-     * @param {Answerable<string>} name
-     *  The name to associate the screenshot with
-     *
-     * @returns {@serenity-js/core/lib/screenplay~Interaction}
-     */
-    static of(name: Answerable<string>): Interaction {
-        return new TakeScreenshot(name);
-    }
-
-    /**
-     * @param {Answerable<string>} name
-     *  The name to associate the screenshot with
-     */
-    constructor(private readonly name: Answerable<string>) {
-        super();
-    }
-
-    /**
-     * @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 & CollectsArtifacts): PromiseLike<void> {
-        return Promise.all([
-            BrowseTheWeb.as(actor).takeScreenshot(),
-            actor.answer(this.name),
-        ]).then(([ screenshot, name ]) => actor.collect(
-            Photo.fromBase64(screenshot),
-            new Name(name),
-        ));
-    }
-
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link @serenity-js/core/lib/screenplay~Activity}.
-     *
-     * @returns {string}
-     */
-    toString(): string {
-        return formatted `#actor takes a screenshot of ${this.name}`;
-    }
-}