@serenity-js/core 3.0.0-rc.9 → 3.0.1

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

@@ -7,57 +7,72 @@ const io_1 = require("../../../io");
 const model_1 = require("../../../model");
 const Hash_1 = require("./Hash");
 /**
- * @desc
- *  Stores any {@link Artifact}s emitted via {@link ArtifactGenerated} events on the {@link FileSystem}
+ * Stores any {@apilink Artifact|artifacts} emitted via {@apilink ArtifactGenerated} events on the {@apilink FileSystem}
  *
- * @example <caption>Registering ArtifactArchiver programmatically</caption>
- *  import { configure, StreamReporter } from '@serenity-js/core';
+ * ## Registering `ArtifactArchiver` programmatically
  *
- *  configure({
- *      crew: [
- *          ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
- *      ],
- *  });
+ * ```ts
+ * import { ArtifactArchiver, configure } from '@serenity-js/core'
  *
- * @example <caption>Registering ArtifactArchiver using Protractor configuration</caption>
- *  // protractor.conf.js
- *  const { ArtifactArchiver } = require('@serenity-js/core');
+ * configure({
+ *   crew: [
+ *     ArtifactArchiver.storingArtifactsAt(`/target/site/serenity`),
+ *   ]
+ *   // other Serenity/JS config
+ * })
+ * ```
  *
- *  exports.config = {
- *    framework:     'custom',
- *    frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
+ * ## Registering `ArtifactArchiver` using Protractor configuration
  *
- *    serenity: {
- *      crew: [
- *        ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
- *      ],
- *      // other Serenity/JS config
- *    },
+ * ```js
+ * // protractor.conf.js
+ * const { ArtifactArchiver } = require('@serenity-js/core')
  *
- *    // other Protractor config
- *  };
+ * exports.config = {
+ *   framework:     'custom',
+ *   frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
  *
- * @public
- * @implements {StageCrewMember}
+ *   serenity: {
+ *     crew: [
+ *       ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
+ *     ],
+ *     // other Serenity/JS config
+ *   },
+ *   // other Protractor config
+ * };
+ * ```
+ *
+ * ## Registering `ArtifactArchiver` using WebdriverIO configuration
+ *
+ * ```ts
+ * // wdio.conf.js
+ * import { ArtifactArchiver } from '@serenity-js/core'
+ * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
+ *
+ * export const config: WebdriverIOConfig = {
+ *
+ *     framework: '@serenity-js/webdriverio',
+ *
+ *     serenity: {
+ *         crew: [
+ *             ArtifactArchiver.storingArtifactsAt(`/target/site/serenity`),
+ *         ]
+ *         // other Serenity/JS config
+ *     },
+ *     // other WebdriverIO config
+ * }
+ * ```
+ *
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
+ *
+ * @group Stage
  */
 class ArtifactArchiver {
     /**
-     * @param {FileSystem} fileSystem
-     * @param {Stage} [stage]
-     *  The stage this {@link StageCrewMember} should be assigned to
-     */
-    constructor(fileSystem, stage) {
-        this.fileSystem = fileSystem;
-        this.stage = stage;
-    }
-    /**
-     * @desc
-     *  Instantiates an `ArtifactArchiver` storing artifacts in a given `destination`.
-     *  The `destination` directory will be created automatically and recursively if it doesn't exist.
-     *
-     * @param {string[]} destination
+     * Instantiates an `ArtifactArchiver` storing artifacts in a given `destination`.
+     * The `destination` directory will be created automatically and recursively if it doesn't exist.
      *
-     * @returns {StageCrewMember}
+     * @param destination
      */
     static storingArtifactsAt(...destination) {
         (0, tiny_types_1.ensure)('Path to destination directory', destination, (0, tiny_types_1.property)('length', (0, tiny_types_1.isGreaterThan)(0)));
@@ -65,28 +80,37 @@ class ArtifactArchiver {
         return new ArtifactArchiver(new io_1.FileSystem(pathToDestination));
     }
     /**
-     * @desc
-     *  Creates a new instance of this {@link StageCrewMember} and assigns it to a given {@link Stage}.
+     * Instantiates an `ArtifactArchiver` storing artifacts in a given `outputDirectory`.
+     * The `outputDirectory` will be created automatically and recursively if it doesn't exist.
      *
-     * @see {@link StageCrewMember}
-     *
-     * @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 config
      */
+    static fromJSON(config) {
+        const outputDirectory = (0, tiny_types_1.ensure)('outputDirectory', config.outputDirectory, (0, tiny_types_1.isDefined)(), (0, tiny_types_1.isString)());
+        return new ArtifactArchiver(new io_1.FileSystem(io_1.Path.from(outputDirectory)));
+    }
+    /**
+     * @param {FileSystem} fileSystem
+     * @param {Stage} [stage]
+     *  The stage this {@apilink StageCrewMember} should be assigned to
+     */
+    constructor(fileSystem, stage) {
+        this.fileSystem = fileSystem;
+        this.stage = stage;
+    }
     assignedTo(stage) {
-        return new ArtifactArchiver(this.fileSystem, stage);
+        this.stage = stage;
+        return this;
     }
     /**
-     * @desc
-     *  Handles {@link DomainEvent} objects emitted by the {@link StageManager}.
+     * Handles {@apilink DomainEvent} objects emitted by the {@apilink StageManager}.
      *
-     * @see {@link StageCrewMember}
+     * @see {@apilink StageCrewMember}
      *
      * @listens {ArtifactGenerated}
      * @emits {ArtifactArchived}
      *
-     * @param {DomainEvent} event
-     * @returns {void}
+     * @param event
      */
     notifyOf(event) {
         if (!(event instanceof events_1.ArtifactGenerated)) {
@@ -112,14 +136,14 @@ class ArtifactArchiver {
     }
     archive(relativePath, contents, encoding, announce) {
         const id = model_1.CorrelationId.create();
-        this.stage.announce(new events_1.AsyncOperationAttempted(new model_1.Description(`[${this.constructor.name}] Saving '${relativePath.value}'...`), id));
+        this.stage.announce(new events_1.AsyncOperationAttempted(new model_1.Name(this.constructor.name), new model_1.Description(`Saving '${relativePath.value}'...`), id, this.stage.currentTime()));
         this.fileSystem.store(relativePath, contents, encoding)
-            .then(absolutePath => {
+            .then(absolutePath_ => {
             announce(relativePath);
-            this.stage.announce(new events_1.AsyncOperationCompleted(new model_1.Description(`[${this.constructor.name}] Saved '${absolutePath.value}'`), id));
+            this.stage.announce(new events_1.AsyncOperationCompleted(id, this.stage.currentTime()));
         })
             .catch(error => {
-            this.stage.announce(new events_1.AsyncOperationFailed(error, id));
+            this.stage.announce(new events_1.AsyncOperationFailed(error, id, this.stage.currentTime()));
         });
     }
     archivisationAnnouncement(event, relativePathToArtifact) {

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

@@ -1 +1 @@
-{"version":3,"file":"ArtifactArchiver.js","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/ArtifactArchiver.ts"],"names":[],"mappings":";;;AACA,2CAA6D;AAE7D,4CASyB;AACzB,oCAA+C;AAC/C,0CAA6G;AAG7G,iCAA8B;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAa,gBAAgB;IAmBzB;;;;OAIG;IACH,YACqB,UAAsB,EACtB,KAAa;QADb,eAAU,GAAV,UAAU,CAAY;QACtB,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;IA1BD;;;;;;;;OAQG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAG,WAAqB;QAC9C,IAAA,mBAAM,EAAC,+BAA+B,EAAE,WAAW,EAAE,IAAA,qBAAQ,EAAC,QAAQ,EAAE,IAAA,0BAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3F,MAAM,iBAAiB,GAAG,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,SAAI,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,eAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACnE,CAAC;IAaD;;;;;;;;OAQG;IACH,UAAU,CAAC,KAAY;QACnB,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,KAAkB;QAEvB,IAAI,CAAC,CAAC,KAAK,YAAY,0BAAiB,CAAC,EAAE;YACvC,0BAA0B;YAC1B,OAAO,KAAK,CAAC,CAAC;SACjB;QAED,IAAI,KAAK,CAAC,QAAQ,YAAY,aAAK,EAAE;YACjC,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;SACL;QAED,IAAI,KAAK,CAAC,QAAQ,YAAY,kBAAU,EAAE;YACtC,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;SACL;IACL,CAAC;IAEO,WAAW,CAAC,MAAc,EAAE,YAAkB,EAAE,QAAkB,EAAE,SAAiB;QACzF,MAAM,IAAI,GAAG,WAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,CAAC;QAE1D,OAAO,SAAI,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,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAE5H,CAAC;IACN,CAAC;IAEO,OAAO,CAAC,YAAkB,EAAE,QAAgB,EAAE,QAA0B,EAAE,QAAsC;QACpH,MAAM,EAAE,GAAG,qBAAa,CAAC,MAAM,EAAE,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC3C,IAAI,mBAAW,CAAC,IAAK,IAAI,CAAC,WAAW,CAAC,IAAK,aAAc,YAAY,CAAC,KAAM,MAAM,CAAC,EACnF,EAAE,CACL,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAC;aAClD,IAAI,CAAC,YAAY,CAAC,EAAE;YACjB,QAAQ,CAAC,YAAY,CAAC,CAAC;YAEvB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC3C,IAAI,mBAAW,CAAC,IAAK,IAAI,CAAC,WAAW,CAAC,IAAK,YAAa,YAAY,CAAC,KAAM,GAAG,CAAC,EAC/E,EAAE,CACL,CAAC,CAAC;QACP,CAAC,CAAC;aACD,KAAK,CAAC,KAAK,CAAC,EAAE;YACX,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,6BAAoB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACX,CAAC;IAEO,yBAAyB,CAAC,KAA2D,EAAE,sBAA4B;QACvH,OAAO,CAAC,YAAkB,EAAE,EAAE;YAC1B,IAAI,KAAK,YAAY,yCAAgC,EAAE;gBACnD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,wCAA+B,CACnD,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,UAAU,EAChB,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,CAAC,WAA2B,EAC1C,sBAAsB,CACzB,CAAC,CAAC;aACN;iBAAM,IAAI,KAAK,YAAY,0BAAiB,EAAE;gBAC3C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,yBAAgB,CACpC,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,CAAC,WAA2B,EAC1C,sBAAsB,CACzB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;IACN,CAAC;CACJ;AA3ID,4CA2IC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,IAAY;IAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE;SAC1B,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;AACrC,CAAC"}
+{"version":3,"file":"ArtifactArchiver.js","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/ArtifactArchiver.ts"],"names":[],"mappings":";;;AACA,2CAAkF;AAElF,4CASyB;AACzB,oCAA+C;AAC/C,0CAA6G;AAG7G,iCAA8B;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,MAAa,gBAAgB;IAEzB;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAG,WAAqB;QAC9C,IAAA,mBAAM,EAAC,+BAA+B,EAAE,WAAW,EAAE,IAAA,qBAAQ,EAAC,QAAQ,EAAE,IAAA,0BAAa,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3F,MAAM,iBAAiB,GAAG,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,SAAI,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,eAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAmC;QAC/C,MAAM,eAAe,GAAG,IAAA,mBAAM,EAAC,iBAAiB,EAAE,MAAM,CAAC,eAAe,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,GAAE,CAAC,CAAC;QAEnG,OAAO,IAAI,gBAAgB,CAAC,IAAI,eAAU,CAAC,SAAI,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,0BAAiB,CAAC,EAAE;YACvC,0BAA0B;YAC1B,OAAO,KAAK,CAAC,CAAC;SACjB;QAED,IAAI,KAAK,CAAC,QAAQ,YAAY,aAAK,EAAE;YACjC,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;SACL;QAED,IAAI,KAAK,CAAC,QAAQ,YAAY,kBAAU,EAAE;YACtC,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;SACL;IACL,CAAC;IAEO,WAAW,CAAC,MAAc,EAAE,YAAkB,EAAE,QAAkB,EAAE,SAAiB;QACzF,MAAM,IAAI,GAAG,WAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,CAAC;QAE1D,OAAO,SAAI,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,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAE5H,CAAC;IACN,CAAC;IAEO,OAAO,CAAC,YAAkB,EAAE,QAAgB,EAAE,QAA0B,EAAE,QAAsC;QACpH,MAAM,EAAE,GAAG,qBAAa,CAAC,MAAM,EAAE,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC3C,IAAI,YAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAC/B,IAAI,mBAAW,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,gCAAuB,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,6BAAoB,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,yCAAgC,EAAE;gBACnD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,wCAA+B,CACnD,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,UAAU,EAChB,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,CAAC,WAA2B,EAC1C,sBAAsB,CACzB,CAAC,CAAC;aACN;iBAAM,IAAI,KAAK,YAAY,0BAAiB,EAAE;gBAC3C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,yBAAgB,CACpC,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,CAAC,WAA2B,EAC1C,sBAAsB,CACzB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;IACN,CAAC;CACJ;AA5ID,4CA4IC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,IAAY;IAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE;SAC1B,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;AACrC,CAAC"}

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

@@ -9,3 +9,4 @@ export declare class Hash extends TinyType {
     long(): string;
     short(): string;
 }
+//# sourceMappingURL=Hash.d.ts.map

package/lib/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/lib/stage/crew/artifact-archiver/Hash.js

@@ -7,14 +7,14 @@ const tiny_types_1 = require("tiny-types");
  * @package
  */
 class Hash extends tiny_types_1.TinyType {
+    static of(value) {
+        return new Hash((0, crypto_1.createHash)('sha1').update(value).digest('hex'));
+    }
     constructor(value) {
         super();
         this.value = value;
         (0, tiny_types_1.ensure)(this.constructor.name, value, (0, tiny_types_1.isDefined)());
     }
-    static of(value) {
-        return new Hash((0, crypto_1.createHash)('sha1').update(value).digest('hex'));
-    }
     long() {
         return this.value;
     }

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

@@ -1 +1 @@
-{"version":3,"file":"Hash.js","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/Hash.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AACpC,2CAAyD;AAEzD;;GAEG;AACH,MAAa,IAAK,SAAQ,qBAAQ;IAK9B,YAA4B,KAAa;QACrC,KAAK,EAAE,CAAC;QADgB,UAAK,GAAL,KAAK,CAAQ;QAErC,IAAA,mBAAM,EAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;IACtD,CAAC;IAPD,MAAM,CAAC,EAAE,CAAC,KAAa;QACnB,OAAO,IAAI,IAAI,CAAC,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,CAAC;IAOD,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;AAjBD,oBAiBC"}
+{"version":3,"file":"Hash.js","sourceRoot":"","sources":["../../../../src/stage/crew/artifact-archiver/Hash.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AACpC,2CAAyD;AAEzD;;GAEG;AACH,MAAa,IAAK,SAAQ,qBAAQ;IAC9B,MAAM,CAAC,EAAE,CAAC,KAAa;QACnB,OAAO,IAAI,IAAI,CAAC,IAAA,mBAAU,EAAC,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,IAAA,mBAAM,EAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAA,sBAAS,GAAE,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;AAjBD,oBAiBC"}

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

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

package/lib/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,oBAAoB,CAAC"}

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

@@ -1,7 +1,11 @@
 "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]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

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

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

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

package/lib/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,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC"}

package/lib/stage/crew/index.js

@@ -1,7 +1,11 @@
 "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]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

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

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

@@ -4,48 +4,79 @@ import { DomainEvent } from '../../../events';
 import { Stage } from '../../Stage';
 import { StageCrewMember } from '../../StageCrewMember';
 /**
- * @desc
- *  Serialises all the {@link DomainEvent} objects it receives and streams
- *  them as [ndjson](http://ndjson.org/) to the output stream.
- *
- * @example <caption>Writing DomainEvents to standard output</caption>
- *  import { configure, StreamReporter } from '@serenity-js/core';
- *
- *  configure({
- *      crew: [
- *          new StreamReporter(process.stdout)
- *      ],
- *  });
- *
- * @example <caption>Writing DomainEvents to a file</caption>
- *  import { configure, StreamReporter } from '@serenity-js/core';
- *  import fs = require('fs');
- *
- *  configure({
- *      crew: [
- *          new StreamReporter(fs.createWriteStream('./events.ndjson'))
- *      ],
- *  });
- *
- * @example <caption>Registering StreamReporter using Protractor configuration</caption>
- *  // 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),
- *      ],
- *      // other Serenity/JS config
- *    },
- *
- *    // other Protractor config
- *  };
- *
- * @implements {StageCrewMember}
+ * Serialises all the {@apilink DomainEvent} objects it receives and streams
+ * them as [ndjson](http://ndjson.org/) to the output stream.
+ *
+ * Useful when debugging issues related to custom Serenity/JS test runner adapters.
+ *
+ * ## Registering `StreamReporter` programmatically
+ *
+ * ```ts
+ * import { configure, StreamReporter } from '@serenity-js/core'
+ *
+ * configure({
+ *   crew: [
+ *     new StreamReporter(process.stdout)
+ *   ],
+ * })
+ * ```
+ *
+ * ## Writing `DomainEvents` to a file
+ *
+ * ```ts
+ * import { configure, StreamReporter } from '@serenity-js/core'
+ * import fs = require('fs')
+ *
+ * configure({
+ *   crew: [
+ *     new StreamReporter(fs.createWriteStream('./events.ndjson'))
+ *   ],
+ * })
+ * ```
+ *
+ * ## Registering `StreamReporter` using Protractor configuration
+ *
+ * ```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),
+ *     ],
+ *     // other Serenity/JS config
+ *   },
+ *   // other Protractor config
+ * };
+ * ```
+ *
+ * ## Registering `StreamReporter` using WebdriverIO configuration
+ *
+ * ```ts
+ * // wdio.conf.js
+ * import { StreamReporter } from '@serenity-js/core'
+ * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
+ *
+ * export const config: WebdriverIOConfig = {
+ *
+ *     framework: '@serenity-js/webdriverio',
+ *
+ *     serenity: {
+ *         crew: [
+ *           new StreamReporter(process.stdout),
+ *         ]
+ *         // other Serenity/JS config
+ *     },
+ *   },
+ *   // other WebdriverIO config
+ * }
+ * ```
+ *
+ * @group Stage
  */
 export declare class StreamReporter implements StageCrewMember {
     private readonly output;
@@ -55,29 +86,26 @@ export declare class StreamReporter implements StageCrewMember {
      *  A Writable stream that should receive the output
      *
      * @param {Stage} [stage]
-     *  The stage this {@link StageCrewMember} should be assigned to
+     *  The stage this {@apilink StageCrewMember} should be assigned to
      */
     constructor(output?: Writable, stage?: Stage);
     /**
-     * @desc
-     *  Creates a new instance of this {@link StageCrewMember} and assigns it to a given {@link Stage}.
+     * Creates a new instance of this {@apilink StageCrewMember} and assigns it to a given {@apilink Stage}.
      *
-     * @see {@link StageCrewMember}
+     * @param stage
+     *  An instance of a {@apilink Stage} this {@apilink StageCrewMember} will be assigned to
      *
-     * @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}
+     * @returns {StageCrewMember}
+     *  A new instance of this {@apilink StageCrewMember}
      */
     assignedTo(stage: Stage): StageCrewMember;
     /**
-     * @desc
-     *  Handles {@link DomainEvent} objects emitted by the {@link StageManager}.
-     *
-     * @see {@link StageCrewMember}
+     * Handles {@apilink DomainEvent} objects emitted by the {@apilink StageManager}.
      *
      * @listens {DomainEvent}
      *
-     * @param {DomainEvent} event
-     * @returns {void}
+     * @param event
      */
     notifyOf(event: DomainEvent): void;
 }
+//# sourceMappingURL=StreamReporter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StreamReporter.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/stream-reporter/StreamReporter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}

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

@@ -2,48 +2,79 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StreamReporter = void 0;
 /**
- * @desc
- *  Serialises all the {@link DomainEvent} objects it receives and streams
- *  them as [ndjson](http://ndjson.org/) to the output stream.
- *
- * @example <caption>Writing DomainEvents to standard output</caption>
- *  import { configure, StreamReporter } from '@serenity-js/core';
- *
- *  configure({
- *      crew: [
- *          new StreamReporter(process.stdout)
- *      ],
- *  });
- *
- * @example <caption>Writing DomainEvents to a file</caption>
- *  import { configure, StreamReporter } from '@serenity-js/core';
- *  import fs = require('fs');
- *
- *  configure({
- *      crew: [
- *          new StreamReporter(fs.createWriteStream('./events.ndjson'))
- *      ],
- *  });
- *
- * @example <caption>Registering StreamReporter using Protractor configuration</caption>
- *  // 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),
- *      ],
- *      // other Serenity/JS config
- *    },
- *
- *    // other Protractor config
- *  };
- *
- * @implements {StageCrewMember}
+ * Serialises all the {@apilink DomainEvent} objects it receives and streams
+ * them as [ndjson](http://ndjson.org/) to the output stream.
+ *
+ * Useful when debugging issues related to custom Serenity/JS test runner adapters.
+ *
+ * ## Registering `StreamReporter` programmatically
+ *
+ * ```ts
+ * import { configure, StreamReporter } from '@serenity-js/core'
+ *
+ * configure({
+ *   crew: [
+ *     new StreamReporter(process.stdout)
+ *   ],
+ * })
+ * ```
+ *
+ * ## Writing `DomainEvents` to a file
+ *
+ * ```ts
+ * import { configure, StreamReporter } from '@serenity-js/core'
+ * import fs = require('fs')
+ *
+ * configure({
+ *   crew: [
+ *     new StreamReporter(fs.createWriteStream('./events.ndjson'))
+ *   ],
+ * })
+ * ```
+ *
+ * ## Registering `StreamReporter` using Protractor configuration
+ *
+ * ```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),
+ *     ],
+ *     // other Serenity/JS config
+ *   },
+ *   // other Protractor config
+ * };
+ * ```
+ *
+ * ## Registering `StreamReporter` using WebdriverIO configuration
+ *
+ * ```ts
+ * // wdio.conf.js
+ * import { StreamReporter } from '@serenity-js/core'
+ * import { WebdriverIOConfig } from '@serenity-js/webdriverio'
+ *
+ * export const config: WebdriverIOConfig = {
+ *
+ *     framework: '@serenity-js/webdriverio',
+ *
+ *     serenity: {
+ *         crew: [
+ *           new StreamReporter(process.stdout),
+ *         ]
+ *         // other Serenity/JS config
+ *     },
+ *   },
+ *   // other WebdriverIO config
+ * }
+ * ```
+ *
+ * @group Stage
  */
 class StreamReporter {
     /**
@@ -51,34 +82,30 @@ class StreamReporter {
      *  A Writable stream that should receive the output
      *
      * @param {Stage} [stage]
-     *  The stage this {@link StageCrewMember} should be assigned to
+     *  The stage this {@apilink StageCrewMember} should be assigned to
      */
     constructor(output = process.stdout, stage) {
         this.output = output;
         this.stage = stage;
     }
     /**
-     * @desc
-     *  Creates a new instance of this {@link StageCrewMember} and assigns it to a given {@link Stage}.
+     * Creates a new instance of this {@apilink StageCrewMember} and assigns it to a given {@apilink Stage}.
      *
-     * @see {@link StageCrewMember}
+     * @param stage
+     *  An instance of a {@apilink Stage} this {@apilink StageCrewMember} will be assigned to
      *
-     * @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}
+     * @returns {StageCrewMember}
+     *  A new instance of this {@apilink StageCrewMember}
      */
     assignedTo(stage) {
         return new StreamReporter(this.output, stage);
     }
     /**
-     * @desc
-     *  Handles {@link DomainEvent} objects emitted by the {@link StageManager}.
-     *
-     * @see {@link StageCrewMember}
+     * Handles {@apilink DomainEvent} objects emitted by the {@apilink StageManager}.
      *
      * @listens {DomainEvent}
      *
-     * @param {DomainEvent} event
-     * @returns {void}
+     * @param event
      */
     notifyOf(event) {
         this.output.write(JSON.stringify({ type: event.constructor.name, event: event.toJSON() }) + '\n');

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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;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;;;;;;;;;;OAUG;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;AA5CD,wCA4CC"}
+{"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"}

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

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

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

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