@serenity-js/core 3.25.0 → 3.25.1

package/lib/stage/Stage.js

@@ -7,17 +7,17 @@ const events_1 = require("../events");
 const model_1 = require("../model");
 const screenplay_1 = require("../screenplay");
 /**
- * Stage is the place where {@apilink Actor|actors} perform.
+ * Stage is the place where [actors](https://serenity-js.org/api/core/class/Actor/) perform.
  *
- * In more technical terms, the Stage is the main event bus propagating {@apilink DomainEvent|DomainEvents}
- * to {@apilink Actor|Actors} it instantiates and {@apilink StageCrewMember|StageCrewMembers} that have been registered with it.
+ * In more technical terms, the Stage is the main event bus propagating [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/)
+ * to [actors](https://serenity-js.org/api/core/class/Actor/) it instantiates and [stage crew members](https://serenity-js.org/api/core/interface/StageCrewMember/) that have been registered with it.
  *
  * It is unlikely that you'll ever need to interact with the `Stage` directly in your tests. Instead, you'll use functions like
- * {@apilink actorCalled} and {@apilink actorInTheSpotlight}.
+ * [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/) and [`actorInTheSpotlight`](https://serenity-js.org/api/core/function/actorInTheSpotlight/).
  *
  * ## Learn more
- * - {@apilink configure}
- * - {@apilink engage}
+ * - [`configure`](https://serenity-js.org/api/core/function/configure/)
+ * - [`engage`](https://serenity-js.org/api/core/function/engage/)
  *
  * @group Stage
  */
@@ -40,7 +40,7 @@ class Stage {
     actorsOnBackstage = new Map();
     actorsOnStage = this.actorsOnBackstage;
     /**
-     * The most recent actor referenced via the {@apilink actor} method
+     * The most recent actor referenced via the [`Actor`](https://serenity-js.org/api/core/class/Actor/) method
      */
     actorInTheSpotlight = undefined;
     currentActivity = undefined;
@@ -65,7 +65,7 @@ class Stage {
         (0, tiny_types_1.ensure)('interactionTimeout', interactionTimeout, (0, tiny_types_1.isDefined)());
     }
     /**
-     * An alias for {@apilink Stage.actor}
+     * An alias for [`Stage.actor`](https://serenity-js.org/api/core/class/Stage/#actor)
      *
      * @param name
      */
@@ -73,7 +73,7 @@ class Stage {
         return this.actor(name);
     }
     /**
-     * Instantiates a new {@apilink Actor} or fetches an existing one
+     * Instantiates a new [`Actor`](https://serenity-js.org/api/core/class/Actor/) or fetches an existing one
      * identified by their name if they've already been instantiated.
      *
      * @param name
@@ -103,11 +103,11 @@ class Stage {
         return this.actorInTheSpotlight;
     }
     /**
-     * Returns the last {@apilink Actor} instantiated via {@apilink Stage.actor}.
+     * Returns the last [`Actor`](https://serenity-js.org/api/core/class/Actor/) instantiated via [`Stage.actor`](https://serenity-js.org/api/core/class/Stage/#actor).
      * Useful when you don't can't or choose not to reference the actor by their name.
      *
-     * @throws {LogicError}
-     *  If no {@apilink Actor} has been activated yet
+     * @throws [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
+     *  If no [`Actor`](https://serenity-js.org/api/core/class/Actor/) has been activated yet
      */
     theActorInTheSpotlight() {
         if (!this.actorInTheSpotlight) {
@@ -116,14 +116,14 @@ class Stage {
         return this.actorInTheSpotlight;
     }
     /**
-     * Returns `true` if there is an {@apilink Actor} in the spotlight, `false` otherwise.
+     * Returns `true` if there is an [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the spotlight, `false` otherwise.
      */
     theShowHasStarted() {
         return !!this.actorInTheSpotlight;
     }
     /**
-     * Configures the Stage to prepare {@apilink Actor|Actors}
-     * instantiated via {@apilink Stage.actor} using the provided {@apilink Cast}.
+     * Configures the Stage to prepare [actors](https://serenity-js.org/api/core/class/Actor/)
+     * instantiated via [`Stage.actor`](https://serenity-js.org/api/core/class/Stage/#actor) using the provided [cast](https://serenity-js.org/api/core/class/Cast/).
      *
      * @param actors
      */
@@ -132,8 +132,8 @@ class Stage {
         this.cast = actors;
     }
     /**
-     * Assigns listeners to be notified of {@apilink DomainEvent|DomainEvents}
-     * emitted via {@apilink Stage.announce}.s
+     * Assigns listeners to be notified of [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/)
+     * emitted via [`Stage.announce`](https://serenity-js.org/api/core/class/Stage/#announce).s
      *
      * @param listeners
      */
@@ -166,21 +166,20 @@ class Stage {
     }
     /**
      * Returns current time. This method should be used whenever
-     * {@apilink DomainEvent} objects are instantiated by you programmatically.
+     * [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects are instantiated by you programmatically.
      */
     currentTime() {
         return this.manager.currentTime();
     }
     /**
-     * Generates and remembers a {@apilink CorrelationId}
+     * Generates and remembers a `CorrelationId`
      * for the current scene.
      *
      * This method should be used in custom test runner adapters
-     * when instantiating a {@apilink SceneStarts} event.
+     * when instantiating a [SceneStarts](https://serenity-js.org/api/core-events/class/SceneStarts/) event.
      *
      * #### Learn more
-     * - {@apilink Stage.currentSceneId}
-     * - {@apilink CorrelationId}
+     * - [`Stage.currentSceneId`](https://serenity-js.org/api/core/class/Stage/#currentSceneId)
      */
     assignNewSceneId() {
         // todo: inject an id factory to make it easier to test
@@ -188,23 +187,23 @@ class Stage {
         return this.currentScene;
     }
     /**
-     * Returns the {@apilink CorrelationId} for the current scene.
+     * Returns the `CorrelationId` for the current scene.
      *
      * #### Learn more
-     * - {@apilink Stage.assignNewSceneId}
+     * - [`Stage.assignNewSceneId`](https://serenity-js.org/api/core/class/Stage/#assignNewSceneId)
      */
     currentSceneId() {
         return this.currentScene;
     }
     /**
-     * Generates and remembers a {@apilink CorrelationId}
-     * for the current {@apilink Activity}.
+     * Generates and remembers a `CorrelationId`
+     * for the current [`Activity`](https://serenity-js.org/api/core/class/Activity/).
      *
      * This method should be used in custom test runner adapters
-     * when instantiating the {@apilink ActivityStarts} event.
+     * when instantiating the [ActivityStarts](https://serenity-js.org/api/core-events/class/ActivityStarts/) event.
      *
      * #### Learn more
-     * - {@apilink Stage.currentActivityId}
+     * - [`Stage.currentActivityId`](https://serenity-js.org/api/core/class/Stage/#currentActivityId)
      */
     assignNewActivityId(activityDetails) {
         this.currentActivity = {
@@ -214,10 +213,10 @@ class Stage {
         return this.currentActivity.id;
     }
     /**
-     * Returns the {@apilink CorrelationId} for the current {@apilink Activity}.
+     * Returns the `CorrelationId` for the current [`Activity`](https://serenity-js.org/api/core/class/Activity/).
      *
      * #### Learn more
-     * - {@apilink Stage.assignNewSceneId}
+     * - [`Stage.assignNewSceneId`](https://serenity-js.org/api/core/class/Stage/#assignNewSceneId)
      */
     currentActivityId() {
         if (!this.currentActivity) {

package/lib/stage/Stage.js.map

@@ -1 +1 @@
-{"version":3,"file":"Stage.js","sourceRoot":"","sources":["../../src/stage/Stage.ts"],"names":[],"mappings":";;;AAAA,2CAA+C;AAG/C,sCAAwE;AAIxE,sCAOmB;AAEnB,oCAA4D;AAE5D,8CAAoD;AAKpD;;;;;;;;;;;;;;GAcG;AACH,MAAa,KAAK;IAmCF;IACS;IACT;IACS;IACA;IArCb,MAAM,CAAU,cAAc,GAAG,IAAI,qBAAa,CAAC,SAAS,CAAC,CAAA;IAErE;;;OAGG;IACK,kBAAkB,GAAuB,IAAI,GAAG,EAAiB,CAAC;IAE1E;;;OAGG;IACK,iBAAiB,GAAuB,IAAI,GAAG,EAAiB,CAAC;IAEjE,aAAa,GAAuB,IAAI,CAAC,iBAAiB,CAAC;IAEnE;;OAEG;IACK,mBAAmB,GAAU,SAAS,CAAC;IAEvC,eAAe,GAAoD,SAAS,CAAC;IAE7E,YAAY,GAAkB,KAAK,CAAC,cAAc,CAAC;IAE3D;;;;;;OAMG;IACH,YACY,IAAU,EACD,OAAqB,EAC9B,MAAoB,EACX,KAAY,EACZ,kBAA4B;QAJrC,SAAI,GAAJ,IAAI,CAAM;QACD,YAAO,GAAP,OAAO,CAAc;QAC9B,WAAM,GAAN,MAAM,CAAc;QACX,UAAK,GAAL,KAAK,CAAO;QACZ,uBAAkB,GAAlB,kBAAkB,CAAU;QAE7C,IAAA,mBAAM,EAAC,MAAM,EAAE,IAAI,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;QAClC,IAAA,mBAAM,EAAC,cAAc,EAAE,OAAO,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;QAC7C,IAAA,mBAAM,EAAC,cAAc,EAAE,MAAM,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;QAC5C,IAAA,mBAAM,EAAC,OAAO,EAAE,KAAK,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;QACpC,IAAA,mBAAM,EAAC,oBAAoB,EAAE,kBAAkB,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,IAAY;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAY;QACd,IAAI,CAAE,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE;YACtC,IAAI,KAAK,CAAC;YACV,IAAI;gBACA,MAAM,QAAQ,GAAG,IAAI,kBAAK,CAAC,IAAI,EAAE,IAAI,EAAE;oBACnC,IAAI,oBAAW,CAAC,IAAI,CAAC;oBACrB,IAAI,yBAAY,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,kBAAkB,CAAC;iBACxD,CAAC,CAAC;gBAEH,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAEpC,0CAA0C;gBAC1C,yEAAyE;aAC5E;YACD,OAAO,KAAK,EAAE;gBACV,MAAM,IAAI,2BAAkB,CAAC,GAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAE,gDAAiD,IAAK,aAAa,EAAE,KAAK,CAAC,CAAC;aACvI;YAED,IAAI,CAAE,CAAC,KAAK,YAAY,kBAAK,CAAC,EAAE;gBAC5B,MAAM,IAAI,2BAAkB,CAAC,uCAAwC,IAAK,MAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAE,aAAc,KAAM,EAAE,CAAC,CAAC;aACnI;YAED,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;SACtC;QAED,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAE9D,OAAO,IAAI,CAAC,mBAAmB,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACH,sBAAsB;QAClB,IAAI,CAAE,IAAI,CAAC,mBAAmB,EAAE;YAC5B,MAAM,IAAI,mBAAU,CAAC,+HAA+H,CAAC,CAAC;SACzJ;QAED,OAAO,IAAI,CAAC,mBAAmB,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,iBAAiB;QACb,OAAO,CAAC,CAAE,IAAI,CAAC,mBAAmB,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAY;QACf,IAAA,mBAAM,EAAC,MAAM,EAAE,MAAM,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;QAEpC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,GAAG,SAAkC;QACxC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,MAA0B;QAClC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACnB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;QAC9B,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,cAAc,CAAC,KAAkB;QACrC,IAAI,KAAK,YAAY,oBAAW,EAAE;YAC9B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC;SAChD;QAED,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE7B,IAAI,KAAK,YAAY,sBAAa,EAAE;YAChC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAEjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC;SAC/C;QAED,IAAI,KAAK,YAAY,wBAAe,EAAE;YAClC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACpC;IACL,CAAC;IAED;;;OAGG;IACH,WAAW;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB;QACZ,uDAAuD;QACvD,IAAI,CAAC,YAAY,GAAG,qBAAa,CAAC,MAAM,EAAE,CAAC;QAE3C,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACH,cAAc;QACV,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED;;;;;;;;;OASG;IACH,mBAAmB,CAAC,eAAgC;QAChD,IAAI,CAAC,eAAe,GAAG;YACnB,EAAE,EAAE,qBAAa,CAAC,MAAM,EAAE;YAC1B,OAAO,EAAE,eAAe;SAC3B,CAAC;QAEF,OAAO,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,iBAAiB;QACb,IAAI,CAAE,IAAI,CAAC,eAAe,EAAE;YACxB,MAAM,IAAI,mBAAU,CAAC,qGAAqG,CAAC,CAAC;SAC/H;QAED,OAAO,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;OAOG;IACH,cAAc;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;IACzC,CAAC;IAED,WAAW,CAA0B,SAAqC,EAAE,OAAqB;QAC7F,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE;YACjC,QAAQ,EAAE,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,QAAQ;YAChD,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAEO,uBAAuB,CAAC,IAAY;QACxC,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC;YACnC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC;YAClC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC3C,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,YAAgC;QAClD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAEjD,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;YAC3C,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;SACxC;QAED,6DAA6D;QAC7D,MAAM,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,CAAC;QAEtD,MAAM,eAAe,GAAG,IAAI,GAAG,CAAuB,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,qBAAa,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QAE5G,KAAK,MAAM,CAAE,KAAK,EAAE,aAAa,CAAE,IAAI,eAAe,EAAE;YACpD,IAAI,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CACrC,IAAI,YAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAC/B,IAAI,mBAAW,CAAC,cAAe,KAAK,CAAC,IAAK,KAAK,CAAC,EAChD,aAAa,EACb,IAAI,CAAC,WAAW,EAAE,CACrB,CAAC,CAAC;SACN;QAED,4BAA4B;QAC5B,KAAK,MAAM,CAAE,KAAK,EAAE,aAAa,CAAE,IAAI,eAAe,EAAE;YACpD,IAAI;gBACA,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;gBAEtB,IAAI,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CACrC,aAAa,EACb,IAAI,CAAC,WAAW,EAAE,CACrB,CAAC,CAAC;aACN;YACD,OAAO,KAAK,EAAE;gBACV,IAAI,CAAC,QAAQ,CAAC,IAAI,6BAAoB,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAK,6BAA6B;aACvH;SACJ;QAED,YAAY,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;IAEO,MAAM,CAAC,IAAU;QACrB,OAAO,IAAI,CAAC,WAAW,KAAK,MAAM;YAC9B,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAChC,CAAC;;AAjTL,sBAkTC"}
+{"version":3,"file":"Stage.js","sourceRoot":"","sources":["../../src/stage/Stage.ts"],"names":[],"mappings":";;;AAAA,2CAA+C;AAG/C,sCAAwE;AAIxE,sCAOmB;AAEnB,oCAA4D;AAE5D,8CAAoD;AAKpD;;;;;;;;;;;;;;GAcG;AACH,MAAa,KAAK;IAmCF;IACS;IACT;IACS;IACA;IArCb,MAAM,CAAU,cAAc,GAAG,IAAI,qBAAa,CAAC,SAAS,CAAC,CAAA;IAErE;;;OAGG;IACK,kBAAkB,GAAuB,IAAI,GAAG,EAAiB,CAAC;IAE1E;;;OAGG;IACK,iBAAiB,GAAuB,IAAI,GAAG,EAAiB,CAAC;IAEjE,aAAa,GAAuB,IAAI,CAAC,iBAAiB,CAAC;IAEnE;;OAEG;IACK,mBAAmB,GAAU,SAAS,CAAC;IAEvC,eAAe,GAAoD,SAAS,CAAC;IAE7E,YAAY,GAAkB,KAAK,CAAC,cAAc,CAAC;IAE3D;;;;;;OAMG;IACH,YACY,IAAU,EACD,OAAqB,EAC9B,MAAoB,EACX,KAAY,EACZ,kBAA4B;QAJrC,SAAI,GAAJ,IAAI,CAAM;QACD,YAAO,GAAP,OAAO,CAAc;QAC9B,WAAM,GAAN,MAAM,CAAc;QACX,UAAK,GAAL,KAAK,CAAO;QACZ,uBAAkB,GAAlB,kBAAkB,CAAU;QAE7C,IAAA,mBAAM,EAAC,MAAM,EAAE,IAAI,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;QAClC,IAAA,mBAAM,EAAC,cAAc,EAAE,OAAO,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;QAC7C,IAAA,mBAAM,EAAC,cAAc,EAAE,MAAM,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;QAC5C,IAAA,mBAAM,EAAC,OAAO,EAAE,KAAK,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;QACpC,IAAA,mBAAM,EAAC,oBAAoB,EAAE,kBAAkB,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,IAAY;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAY;QACd,IAAI,CAAE,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE;YACtC,IAAI,KAAK,CAAC;YACV,IAAI;gBACA,MAAM,QAAQ,GAAG,IAAI,kBAAK,CAAC,IAAI,EAAE,IAAI,EAAE;oBACnC,IAAI,oBAAW,CAAC,IAAI,CAAC;oBACrB,IAAI,yBAAY,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,kBAAkB,CAAC;iBACxD,CAAC,CAAC;gBAEH,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAEpC,0CAA0C;gBAC1C,yEAAyE;aAC5E;YACD,OAAO,KAAK,EAAE;gBACV,MAAM,IAAI,2BAAkB,CAAC,GAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAE,gDAAiD,IAAK,aAAa,EAAE,KAAK,CAAC,CAAC;aACvI;YAED,IAAI,CAAE,CAAC,KAAK,YAAY,kBAAK,CAAC,EAAE;gBAC5B,MAAM,IAAI,2BAAkB,CAAC,uCAAwC,IAAK,MAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAE,aAAc,KAAM,EAAE,CAAC,CAAC;aACnI;YAED,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;SACtC;QAED,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAE9D,OAAO,IAAI,CAAC,mBAAmB,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACH,sBAAsB;QAClB,IAAI,CAAE,IAAI,CAAC,mBAAmB,EAAE;YAC5B,MAAM,IAAI,mBAAU,CAAC,+HAA+H,CAAC,CAAC;SACzJ;QAED,OAAO,IAAI,CAAC,mBAAmB,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,iBAAiB;QACb,OAAO,CAAC,CAAE,IAAI,CAAC,mBAAmB,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAY;QACf,IAAA,mBAAM,EAAC,MAAM,EAAE,MAAM,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;QAEpC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,GAAG,SAAkC;QACxC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,MAA0B;QAClC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACnB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;QAC9B,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,cAAc,CAAC,KAAkB;QACrC,IAAI,KAAK,YAAY,oBAAW,EAAE;YAC9B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC;SAChD;QAED,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE7B,IAAI,KAAK,YAAY,sBAAa,EAAE;YAChC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAEjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC;SAC/C;QAED,IAAI,KAAK,YAAY,wBAAe,EAAE;YAClC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACpC;IACL,CAAC;IAED;;;OAGG;IACH,WAAW;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB;QACZ,uDAAuD;QACvD,IAAI,CAAC,YAAY,GAAG,qBAAa,CAAC,MAAM,EAAE,CAAC;QAE3C,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACH,cAAc;QACV,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED;;;;;;;;;OASG;IACH,mBAAmB,CAAC,eAAgC;QAChD,IAAI,CAAC,eAAe,GAAG;YACnB,EAAE,EAAE,qBAAa,CAAC,MAAM,EAAE;YAC1B,OAAO,EAAE,eAAe;SAC3B,CAAC;QAEF,OAAO,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,iBAAiB;QACb,IAAI,CAAE,IAAI,CAAC,eAAe,EAAE;YACxB,MAAM,IAAI,mBAAU,CAAC,qGAAqG,CAAC,CAAC;SAC/H;QAED,OAAO,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;OAOG;IACH,cAAc;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;IACzC,CAAC;IAED,WAAW,CAA0B,SAAqC,EAAE,OAAqB;QAC7F,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE;YACjC,QAAQ,EAAE,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,QAAQ;YAChD,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAEO,uBAAuB,CAAC,IAAY;QACxC,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC;YACnC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC;YAClC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC3C,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,YAAgC;QAClD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAEjD,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;YAC3C,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;SACxC;QAED,6DAA6D;QAC7D,MAAM,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,CAAC;QAEtD,MAAM,eAAe,GAAG,IAAI,GAAG,CAAuB,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,qBAAa,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QAE5G,KAAK,MAAM,CAAE,KAAK,EAAE,aAAa,CAAE,IAAI,eAAe,EAAE;YACpD,IAAI,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CACrC,IAAI,YAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAC/B,IAAI,mBAAW,CAAC,cAAe,KAAK,CAAC,IAAK,KAAK,CAAC,EAChD,aAAa,EACb,IAAI,CAAC,WAAW,EAAE,CACrB,CAAC,CAAC;SACN;QAED,4BAA4B;QAC5B,KAAK,MAAM,CAAE,KAAK,EAAE,aAAa,CAAE,IAAI,eAAe,EAAE;YACpD,IAAI;gBACA,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;gBAEtB,IAAI,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CACrC,aAAa,EACb,IAAI,CAAC,WAAW,EAAE,CACrB,CAAC,CAAC;aACN;YACD,OAAO,KAAK,EAAE;gBACV,IAAI,CAAC,QAAQ,CAAC,IAAI,6BAAoB,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAK,6BAA6B;aACvH;SACJ;QAED,YAAY,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;IAEO,MAAM,CAAC,IAAU;QACrB,OAAO,IAAI,CAAC,WAAW,KAAK,MAAM;YAC9B,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAChC,CAAC;;AAhTL,sBAiTC"}

package/lib/stage/StageCrewMember.d.ts

@@ -1,12 +1,12 @@
 import type { ListensToDomainEvents } from './ListensToDomainEvents';
 import type { Stage } from './Stage';
 /**
- * You can think of the {@apilink StageCrewMember} as an in-memory microservice that reacts to {@apilink DomainEvent|domain events},
- * published by the {@apilink StageManager}, and originally emitted by {@apilink Actor|actors} performing activities and Serenity/JS
- * test runner adapters notifying the framework about test scenario-specific events like {@apilink SceneStarts} or {@apilink SceneFinishes}.
+ * You can think of the [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) as an in-memory microservice that reacts to [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/),
+ * published by the [`StageManager`](https://serenity-js.org/api/core/class/StageManager/), and originally emitted by [actors](https://serenity-js.org/api/core/class/Actor/) performing activities and Serenity/JS
+ * test runner adapters notifying the framework about test scenario-specific events like [SceneStarts](https://serenity-js.org/api/core-events/class/SceneStarts/) or [SceneFinishes](https://serenity-js.org/api/core-events/class/SceneFinishes/).
  *
- * Every {@apilink StageCrewMember} receives a reference to the {@apilink Stage},
- * and therefore {@apilink StageManager} as well, which enables them to emit {@apilink DomainEvent}s back.
+ * Every [stage crew member](https://serenity-js.org/api/core/interface/StageCrewMember/) receives a reference to the [stage](https://serenity-js.org/api/core/class/Stage/),
+ * and therefore the [stage manager](https://serenity-js.org/api/core/class/StageManager/), which enables them to emit [domain events](https://serenity-js.org/api/core-events/class/DomainEvent/) back.
  *
  * This interface is useful when you're interested in implementing custom Serenity/JS reporters or supporting services.
  *
@@ -61,17 +61,17 @@ import type { Stage } from './Stage';
  * ```
  *
  * ## Learn more
- * - {@apilink SerenityConfig.crew}
- * - {@apilink configure}
- * - {@apilink StageCrewMemberBuilder}
- * - {@apilink ListensToDomainEvents}
- * - {@apilink DomainEvent}
+ * - [`SerenityConfig.crew`](https://serenity-js.org/api/core/class/SerenityConfig/#crew)
+ * - [`configure`](https://serenity-js.org/api/core/function/configure/)
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/)
+ * - [`ListensToDomainEvents`](https://serenity-js.org/api/core/interface/ListensToDomainEvents/)
+ * - [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/)
  *
  * @group Stage
  */
 export interface StageCrewMember extends ListensToDomainEvents {
     /**
-     * Assigns a {@apilink Stage} to this {@apilink StageCrewMember}
+     * Assigns a [`Stage`](https://serenity-js.org/api/core/class/Stage/) to this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
      */
     assignedTo(stage: Stage): StageCrewMember;
 }

package/lib/stage/StageCrewMemberBuilder.d.ts

@@ -1,22 +1,22 @@
 import type { ListensToDomainEvents } from './ListensToDomainEvents';
 import type { StageCrewMemberBuilderDependencies } from './StageCrewMemberBuilderDependencies';
 /**
- * Use a {@apilink StageCrewMemberBuilder} to configure complex {@apilink StageCrewMember} objects.
+ * Use a [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/) to configure complex [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) objects.
  *
  * Useful when you're interested in implementing custom reporters with multiple configuration options.
- * See {@apilink ConsoleReporter} for an example.
+ * See [`ConsoleReporter`](https://serenity-js.org/api/console-reporter/class/ConsoleReporter/) for an example.
  *
  * ## Learn more
- * - {@apilink StageCrewMember}
- * - {@apilink StageCrewMemberBuilderDependencies}
- * - {@apilink SerenityConfig.crew}
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
+ * - [`StageCrewMemberBuilderDependencies`](https://serenity-js.org/api/core/interface/StageCrewMemberBuilderDependencies/)
+ * - [`SerenityConfig.crew`](https://serenity-js.org/api/core/class/SerenityConfig/#crew)
  *
  * @group Stage
  */
 export interface StageCrewMemberBuilder<T extends ListensToDomainEvents = ListensToDomainEvents> {
     /**
-     * Instantiates a {@apilink StageCrewMember}, giving it access to shared dependencies
-     * such as {@apilink Stage} or {@apilink OutputStream}
+     * Instantiates a [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/), giving it access to shared dependencies
+     * such as [`Stage`](https://serenity-js.org/api/core/class/Stage/) or [`OutputStream`](https://serenity-js.org/api/core-adapter/interface/OutputStream/)
      */
     build(dependencies: StageCrewMemberBuilderDependencies): T;
 }

package/lib/stage/StageCrewMemberBuilderDependencies.d.ts

@@ -2,10 +2,10 @@ import type { OutputStream } from '../adapter';
 import type { FileSystem } from '../io';
 import type { Stage } from './Stage';
 /**
- * Dependencies injected by {@apilink Serenity.configure} into {@apilink StageCrewMemberBuilder.build}
+ * Dependencies injected by [`Serenity.configure`](https://serenity-js.org/api/core/class/Serenity/#configure) into [`StageCrewMemberBuilder.build`](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/#build)
  *
  * ## Learn more
- * - {@apilink StageCrewMemberBuilder}
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/)
  *
  * @group Stage
  */

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

@@ -3,7 +3,7 @@ import { FileSystem } from '../../../io';
 import type { Stage } from '../../Stage';
 import type { StageCrewMember } from '../../StageCrewMember';
 /**
- * Stores any {@apilink Artifact|artifacts} emitted via {@apilink ArtifactGenerated} events on the {@apilink FileSystem}.
+ * Stores any artifacts emitted via [`ArtifactGenerated`](https://serenity-js.org/api/core-events/class/ArtifactGenerated/) events on the file system.
  *
  * ## Registering Artifact Archiver programmatically
  *
@@ -104,14 +104,14 @@ export declare class ArtifactArchiver implements StageCrewMember {
     /**
      * @param {FileSystem} fileSystem
      * @param {Stage} [stage]
-     *  The stage this {@apilink StageCrewMember} should be assigned to
+     *  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 {@apilink DomainEvent} objects emitted by the {@apilink StageManager}.
+     * 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 {@apilink StageCrewMember}
+     * @see [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
      *
      * @listens {ArtifactGenerated}
      * @emits {ArtifactArchived}

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

@@ -7,7 +7,7 @@ const io_1 = require("../../../io");
 const model_1 = require("../../../model");
 const Hash_1 = require("./Hash");
 /**
- * Stores any {@apilink Artifact|artifacts} emitted via {@apilink ArtifactGenerated} events on the {@apilink FileSystem}.
+ * Stores any artifacts emitted via [`ArtifactGenerated`](https://serenity-js.org/api/core-events/class/ArtifactGenerated/) events on the file system.
  *
  * ## Registering Artifact Archiver programmatically
  *
@@ -113,7 +113,7 @@ class ArtifactArchiver {
     /**
      * @param {FileSystem} fileSystem
      * @param {Stage} [stage]
-     *  The stage this {@apilink StageCrewMember} should be assigned to
+     *  The stage this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) should be assigned to
      */
     constructor(fileSystem, stage) {
         this.fileSystem = fileSystem;
@@ -124,9 +124,9 @@ class ArtifactArchiver {
         return this;
     }
     /**
-     * Handles {@apilink DomainEvent} objects emitted by the {@apilink StageManager}.
+     * 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 {@apilink StageCrewMember}
+     * @see [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
      *
      * @listens {ArtifactGenerated}
      * @emits {ArtifactArchived}

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

@@ -4,7 +4,7 @@ import type { DomainEvent } from '../../../events';
 import type { Stage } from '../../Stage';
 import type { StageCrewMember } from '../../StageCrewMember';
 /**
- * Serialises all the {@apilink DomainEvent} objects it receives and streams
+ * Serialises all the [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects it receives and streams
  * them as [ndjson](http://ndjson.org/) to the output stream or file.
  *
  * Useful when debugging issues related to custom Serenity/JS test runner adapters.
@@ -99,7 +99,7 @@ export declare class StreamReporter implements StageCrewMember {
     private readonly output;
     private readonly stage?;
     /**
-     * Instantiates a `StreamReporter` outputting a stream of {@apilink DomainEvent|domain events}
+     * Instantiates a `StreamReporter` outputting a stream of [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/)
      * to an `outputFile` at the given location.
      *
      * @param config
@@ -113,21 +113,21 @@ export declare class StreamReporter implements StageCrewMember {
      *  A Writable stream that should receive the output
      *
      * @param {Stage} [stage]
-     *  The stage this {@apilink StageCrewMember} should be assigned to
+     *  The stage this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) should be assigned to
      */
     constructor(output?: Writable, stage?: Stage);
     /**
-     * Creates a new instance of this {@apilink StageCrewMember} and assigns it to a given {@apilink Stage}.
+     * Creates a new instance of this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) and assigns it to a given [`Stage`](https://serenity-js.org/api/core/class/Stage/).
      *
      * @param stage
-     *  An instance of a {@apilink Stage} this {@apilink StageCrewMember} will be assigned to
+     *  An instance of a [`Stage`](https://serenity-js.org/api/core/class/Stage/) this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) will be assigned to
      *
      * @returns {StageCrewMember}
-     *  A new instance of this {@apilink StageCrewMember}
+     *  A new instance of this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
      */
     assignedTo(stage: Stage): StageCrewMember;
     /**
-     * Handles {@apilink DomainEvent} objects emitted by the {@apilink StageManager}.
+     * Handles [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects emitted by the [`StageManager`](https://serenity-js.org/api/core/class/StageManager/).
      *
      * @listens {DomainEvent}
      *

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

@@ -4,7 +4,7 @@ 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
+ * Serialises all the [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects it receives and streams
  * them as [ndjson](http://ndjson.org/) to the output stream or file.
  *
  * Useful when debugging issues related to custom Serenity/JS test runner adapters.
@@ -99,7 +99,7 @@ class StreamReporter {
     output;
     stage;
     /**
-     * Instantiates a `StreamReporter` outputting a stream of {@apilink DomainEvent|domain events}
+     * Instantiates a `StreamReporter` outputting a stream of [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/)
      * to an `outputFile` at the given location.
      *
      * @param config
@@ -115,26 +115,26 @@ class StreamReporter {
      *  A Writable stream that should receive the output
      *
      * @param {Stage} [stage]
-     *  The stage this {@apilink StageCrewMember} should be assigned to
+     *  The stage this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) should be assigned to
      */
     constructor(output = process.stdout, stage) {
         this.output = output;
         this.stage = stage;
     }
     /**
-     * Creates a new instance of this {@apilink StageCrewMember} and assigns it to a given {@apilink Stage}.
+     * Creates a new instance of this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) and assigns it to a given [`Stage`](https://serenity-js.org/api/core/class/Stage/).
      *
      * @param stage
-     *  An instance of a {@apilink Stage} this {@apilink StageCrewMember} will be assigned to
+     *  An instance of a [`Stage`](https://serenity-js.org/api/core/class/Stage/) this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) will be assigned to
      *
      * @returns {StageCrewMember}
-     *  A new instance of this {@apilink StageCrewMember}
+     *  A new instance of this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
      */
     assignedTo(stage) {
         return new StreamReporter(this.output, stage);
     }
     /**
-     * Handles {@apilink DomainEvent} objects emitted by the {@apilink StageManager}.
+     * Handles [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects emitted by the [`StageManager`](https://serenity-js.org/api/core/class/StageManager/).
      *
      * @listens {DomainEvent}
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/core",
-  "version": "3.25.0",
+  "version": "3.25.1",
   "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": "22657b685b6002f75b2569db54f4bea31ab91d12"
+  "gitHead": "450b994115cf9f1a1547ef92ac9387e0c57821ce"
 }

package/src/Serenity.ts

@@ -121,20 +121,20 @@ export class Serenity implements EmitsDomainEvents {
     }
 
     /**
-     * Re-configures Serenity/JS with a new {@apilink Cast} of {@apilink Actor|actors}
-     * you want to use in any subsequent calls to {@apilink actorCalled}.
+     * Re-configures Serenity/JS with a new [cast](https://serenity-js.org/api/core/class/Cast/) of [actors](https://serenity-js.org/api/core/class/Actor/)
+     * you want to use in any subsequent calls to [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/).
      *
-     * For your convenience, use {@apilink engage} function instead,
-     * which provides an alternative to calling {@apilink Actor.whoCan} directly in your tests
+     * For your convenience, use [`engage`](https://serenity-js.org/api/core/function/engage/) function instead,
+     * which provides an alternative to calling [`Actor.whoCan`](https://serenity-js.org/api/core/class/Actor/#whoCan) directly in your tests
      * and is typically invoked in a "before all" or "before each" hook of your test runner of choice.
      *
-     * If your implementation of the {@apilink Cast} interface is stateless,
+     * If your implementation of the [cast](https://serenity-js.org/api/core/class/Cast/) interface is stateless,
      * you can invoke this function just once before your entire test suite is executed, see
      * - [`beforeAll`](https://jasmine.github.io/api/3.6/global.html#beforeAll) in Jasmine,
      * - [`before`](https://mochajs.org/#hooks) in Mocha,
      * - [`BeforeAll`](https://github.com/cucumber/cucumber-js/blob/master/docs/support_files/hooks.md#beforeall--afterall) in Cucumber.js
      *
-     * However, if your {@apilink Cast} holds state that you want to reset before each scenario,
+     * However, if your [cast](https://serenity-js.org/api/core/class/Cast/) holds state that you want to reset before each scenario,
      * it's better to invoke `engage` before each test using:
      * - [`beforeEach`](https://jasmine.github.io/api/3.6/global.html#beforeEach) in Jasmine
      * - [`beforeEach`](https://mochajs.org/#hooks) in Mocha,
@@ -181,9 +181,9 @@ export class Serenity implements EmitsDomainEvents {
      * ```
      *
      * ## Learn more
-     * - {@apilink Actor}
-     * - {@apilink Cast}
-     * - {@apilink engage}
+     * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
+     * - [`engage`](https://serenity-js.org/api/core/function/engage/)
      *
      * @param actors
      */
@@ -194,10 +194,10 @@ export class Serenity implements EmitsDomainEvents {
     }
 
     /**
-     * Instantiates or retrieves an {@apilink Actor}
+     * Instantiates or retrieves an [`Actor`](https://serenity-js.org/api/core/class/Actor/)
      * called `name` if one has already been instantiated.
      *
-     * For your convenience, use {@apilink actorCalled} function instead.
+     * For your convenience, use [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/) function instead.
      *
      * ## Usage with Mocha
      *
@@ -243,10 +243,10 @@ export class Serenity implements EmitsDomainEvents {
      *
      * ## Learn more
      *
-     * - {@apilink engage}
-     * - {@apilink Actor}
-     * - {@apilink Cast}
-     * - {@apilink actorCalled}
+     * - [`engage`](https://serenity-js.org/api/core/function/engage/)
+     * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
+     * - [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/)
      *
      * @param name
      *  The name of the actor to instantiate or retrieve
@@ -257,11 +257,11 @@ export class Serenity implements EmitsDomainEvents {
 
     /**
      * Retrieves an actor who was last instantiated or retrieved
-     * using {@apilink Serenity.theActorCalled}.
+     * using [`Serenity.theActorCalled`](https://serenity-js.org/api/core/class/Serenity/#theActorCalled).
      *
      * This function is particularly useful when automating Cucumber scenarios.
      *
-     * For your convenience, use {@apilink actorInTheSpotlight} function instead.
+     * For your convenience, use [`actorInTheSpotlight`](https://serenity-js.org/api/core/function/actorInTheSpotlight/) function instead.
      *
      * ## Usage with Cucumber
      *
@@ -282,11 +282,11 @@ export class Serenity implements EmitsDomainEvents {
      *
      * ## Learn more
      *
-     * - {@apilink engage}
-     * - {@apilink actorCalled}
-     * - {@apilink actorInTheSpotlight}
-     * - {@apilink Actor}
-     * - {@apilink Cast}
+     * - [`engage`](https://serenity-js.org/api/core/function/engage/)
+     * - [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/)
+     * - [`actorInTheSpotlight`](https://serenity-js.org/api/core/function/actorInTheSpotlight/)
+     * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
      */
     theActorInTheSpotlight(): Actor {
         return this.stage.theActorInTheSpotlight();

package/src/adapter/OutputStream.ts

@@ -1,10 +1,11 @@
 /**
- * An output stream to be injected into {@apilink StageCrewMemberBuilder|StageCrewMemberBuilders} configured via {@apilink SerenityConfig.crew}.
+ * An output stream to be injected into [stage crew member builders](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/)
+ * configured via [`SerenityConfig.crew`](https://serenity-js.org/api/core/class/SerenityConfig/#crew).
  *
  * ## Learn more
- * - {@apilink StageCrewMemberBuilder}
- * - {@apilink Serenity.configure}
- * - {@apilink SerenityConfig.crew}
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/)
+ * - [`Serenity.configure`](https://serenity-js.org/api/core/class/Serenity/#configure)
+ * - [`SerenityConfig.crew`](https://serenity-js.org/api/core/class/SerenityConfig/#crew)
  *
  * @group Integration
  */

package/src/adapter/TestRunnerAdapter.ts

@@ -15,7 +15,7 @@ export interface TestRunnerAdapter {
     /**
      * Returns the number of loaded scenarios
      *
-     * @throws {@apilink LogicError}
+     * @throws [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      *  If called before `load`
      */
     scenarioCount(): number;
@@ -23,7 +23,7 @@ export interface TestRunnerAdapter {
     /**
      * Runs loaded test scenarios.
      *
-     * @throws {@apilink LogicError}
+     * @throws [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      *  If called before `load`
      */
     run(): Promise<void>;

package/src/config/ClassDescription.ts

@@ -3,7 +3,7 @@
  * - a named export that you want to import
  * - a parameter that should be passed to the static `fromJSON` method if the imported type provides it.
  *
- * `ClassDescription` is used to describe the {@apilink StageCrewMember|StageCrewMembers} passed to {@apilink SerenityConfig}.
+ * `ClassDescription` is used to describe the [stage crew members](https://serenity-js.org/api/core/interface/StageCrewMember/) passed to [`SerenityConfig`](https://serenity-js.org/api/core/class/SerenityConfig/).
  *
  * The most basic class description is the name of a Node module that must provide a `default` export.
  * For example, below definition would be interpreted as a request to import the `default` export from the `@serenity-js/serenity-bdd` module and instantiate it using its no-arg constructor: