@serenity-js/core 3.7.2 → 3.9.0

package/lib/stage/crew/stream-reporter/StreamReporter.d.ts

@@ -5,7 +5,7 @@ import type { Stage } from '../../Stage';
 import type { StageCrewMember } from '../../StageCrewMember';
 /**
  * Serialises all the {@apilink DomainEvent} objects it receives and streams
- * them as [ndjson](http://ndjson.org/) to the output stream.
+ * them as [ndjson](http://ndjson.org/) to the output stream or file.
  *
  * Useful when debugging issues related to custom Serenity/JS test runner adapters.
  *
@@ -34,43 +34,61 @@ import type { StageCrewMember } from '../../StageCrewMember';
  * })
  * ```
  *
- * ## Registering `StreamReporter` using Protractor configuration
+ * ## Using `StreamReporter` 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/core:StreamReporter', { outputFile: './events.ndjson' }]
+ *       ]
+ *       // other Serenity/JS config
+ *     }]
+ *   ],
+ *   // other Playwright Test config
+ * }
+ * ```
+ *
+ * ## Using `StreamReporter` with Protractor
  *
  * ```js
  * // protractor.conf.js
- * const { StreamReporter } = require('@serenity-js/core');
- *
  * exports.config = {
  *   framework:     'custom',
  *   frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
  *
  *   serenity: {
  *     crew: [
- *       new StreamReporter(process.stdout),
+ *       [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
  *     ],
  *     // other Serenity/JS config
  *   },
  *   // other Protractor config
- * };
+ * }
  * ```
  *
- * ## Registering `StreamReporter` using WebdriverIO configuration
+ * ## Using `StreamReporter` with WebdriverIO
  *
  * ```ts
- * // wdio.conf.js
- * import { StreamReporter } from '@serenity-js/core'
+ * // wdio.conf.ts
  * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
  *
  * export const config: WebdriverIOConfig = {
  *
- *     framework: '@serenity-js/webdriverio',
+ *   framework: '@serenity-js/webdriverio',
  *
- *     serenity: {
- *         crew: [
- *           new StreamReporter(process.stdout),
- *         ]
- *         // other Serenity/JS config
- *     },
+ *   serenity: {
+ *     crew: [
+ *       '@serenity-js/serenity-bdd',
+ *       [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
+ *     ]
+ *     // other Serenity/JS config
  *   },
  *   // other WebdriverIO config
  * }
@@ -81,6 +99,16 @@ import type { StageCrewMember } from '../../StageCrewMember';
 export declare class StreamReporter implements StageCrewMember {
     private readonly output;
     private readonly stage?;
+    /**
+     * Instantiates a `StreamReporter` outputting a stream of {@apilink DomainEvent|domain events}
+     * to an `outputFile` at the given location.
+     *
+     * @param config
+     */
+    static fromJSON(config: {
+        outputFile: string;
+        cwd?: string;
+    }): StageCrewMember;
     /**
      * @param {stream~Writable} output
      *  A Writable stream that should receive the output

package/lib/stage/crew/stream-reporter/StreamReporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StreamReporter.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/stream-reporter/StreamReporter.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAEvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,qBAAa,cAAe,YAAW,eAAe;IAU9C,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IAT3B;;;;;;OAMG;gBAEkB,MAAM,GAAE,QAAyB,EACjC,KAAK,CAAC,EAAE,KAAK;IAIlC;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAIzC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;CAKrC"}
+{"version":3,"file":"StreamReporter.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/stream-reporter/StreamReporter.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAGvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4FG;AACH,qBAAa,cAAe,YAAW,eAAe;IAyB9C,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IAxB3B;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,eAAe;IAS9E;;;;;;OAMG;gBAEkB,MAAM,GAAE,QAAyB,EACjC,KAAK,CAAC,EAAE,KAAK;IAIlC;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAIzC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;CAKrC"}

package/lib/stage/crew/stream-reporter/StreamReporter.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StreamReporter = void 0;
+const tiny_types_1 = require("tiny-types");
+const io_1 = require("../../../io");
 /**
  * Serialises all the {@apilink DomainEvent} objects it receives and streams
- * them as [ndjson](http://ndjson.org/) to the output stream.
+ * them as [ndjson](http://ndjson.org/) to the output stream or file.
  *
  * Useful when debugging issues related to custom Serenity/JS test runner adapters.
  *
@@ -32,43 +34,61 @@ exports.StreamReporter = void 0;
  * })
  * ```
  *
- * ## Registering `StreamReporter` using Protractor configuration
+ * ## Using `StreamReporter` 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/core:StreamReporter', { outputFile: './events.ndjson' }]
+ *       ]
+ *       // other Serenity/JS config
+ *     }]
+ *   ],
+ *   // other Playwright Test config
+ * }
+ * ```
+ *
+ * ## Using `StreamReporter` with Protractor
  *
  * ```js
  * // protractor.conf.js
- * const { StreamReporter } = require('@serenity-js/core');
- *
  * exports.config = {
  *   framework:     'custom',
  *   frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
  *
  *   serenity: {
  *     crew: [
- *       new StreamReporter(process.stdout),
+ *       [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
  *     ],
  *     // other Serenity/JS config
  *   },
  *   // other Protractor config
- * };
+ * }
  * ```
  *
- * ## Registering `StreamReporter` using WebdriverIO configuration
+ * ## Using `StreamReporter` with WebdriverIO
  *
  * ```ts
- * // wdio.conf.js
- * import { StreamReporter } from '@serenity-js/core'
+ * // wdio.conf.ts
  * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
  *
  * export const config: WebdriverIOConfig = {
  *
- *     framework: '@serenity-js/webdriverio',
+ *   framework: '@serenity-js/webdriverio',
  *
- *     serenity: {
- *         crew: [
- *           new StreamReporter(process.stdout),
- *         ]
- *         // other Serenity/JS config
- *     },
+ *   serenity: {
+ *     crew: [
+ *       '@serenity-js/serenity-bdd',
+ *       [ '@serenity-js/core:StreamReporter', { outputFile: './events.ndjson' }]
+ *     ]
+ *     // other Serenity/JS config
  *   },
  *   // other WebdriverIO config
  * }
@@ -77,6 +97,18 @@ exports.StreamReporter = void 0;
  * @group Stage
  */
 class StreamReporter {
+    /**
+     * Instantiates a `StreamReporter` outputting a stream of {@apilink DomainEvent|domain events}
+     * to an `outputFile` at the given location.
+     *
+     * @param config
+     */
+    static fromJSON(config) {
+        const outputFile = (0, tiny_types_1.ensure)('outputFile', config?.outputFile, (0, tiny_types_1.isDefined)(), (0, tiny_types_1.isString)());
+        const cwd = config.cwd || process.cwd();
+        const fs = new io_1.FileSystem(io_1.Path.from(cwd));
+        return new StreamReporter(fs.createWriteStreamTo(io_1.Path.from(outputFile)));
+    }
     /**
      * @param {stream~Writable} output
      *  A Writable stream that should receive the output

package/lib/stage/crew/stream-reporter/StreamReporter.js.map

@@ -1 +1 @@
-{"version":3,"file":"StreamReporter.js","sourceRoot":"","sources":["../../../../src/stage/crew/stream-reporter/StreamReporter.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,MAAa,cAAc;IAEvB;;;;;;OAMG;IACH,YACqB,SAAmB,OAAO,CAAC,MAAM,EACjC,KAAa;QADb,WAAM,GAAN,MAAM,CAA2B;QACjC,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAY;QACnB,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,KAAkB;QACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CACb,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,IAAI,CACjF,CAAC;IACN,CAAC;CACJ;AAxCD,wCAwCC"}
+{"version":3,"file":"StreamReporter.js","sourceRoot":"","sources":["../../../../src/stage/crew/stream-reporter/StreamReporter.ts"],"names":[],"mappings":";;;AACA,2CAAyD;AAGzD,oCAA+C;AAI/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4FG;AACH,MAAa,cAAc;IAEvB;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAA4C;QACxD,MAAM,UAAU,GAAG,IAAA,mBAAM,EAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,GAAE,CAAC,CAAC;QACrF,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAExC,MAAM,EAAE,GAAG,IAAI,eAAU,CAAC,SAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;QAEzC,OAAO,IAAI,cAAc,CAAC,EAAE,CAAC,mBAAmB,CAAC,SAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,YACqB,SAAmB,OAAO,CAAC,MAAM,EACjC,KAAa;QADb,WAAM,GAAN,MAAM,CAA2B;QACjC,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAY;QACnB,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,KAAkB;QACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CACb,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,IAAI,CACjF,CAAC;IACN,CAAC;CACJ;AAvDD,wCAuDC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/core",
-  "version": "3.7.2",
+  "version": "3.9.0",
   "description": "Serenity/JS Screenplay, reporting engine and core interfaces.",
   "author": {
     "name": "Jan Molak",
@@ -71,5 +71,5 @@
   "engines": {
     "node": "^16.13 || ^18.12 || ^20"
   },
-  "gitHead": "1803ef1287e21b4b6239f0800788483fe4e9d580"
+  "gitHead": "9e882e469e9c6b1617e6f645b999036ba249478b"
 }

package/src/events/ActivityRelatedArtifactArchived.ts

@@ -22,6 +22,7 @@ export class ActivityRelatedArtifactArchived extends ArtifactArchived {
             Name.fromJSON(o.name as string),
             Artifact.ofType(o.type as string),
             Path.fromJSON(o.path as string),
+            Timestamp.fromJSON(o.artifactTimestamp as string),
             Timestamp.fromJSON(o.timestamp as string),
         );
     }
@@ -32,9 +33,10 @@ export class ActivityRelatedArtifactArchived extends ArtifactArchived {
         name: Name,
         type: ArtifactType,
         path: Path,
+        artifactTimestamp: Timestamp,
         timestamp?: Timestamp,
     ) {
-        super(sceneId, name, type, path, timestamp);
+        super(sceneId, name, type, path, artifactTimestamp, timestamp);
         ensure('activityId', activityId, isDefined());
     }
 
@@ -45,6 +47,7 @@ export class ActivityRelatedArtifactArchived extends ArtifactArchived {
             name: this.name.toJSON(),
             type: this.type.name,
             path: this.path.toJSON(),
+            artifactTimestamp: this.artifactTimestamp.toJSON(),
             timestamp: this.timestamp.toJSON(),
         };
     }

package/src/events/ArtifactArchived.ts

@@ -17,6 +17,7 @@ export class ArtifactArchived extends DomainEvent {
             Name.fromJSON(o.name as string),
             Artifact.ofType(o.type as string),
             Path.fromJSON(o.path as string),
+            Timestamp.fromJSON(o.artifactTimestamp as string),
             Timestamp.fromJSON(o.timestamp as string),
         );
     }
@@ -26,6 +27,7 @@ export class ArtifactArchived extends DomainEvent {
         public readonly name: Name,
         public readonly type: ArtifactType,
         public readonly path: Path,
+        public readonly artifactTimestamp: Timestamp,
         timestamp?: Timestamp,
     ) {
         super(timestamp);
@@ -34,6 +36,7 @@ export class ArtifactArchived extends DomainEvent {
         ensure('name', name, isDefined());
         ensure('type', type, isDefined());
         ensure('path', path, isDefined());
+        ensure('artifactTimestamp', artifactTimestamp, isDefined());
     }
 
     toJSON(): JSONObject {
@@ -41,6 +44,7 @@ export class ArtifactArchived extends DomainEvent {
             name: this.name.toJSON(),
             type: this.type.name,
             path: this.path.toJSON(),
+            createdAt: this.artifactTimestamp.toJSON(),
             timestamp: this.timestamp.toJSON(),
         };
     }

package/src/screenplay/Question.ts

@@ -2,12 +2,14 @@ import { isRecord } from 'tiny-types/lib/objects';
 import * as util from 'util'; // eslint-disable-line unicorn/import-style
 
 import { LogicError } from '../errors';
-import { f, inspectedObject } from '../io';
+import type { FileSystemLocation } from '../io';
+import { d, f, inspectedObject } from '../io';
 import type { UsesAbilities } from './abilities';
 import type { Answerable } from './Answerable';
 import { Interaction } from './Interaction';
 import type { Optional } from './Optional';
 import type { AnswersQuestions } from './questions/AnswersQuestions';
+import type { MetaQuestion } from './questions/MetaQuestion';
 import { Unanswered } from './questions/Unanswered';
 import type { RecursivelyAnswered } from './RecursivelyAnswered';
 import type { WithAnswerableProperties } from './WithAnswerableProperties';
@@ -123,9 +125,30 @@ export abstract class Question<T> {
      *
      * @param description
      * @param body
+     * @param [metaQuestionBody]
      */
-    static about<Result_Type>(description: string, body: (actor: AnswersQuestions & UsesAbilities) => Promise<Result_Type> | Result_Type): QuestionAdapter<Awaited<Result_Type>> {
-        return Question.createAdapter(new QuestionStatement(description, body));
+    static about<Answer_Type, Supported_Context_Type>(
+        description: string,
+        body: (actor: AnswersQuestions & UsesAbilities) => Promise<Answer_Type> | Answer_Type,
+        metaQuestionBody: (answerable: Answerable<Supported_Context_Type>) => Question<Promise<Answer_Type>> | Question<Answer_Type>,
+    ): MetaQuestionAdapter<Supported_Context_Type, Awaited<Answer_Type>>
+
+    static about<Answer_Type>(
+        description: string,
+        body: (actor: AnswersQuestions & UsesAbilities) => Promise<Answer_Type> | Answer_Type
+    ): QuestionAdapter<Awaited<Answer_Type>>
+
+    static about<Answer_Type, Supported_Context_Type extends Answerable<any>>(
+        description: string,
+        body: (actor: AnswersQuestions & UsesAbilities) => Promise<Answer_Type> | Answer_Type,
+        metaQuestionBody?: (answerable: Supported_Context_Type) => QuestionAdapter<Answer_Type>,
+    ): any
+    {
+        const statement = typeof metaQuestionBody === 'function'
+            ? new MetaQuestionStatement(description, body, metaQuestionBody)
+            : new QuestionStatement(description, body);
+
+        return Question.createAdapter(statement);
     }
 
     /**
@@ -429,13 +452,25 @@ export type QuestionAdapterFieldDecorator<Original_Type> = {
  *
  * @group Questions
  */
-export type QuestionAdapter<T> =
-    & Question<Promise<T>>
+export type QuestionAdapter<Answer_Type> =
+    & Question<Promise<Answer_Type>>
     & Interaction
     & { isPresent(): Question<Promise<boolean>>; }  // more specialised Optional
-    & QuestionAdapterFieldDecorator<T>;
+    & QuestionAdapterFieldDecorator<Answer_Type>;
 
-/** @package */
+/**
+ * An extension of {@apilink QuestionAdapter}, that in addition to proxying methods and fields
+ * of the wrapped object can also act as a {@apilink MetaQuestion}.
+ *
+ * @group Questions
+ */
+export type MetaQuestionAdapter<Context_Type, Answer_Type> =
+    & QuestionAdapter<Answer_Type>
+    & MetaQuestion<Context_Type, Answer_Type>
+
+/**
+ * @package
+ */
 class QuestionStatement<Answer_Type> extends Interaction implements Question<Promise<Answer_Type>>, Optional {
 
     private answer: Answer_Type | Unanswered = new Unanswered();
@@ -443,8 +478,9 @@ class QuestionStatement<Answer_Type> extends Interaction implements Question<Pro
     constructor(
         private subject: string,
         private readonly body: (actor: AnswersQuestions & UsesAbilities, ...Parameters) => Promise<Answer_Type> | Answer_Type,
+        location: FileSystemLocation = QuestionStatement.callerLocation(4),
     ) {
-        super(subject, QuestionStatement.callerLocation(4));
+        super(subject, location);
     }
 
     /**
@@ -490,6 +526,29 @@ class QuestionStatement<Answer_Type> extends Interaction implements Question<Pro
     }
 }
 
+/**
+ * @package
+ */
+class MetaQuestionStatement<Answer_Type, Supported_Context_Type extends Answerable<any>>
+    extends QuestionStatement<Answer_Type>
+    implements MetaQuestion<Supported_Context_Type, Answer_Type>
+{
+    constructor(
+        subject: string,
+        body: (actor: AnswersQuestions & UsesAbilities, ...Parameters) => Promise<Answer_Type> | Answer_Type,
+        private readonly metaQuestionBody: (answerable: Answerable<Supported_Context_Type>) => QuestionAdapter<Answer_Type>,
+    ) {
+        super(subject, body);
+    }
+
+    of(answerable: Answerable<Supported_Context_Type>): Question<Promise<Answer_Type>> | Question<Answer_Type> {
+        return Question.about(
+            d`${ this.toString() } of ${ answerable }`,
+            actor => actor.answer(this.metaQuestionBody(answerable))
+        );
+    }
+}
+
 /**
  * @package
  */

package/src/screenplay/questions/MetaQuestion.ts

@@ -2,11 +2,12 @@ import type { Answerable } from '../Answerable';
 import type { Question } from '../Question';
 
 /**
- * A "meta question" is a {@apilink Question} about another {@apilink Answerable},
- * used to retrieve a transformed version of the value that answerable holds.
+ * A meta-question is a {@apilink Question} that can be answered
+ * in the context of another {@apilink Answerable},
+ * typically to transform its value.
  *
- * For example, the question {@apilink Text.of}
- * returns text content of a {@apilink PageElement}.
+ * For example, the question {@apilink Text.of} can be answered in the context
+ * of a {@apilink PageElement} to return its text content.
  *
  * {@apilink MetaQuestion|Meta questions} are typically used when filtering a {@apilink List}.
  *
@@ -15,15 +16,15 @@ import type { Question } from '../Question';
  *
  * @group Questions
  */
-export interface MetaQuestion<Supported_Answerable_Type extends Answerable<any>, Answer> {
+export interface MetaQuestion<Supported_Context_Type, Answer_Type> {
 
     /**
-     * Transforms a given `answerable` to another {@apilink Question}.
+     * Answers the given `MetaQuestion` in the context of another {@apilink Answerable}.
      *
      * #### Learn more
      * - {@apilink List}
      */
-    of(answerable: Supported_Answerable_Type): Question<Answer>;
+    of(context: Answerable<Supported_Context_Type>): Question<Promise<Answer_Type>> | Question<Answer_Type>;
 
     /**
      * Human-readable description of this {@apilink MetaQuestion},

package/src/stage/crew/artifact-archiver/ArtifactArchiver.ts

@@ -20,7 +20,7 @@ import type { StageCrewMember } from '../../StageCrewMember';
 import { Hash } from './Hash';
 
 /**
- * Stores any {@apilink Artifact|artifacts} emitted via {@apilink ArtifactGenerated} events on the {@apilink FileSystem}
+ * Stores any {@apilink Artifact|artifacts} emitted via {@apilink ArtifactGenerated} events on the {@apilink FileSystem}.
  *
  * ## Registering `ArtifactArchiver` programmatically
  *
@@ -35,49 +35,69 @@ import { Hash } from './Hash';
  * })
  * ```
  *
- * ## Registering `ArtifactArchiver` using Protractor configuration
+ * ## Using `ArtifactArchiver` 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' } ],
+ *         [ '@serenity-js/core:StreamReporter', { outputFile: 'target/events.ndjson' }]
+ *       ]
+ *       // other Serenity/JS config
+ *     }]
+ *   ],
+ *   // other Playwright Test config
+ * }
+ * ```
+ *
+ * ## Using `ArtifactArchiver` with Protractor
  *
  * ```js
  * // protractor.conf.js
- * const { ArtifactArchiver } = require('@serenity-js/core')
- *
  * exports.config = {
  *   framework:     'custom',
  *   frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
  *
  *   serenity: {
  *     crew: [
- *       ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
+ *       '@serenity-js/serenity-bdd',
+ *       [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
  *     ],
  *     // other Serenity/JS config
  *   },
  *   // other Protractor config
- * };
+ * }
  * ```
  *
- * ## Registering `ArtifactArchiver` using WebdriverIO configuration
+ * ## Using `ArtifactArchiver` with WebdriverIO
  *
  * ```ts
- * // wdio.conf.js
- * import { ArtifactArchiver } from '@serenity-js/core'
+ * // wdio.conf.ts
  * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
  *
  * export const config: WebdriverIOConfig = {
  *
- *     framework: '@serenity-js/webdriverio',
+ *   framework: '@serenity-js/webdriverio',
  *
- *     serenity: {
- *         crew: [
- *             ArtifactArchiver.storingArtifactsAt(`/target/site/serenity`),
- *         ]
- *         // other Serenity/JS config
- *     },
- *     // other WebdriverIO config
+ *   serenity: {
+ *     crew: [
+ *      '@serenity-js/serenity-bdd',
+ *       [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *     ]
+ *     // other Serenity/JS config
+ *   },
+ *   // other WebdriverIO config
  * }
  * ```
  *
- * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
- *
  * @group Stage
  */
 export class ArtifactArchiver implements StageCrewMember {
@@ -209,6 +229,8 @@ export class ArtifactArchiver implements StageCrewMember {
                     event.name,
                     event.artifact.constructor as ArtifactType,
                     relativePathToArtifact,
+                    event.timestamp,
+                    this.stage.currentTime(),
                 ));
             } else if (event instanceof ArtifactGenerated) {
                 this.stage.announce(new ArtifactArchived(
@@ -216,6 +238,8 @@ export class ArtifactArchiver implements StageCrewMember {
                     event.name,
                     event.artifact.constructor as ArtifactType,
                     relativePathToArtifact,
+                    event.timestamp,
+                    this.stage.currentTime(),
                 ));
             }
         };