@serenity-js/core 3.25.0 → 3.25.1

package/lib/screenplay/time/models/Clock.d.ts

@@ -1,7 +1,7 @@
 import { Duration } from './Duration';
 import { Timestamp } from './Timestamp';
 /**
- * A {@apilink Clock} tells the time. This abstraction allows Serenity/JS to have a single place
+ * A [`Clock`](https://serenity-js.org/api/core/class/Clock/) tells the time. This abstraction allows Serenity/JS to have a single place
  * in the framework responsible for telling the time, and one that can be easily mocked for internal testing.
  *
  * ```ts
@@ -9,8 +9,8 @@ import { Timestamp } from './Timestamp';
  * ```
  *
  * ## Learn more
- * - {@apilink Timestamp}
- * - {@apilink Duration}
+ * - [`Timestamp`](https://serenity-js.org/api/core/class/Timestamp/)
+ * - [`Duration`](https://serenity-js.org/api/core/class/Duration/)
  *
  * @group Time
  */
@@ -21,7 +21,7 @@ export declare class Clock {
     constructor(checkTime?: () => Date);
     /**
      * Sets the clock ahead to force early resolution of promises
-     * returned by {@apilink Clock.waitFor};
+     * returned by [`Clock.waitFor`](https://serenity-js.org/api/core/class/Clock/#waitFor).
      *
      * Useful for test purposes to avoid unnecessary delays.
      *

package/lib/screenplay/time/models/Clock.js

@@ -5,7 +5,7 @@ const tiny_types_1 = require("tiny-types");
 const Duration_1 = require("./Duration");
 const Timestamp_1 = require("./Timestamp");
 /**
- * A {@apilink Clock} tells the time. This abstraction allows Serenity/JS to have a single place
+ * A [`Clock`](https://serenity-js.org/api/core/class/Clock/) tells the time. This abstraction allows Serenity/JS to have a single place
  * in the framework responsible for telling the time, and one that can be easily mocked for internal testing.
  *
  * ```ts
@@ -13,8 +13,8 @@ const Timestamp_1 = require("./Timestamp");
  * ```
  *
  * ## Learn more
- * - {@apilink Timestamp}
- * - {@apilink Duration}
+ * - [`Timestamp`](https://serenity-js.org/api/core/class/Timestamp/)
+ * - [`Duration`](https://serenity-js.org/api/core/class/Duration/)
  *
  * @group Time
  */
@@ -27,7 +27,7 @@ class Clock {
     }
     /**
      * Sets the clock ahead to force early resolution of promises
-     * returned by {@apilink Clock.waitFor};
+     * returned by [`Clock.waitFor`](https://serenity-js.org/api/core/class/Clock/#waitFor).
      *
      * Useful for test purposes to avoid unnecessary delays.
      *

package/lib/screenplay/time/models/Duration.d.ts

@@ -1,7 +1,7 @@
 import type { JSONObject } from 'tiny-types';
 import { TinyType } from 'tiny-types';
 /**
- * Represents a duration in milliseconds between two {@apilink Timestamp|timestamps}.
+ * Represents a duration in milliseconds between two [timestamps](https://serenity-js.org/api/core/class/Timestamp/).
  *
  * @group Time
  */

package/lib/screenplay/time/models/Duration.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Duration = void 0;
 const tiny_types_1 = require("tiny-types");
 /**
- * Represents a duration in milliseconds between two {@apilink Timestamp|timestamps}.
+ * Represents a duration in milliseconds between two [timestamps](https://serenity-js.org/api/core/class/Timestamp/).
  *
  * @group Time
  */

package/lib/screenplay/time/models/Timestamp.d.ts

@@ -5,10 +5,10 @@ import { Duration } from './Duration';
 /**
  * Represents a point in time.
  *
- * `Timestamp` makes it easier for you to work with information related to time, like {@apilink DomainEvent|domain events}.
+ * `Timestamp` makes it easier for you to work with information related to time, like [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/).
  *
  * ## Learn more
- * - {@apilink Duration}
+ * - [`Duration`](https://serenity-js.org/api/core/class/Duration/)
  * - [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)
  *
  * @group Time

package/lib/screenplay/time/models/Timestamp.js

@@ -7,10 +7,10 @@ const Duration_1 = require("./Duration");
 /**
  * Represents a point in time.
  *
- * `Timestamp` makes it easier for you to work with information related to time, like {@apilink DomainEvent|domain events}.
+ * `Timestamp` makes it easier for you to work with information related to time, like [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/).
  *
  * ## Learn more
- * - {@apilink Duration}
+ * - [`Duration`](https://serenity-js.org/api/core/class/Duration/)
  * - [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)
  *
  * @group Time

package/lib/stage/Cast.d.ts

@@ -1,10 +1,10 @@
 import type { Actor } from '../screenplay';
 /**
- * Serenity/JS uses the concept of a _**cast of actors**_ to centralise the process of configuring the {@apilink Actor|actors} and assigning their {@apilink Ability|abilities}.
+ * Serenity/JS uses the concept of a _**cast of actors**_ to centralise the process of configuring the [actors](https://serenity-js.org/api/core/class/Actor/) and assigning their [abilities](https://serenity-js.org/api/core/class/Ability/).
  *
- * When you invoke {@apilink actorCalled} for the first time in a test scenario,
- * Serenity/JS {@apilink Actor|instantiates a new actor}
- * and passes it through the {@apilink Cast.prepare} method.
+ * When you invoke [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/) for the first time in a test scenario,
+ * Serenity/JS [instantiates a new actor](https://serenity-js.org/api/core/class/Actor/)
+ * and passes it through the [`Cast.prepare`](https://serenity-js.org/api/core/class/Cast/#prepare) method.
  * Specifying a **custom cast** gives you an opportunity to configure the actor with the abilities
  * they need before it's returned to the caller,
  * or configure the actors differently **depending on their name**.
@@ -17,7 +17,7 @@ import type { Actor } from '../screenplay';
  * ## Configuring a cast of actors for the entire test suite
  *
  * When working with relatively **simple scenarios** where all the actors should always receive the same set of abilities,
- * you can {@apilink configure} Serenity/JS to use a generic {@apilink Cast.where}:
+ * you can [`engage`](https://serenity-js.org/api/core/function/engage/) Serenity/JS to use a generic [`Cast.where`](https://serenity-js.org/api/core/class/Cast/#where):
  *
  * ```typescript
  * import { Cast, configure } from '@serenity-js/core'
@@ -31,28 +31,28 @@ import type { Actor } from '../screenplay';
  * })
  * ```
  *
- * If you're using Serenity/JS with one of the [supported test runners](/handbook/test-runners/),
+ * If you're using Serenity/JS with one of the [supported test runners](https://serenity-js.org/handbook/test-runners/),
  * you might prefer to use your test runner's native configuration mechanism
- * instead of invoking {@apilink configure} explicitly.
+ * instead of invoking [`engage`](https://serenity-js.org/api/core/function/engage/) explicitly.
  *
  * :::tip configure vs engage
- * Calling {@apilink configure} resets the entire Serenity/JS configuration
+ * Calling [`configure`](https://serenity-js.org/api/core/function/configure/) resets the entire Serenity/JS configuration
  * and should be done exactly once in your entire test suite.
- * If you want to retain the configuration but reset the cast, use {@apilink engage} instead.
+ * If you want to retain the configuration but reset the cast, use [`engage`](https://serenity-js.org/api/core/function/engage/) instead.
  * :::
  *
  * Learn more about configuring Serenity/JS with:
- * - [Cucumber.js](/handbook/test-runners/cucumber)
- * - [Jasmine](/handbook/test-runners/jasmine)
- * - [Mocha](/handbook/test-runners/mocha)
- * - [Playwright Test](/handbook/test-runners/playwright-test)
- * - [Protractor](/handbook/test-runners/protractor)
- * - [WebdriverIO](/handbook/test-runners/webdriverio)
+ * - [Cucumber.js](https://serenity-js.org/handbook/test-runners/cucumber)
+ * - [Jasmine](https://serenity-js.org/handbook/test-runners/jasmine)
+ * - [Mocha](https://serenity-js.org/handbook/test-runners/mocha)
+ * - [Playwright Test](https://serenity-js.org/handbook/test-runners/playwright-test)
+ * - [Protractor](https://serenity-js.org/handbook/test-runners/protractor)
+ * - [WebdriverIO](https://serenity-js.org/handbook/test-runners/webdriverio)
  *
  * ## Engaging a cast of actors for the specific scenario
  *
- * If you want to retain Serenity/JS configuration, but set a different {@apilink Cast}
- * for the given test scenario you should use {@apilink engage} instead of {@apilink configure}.
+ * If you want to retain Serenity/JS configuration, but set a different [cast](https://serenity-js.org/api/core/class/Cast/)
+ * for the given test scenario you should use [`engage`](https://serenity-js.org/api/core/function/engage/) instead of [`configure`](https://serenity-js.org/api/core/function/configure/).
  *
  * This approach is useful for example when your entire test suite is dedicated to interacting with the system
  * under test via its REST APIs, and you have a handful of scenarios that need a web browser.
@@ -76,10 +76,10 @@ import type { Actor } from '../screenplay';
  * ## Writing custom casts for complex scenarios
  *
  * In **complex scenarios** that involve multiple **actors with different abilities**,
- * you should create a custom implementation of the {@apilink Cast}.
+ * you should create a custom implementation of the [cast](https://serenity-js.org/api/core/class/Cast/).
  *
  * Examples of such scenarios include those where actors use separate browser instances, interact with different REST APIs,
- * or start with different data in their {@apilink Notepad|notepads}.
+ * or start with different data in their [notepads](https://serenity-js.org/api/core/class/Notepad/).
  *
  * ### Defining a custom cast of actors interacting with a Web UI
  *
@@ -155,12 +155,12 @@ export declare abstract class Cast {
      */
     static where(prepareFunction: (actor: Actor) => Actor): Cast;
     /**
-     * Configures an {@apilink Actor} instantiated when {@apilink Stage.actor} is invoked.
+     * Configures an [`Actor`](https://serenity-js.org/api/core/class/Actor/) instantiated when [`Stage.actor`](https://serenity-js.org/api/core/class/Stage/#actor) is invoked.
      *
      * @param actor
      *
      * #### Learn more
-     * - {@apilink engage}
+     * - [`engage`](https://serenity-js.org/api/core/function/engage/)
      */
     abstract prepare(actor: Actor): Actor;
 }

package/lib/stage/Cast.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cast = void 0;
 /**
- * Serenity/JS uses the concept of a _**cast of actors**_ to centralise the process of configuring the {@apilink Actor|actors} and assigning their {@apilink Ability|abilities}.
+ * Serenity/JS uses the concept of a _**cast of actors**_ to centralise the process of configuring the [actors](https://serenity-js.org/api/core/class/Actor/) and assigning their [abilities](https://serenity-js.org/api/core/class/Ability/).
  *
- * When you invoke {@apilink actorCalled} for the first time in a test scenario,
- * Serenity/JS {@apilink Actor|instantiates a new actor}
- * and passes it through the {@apilink Cast.prepare} method.
+ * When you invoke [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/) for the first time in a test scenario,
+ * Serenity/JS [instantiates a new actor](https://serenity-js.org/api/core/class/Actor/)
+ * and passes it through the [`Cast.prepare`](https://serenity-js.org/api/core/class/Cast/#prepare) method.
  * Specifying a **custom cast** gives you an opportunity to configure the actor with the abilities
  * they need before it's returned to the caller,
  * or configure the actors differently **depending on their name**.
@@ -19,7 +19,7 @@ exports.Cast = void 0;
  * ## Configuring a cast of actors for the entire test suite
  *
  * When working with relatively **simple scenarios** where all the actors should always receive the same set of abilities,
- * you can {@apilink configure} Serenity/JS to use a generic {@apilink Cast.where}:
+ * you can [`engage`](https://serenity-js.org/api/core/function/engage/) Serenity/JS to use a generic [`Cast.where`](https://serenity-js.org/api/core/class/Cast/#where):
  *
  * ```typescript
  * import { Cast, configure } from '@serenity-js/core'
@@ -33,28 +33,28 @@ exports.Cast = void 0;
  * })
  * ```
  *
- * If you're using Serenity/JS with one of the [supported test runners](/handbook/test-runners/),
+ * If you're using Serenity/JS with one of the [supported test runners](https://serenity-js.org/handbook/test-runners/),
  * you might prefer to use your test runner's native configuration mechanism
- * instead of invoking {@apilink configure} explicitly.
+ * instead of invoking [`engage`](https://serenity-js.org/api/core/function/engage/) explicitly.
  *
  * :::tip configure vs engage
- * Calling {@apilink configure} resets the entire Serenity/JS configuration
+ * Calling [`configure`](https://serenity-js.org/api/core/function/configure/) resets the entire Serenity/JS configuration
  * and should be done exactly once in your entire test suite.
- * If you want to retain the configuration but reset the cast, use {@apilink engage} instead.
+ * If you want to retain the configuration but reset the cast, use [`engage`](https://serenity-js.org/api/core/function/engage/) instead.
  * :::
  *
  * Learn more about configuring Serenity/JS with:
- * - [Cucumber.js](/handbook/test-runners/cucumber)
- * - [Jasmine](/handbook/test-runners/jasmine)
- * - [Mocha](/handbook/test-runners/mocha)
- * - [Playwright Test](/handbook/test-runners/playwright-test)
- * - [Protractor](/handbook/test-runners/protractor)
- * - [WebdriverIO](/handbook/test-runners/webdriverio)
+ * - [Cucumber.js](https://serenity-js.org/handbook/test-runners/cucumber)
+ * - [Jasmine](https://serenity-js.org/handbook/test-runners/jasmine)
+ * - [Mocha](https://serenity-js.org/handbook/test-runners/mocha)
+ * - [Playwright Test](https://serenity-js.org/handbook/test-runners/playwright-test)
+ * - [Protractor](https://serenity-js.org/handbook/test-runners/protractor)
+ * - [WebdriverIO](https://serenity-js.org/handbook/test-runners/webdriverio)
  *
  * ## Engaging a cast of actors for the specific scenario
  *
- * If you want to retain Serenity/JS configuration, but set a different {@apilink Cast}
- * for the given test scenario you should use {@apilink engage} instead of {@apilink configure}.
+ * If you want to retain Serenity/JS configuration, but set a different [cast](https://serenity-js.org/api/core/class/Cast/)
+ * for the given test scenario you should use [`engage`](https://serenity-js.org/api/core/function/engage/) instead of [`configure`](https://serenity-js.org/api/core/function/configure/).
  *
  * This approach is useful for example when your entire test suite is dedicated to interacting with the system
  * under test via its REST APIs, and you have a handful of scenarios that need a web browser.
@@ -78,10 +78,10 @@ exports.Cast = void 0;
  * ## Writing custom casts for complex scenarios
  *
  * In **complex scenarios** that involve multiple **actors with different abilities**,
- * you should create a custom implementation of the {@apilink Cast}.
+ * you should create a custom implementation of the [cast](https://serenity-js.org/api/core/class/Cast/).
  *
  * Examples of such scenarios include those where actors use separate browser instances, interact with different REST APIs,
- * or start with different data in their {@apilink Notepad|notepads}.
+ * or start with different data in their [notepads](https://serenity-js.org/api/core/class/Notepad/).
  *
  * ### Defining a custom cast of actors interacting with a Web UI
  *

package/lib/stage/Extras.d.ts

@@ -1,7 +1,7 @@
 import type { Actor } from '../screenplay';
 import type { Cast } from './Cast';
 /**
- * Produces no-op actors with no special {@apilink Ability}
+ * Produces no-op actors with no special [`Ability`](https://serenity-js.org/api/core/class/Ability/)
  */
 export declare class Extras implements Cast {
     prepare(actor: Actor): Actor;

package/lib/stage/Extras.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Extras = void 0;
 /**
- * Produces no-op actors with no special {@apilink Ability}
+ * Produces no-op actors with no special [`Ability`](https://serenity-js.org/api/core/class/Ability/)
  */
 class Extras {
     prepare(actor) {

package/lib/stage/ListensToDomainEvents.d.ts

@@ -1,20 +1,20 @@
 import type { DomainEvent } from '../events';
 /**
- * A {@apilink StageCrewMember} that can listen and react to {@apilink DomainEvent|DomainEvents}
+ * A [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) that can listen and react to [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/)
  *
  * ## Learn more
  *
- * - {@apilink StageCrewMember}
- * - {@apilink StageCrewMemberBuilder}
- * - {@apilink configure}
- * - {@apilink SerenityConfig.crew}
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMemberBuilder/)
+ * - [`engage`](https://serenity-js.org/api/core/function/engage/)
+ * - [`SerenityConfig.crew`](https://serenity-js.org/api/core/class/SerenityConfig/#crew)
  *
  * @group Stage
  */
 export interface ListensToDomainEvents {
     /**
-     * Handles {@apilink DomainEvent} objects emitted by the {@apilink Stage}
-     * that this {@apilink StageCrewMember} is assigned to.
+     * Handles [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects emitted by the [`Stage`](https://serenity-js.org/api/core/class/Stage/)
+     * that this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) is assigned to.
      *
      * @param event
      */

package/lib/stage/Stage.d.ts

@@ -8,17 +8,17 @@ import type { ListensToDomainEvents } from '../stage';
 import type { Cast } from './Cast';
 import type { StageManager } from './StageManager';
 /**
- * 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
  */
@@ -41,7 +41,7 @@ export declare class Stage implements EmitsDomainEvents {
     private actorsOnBackstage;
     private actorsOnStage;
     /**
-     * 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
      */
     private actorInTheSpotlight;
     private currentActivity;
@@ -55,13 +55,13 @@ export declare class Stage implements EmitsDomainEvents {
      */
     constructor(cast: Cast, manager: StageManager, errors: ErrorFactory, clock: Clock, interactionTimeout: Duration);
     /**
-     * An alias for {@apilink Stage.actor}
+     * An alias for [`Stage.actor`](https://serenity-js.org/api/core/class/Stage/#actor)
      *
      * @param name
      */
     theActorCalled(name: string): Actor;
     /**
-     * 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
@@ -69,27 +69,27 @@ export declare class Stage implements EmitsDomainEvents {
      */
     actor(name: string): Actor;
     /**
-     * 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(): Actor;
     /**
-     * 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(): boolean;
     /**
-     * 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
      */
     engage(actors: Cast): void;
     /**
-     * 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
      */
@@ -104,44 +104,43 @@ export declare class Stage implements EmitsDomainEvents {
     private announceSingle;
     /**
      * 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(): Timestamp;
     /**
-     * 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(): CorrelationId;
     /**
-     * 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(): CorrelationId;
     /**
-     * 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: ActivityDetails): CorrelationId;
     /**
-     * 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(): CorrelationId;
     /**

package/lib/stage/Stage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Stage.d.ts","sourceRoot":"","sources":["../../src/stage/Stage.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE1E,OAAO,KAAK,EACR,WAAW,EACX,iBAAiB,EAAC,MAAM,WAAW,CAAC;AASxC,OAAO,KAAK,EAAE,eAAe,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAqB,MAAM,UAAU,CAAC;AAC5D,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,KAAK,EAAgB,MAAM,eAAe,CAAC;AACpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,KAAM,YAAW,iBAAiB;IAmCvC,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IArCvC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAA+B;IAErE;;;OAGG;IACH,OAAO,CAAC,kBAAkB,CAAgD;IAE1E;;;OAGG;IACH,OAAO,CAAC,iBAAiB,CAAgD;IAEzE,OAAO,CAAC,aAAa,CAA8C;IAEnE;;OAEG;IACH,OAAO,CAAC,mBAAmB,CAAoB;IAE/C,OAAO,CAAC,eAAe,CAA8D;IAErF,OAAO,CAAC,YAAY,CAAuC;IAE3D;;;;;;OAMG;gBAES,IAAI,EAAE,IAAI,EACD,OAAO,EAAE,YAAY,EAC9B,MAAM,EAAE,YAAY,EACX,KAAK,EAAE,KAAK,EACZ,kBAAkB,EAAE,QAAQ;IASjD;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK;IAInC;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK;IA8B1B;;;;;;OAMG;IACH,sBAAsB,IAAI,KAAK;IAQ/B;;OAEG;IACH,iBAAiB,IAAI,OAAO;IAI5B;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI;IAM1B;;;;;OAKG;IACH,MAAM,CAAC,GAAG,SAAS,EAAE,qBAAqB,EAAE,GAAG,IAAI;IAInD;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI;IAM7C,OAAO,CAAC,cAAc;IAkBtB;;;OAGG;IACH,WAAW,IAAI,SAAS;IAIxB;;;;;;;;;;OAUG;IACH,gBAAgB,IAAI,aAAa;IAOjC;;;;;OAKG;IACH,cAAc,IAAI,aAAa;IAI/B;;;;;;;;;OASG;IACH,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,aAAa;IASpE;;;;;OAKG;IACH,iBAAiB,IAAI,aAAa;IAQlC;;;;;;;OAOG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B,WAAW,CAAC,EAAE,SAAS,YAAY,EAAE,SAAS,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,YAAY,GAAG,EAAE;IAOtG,OAAO,CAAC,uBAAuB;YAMjB,OAAO;IAuCrB,OAAO,CAAC,MAAM;CAKjB"}
+{"version":3,"file":"Stage.d.ts","sourceRoot":"","sources":["../../src/stage/Stage.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE1E,OAAO,KAAK,EACR,WAAW,EACX,iBAAiB,EAAC,MAAM,WAAW,CAAC;AASxC,OAAO,KAAK,EAAE,eAAe,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAqB,MAAM,UAAU,CAAC;AAC5D,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,KAAK,EAAgB,MAAM,eAAe,CAAC;AACpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,KAAM,YAAW,iBAAiB;IAmCvC,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IArCvC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAA+B;IAErE;;;OAGG;IACH,OAAO,CAAC,kBAAkB,CAAgD;IAE1E;;;OAGG;IACH,OAAO,CAAC,iBAAiB,CAAgD;IAEzE,OAAO,CAAC,aAAa,CAA8C;IAEnE;;OAEG;IACH,OAAO,CAAC,mBAAmB,CAAoB;IAE/C,OAAO,CAAC,eAAe,CAA8D;IAErF,OAAO,CAAC,YAAY,CAAuC;IAE3D;;;;;;OAMG;gBAES,IAAI,EAAE,IAAI,EACD,OAAO,EAAE,YAAY,EAC9B,MAAM,EAAE,YAAY,EACX,KAAK,EAAE,KAAK,EACZ,kBAAkB,EAAE,QAAQ;IASjD;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK;IAInC;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK;IA8B1B;;;;;;OAMG;IACH,sBAAsB,IAAI,KAAK;IAQ/B;;OAEG;IACH,iBAAiB,IAAI,OAAO;IAI5B;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI;IAM1B;;;;;OAKG;IACH,MAAM,CAAC,GAAG,SAAS,EAAE,qBAAqB,EAAE,GAAG,IAAI;IAInD;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI;IAM7C,OAAO,CAAC,cAAc;IAkBtB;;;OAGG;IACH,WAAW,IAAI,SAAS;IAIxB;;;;;;;;;OASG;IACH,gBAAgB,IAAI,aAAa;IAOjC;;;;;OAKG;IACH,cAAc,IAAI,aAAa;IAI/B;;;;;;;;;OASG;IACH,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,aAAa;IASpE;;;;;OAKG;IACH,iBAAiB,IAAI,aAAa;IAQlC;;;;;;;OAOG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B,WAAW,CAAC,EAAE,SAAS,YAAY,EAAE,SAAS,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,YAAY,GAAG,EAAE;IAOtG,OAAO,CAAC,uBAAuB;YAMjB,OAAO;IAuCrB,OAAO,CAAC,MAAM;CAKjB"}