@serenity-js/web 3.0.0-rc.9 → 3.0.0

package/src/stage/crew/photographer/Photographer.ts

@@ -1,96 +1,197 @@
-import { LogicError } from '@serenity-js/core';
+import { ConfigurationError, LogicError } from '@serenity-js/core';
 import { ActivityFinished, ActivityStarts, DomainEvent } from '@serenity-js/core/lib/events';
 import { Stage, StageCrewMember } from '@serenity-js/core/lib/stage';
 
-import { PhotoTakingStrategy } from './strategies';
+import * as strategies from './strategies';
 
 /**
- * @desc
- *  The Photographer is a {@link @serenity-js/core/lib/stage~StageCrewMember} who takes screenshots
- *  of the web browser that the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight is using.
+ * The Photographer is a {@apilink StageCrewMember} who takes screenshots
+ * using the web browser associated with the {@apilink Actor} that is currently {@apilink actorInTheSpotlight|in the spotlight}.
  *
- * @example <caption>Assigning the Photographer to the Stage</caption>
+ * ## Programmatically assigning the `Photographer` to the {@apilink Stage}
+ *
+ * ```ts
+ * import { configure, ArtifactArchiver } from '@serenity-js/core'
+ * import { Photographer, TakePhotosOfFailures } from '@serenity-js/web'
+ *
+ * configure({
+ *   crew: [
+ *     ArtifactArchiver.storingArtifactsAt(process.cwd(), 'target/site/serenity'),
+ *     Photographer.whoWill(TakePhotosOfFailures),
+ *   ]
+ * })
+ * ```
+ *
+ * ## Using `Photographer` with WebdriverIO
+ *
+ * ```ts
  * // wdio.conf.ts
- * import { ArtifactArchiver } from '@serenity-js/core';
- * import { Photographer, TakePhotosOfFailures } from '@serenity-js/webdriverio';
+ * import { ArtifactArchiver } from '@serenity-js/core'
+ * import { Photographer, TakePhotosOfFailures } from '@serenity-js/web'
+ * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
+ *
+ * export const config: WebdriverIOConfig= {
+ *
+ *   // Tell WebdriverIO to use Serenity/JS framework
+ *   framework: '@serenity-js/webdriverio',
+ *
+ *   serenity: {
+ *     // Configure Serenity/JS to use an appropriate test runner adapter
+ *     runner: 'cucumber',
+ *     // runner: 'mocha',
+ *     // runner: 'jasmine',
+ *
+ *     // register custom Actors class to configure your Serenity/JS actors
+ *     actors: new Actors(),
  *
- * export const config = {
+ *     // Register StageCrewMembers we've imported at the top of this file
+ *     crew: [
+ *       ArtifactArchiver.storingArtifactsAt(process.cwd(), 'target/site/serenity'),
+ *       Photographer.whoWill(TakePhotosOfFailures),
+ *     ]
+ *   },
  *
- *     serenity: {
+ *   // ... rest of the config omitted for brevity
+ * }
+ * ```
+ *
+ * ## Using `Photographer` with Playwright Test
+ *
+ * ```ts
+ * // playwright.config.ts
+ * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
+ *
+ * const config: PlaywrightTestConfig = {
+ *     use: {
  *         crew: [
- *             ArtifactArchiver.storingArtifactsAt(process.cwd(), 'target/site/serenity'),
+ *             [ '@serenity-js/web:Photographer', { strategy: 'TakePhotosOfFailures' } ] // or 'TakePhotosOfInteractions'
+ *         ],
+ *     },
+ * };
+ * export default config;
+ * ```
+ *
+ * #### Learn more
+ * - {@apilink SerenityOptions}
+ *
+ * ## Using `Photographer` with Protractor
+ *
+ * ```ts
+ * // protractor.conf.js
+ * const { ArtifactArchiver } = require('@serenity-js/core')
+ * const { Photographer, TakePhotosOfFailures } = require('@serenity-js/web')
+ *
+ * exports.config = {
+ *
+ *   // Tell Protractor to use the Serenity/JS framework Protractor Adapter
+ *   framework:      'custom',
+ *   frameworkPath:  require.resolve('@serenity-js/protractor/adapter'),
+ *
+ *   serenity: {
+ *         runner: 'jasmine',
+ *         // runner: 'cucumber',
+ *         // runner: 'mocha',
+ *         crew: [
+ *             ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
  *             Photographer.whoWill(TakePhotosOfFailures),
  *         ]
  *     },
  *
  *     // ... rest of the config omitted for brevity
- * };
+ * }
+ * ```
  *
- * @example <caption>Taking photos upon failures only</caption>
+ * ## Taking photos only upon failures only
  *
- * import { Photographer, TakePhotosOfFailures } from '@serenity-js/webdriverio';
+ * ```ts
+ * import { Photographer, TakePhotosOfFailures } from '@serenity-js/web'
  *
  * Photographer.whoWill(TakePhotosOfFailures)
+ * ```
  *
- * @example <caption>Taking photos of all the interactions</caption>
+ * ## Taking photos of all the interactions
  *
- * import { Photographer, TakePhotosOfInteractions } from '@serenity-js/webdriverio';
+ * ```ts
+ * import { Photographer, TakePhotosOfInteractions } from '@serenity-js/web'
  *
  * Photographer.whoWill(TakePhotosOfInteractions)
+ * ```
  *
- * @example <caption>Taking photos before and after all the interactions</caption>
+ * ## Taking photos before and after all the interactions
  *
- * import { Photographer, TakePhotosBeforeAndAfterInteractions } from '@serenity-js/webdriverio';
+ * ```ts
+ * import { Photographer, TakePhotosBeforeAndAfterInteractions } from '@serenity-js/web'
  *
  * Photographer.whoWill(TakePhotosBeforeAndAfterInteractions)
+ * ```
+ *
+ * ## Learn more
+ * - {@apilink Stage}
+ * - {@apilink StageCrewMember}
+ * - {@apilink TakePhotosBeforeAndAfterInteractions}
+ * - {@apilink TakePhotosOfFailures}
+ * - {@apilink TakePhotosOfInteractions}
  *
- * @see {@link @serenity-js/core/lib/stage~Stage}
- * @see {@link TakePhotosBeforeAndAfterInteractions}
- * @see {@link TakePhotosOfFailures}
- * @see {@link TakePhotosOfInteractions}
+ * @group Stage
  */
 export class Photographer implements StageCrewMember {
 
     /**
-     * @desc
-     *  Instantiates a new {@link Photographer} configured to take photos (screenshots)
-     *  as per the specified {@link PhotoTakingStrategy}.
+     * Instantiates a new {@apilink Photographer} configured to take photos (screenshots)
+     * as per the specified {@apilink PhotoTakingStrategy}.
      *
-     * @param {Function} strategy - A no-arg constructor function that instantiates a {@link PhotoTakingStrategy}.
-     * @returns {StageCrewMember}
+     * @param strategy
+     *  A no-arg constructor function that instantiates a {@apilink PhotoTakingStrategy}
      */
-    static whoWill(strategy: new () => PhotoTakingStrategy): StageCrewMember {
+    static whoWill(strategy: new () => strategies.PhotoTakingStrategy): StageCrewMember {
         return new Photographer(new strategy());
     }
 
     /**
-     * @param {PhotoTakingStrategy} photoTakingStrategy
-     * @param {Stage} stage
+     * Instantiates a new {@apilink Photographer} configured to take photos (screenshots)
+     * as per the specified {@apilink PhotoTakingStrategy}.
+     *
+     * @param config
      */
+    static fromJSON(config?: { strategy?: Omit<keyof typeof strategies, 'PhotoTakingStrategy'> }): StageCrewMember {
+        if (config && config.strategy) {
+            const availableStrategies = Object.keys(strategies).filter(strategy => strategy !== strategies.PhotoTakingStrategy.name)    // not the abstract class
+
+            if (availableStrategies.includes(config.strategy as string)) {
+                return new Photographer(new strategies[config.strategy as string]());
+            }
+
+            throw new ConfigurationError(
+                `'${ config.strategy }' is not an available PhotoTakingStrategy. ` +
+                `Available strategies: ${ availableStrategies.join(', ') }.`
+            );
+        }
+
+        return new Photographer(new strategies.TakePhotosOfFailures());
+    }
+
     constructor(
-        private readonly photoTakingStrategy: PhotoTakingStrategy,
+        private readonly photoTakingStrategy: strategies.PhotoTakingStrategy,
         private stage?: Stage,
     ) {
     }
 
     /**
-     * @desc
-     *  Creates a new instance of this {@link StageCrewMember} and assigns it to a given {@link Stage}.
+     * Assigns this {@apilink StageCrewMember} to a given {@apilink Stage}.
      *
-     * @param {Stage} stage - An instance of a {@link Stage} this {@link StageCrewMember} will be assigned to
-     * @returns {StageCrewMember} - A new instance of this {@link StageCrewMember}
+     * @param stage
+     *  An instance of a {@apilink Stage} this {@apilink StageCrewMember} will be assigned to
      */
     assignedTo(stage: Stage): StageCrewMember {
-        return new Photographer(this.photoTakingStrategy, stage);
+        this.stage = stage;
+        return this;
     }
 
     /**
-     * @desc
-     *  Handles {@link DomainEvent} objects emitted by the {@link Stage}
-     *  this {@link StageCrewMember} is assigned to.
+     * Handles {@apilink DomainEvent} objects emitted by the {@apilink Stage}
+     * this {@apilink StageCrewMember} is assigned to.
      *
-     * @param {DomainEvent} event
-     * @returns {void}
+     * @param event
      */
     notifyOf(event: DomainEvent): void {
         if (! this.stage) {

package/src/stage/crew/photographer/strategies/PhotoTakingStrategy.ts

@@ -1,29 +1,29 @@
-import { Stage } from '@serenity-js/core';
-import { ActivityFinished, ActivityRelatedArtifactGenerated, ActivityStarts, AsyncOperationAttempted, AsyncOperationCompleted, AsyncOperationFailed, DomainEvent } from '@serenity-js/core/lib/events';
+import { LogicError, Stage } from '@serenity-js/core';
+import { ActivityFinished, ActivityRelatedArtifactGenerated, ActivityStarts, AsyncOperationAborted, AsyncOperationAttempted, AsyncOperationCompleted, AsyncOperationFailed, DomainEvent } from '@serenity-js/core/lib/events';
 import { CorrelationId, Description, Name, Photo } from '@serenity-js/core/lib/model';
 
 import { BrowseTheWeb } from '../../../../screenplay';
 
 /**
- * @desc
- *  Configures the {@link Photographer} to take photos (a.k.a. screenshots)
- *  of the {@link @serenity-js/core/lib/screenplay~Activity} performed
- *  by the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight
- *  under specific conditions.
+ * Configures the {@apilink Photographer} to take {@apilink Photo|photos}, a.k.a. screenshots,
+ * of the {@apilink Activity} performed by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
+ * when desired conditions are met.
  *
- * @abstract
+ * @group Stage
  */
 export abstract class PhotoTakingStrategy {
 
     /**
-     * @desc
-     *  Takes a photo of the web browser held by the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight.
+     * Takes a photo of the web browser used by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}.
      *
-     * @param {@serenity-js/core/lib/events~ActivityStarts | @serenity-js/core/lib/events~ActivityFinished} event
-     * @param {@serenity-js/core/lib/stage~Stage} stage - the Stage that holds reference to the Actor in the spotlight
-     * @returns {void}
+     * #### Learn more
+     * - {@apilink ActivityStarts}
+     * - {@apilink ActivityFinished}
+     * - {@apilink Stage}
      *
-     * @see {@link @serenity-js/core/lib/stage~Stage#theActorInTheSpotlight}
+     * @param event
+     * @param stage
+     *  The Stage that holds reference to the Actor in the spotlight
      */
     async considerTakingPhoto(event: ActivityStarts | ActivityFinished, stage: Stage): Promise<void> {
         if (! this.shouldTakeAPhotoOf(event)) {
@@ -44,28 +44,16 @@ export abstract class PhotoTakingStrategy {
             nameSuffix      = this.photoNameFor(event);
 
         stage.announce(new AsyncOperationAttempted(
-            new Description(`[Photographer:${ this.constructor.name }] Taking screenshot of '${ nameSuffix }'...`),
+            new Name(`Photographer:${ this.constructor.name }`),
+            new Description(`Taking screenshot of '${ nameSuffix }'...`),
             id,
+            stage.currentTime(),
         ));
 
-        let dialogIsPresent: boolean;
-
-        try {
-            dialogIsPresent = await browseTheWeb.modalDialog().then(dialog => dialog.isPresent());
-
-            if (dialogIsPresent) {
-                return stage.announce(new AsyncOperationCompleted(
-                    new Description(`[${ this.constructor.name }] Aborted taking screenshot of '${ nameSuffix }' because of a modal dialog obstructing the view`),
-                    id,
-                ));
-            }
-        } catch (error) {
-            return stage.announce(new AsyncOperationFailed(error, id));
-        }
-
         try {
             const capabilities  = await browseTheWeb.browserCapabilities();
-            const screenshot    = await browseTheWeb.takeScreenshot();
+            const page          = await browseTheWeb.currentPage();
+            const screenshot    = await page.takeScreenshot();
 
             const
                 context   = [ capabilities.platformName, capabilities.browserName, capabilities.browserVersion ],
@@ -76,22 +64,24 @@ export abstract class PhotoTakingStrategy {
                 event.activityId,
                 photoName,
                 Photo.fromBase64(screenshot),
+                stage.currentTime(),
             ));
 
             return stage.announce(new AsyncOperationCompleted(
-                new Description(`[${ this.constructor.name }] Took screenshot of '${ nameSuffix }' on ${ context }`),
                 id,
+                stage.currentTime(),
             ));
         }
         catch (error) {
             if (this.shouldIgnore(error)) {
-                stage.announce(new AsyncOperationCompleted(
-                    new Description(`[${ this.constructor.name }] Aborted taking screenshot of '${ nameSuffix }' because of ${ error.constructor && error.constructor.name }`),
+                stage.announce(new AsyncOperationAborted(
+                    new Description(`Aborted taking screenshot of '${ nameSuffix }' because of ${ error.constructor && error.constructor.name }`),
                     id,
+                    stage.currentTime(),
                 ));
             }
             else {
-                stage.announce(new AsyncOperationFailed(error, id));
+                stage.announce(new AsyncOperationFailed(error, id, stage.currentTime()));
             }
         }
     }
@@ -105,12 +95,7 @@ export abstract class PhotoTakingStrategy {
     }
 
     private shouldIgnore(error: Error) {
-        return error.name && (
-            error.name === 'NoSuchSessionError' ||
-            (error.name === 'ProtocolError' && error.message.includes('Target closed'))
-        );
-        // todo: add SauceLabs
-        //  [0-0] 2021-12-02T01:32:36.402Z ERROR webdriver: Request failed with status 404 due to no such window: no such window: target window already closed
-        //  [0-0] from unknown error: web view not found
+        return error instanceof LogicError
+            || (error.name && error.name === LogicError.name);
     }
 }

package/src/stage/crew/photographer/strategies/TakePhotosBeforeAndAfterInteractions.ts

@@ -3,16 +3,15 @@ import { DomainEvent, InteractionFinished, InteractionStarts } from '@serenity-j
 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.
+ * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots) **both before and after**
+ * every single {@apilink Interaction} performed
+ * by the {@apilink Actor} in the {@apilink actorInTheSpotlight|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.
+ * **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}
+ * @group Stage
  */
 export class TakePhotosBeforeAndAfterInteractions extends PhotoTakingStrategy {
     protected shouldTakeAPhotoOf(event: DomainEvent): boolean {

package/src/stage/crew/photographer/strategies/TakePhotosOfFailures.ts

@@ -4,15 +4,15 @@ import { ImplementationPending } from '@serenity-js/core/lib/model';
 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.
+ * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots)
+ * when then {@apilink Interaction} performed
+ * by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
+ * results in an error.
  *
- *  This strategy works best when you are interested in the screenshots only when
- *  a scenario fails.
+ * This strategy works best when you are interested in the screenshots only when
+ * a scenario fails.
  *
- * @extends {PhotoTakingStrategy}
+ * @group Stage
  */
 export class TakePhotosOfFailures extends PhotoTakingStrategy {
     protected shouldTakeAPhotoOf(event: DomainEvent): boolean {

package/src/stage/crew/photographer/strategies/TakePhotosOfInteractions.ts

@@ -3,17 +3,16 @@ 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}.
+ * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots)
+ * when then {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
+ * performs any {@apilink Interaction}.
  *
- *  This strategy works best when you want the results of your automated tests
- *  to become comprehensive living documentation of your system.
+ * 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.
+ * *Please note* that taking screenshots affects the performance of your tests.
  *
- * @extends {PhotoTakingStrategy}
+ * @group Stage
  */
 export class TakePhotosOfInteractions extends PhotoTakingStrategy {
     protected shouldTakeAPhotoOf(event: DomainEvent): boolean {

package/tsconfig.build.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "outDir": "lib",
+    "rootDir": "src",
+    "lib": [
+      "es2019",
+      "dom"
+    ]
+  },
+  "include": [
+    "src/**/*.ts"
+  ]
+}

package/lib/expectations/ElementExpectation.d.ts

@@ -1,83 +0,0 @@
-import { Expectation } from '@serenity-js/core';
-import { PageElement } from '../screenplay';
-/**
- * @desc
- *  A convenience method to create a custom {@link PageElement}-related {@link @serenity-js/core/lib/screenplay/questions~Expectation}
- *
- * @example <caption>Defining an expectation</caption>
- *  import { Expectation } from '@serenity-js/core';
- *  import { ElementExpectation, PageElement } from '@serenity-js/web';
- *
- *  export function isPresent(): Expectation<boolean, PageElement> {
- *      return ElementExpectation.forElementTo('become present', actual => actual.isPresent());
- *  }
- *
- * @example <caption>Using an expectation in an assertion</caption>
- *  import { Ensure } from '@serenity-js/assertions';
- *  import { actorCalled } from '@serenity-js/core';
- *  import { By, PageElement } from '@serenity-js/web';
- *
- *  const submitButton = () =>
- *      PageElement.located(By.css('.submit')).describedAs('submit button');
- *
- *  actorCalled('Izzy').attemptsTo(
- *      Ensure.that(submitButton(), isPresent())
- *  );
- *
- * @example <caption>Using an expectation in a synchronisation statement</caption>
- *  import { actorCalled, Duration } from '@serenity-js/core';
- *  import { By, PageElement, Wait } from '@serenity-js/web';
- *
- *  const submitButton = () =>
- *      PageElement.located(By.css('.submit')).describedAs('submit button');
- *
- *  actorCalled('Izzy').attemptsTo(
- *      Wait.upTo(Duration.ofSeconds(2)).until(submitButton(), isPresent())
- *  );
- *
- * @public
- * @extends {@serenity-js/core/lib/screenplay/questions~Expectation}
- */
-export declare class ElementExpectation extends Expectation<PageElement> {
-    private readonly fn;
-    /**
-     * @desc
-     *  Creates an {@link @serenity-js/core/lib/screenplay/questions~Expectation}
-     *
-     * @example <caption>Defining an expectation</caption>
-     *  import { Expectation } from '@serenity-js/core';
-     *  import { ElementExpectation, PageElement } from '@serenity-js/web';
-     *
-     *  export function isPresent(): Expectation<boolean, PageElement> {
-     *      return ElementExpectation.forElementTo('become present', actual => actual.isPresent());
-     *  }
-     *
-     * @param {string} description
-     *  A description of the expectation.
-     *  Please note that Serenity/JS will use it to describe your expectation in sentences like these:
-     *  - `actor ensures that <something> does <description>`
-     *  - `actor ensures that <something> does not <description>`
-     *  - `actor waits until <something> does <description>`
-     *  - `actor waits until <something> does not <description>`
-     *
-     *  To work with the above templates, the description should be similar to
-     *  - `become present`,
-     *  - `become active`,
-     *  - `equal X`,
-     *  - `has value greater than Y`.
-     *
-     *  Descriptions like "is present", "is active", "equals X", "is greater than Y" WILL NOT work well.
-     *
-     * @param {function(actual: PageElement): Promise<boolean>} fn
-     *  An asynchronous callback function that receives a {@link PageElement} and returns a {@link Promise}
-     *  that should resolve to `true` when the expectation is met, and `false` otherwise.
-     *
-     * @returns {ElementExpectation<any, PageElement>}
-     */
-    static forElementTo(description: string, fn: (actual: PageElement) => Promise<boolean>): Expectation<PageElement>;
-    /**
-     * @param {string} description
-     * @param {function(actual: PageElement): Promise<boolean>} fn
-     */
-    constructor(description: string, fn: (actual: PageElement) => Promise<boolean>);
-}

package/lib/expectations/ElementExpectation.js

@@ -1,102 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ElementExpectation = void 0;
-const core_1 = require("@serenity-js/core");
-/**
- * @desc
- *  A convenience method to create a custom {@link PageElement}-related {@link @serenity-js/core/lib/screenplay/questions~Expectation}
- *
- * @example <caption>Defining an expectation</caption>
- *  import { Expectation } from '@serenity-js/core';
- *  import { ElementExpectation, PageElement } from '@serenity-js/web';
- *
- *  export function isPresent(): Expectation<boolean, PageElement> {
- *      return ElementExpectation.forElementTo('become present', actual => actual.isPresent());
- *  }
- *
- * @example <caption>Using an expectation in an assertion</caption>
- *  import { Ensure } from '@serenity-js/assertions';
- *  import { actorCalled } from '@serenity-js/core';
- *  import { By, PageElement } from '@serenity-js/web';
- *
- *  const submitButton = () =>
- *      PageElement.located(By.css('.submit')).describedAs('submit button');
- *
- *  actorCalled('Izzy').attemptsTo(
- *      Ensure.that(submitButton(), isPresent())
- *  );
- *
- * @example <caption>Using an expectation in a synchronisation statement</caption>
- *  import { actorCalled, Duration } from '@serenity-js/core';
- *  import { By, PageElement, Wait } from '@serenity-js/web';
- *
- *  const submitButton = () =>
- *      PageElement.located(By.css('.submit')).describedAs('submit button');
- *
- *  actorCalled('Izzy').attemptsTo(
- *      Wait.upTo(Duration.ofSeconds(2)).until(submitButton(), isPresent())
- *  );
- *
- * @public
- * @extends {@serenity-js/core/lib/screenplay/questions~Expectation}
- */
-class ElementExpectation extends core_1.Expectation {
-    /**
-     * @param {string} description
-     * @param {function(actual: PageElement): Promise<boolean>} fn
-     */
-    constructor(description, fn) {
-        super(description, async (actor, actual) => {
-            const pageElement = await actor.answer(actual);
-            try {
-                const result = await fn(pageElement);
-                return result
-                    ? new core_1.ExpectationMet(this.toString(), undefined, pageElement)
-                    : new core_1.ExpectationNotMet(this.toString(), undefined, pageElement);
-            }
-            catch (error) {
-                return new core_1.ExpectationNotMet(`${description} (${error.message})`, undefined, pageElement);
-            }
-        });
-        this.fn = fn;
-    }
-    /**
-     * @desc
-     *  Creates an {@link @serenity-js/core/lib/screenplay/questions~Expectation}
-     *
-     * @example <caption>Defining an expectation</caption>
-     *  import { Expectation } from '@serenity-js/core';
-     *  import { ElementExpectation, PageElement } from '@serenity-js/web';
-     *
-     *  export function isPresent(): Expectation<boolean, PageElement> {
-     *      return ElementExpectation.forElementTo('become present', actual => actual.isPresent());
-     *  }
-     *
-     * @param {string} description
-     *  A description of the expectation.
-     *  Please note that Serenity/JS will use it to describe your expectation in sentences like these:
-     *  - `actor ensures that <something> does <description>`
-     *  - `actor ensures that <something> does not <description>`
-     *  - `actor waits until <something> does <description>`
-     *  - `actor waits until <something> does not <description>`
-     *
-     *  To work with the above templates, the description should be similar to
-     *  - `become present`,
-     *  - `become active`,
-     *  - `equal X`,
-     *  - `has value greater than Y`.
-     *
-     *  Descriptions like "is present", "is active", "equals X", "is greater than Y" WILL NOT work well.
-     *
-     * @param {function(actual: PageElement): Promise<boolean>} fn
-     *  An asynchronous callback function that receives a {@link PageElement} and returns a {@link Promise}
-     *  that should resolve to `true` when the expectation is met, and `false` otherwise.
-     *
-     * @returns {ElementExpectation<any, PageElement>}
-     */
-    static forElementTo(description, fn) {
-        return new ElementExpectation(description, fn);
-    }
-}
-exports.ElementExpectation = ElementExpectation;
-//# sourceMappingURL=ElementExpectation.js.map

package/lib/expectations/ElementExpectation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ElementExpectation.js","sourceRoot":"","sources":["../../src/expectations/ElementExpectation.ts"],"names":[],"mappings":";;;AAAA,4CAAiH;AAIjH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAa,kBAAmB,SAAQ,kBAAwB;IAwC5D;;;OAGG;IACH,YACI,WAAmB,EACF,EAA6C;QAE9D,KAAK,CACD,WAAW,EACX,KAAK,EAAE,KAAuB,EAAE,MAA+B,EAAE,EAAE;YAC/D,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAE/C,IAAI;gBACA,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,WAAW,CAAC,CAAC;gBAErC,OAAO,MAAM;oBACT,CAAC,CAAC,IAAI,qBAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,WAAW,CAAC;oBAC7D,CAAC,CAAC,IAAI,wBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;aACxE;YAAC,OAAM,KAAK,EAAE;gBACX,OAAO,IAAI,wBAAiB,CAAC,GAAI,WAAY,KAAM,KAAK,CAAC,OAAQ,GAAG,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;aACjG;QACL,CAAC,CACJ,CAAC;QAjBe,OAAE,GAAF,EAAE,CAA2C;IAkBlE,CAAC;IA9DD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CAAC,YAAY,CAAC,WAAmB,EAAE,EAA6C;QAClF,OAAO,IAAI,kBAAkB,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IACnD,CAAC;CA2BJ;AAjED,gDAiEC"}

package/lib/input/Key.js.map

@@ -1 +0,0 @@
-{"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

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

package/lib/input/index.js.map

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