@serenity-js/core 3.41.2 → 3.42.1

package/esm/stage/StageManager.d.ts

@@ -0,0 +1,23 @@
+import type { DomainEvent } from '../events/index.js';
+import type { Clock, Duration, TellsTime, Timestamp } from '../screenplay/index.js';
+import type { ListensToDomainEvents } from '../stage/index.js';
+/**
+ * @group Stage
+ */
+export declare class StageManager implements TellsTime {
+    private cueTimeout;
+    private readonly clock;
+    private readonly subscribers;
+    private readonly wip;
+    constructor(cueTimeout: Duration, clock: Clock);
+    configure(options: {
+        cueTimeout: Duration;
+    }): void;
+    register(...subscribers: ListensToDomainEvents[]): void;
+    deregister(subscriber: ListensToDomainEvents): void;
+    notifyOf(event: DomainEvent): void;
+    waitForAsyncOperationsToComplete(): Promise<void>;
+    waitForNextCue(): Promise<void>;
+    currentTime(): Timestamp;
+}
+//# sourceMappingURL=StageManager.d.ts.map

package/esm/stage/StageManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StageManager.d.ts","sourceRoot":"","sources":["../../src/stage/StageManager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGtD,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACpF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAE/D;;GAEG;AACH,qBAAa,YAAa,YAAW,SAAS;IAI9B,OAAO,CAAC,UAAU;IAAY,OAAO,CAAC,QAAQ,CAAC,KAAK;IAHhE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA+B;IAC3D,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAM;gBAEN,UAAU,EAAE,QAAQ,EAAmB,KAAK,EAAE,KAAK;IAIvE,SAAS,CAAC,OAAO,EAAE;QAAE,UAAU,EAAE,QAAQ,CAAA;KAAE,GAAG,IAAI;IAKlD,QAAQ,CAAC,GAAG,WAAW,EAAE,qBAAqB,EAAE,GAAG,IAAI;IAIvD,UAAU,CAAC,UAAU,EAAE,qBAAqB,GAAG,IAAI;IAInD,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAMlC,gCAAgC,IAAI,OAAO,CAAC,IAAI,CAAC;IAoB3C,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBrC,WAAW,IAAI,SAAS;CAG3B"}

package/esm/stage/StageManager.js

@@ -0,0 +1,146 @@
+import { AsyncOperationAttempted, AsyncOperationCompleted, AsyncOperationFailed } from '../events/index.js';
+/**
+ * @group Stage
+ */
+export class StageManager {
+    cueTimeout;
+    clock;
+    subscribers = [];
+    wip;
+    constructor(cueTimeout, clock) {
+        this.cueTimeout = cueTimeout;
+        this.clock = clock;
+        this.wip = new WIP(cueTimeout, clock);
+    }
+    configure(options) {
+        this.cueTimeout = options.cueTimeout;
+        this.wip.configure(options);
+    }
+    register(...subscribers) {
+        this.subscribers.push(...subscribers);
+    }
+    deregister(subscriber) {
+        this.subscribers.splice(this.subscribers.indexOf(subscriber), 1);
+    }
+    notifyOf(event) {
+        this.wip.recordIfAsync(event);
+        this.subscribers.forEach(crewMember => crewMember.notifyOf(event));
+    }
+    waitForAsyncOperationsToComplete() {
+        return new Promise((resolve, reject) => {
+            const timeout = setTimeout(() => {
+                clearInterval(interval);
+                return resolve();
+            }, this.cueTimeout.inMilliseconds());
+            const interval = setInterval(() => {
+                if (this.wip.hasAllOperationsCompleted()) {
+                    clearTimeout(timeout);
+                    clearInterval(interval);
+                    return resolve();
+                }
+            }, 10);
+        });
+    }
+    async waitForNextCue() {
+        await this.waitForAsyncOperationsToComplete();
+        if (this.wip.hasFailedOperations()) {
+            const error = new Error(this.wip.descriptionOfFailedOperations());
+            this.wip.resetFailedOperations();
+            throw error;
+        }
+        if (this.wip.hasActiveOperations()) {
+            throw new Error(this.wip.descriptionOfTimedOutOperations());
+        }
+    }
+    currentTime() {
+        return this.clock.now();
+    }
+}
+/**
+ * @package
+ */
+class WIP {
+    cueTimeout;
+    clock;
+    wip = new Map();
+    failedOperations = [];
+    constructor(cueTimeout, clock) {
+        this.cueTimeout = cueTimeout;
+        this.clock = clock;
+    }
+    configure(options) {
+        this.cueTimeout = options.cueTimeout;
+    }
+    recordIfAsync(event) {
+        if (event instanceof AsyncOperationAttempted) {
+            this.set(event.correlationId, {
+                name: event.name,
+                description: event.description,
+                startedAt: event.timestamp,
+            });
+        }
+        if (event instanceof AsyncOperationCompleted) {
+            this.delete(event.correlationId);
+        }
+        if (event instanceof AsyncOperationFailed) {
+            const original = this.get(event.correlationId);
+            this.failedOperations.push({
+                name: original.name,
+                description: original.description,
+                startedAt: original.startedAt,
+                duration: event.timestamp.diff(original.startedAt),
+                error: event.error,
+            });
+            this.delete(event.correlationId);
+        }
+    }
+    hasAllOperationsCompleted() {
+        return this.wip.size === 0;
+    }
+    hasActiveOperations() {
+        return this.wip.size > 0;
+    }
+    hasFailedOperations() {
+        return this.failedOperations.length > 0;
+    }
+    descriptionOfTimedOutOperations() {
+        const now = this.clock.now();
+        return this.activeOperations().reduce((acc, op) => acc.concat(`${now.diff(op.startedAt)} - [${op.name.value}] ${op.description.value}`), [`${this.header(this.wip.size)} within a ${this.cueTimeout} cue timeout:`]).join('\n');
+    }
+    descriptionOfFailedOperations() {
+        let message = `${this.header(this.failedOperations.length)}:\n`;
+        this.failedOperations.forEach((op) => {
+            message += `[${op.name.value}] ${op.description.value} - ${op.error.stack}\n---\n`;
+        });
+        return message;
+    }
+    resetFailedOperations() {
+        this.failedOperations.length = 0;
+    }
+    activeOperations() {
+        return Array.from(this.wip.values());
+    }
+    header(numberOfFailures) {
+        return numberOfFailures === 1
+            ? `1 async operation has failed to complete`
+            : `${numberOfFailures} async operations have failed to complete`;
+    }
+    set(correlationId, details) {
+        return this.wip.set(correlationId, details);
+    }
+    get(correlationId) {
+        return this.wip.get(this.asReference(correlationId));
+    }
+    delete(correlationId) {
+        this.wip.delete(this.asReference(correlationId));
+    }
+    asReference(key) {
+        for (const [k, v_] of this.wip.entries()) {
+            if (k.equals(key)) {
+                return k;
+            }
+        }
+        return undefined;
+    }
+}
+//# sourceMappingURL=StageManager.js.map

package/esm/stage/StageManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StageManager.js","sourceRoot":"","sources":["../../src/stage/StageManager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAK5G;;GAEG;AACH,MAAM,OAAO,YAAY;IAID;IAAuC;IAH1C,WAAW,GAA4B,EAAE,CAAC;IAC1C,GAAG,CAAM;IAE1B,YAAoB,UAAoB,EAAmB,KAAY;QAAnD,eAAU,GAAV,UAAU,CAAU;QAAmB,UAAK,GAAL,KAAK,CAAO;QACnE,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED,SAAS,CAAC,OAAiC;QACvC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED,QAAQ,CAAC,GAAG,WAAoC;QAC5C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;IAC1C,CAAC;IAED,UAAU,CAAC,UAAiC;QACxC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,QAAQ,CAAC,KAAkB;QACvB,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAE9B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,gCAAgC;QAC5B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAEnC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,aAAa,CAAC,QAAQ,CAAC,CAAC;gBAExB,OAAO,OAAO,EAAE,CAAC;YACrB,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;YAErC,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;gBAC9B,IAAI,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,CAAC;oBACvC,YAAY,CAAC,OAAO,CAAC,CAAC;oBACtB,aAAa,CAAC,QAAQ,CAAC,CAAC;oBAExB,OAAO,OAAO,EAAE,CAAC;gBACrB,CAAC;YACL,CAAC,EAAE,EAAE,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,cAAc;QAEhB,MAAM,IAAI,CAAC,gCAAgC,EAAE,CAAC;QAE9C,IAAI,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,6BAA6B,EAAE,CAAC,CAAC;YAElE,IAAI,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC;YAEjC,MAAM,KAAK,CAAC;QAChB,CAAC;QAED,IAAI,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,CAAC,CAAC;QAChE,CAAC;IACL,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IAC5B,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,GAAG;IAKO;IACS;IALJ,GAAG,GAAG,IAAI,GAAG,EAAwC,CAAC;IACtD,gBAAgB,GAAkC,EAAE,CAAC;IAEtE,YACY,UAAoB,EACX,KAAY;QADrB,eAAU,GAAV,UAAU,CAAU;QACX,UAAK,GAAL,KAAK,CAAO;IAEjC,CAAC;IAED,SAAS,CAAC,OAAiC;QACvC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACzC,CAAC;IAED,aAAa,CAAC,KAAkB;QAC5B,IAAI,KAAK,YAAY,uBAAuB,EAAE,CAAC;YAC3C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,EAAE;gBAC1B,IAAI,EAAY,KAAK,CAAC,IAAI;gBAC1B,WAAW,EAAK,KAAK,CAAC,WAAW;gBACjC,SAAS,EAAO,KAAK,CAAC,SAAS;aAClC,CAAC,CAAC;QACP,CAAC;QAED,IAAI,KAAK,YAAY,uBAAuB,EAAE,CAAC;YAC3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,KAAK,YAAY,oBAAoB,EAAE,CAAC;YACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAE/C,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBACvB,IAAI,EAAY,QAAQ,CAAC,IAAI;gBAC7B,WAAW,EAAK,QAAQ,CAAC,WAAW;gBACpC,SAAS,EAAO,QAAQ,CAAC,SAAS;gBAClC,QAAQ,EAAQ,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACxD,KAAK,EAAW,KAAK,CAAC,KAAK;aAC9B,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;QACpC,CAAC;IACL,CAAC;IAED,yBAAyB;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,mBAAmB;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,mBAAmB;QACf,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,+BAA+B;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAE7B,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,MAAM,CACjC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAI,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAE,OAAQ,EAAE,CAAC,IAAI,CAAC,KAAM,KAAM,EAAE,CAAC,WAAW,CAAC,KAAM,EAAE,CAAC,EACvG,CAAC,GAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAE,aAAc,IAAI,CAAC,UAAW,eAAe,CAAC,CACjF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,6BAA6B;QACzB,IAAI,OAAO,GAAG,GAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAE,KAAK,CAAC;QAElE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,EAA+B,EAAE,EAAE;YAC9D,OAAO,IAAI,IAAK,EAAE,CAAC,IAAI,CAAC,KAAM,KAAM,EAAE,CAAC,WAAW,CAAC,KAAM,MAAO,EAAE,CAAC,KAAK,CAAC,KAAM,SAAS,CAAC;QAC7F,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,qBAAqB;QACjB,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC;IACrC,CAAC;IAEO,gBAAgB;QACpB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,CAAC;IAEO,MAAM,CAAC,gBAAwB;QACnC,OAAO,gBAAgB,KAAK,CAAC;YACzB,CAAC,CAAC,0CAA0C;YAC5C,CAAC,CAAC,GAAI,gBAAiB,2CAA2C,CAAC;IAC3E,CAAC;IAEO,GAAG,CAAC,aAA4B,EAAE,OAA8B;QACpE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAEO,GAAG,CAAC,aAA4B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC;IACzD,CAAC;IAEO,MAAM,CAAC,aAA4B;QACvC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAA;IACpD,CAAC;IAEO,WAAW,CAAC,GAAkB;QAClC,KAAK,MAAM,CAAE,CAAC,EAAE,EAAE,CAAE,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;YACzC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChB,OAAO,CAAC,CAAC;YACb,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ"}

package/esm/stage/crew/artifact-archiver/ArtifactArchiver.d.ts

@@ -0,0 +1,126 @@
+import type { DomainEvent } from '../../../events/index.js';
+import { FileSystem } from '../../../io/index.js';
+import type { Stage } from '../../Stage.js';
+import type { StageCrewMember } from '../../StageCrewMember.js';
+/**
+ * Stores any artifacts emitted via [`ArtifactGenerated`](https://serenity-js.org/api/core-events/class/ArtifactGenerated/) events on the file system.
+ *
+ * ## Registering Artifact Archiver programmatically
+ *
+ * ```ts
+ * import { ArtifactArchiver, configure } from '@serenity-js/core'
+ *
+ * configure({
+ *   crew: [
+ *     ArtifactArchiver.storingArtifactsAt(`/target/site/serenity`),
+ *   ]
+ *   // other Serenity/JS config
+ * })
+ * ```
+ *
+ * ## Using Artifact Archiver with Playwright Test
+ *
+ * ```ts
+ * // playwright.config.ts
+ * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
+ *
+ * const config: PlaywrightTestConfig = {
+ *   testDir: './spec',
+ *
+ *   reporter: [
+ *     [ '@serenity-js/playwright-test', {
+ *       crew: [
+ *         '@serenity-js/serenity-bdd',
+ *         [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *       ]
+ *       // other Serenity/JS config
+ *     }]
+ *   ],
+ *   // other Playwright Test config
+ * }
+ * ```
+ *
+ * ## Using Artifact Archiver with WebdriverIO
+ *
+ * ```ts
+ * // wdio.conf.ts
+ * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
+ *
+ * export const config: WebdriverIOConfig = {
+ *
+ *   framework: '@serenity-js/webdriverio',
+ *
+ *   serenity: {
+ *     crew: [
+ *      '@serenity-js/serenity-bdd',
+ *       [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *     ]
+ *     // other Serenity/JS config
+ *   },
+ *   // other WebdriverIO config
+ * }
+ * ```
+ *
+ * ## Using Artifact Archiver with Protractor
+ *
+ * ```js
+ * // protractor.conf.js
+ * exports.config = {
+ *   framework:     'custom',
+ *   frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
+ *
+ *   serenity: {
+ *     crew: [
+ *       '@serenity-js/serenity-bdd',
+ *       [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *     ],
+ *     // other Serenity/JS config
+ *   },
+ *   // other Protractor config
+ * }
+ * ```
+ *
+ * @group Stage
+ */
+export declare class ArtifactArchiver implements StageCrewMember {
+    private readonly fileSystem;
+    private stage?;
+    /**
+     * Instantiates an `ArtifactArchiver` storing artifacts in a given `destination`.
+     * The `destination` directory will be created automatically and recursively if it doesn't exist.
+     *
+     * @param destination
+     */
+    static storingArtifactsAt(...destination: string[]): StageCrewMember;
+    /**
+     * Instantiates an `ArtifactArchiver` storing artifacts in a given `outputDirectory`.
+     * The `outputDirectory` will be created automatically and recursively if it doesn't exist.
+     *
+     * @param config
+     */
+    static fromJSON(config: {
+        outputDirectory: string;
+    }): StageCrewMember;
+    /**
+     * @param {FileSystem} fileSystem
+     * @param {Stage} [stage]
+     *  The stage this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) should be assigned to
+     */
+    constructor(fileSystem: FileSystem, stage?: Stage);
+    assignedTo(stage: Stage): StageCrewMember;
+    /**
+     * Handles [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects emitted by the [`StageManager`](https://serenity-js.org/api/core/class/StageManager/).
+     *
+     * @see [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
+     *
+     * @listens {ArtifactGenerated}
+     * @emits {ArtifactArchived}
+     *
+     * @param event
+     */
+    notifyOf(event: DomainEvent): void;
+    private fileNameFor;
+    private archive;
+    private archivisationAnnouncement;
+}
+//# sourceMappingURL=ArtifactArchiver.d.ts.map

package/esm/stage/crew/artifact-archiver/ArtifactArchiver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArtifactArchiver.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/ArtifactArchiver.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAU3D,OAAO,EAAE,UAAU,EAAQ,MAAM,sBAAsB,CAAC;AAGxD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAGhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AACH,qBAAa,gBAAiB,YAAW,eAAe;IAkChD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,KAAK,CAAC;IAjClB;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,eAAe;IAQpE;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,GAAG,eAAe;IAMrE;;;;OAIG;gBAEkB,UAAU,EAAE,UAAU,EAC/B,KAAK,CAAC,EAAE,KAAK;IAIzB,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAKzC;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IA8BlC,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,OAAO;IAwBf,OAAO,CAAC,yBAAyB;CAwBpC"}

package/esm/stage/crew/artifact-archiver/ArtifactArchiver.js

@@ -0,0 +1,186 @@
+import { ensure, isDefined, isGreaterThan, isString, property } from 'tiny-types';
+import { ActivityRelatedArtifactArchived, ActivityRelatedArtifactGenerated, ArtifactArchived, ArtifactGenerated, AsyncOperationAttempted, AsyncOperationCompleted, AsyncOperationFailed } from '../../../events/index.js';
+import { FileSystem, Path } from '../../../io/index.js';
+import { CorrelationId, Description, Name, Photo, TestReport } from '../../../model/index.js';
+import { Hash } from './Hash.js';
+/**
+ * Stores any artifacts emitted via [`ArtifactGenerated`](https://serenity-js.org/api/core-events/class/ArtifactGenerated/) events on the file system.
+ *
+ * ## Registering Artifact Archiver programmatically
+ *
+ * ```ts
+ * import { ArtifactArchiver, configure } from '@serenity-js/core'
+ *
+ * configure({
+ *   crew: [
+ *     ArtifactArchiver.storingArtifactsAt(`/target/site/serenity`),
+ *   ]
+ *   // other Serenity/JS config
+ * })
+ * ```
+ *
+ * ## Using Artifact Archiver with Playwright Test
+ *
+ * ```ts
+ * // playwright.config.ts
+ * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test'
+ *
+ * const config: PlaywrightTestConfig = {
+ *   testDir: './spec',
+ *
+ *   reporter: [
+ *     [ '@serenity-js/playwright-test', {
+ *       crew: [
+ *         '@serenity-js/serenity-bdd',
+ *         [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *       ]
+ *       // other Serenity/JS config
+ *     }]
+ *   ],
+ *   // other Playwright Test config
+ * }
+ * ```
+ *
+ * ## Using Artifact Archiver with WebdriverIO
+ *
+ * ```ts
+ * // wdio.conf.ts
+ * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
+ *
+ * export const config: WebdriverIOConfig = {
+ *
+ *   framework: '@serenity-js/webdriverio',
+ *
+ *   serenity: {
+ *     crew: [
+ *      '@serenity-js/serenity-bdd',
+ *       [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *     ]
+ *     // other Serenity/JS config
+ *   },
+ *   // other WebdriverIO config
+ * }
+ * ```
+ *
+ * ## Using Artifact Archiver with Protractor
+ *
+ * ```js
+ * // protractor.conf.js
+ * exports.config = {
+ *   framework:     'custom',
+ *   frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
+ *
+ *   serenity: {
+ *     crew: [
+ *       '@serenity-js/serenity-bdd',
+ *       [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *     ],
+ *     // other Serenity/JS config
+ *   },
+ *   // other Protractor config
+ * }
+ * ```
+ *
+ * @group Stage
+ */
+export class ArtifactArchiver {
+    fileSystem;
+    stage;
+    /**
+     * Instantiates an `ArtifactArchiver` storing artifacts in a given `destination`.
+     * The `destination` directory will be created automatically and recursively if it doesn't exist.
+     *
+     * @param destination
+     */
+    static storingArtifactsAt(...destination) {
+        ensure('Path to destination directory', destination, property('length', isGreaterThan(0)));
+        const pathToDestination = destination.map(segment => new Path(segment)).reduce((acc, current) => acc.join(current));
+        return new ArtifactArchiver(new FileSystem(pathToDestination));
+    }
+    /**
+     * Instantiates an `ArtifactArchiver` storing artifacts in a given `outputDirectory`.
+     * The `outputDirectory` will be created automatically and recursively if it doesn't exist.
+     *
+     * @param config
+     */
+    static fromJSON(config) {
+        const outputDirectory = ensure('outputDirectory', config.outputDirectory, isDefined(), isString());
+        return new ArtifactArchiver(new FileSystem(Path.from(outputDirectory)));
+    }
+    /**
+     * @param {FileSystem} fileSystem
+     * @param {Stage} [stage]
+     *  The stage this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) should be assigned to
+     */
+    constructor(fileSystem, stage) {
+        this.fileSystem = fileSystem;
+        this.stage = stage;
+    }
+    assignedTo(stage) {
+        this.stage = stage;
+        return this;
+    }
+    /**
+     * Handles [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects emitted by the [`StageManager`](https://serenity-js.org/api/core/class/StageManager/).
+     *
+     * @see [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
+     *
+     * @listens {ArtifactGenerated}
+     * @emits {ArtifactArchived}
+     *
+     * @param event
+     */
+    notifyOf(event) {
+        if (!(event instanceof ArtifactGenerated)) {
+            // ignore any other events
+            return void 0;
+        }
+        if (event.artifact instanceof Photo) {
+            const filename = this.fileNameFor('photo', event.name, event.artifact, 'png');
+            this.archive(filename, event.artifact.base64EncodedValue, 'base64', this.archivisationAnnouncement(event, filename));
+        }
+        if (event.artifact instanceof TestReport) {
+            const filename = this.fileNameFor('scenario', event.name, event.artifact, 'json');
+            this.archive(filename, event.artifact.map(JSON.stringify), 'utf8', this.archivisationAnnouncement(event, filename));
+        }
+    }
+    fileNameFor(prefix, artifactName, artifact, extension) {
+        const hash = Hash.of(artifact.base64EncodedValue).short();
+        return Path.fromSanitisedString(
+        // Ensure that the file name is shorter than 250 chars, which is safe with all the filesystems
+        // note: we can't do that in the Path constructor as the Path can be used to join other paths,
+        // so restricting the length of the _path_ itself would not be correct.
+        `${prefix.slice(0, 10)}-${urlFriendly(artifactName.value).slice(0, 64)}-${hash}.${extension}`.replaceAll(/-+/g, '-'));
+    }
+    archive(relativePath, contents, encoding, announce) {
+        const id = CorrelationId.create();
+        this.stage.announce(new AsyncOperationAttempted(new Name(this.constructor.name), new Description(`Saving '${relativePath.value}'...`), id, this.stage.currentTime()));
+        this.fileSystem.store(relativePath, contents, encoding)
+            .then(absolutePath_ => {
+            announce(relativePath);
+            this.stage.announce(new AsyncOperationCompleted(id, this.stage.currentTime()));
+        })
+            .catch(error => {
+            this.stage.announce(new AsyncOperationFailed(error, id, this.stage.currentTime()));
+        });
+    }
+    archivisationAnnouncement(event, relativePathToArtifact) {
+        return (absolutePath) => {
+            if (event instanceof ActivityRelatedArtifactGenerated) {
+                this.stage.announce(new ActivityRelatedArtifactArchived(event.sceneId, event.activityId, event.name, event.artifact.constructor, relativePathToArtifact, event.timestamp, this.stage.currentTime()));
+            }
+            else if (event instanceof ArtifactGenerated) {
+                this.stage.announce(new ArtifactArchived(event.sceneId, event.name, event.artifact.constructor, relativePathToArtifact, event.timestamp, this.stage.currentTime()));
+            }
+        };
+    }
+}
+/**
+ * @private
+ * @param {string} name
+ */
+function urlFriendly(name) {
+    return name.toLocaleLowerCase()
+        .replaceAll(/[^\d.a-z-]/g, '-');
+}
+//# sourceMappingURL=ArtifactArchiver.js.map

package/esm/stage/crew/artifact-archiver/ArtifactArchiver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArtifactArchiver.js","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/ArtifactArchiver.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGlF,OAAO,EACH,+BAA+B,EAC/B,gCAAgC,EAChC,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,uBAAuB,EACvB,oBAAoB,EACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAG9F,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AACH,MAAM,OAAO,gBAAgB;IAkCJ;IACT;IAjCZ;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAG,WAAqB;QAC9C,MAAM,CAAC,+BAA+B,EAAE,WAAW,EAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3F,MAAM,iBAAiB,GAAG,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAEpH,OAAO,IAAI,gBAAgB,CAAC,IAAI,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAmC;QAC/C,MAAM,eAAe,GAAG,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,eAAe,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAEnG,OAAO,IAAI,gBAAgB,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,YACqB,UAAsB,EAC/B,KAAa;QADJ,eAAU,GAAV,UAAU,CAAY;QAC/B,UAAK,GAAL,KAAK,CAAQ;IAEzB,CAAC;IAED,UAAU,CAAC,KAAY;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAkB;QAEvB,IAAI,CAAC,CAAC,KAAK,YAAY,iBAAiB,CAAC,EAAE,CAAC;YACxC,0BAA0B;YAC1B,OAAO,KAAK,CAAC,CAAC;QAClB,CAAC;QAED,IAAI,KAAK,CAAC,QAAQ,YAAY,KAAK,EAAE,CAAC;YAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAE9E,IAAI,CAAC,OAAO,CACR,QAAQ,EACR,KAAK,CAAC,QAAQ,CAAC,kBAAkB,EACjC,QAAQ,EACR,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAClD,CAAC;QACN,CAAC;QAED,IAAI,KAAK,CAAC,QAAQ,YAAY,UAAU,EAAE,CAAC;YACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAElF,IAAI,CAAC,OAAO,CACR,QAAQ,EACR,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAClC,MAAM,EACN,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAClD,CAAC;QACN,CAAC;IACL,CAAC;IAEO,WAAW,CAAC,MAAc,EAAE,YAAkB,EAAE,QAAkB,EAAE,SAAiB;QACzF,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,CAAC;QAE1D,OAAO,IAAI,CAAC,mBAAmB;QAC3B,8FAA8F;QAC9F,8FAA8F;QAC9F,uEAAuE;QACvE,GAAI,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAE,IAAK,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAE,IAAK,IAAK,IAAK,SAAU,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAE/H,CAAC;IACN,CAAC;IAEO,OAAO,CAAC,YAAkB,EAAE,QAAgB,EAAE,QAA0B,EAAE,QAAsC;QACpH,MAAM,EAAE,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,uBAAuB,CAC3C,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAC/B,IAAI,WAAW,CAAC,WAAY,YAAY,CAAC,KAAM,MAAM,CAAC,EACtD,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAC;aAClD,IAAI,CAAC,aAAa,CAAC,EAAE;YAClB,QAAQ,CAAC,YAAY,CAAC,CAAC;YAEvB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,uBAAuB,CAC3C,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;QACP,CAAC,CAAC;aACD,KAAK,CAAC,KAAK,CAAC,EAAE;YACX,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,oBAAoB,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;IACX,CAAC;IAEO,yBAAyB,CAAC,KAA2D,EAAE,sBAA4B;QACvH,OAAO,CAAC,YAAkB,EAAE,EAAE;YAC1B,IAAI,KAAK,YAAY,gCAAgC,EAAE,CAAC;gBACpD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,+BAA+B,CACnD,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,UAAU,EAChB,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,CAAC,WAA2B,EAC1C,sBAAsB,EACtB,KAAK,CAAC,SAAS,EACf,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;YACP,CAAC;iBAAM,IAAI,KAAK,YAAY,iBAAiB,EAAE,CAAC;gBAC5C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CACpC,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,CAAC,WAA2B,EAC1C,sBAAsB,EACtB,KAAK,CAAC,SAAS,EACf,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;YACP,CAAC;QACL,CAAC,CAAC;IACN,CAAC;CACJ;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,IAAY;IAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE;SAC1B,UAAU,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;AACxC,CAAC"}

package/esm/stage/crew/artifact-archiver/Hash.d.ts

@@ -0,0 +1,12 @@
+import { TinyType } from 'tiny-types';
+/**
+ * @package
+ */
+export declare class Hash extends TinyType {
+    readonly value: string;
+    static of(value: string): Hash;
+    constructor(value: string);
+    long(): string;
+    short(): string;
+}
+//# sourceMappingURL=Hash.d.ts.map

package/esm/stage/crew/artifact-archiver/Hash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Hash.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/Hash.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEzD;;GAEG;AACH,qBAAa,IAAK,SAAQ,QAAQ;aAKF,KAAK,EAAE,MAAM;IAJzC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;gBAIF,KAAK,EAAE,MAAM;IAKzC,IAAI,IAAI,MAAM;IAId,KAAK,IAAI,MAAM;CAGlB"}

package/esm/stage/crew/artifact-archiver/Hash.js

@@ -0,0 +1,23 @@
+import { createHash } from 'crypto';
+import { ensure, isDefined, TinyType } from 'tiny-types';
+/**
+ * @package
+ */
+export class Hash extends TinyType {
+    value;
+    static of(value) {
+        return new Hash(createHash('sha1').update(value).digest('hex'));
+    }
+    constructor(value) {
+        super();
+        this.value = value;
+        ensure(this.constructor.name, value, isDefined());
+    }
+    long() {
+        return this.value;
+    }
+    short() {
+        return this.value.slice(0, 10);
+    }
+}
+//# sourceMappingURL=Hash.js.map

package/esm/stage/crew/artifact-archiver/Hash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Hash.js","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/Hash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEzD;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,QAAQ;IAKF;IAJ5B,MAAM,CAAC,EAAE,CAAC,KAAa;QACnB,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,CAAC;IAED,YAA4B,KAAa;QACrC,KAAK,EAAE,CAAC;QADgB,UAAK,GAAL,KAAK,CAAQ;QAErC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED,KAAK;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;CACJ"}

package/esm/stage/crew/artifact-archiver/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ArtifactArchiver.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/stage/crew/artifact-archiver/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}

package/esm/stage/crew/artifact-archiver/index.js

@@ -0,0 +1,2 @@
+export * from './ArtifactArchiver.js';
+//# sourceMappingURL=index.js.map

package/esm/stage/crew/artifact-archiver/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}

package/esm/stage/crew/index.d.ts

@@ -0,0 +1,3 @@
+export * from './artifact-archiver/index.js';
+export * from './stream-reporter/index.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/stage/crew/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/stage/crew/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC"}

package/esm/stage/crew/index.js

@@ -0,0 +1,3 @@
+export * from './artifact-archiver/index.js';
+export * from './stream-reporter/index.js';
+//# sourceMappingURL=index.js.map

package/esm/stage/crew/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/stage/crew/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC"}