@serenity-js/web 3.0.0-rc.0

package/lib/stage/crew/photographer/Photographer.d.ts

@@ -0,0 +1,83 @@
+import { DomainEvent } from '@serenity-js/core/lib/events';
+import { Stage, StageCrewMember } from '@serenity-js/core/lib/stage';
+import { PhotoTakingStrategy } 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.
+ *
+ * @example <caption>Assigning the Photographer to the Stage</caption>
+ * // wdio.conf.ts
+ * import { ArtifactArchiver } from '@serenity-js/core';
+ * import { Photographer, TakePhotosOfFailures } from '@serenity-js/webdriverio';
+ *
+ * export const config = {
+ *
+ *     serenity: {
+ *         crew: [
+ *             ArtifactArchiver.storingArtifactsAt(process.cwd(), 'target/site/serenity'),
+ *             Photographer.whoWill(TakePhotosOfFailures),
+ *         ]
+ *     },
+ *
+ *     // ... rest of the config omitted for brevity
+ * };
+ *
+ * @example <caption>Taking photos upon failures only</caption>
+ *
+ * import { Photographer, TakePhotosOfFailures } from '@serenity-js/webdriverio';
+ *
+ * Photographer.whoWill(TakePhotosOfFailures)
+ *
+ * @example <caption>Taking photos of all the interactions</caption>
+ *
+ * import { Photographer, TakePhotosOfInteractions } from '@serenity-js/webdriverio';
+ *
+ * Photographer.whoWill(TakePhotosOfInteractions)
+ *
+ * @example <caption>Taking photos before and after all the interactions</caption>
+ *
+ * import { Photographer, TakePhotosBeforeAndAfterInteractions } from '@serenity-js/webdriverio';
+ *
+ * Photographer.whoWill(TakePhotosBeforeAndAfterInteractions)
+ *
+ * @see {@link @serenity-js/core/lib/stage~Stage}
+ * @see {@link TakePhotosBeforeAndAfterInteractions}
+ * @see {@link TakePhotosOfFailures}
+ * @see {@link TakePhotosOfInteractions}
+ */
+export declare class Photographer implements StageCrewMember {
+    private readonly photoTakingStrategy;
+    private stage?;
+    /**
+     * @desc
+     *  Instantiates a new {@link Photographer} configured to take photos (screenshots)
+     *  as per the specified {@link PhotoTakingStrategy}.
+     *
+     * @param {Function} strategy - A no-arg constructor function that instantiates a {@link PhotoTakingStrategy}.
+     * @returns {StageCrewMember}
+     */
+    static whoWill(strategy: new () => PhotoTakingStrategy): StageCrewMember;
+    /**
+     * @param {PhotoTakingStrategy} photoTakingStrategy
+     * @param {Stage} stage
+     */
+    constructor(photoTakingStrategy: PhotoTakingStrategy, stage?: Stage);
+    /**
+     * @desc
+     *  Creates a new instance of this {@link StageCrewMember} and assigns it to a given {@link 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}
+     */
+    assignedTo(stage: Stage): StageCrewMember;
+    /**
+     * @desc
+     *  Handles {@link DomainEvent} objects emitted by the {@link Stage}
+     *  this {@link StageCrewMember} is assigned to.
+     *
+     * @param {DomainEvent} event
+     * @returns {void}
+     */
+    notifyOf(event: DomainEvent): void;
+}

package/lib/stage/crew/photographer/Photographer.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Photographer = void 0;
+const core_1 = require("@serenity-js/core");
+const events_1 = require("@serenity-js/core/lib/events");
+/**
+ * @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.
+ *
+ * @example <caption>Assigning the Photographer to the Stage</caption>
+ * // wdio.conf.ts
+ * import { ArtifactArchiver } from '@serenity-js/core';
+ * import { Photographer, TakePhotosOfFailures } from '@serenity-js/webdriverio';
+ *
+ * export const config = {
+ *
+ *     serenity: {
+ *         crew: [
+ *             ArtifactArchiver.storingArtifactsAt(process.cwd(), 'target/site/serenity'),
+ *             Photographer.whoWill(TakePhotosOfFailures),
+ *         ]
+ *     },
+ *
+ *     // ... rest of the config omitted for brevity
+ * };
+ *
+ * @example <caption>Taking photos upon failures only</caption>
+ *
+ * import { Photographer, TakePhotosOfFailures } from '@serenity-js/webdriverio';
+ *
+ * Photographer.whoWill(TakePhotosOfFailures)
+ *
+ * @example <caption>Taking photos of all the interactions</caption>
+ *
+ * import { Photographer, TakePhotosOfInteractions } from '@serenity-js/webdriverio';
+ *
+ * Photographer.whoWill(TakePhotosOfInteractions)
+ *
+ * @example <caption>Taking photos before and after all the interactions</caption>
+ *
+ * import { Photographer, TakePhotosBeforeAndAfterInteractions } from '@serenity-js/webdriverio';
+ *
+ * Photographer.whoWill(TakePhotosBeforeAndAfterInteractions)
+ *
+ * @see {@link @serenity-js/core/lib/stage~Stage}
+ * @see {@link TakePhotosBeforeAndAfterInteractions}
+ * @see {@link TakePhotosOfFailures}
+ * @see {@link TakePhotosOfInteractions}
+ */
+class Photographer {
+    /**
+     * @param {PhotoTakingStrategy} photoTakingStrategy
+     * @param {Stage} stage
+     */
+    constructor(photoTakingStrategy, stage) {
+        this.photoTakingStrategy = photoTakingStrategy;
+        this.stage = stage;
+    }
+    /**
+     * @desc
+     *  Instantiates a new {@link Photographer} configured to take photos (screenshots)
+     *  as per the specified {@link PhotoTakingStrategy}.
+     *
+     * @param {Function} strategy - A no-arg constructor function that instantiates a {@link PhotoTakingStrategy}.
+     * @returns {StageCrewMember}
+     */
+    static whoWill(strategy) {
+        return new Photographer(new strategy());
+    }
+    /**
+     * @desc
+     *  Creates a new instance of this {@link StageCrewMember} and assigns it to a given {@link 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}
+     */
+    assignedTo(stage) {
+        return new Photographer(this.photoTakingStrategy, stage);
+    }
+    /**
+     * @desc
+     *  Handles {@link DomainEvent} objects emitted by the {@link Stage}
+     *  this {@link StageCrewMember} is assigned to.
+     *
+     * @param {DomainEvent} event
+     * @returns {void}
+     */
+    notifyOf(event) {
+        if (!this.stage) {
+            throw new core_1.LogicError(`Photographer needs to be assigned to the Stage before it can be notified of any DomainEvents`);
+        }
+        if (!this.stage.theShowHasStarted()) {
+            return void 0;
+        }
+        if (event instanceof events_1.ActivityStarts || event instanceof events_1.ActivityFinished) {
+            this.photoTakingStrategy.considerTakingPhoto(event, this.stage);
+        }
+    }
+}
+exports.Photographer = Photographer;
+//# sourceMappingURL=Photographer.js.map

package/lib/stage/crew/photographer/Photographer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Photographer.js","sourceRoot":"","sources":["../../../../src/stage/crew/photographer/Photographer.ts"],"names":[],"mappings":";;;AAAA,4CAA+C;AAC/C,yDAA6F;AAK7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAa,YAAY;IAcrB;;;OAGG;IACH,YACqB,mBAAwC,EACjD,KAAa;QADJ,wBAAmB,GAAnB,mBAAmB,CAAqB;QACjD,UAAK,GAAL,KAAK,CAAQ;IAEzB,CAAC;IApBD;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,CAAC,QAAuC;QAClD,OAAO,IAAI,YAAY,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;IAC5C,CAAC;IAYD;;;;;;OAMG;IACH,UAAU,CAAC,KAAY;QACnB,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAkB;QACvB,IAAI,CAAE,IAAI,CAAC,KAAK,EAAE;YACd,MAAM,IAAI,iBAAU,CAAC,8FAA8F,CAAC,CAAC;SACxH;QAED,IAAI,CAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE;YAClC,OAAO,KAAK,CAAC,CAAC;SACjB;QAED,IAAI,KAAK,YAAY,uBAAc,IAAI,KAAK,YAAY,yBAAgB,EAAE;YACtE,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;SACnE;IACL,CAAC;CACJ;AAxDD,oCAwDC"}

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

@@ -0,0 +1,2 @@
+export * from './Photographer';
+export * from './strategies';

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

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Photographer"), exports);
+__exportStar(require("./strategies"), exports);
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,28 @@
+import { Stage } from '@serenity-js/core';
+import { ActivityFinished, ActivityStarts, DomainEvent } from '@serenity-js/core/lib/events';
+/**
+ * @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.
+ *
+ * @abstract
+ */
+export declare 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.
+     *
+     * @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}
+     *
+     * @see {@link @serenity-js/core/lib/stage~Stage#theActorInTheSpotlight}
+     */
+    considerTakingPhoto(event: ActivityStarts | ActivityFinished, stage: Stage): Promise<void>;
+    protected abstract shouldTakeAPhotoOf(event: DomainEvent): boolean;
+    protected abstract photoNameFor(event: DomainEvent): string;
+    private combinedNameFrom;
+    private shouldIgnore;
+}

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

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PhotoTakingStrategy = void 0;
+const events_1 = require("@serenity-js/core/lib/events");
+const model_1 = require("@serenity-js/core/lib/model");
+const screenplay_1 = require("../../../../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.
+ *
+ * @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.
+     *
+     * @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}
+     *
+     * @see {@link @serenity-js/core/lib/stage~Stage#theActorInTheSpotlight}
+     */
+    async considerTakingPhoto(event, stage) {
+        if (!this.shouldTakeAPhotoOf(event)) {
+            return void 0;
+        }
+        let browseTheWeb;
+        try {
+            browseTheWeb = screenplay_1.BrowseTheWeb.as(stage.theActorInTheSpotlight());
+        }
+        catch {
+            // actor doesn't have a browser, abort
+            return void 0;
+        }
+        const id = model_1.CorrelationId.create(), nameSuffix = this.photoNameFor(event);
+        stage.announce(new events_1.AsyncOperationAttempted(new model_1.Description(`[Photographer:${this.constructor.name}] Taking screenshot of '${nameSuffix}'...`), id));
+        let dialogIsPresent;
+        try {
+            dialogIsPresent = await browseTheWeb.modalDialog().then(dialog => dialog.isPresent());
+            if (dialogIsPresent) {
+                return stage.announce(new events_1.AsyncOperationCompleted(new model_1.Description(`[${this.constructor.name}] Aborted taking screenshot of '${nameSuffix}' because of a modal dialog obstructing the view`), id));
+            }
+        }
+        catch (error) {
+            return stage.announce(new events_1.AsyncOperationFailed(error, id));
+        }
+        try {
+            const [screenshot, capabilities] = await Promise.all([
+                browseTheWeb.takeScreenshot(),
+                browseTheWeb.browserCapabilities(),
+            ]);
+            const context = [capabilities.platformName, capabilities.browserName, capabilities.browserVersion], photoName = this.combinedNameFrom(...context, nameSuffix);
+            stage.announce(new events_1.ActivityRelatedArtifactGenerated(event.sceneId, event.activityId, photoName, model_1.Photo.fromBase64(screenshot)));
+            return stage.announce(new events_1.AsyncOperationCompleted(new model_1.Description(`[${this.constructor.name}] Took screenshot of '${nameSuffix}' on ${context}`), id));
+        }
+        catch (error) {
+            if (this.shouldIgnore(error)) {
+                stage.announce(new events_1.AsyncOperationCompleted(new model_1.Description(`[${this.constructor.name}] Aborted taking screenshot of '${nameSuffix}' because of ${error.constructor && error.constructor.name}`), id));
+            }
+            else {
+                stage.announce(new events_1.AsyncOperationFailed(error, id));
+            }
+        }
+    }
+    combinedNameFrom(...parts) {
+        return new model_1.Name(parts.filter(v => !!v).join('-'));
+    }
+    shouldIgnore(error) {
+        return error.name
+            && (error.name === 'NoSuchSessionError');
+        // 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
+    }
+}
+exports.PhotoTakingStrategy = PhotoTakingStrategy;
+//# sourceMappingURL=PhotoTakingStrategy.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PhotoTakingStrategy.js","sourceRoot":"","sources":["../../../../../src/stage/crew/photographer/strategies/PhotoTakingStrategy.ts"],"names":[],"mappings":";;;AACA,yDAAuM;AACvM,uDAAsF;AAEtF,uDAAsD;AAEtD;;;;;;;;GAQG;AACH,MAAsB,mBAAmB;IAErC;;;;;;;;;OASG;IACH,KAAK,CAAC,mBAAmB,CAAC,KAAwC,EAAE,KAAY;QAC5E,IAAI,CAAE,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE;YAClC,OAAO,KAAK,CAAC,CAAC;SACjB;QAED,IAAI,YAA0B,CAAC;QAE/B,IAAI;YACA,YAAY,GAAG,yBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,EAAE,CAAC,CAAC;SAClE;QAAC,MAAM;YACJ,sCAAsC;YACtC,OAAO,KAAK,CAAC,CAAC;SACjB;QAED,MACI,EAAE,GAAgB,qBAAa,CAAC,MAAM,EAAE,EACxC,UAAU,GAAQ,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAE/C,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CACtC,IAAI,mBAAW,CAAC,iBAAkB,IAAI,CAAC,WAAW,CAAC,IAAK,2BAA4B,UAAW,MAAM,CAAC,EACtG,EAAE,CACL,CAAC,CAAC;QAEH,IAAI,eAAwB,CAAC;QAE7B,IAAI;YACA,eAAe,GAAG,MAAM,YAAY,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YAEtF,IAAI,eAAe,EAAE;gBACjB,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC7C,IAAI,mBAAW,CAAC,IAAK,IAAI,CAAC,WAAW,CAAC,IAAK,mCAAoC,UAAW,kDAAkD,CAAC,EAC7I,EAAE,CACL,CAAC,CAAC;aACN;SACJ;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,6BAAoB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;SAC9D;QAED,IAAI;YACA,MAAM,CAAE,UAAU,EAAE,YAAY,CAAE,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACnD,YAAY,CAAC,cAAc,EAAE;gBAC7B,YAAY,CAAC,mBAAmB,EAAE;aACrC,CAAC,CAAC;YAEH,MACI,OAAO,GAAK,CAAE,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,WAAW,EAAE,YAAY,CAAC,cAAc,CAAE,EAChG,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,OAAO,EAAE,UAAU,CAAC,CAAC;YAE9D,KAAK,CAAC,QAAQ,CAAC,IAAI,yCAAgC,CAC/C,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,UAAU,EAChB,SAAS,EACT,aAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAC/B,CAAC,CAAC;YAEH,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC7C,IAAI,mBAAW,CAAC,IAAK,IAAI,CAAC,WAAW,CAAC,IAAK,yBAA0B,UAAW,QAAS,OAAQ,EAAE,CAAC,EACpG,EAAE,CACL,CAAC,CAAC;SACN;QACD,OAAO,KAAK,EAAE;YACV,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;gBAC1B,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CACtC,IAAI,mBAAW,CAAC,IAAK,IAAI,CAAC,WAAW,CAAC,IAAK,mCAAoC,UAAW,gBAAiB,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,WAAW,CAAC,IAAK,EAAE,CAAC,EAC1J,EAAE,CACL,CAAC,CAAC;aACN;iBACI;gBACD,KAAK,CAAC,QAAQ,CAAC,IAAI,6BAAoB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;aACvD;SACJ;IACL,CAAC;IAMO,gBAAgB,CAAC,GAAG,KAAe;QACvC,OAAO,IAAI,YAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACvD,CAAC;IAEO,YAAY,CAAC,KAAY;QAC7B,OAAO,KAAK,CAAC,IAAI;eACV,CAAC,KAAK,CAAC,IAAI,KAAK,oBAAoB,CAAC,CAAC;QAC7C,sBAAsB;QACtB,sJAAsJ;QACtJ,gDAAgD;IACpD,CAAC;CACJ;AApGD,kDAoGC"}

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./PhotoTakingStrategy"), exports);
+__exportStar(require("./TakePhotosBeforeAndAfterInteractions"), exports);
+__exportStar(require("./TakePhotosOfFailures"), exports);
+__exportStar(require("./TakePhotosOfInteractions"), exports);
+//# sourceMappingURL=index.js.map

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

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

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

package/lib/stage/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./crew"), exports);
+//# sourceMappingURL=index.js.map

package/lib/stage/index.js.map

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

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@serenity-js/web",
+  "version": "3.0.0-rc.0",
+  "description": "Serenity/JS Screenplay Pattern APIs for the Web",
+  "author": {
+    "name": "Jan Molak",
+    "email": "jan.molak@smartcodeltd.co.uk",
+    "url": "https://janmolak.com"
+  },
+  "funding": {
+    "url": "https://github.com/sponsors/serenity-js"
+  },
+  "homepage": "https://serenity-js.org",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "keywords": [
+    "serenity-js",
+    "mocha",
+    "tdd",
+    "bdd",
+    "test",
+    "testing",
+    "web"
+  ],
+  "scripts": {
+    "clean": "rimraf .nyc_output lib target",
+    "lint": "eslint --ext ts --config ../../.eslintrc.js .",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "nyc --report-dir ../../target/coverage/web mocha --config ../../.mocharc.yml 'spec/**/*.spec.*'",
+    "compile": "tsc --project tsconfig.json",
+    "site": "esdoc -c .esdoc.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/serenity-js/serenity-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/serenity-js/serenity-js/issues"
+  },
+  "engines": {
+    "node": "^14 || ^16",
+    "npm": "^6 || ^7"
+  },
+  "dependencies": {
+    "@serenity-js/assertions": "3.0.0-rc.0",
+    "@serenity-js/core": "3.0.0-rc.0",
+    "tiny-types": "^1.16.1"
+  },
+  "devDependencies": {
+    "@documentation/esdoc-template": "2.0.0",
+    "@integration/testing-tools": "2.0.0",
+    "@types/chai": "^4.3.0",
+    "@types/mocha": "^9.0.0",
+    "mocha": "^9.1.3",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.5.2"
+  },
+  "nyc": {
+    "include": [
+      "src/**/*.ts"
+    ],
+    "exclude": [
+      "src/**/*.d.ts",
+      "lib",
+      "node_modules",
+      "spec"
+    ],
+    "extension": [
+      ".ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ],
+    "reporter": [
+      "json"
+    ],
+    "cache": true,
+    "all": true
+  },
+  "gitHead": "a63381d088cc068bc3edcbd1eb59a7e609cb6a8c"
+}

package/src/errors/CookieMissingError.ts

@@ -0,0 +1,7 @@
+import { RuntimeError } from '@serenity-js/core';
+
+export class CookieMissingError extends RuntimeError {
+    constructor(message: string, cause?: Error) {
+        super(CookieMissingError, message, cause);
+    }
+}

package/src/errors/index.ts

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