@serenity-js/core 3.25.0 → 3.25.2

package/lib/errors/diff/AnsiDiffFormatter.d.ts

@@ -1,7 +1,7 @@
 import type { Options } from 'chalk';
 import type { DiffFormatter } from './DiffFormatter';
 /**
- * A {@apilink DiffFormatter} that uses [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code)
+ * A [`DiffFormatter`](https://serenity-js.org/api/core/interface/DiffFormatter/) that uses [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code)
  * to format the output.
  *
  * @group Errors

package/lib/errors/diff/AnsiDiffFormatter.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AnsiDiffFormatter = void 0;
 const chalk_1 = require("chalk"); // eslint-disable-line unicorn/import-style
 /**
- * A {@apilink DiffFormatter} that uses [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code)
+ * A [`DiffFormatter`](https://serenity-js.org/api/core/interface/DiffFormatter/) that uses [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code)
  * to format the output.
  *
  * @group Errors

package/lib/errors/diff/DiffFormatter.d.ts

@@ -1,6 +1,6 @@
 /**
  * Formats text representing expected, received, and unchanged lines of a diff
- * produced by the {@apilink ErrorFactory}, so that they can be presented to a developer
+ * produced by the [`ErrorFactory`](https://serenity-js.org/api/core/class/ErrorFactory/), so that they can be presented to a developer
  * in a visually distinctive way.
  *
  * @group Errors

package/lib/errors/diff/NoOpDiffFormatter.d.ts

@@ -1,6 +1,6 @@
 import type { DiffFormatter } from './DiffFormatter';
 /**
- * A no-op {@apilink DiffFormatter} that produces output identical to input.
+ * A no-op [`DiffFormatter`](https://serenity-js.org/api/core/interface/DiffFormatter/) that produces output identical to input.
  *
  * @group Errors
  */

package/lib/errors/diff/NoOpDiffFormatter.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NoOpDiffFormatter = void 0;
 /**
- * A no-op {@apilink DiffFormatter} that produces output identical to input.
+ * A no-op [`DiffFormatter`](https://serenity-js.org/api/core/interface/DiffFormatter/) that produces output identical to input.
  *
  * @group Errors
  */

package/lib/errors/model/AssertionError.d.ts

@@ -9,7 +9,7 @@ export declare class AssertionError extends RuntimeError {
     static fromJSON(serialised: JSONObject): AssertionError;
     /**
      * @param message - Human-readable description of the error and the difference between the expected and actual values
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message: string, cause?: Error);
 }

package/lib/errors/model/AssertionError.js

@@ -16,7 +16,7 @@ class AssertionError extends RuntimeError_1.RuntimeError {
     }
     /**
      * @param message - Human-readable description of the error and the difference between the expected and actual values
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message, cause) {
         super(AssertionError, message, cause);

package/lib/errors/model/ConfigurationError.d.ts

@@ -9,7 +9,7 @@ export declare class ConfigurationError extends RuntimeError {
     static fromJSON(serialised: JSONObject): ConfigurationError;
     /**
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message: string, cause?: Error);
 }

package/lib/errors/model/ConfigurationError.js

@@ -16,7 +16,7 @@ class ConfigurationError extends RuntimeError_1.RuntimeError {
     }
     /**
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message, cause) {
         super(ConfigurationError, message, cause);

package/lib/errors/model/ImplementationPendingError.d.ts

@@ -1,8 +1,8 @@
 import type { JSONObject } from 'tiny-types';
 import { RuntimeError } from './RuntimeError';
 /**
- * Thrown to indicate that the {@apilink Actor} attempted to perform
- * a {@apilink Task} or {@apilink Interaction} that hasn't been implemented yet.
+ * Thrown to indicate that the [`Actor`](https://serenity-js.org/api/core/class/Actor/) attempted to perform
+ * a [`Task`](https://serenity-js.org/api/core/class/Task/) or [`Interaction`](https://serenity-js.org/api/core/class/Interaction/) that hasn't been implemented yet.
  *
  * ## A pending Task
  *
@@ -30,7 +30,7 @@ export declare class ImplementationPendingError extends RuntimeError {
     static fromJSON(serialised: JSONObject): ImplementationPendingError;
     /**
      * @param {string} message - Human-readable description of the error
-     * @param {Error} [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param {Error} [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message: string, cause?: Error);
 }

package/lib/errors/model/ImplementationPendingError.js

@@ -4,8 +4,8 @@ exports.ImplementationPendingError = void 0;
 const ErrorSerialiser_1 = require("../ErrorSerialiser");
 const RuntimeError_1 = require("./RuntimeError");
 /**
- * Thrown to indicate that the {@apilink Actor} attempted to perform
- * a {@apilink Task} or {@apilink Interaction} that hasn't been implemented yet.
+ * Thrown to indicate that the [`Actor`](https://serenity-js.org/api/core/class/Actor/) attempted to perform
+ * a [`Task`](https://serenity-js.org/api/core/class/Task/) or [`Interaction`](https://serenity-js.org/api/core/class/Interaction/) that hasn't been implemented yet.
  *
  * ## A pending Task
  *
@@ -37,7 +37,7 @@ class ImplementationPendingError extends RuntimeError_1.RuntimeError {
     }
     /**
      * @param {string} message - Human-readable description of the error
-     * @param {Error} [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param {Error} [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message, cause) {
         super(ImplementationPendingError, message, cause);

package/lib/errors/model/ListItemNotFoundError.d.ts

@@ -1,7 +1,7 @@
 import type { JSONObject } from 'tiny-types';
 import { RuntimeError } from './RuntimeError';
 /**
- * Thrown to indicate that an {@apilink Interaction}, a {@apilink Task} or a test scenario
+ * Thrown to indicate that an [`Interaction`](https://serenity-js.org/api/core/class/Interaction/), a [`Task`](https://serenity-js.org/api/core/class/Task/) or a test scenario
  * can't be executed due to no items are found in a list.
  *
  * For example, it's not possible to get the first() or the last() item of a list
@@ -13,7 +13,7 @@ export declare class ListItemNotFoundError extends RuntimeError {
     static fromJSON(serialised: JSONObject): ListItemNotFoundError;
     /**
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink ListItemNotFoundError}, if any
+     * @param [cause] - The root cause of this [`ListItemNotFoundError`](https://serenity-js.org/api/core/class/ListItemNotFoundError/), if any
      */
     constructor(message: string, cause?: Error);
 }

package/lib/errors/model/ListItemNotFoundError.js

@@ -4,7 +4,7 @@ exports.ListItemNotFoundError = void 0;
 const ErrorSerialiser_1 = require("../ErrorSerialiser");
 const RuntimeError_1 = require("./RuntimeError");
 /**
- * Thrown to indicate that an {@apilink Interaction}, a {@apilink Task} or a test scenario
+ * Thrown to indicate that an [`Interaction`](https://serenity-js.org/api/core/class/Interaction/), a [`Task`](https://serenity-js.org/api/core/class/Task/) or a test scenario
  * can't be executed due to no items are found in a list.
  *
  * For example, it's not possible to get the first() or the last() item of a list
@@ -20,7 +20,7 @@ class ListItemNotFoundError extends RuntimeError_1.RuntimeError {
     }
     /**
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink ListItemNotFoundError}, if any
+     * @param [cause] - The root cause of this [`ListItemNotFoundError`](https://serenity-js.org/api/core/class/ListItemNotFoundError/), if any
      */
     constructor(message, cause) {
         super(ListItemNotFoundError, message, cause);

package/lib/errors/model/LogicError.d.ts

@@ -1,7 +1,7 @@
 import type { JSONObject } from 'tiny-types';
 import { RuntimeError } from './RuntimeError';
 /**
- * Thrown to indicate that an {@apilink Interaction}, a {@apilink Task} or a test scenario
+ * Thrown to indicate that an [`Interaction`](https://serenity-js.org/api/core/class/Interaction/), a [`Task`](https://serenity-js.org/api/core/class/Task/) or a test scenario
  * can't be executed due to a logical error.
  *
  * For example, it's not possible to assert on the last HTTP Response if the request
@@ -13,7 +13,7 @@ export declare class LogicError extends RuntimeError {
     static fromJSON(serialised: JSONObject): LogicError;
     /**
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message: string, cause?: Error);
 }

package/lib/errors/model/LogicError.js

@@ -4,7 +4,7 @@ exports.LogicError = void 0;
 const ErrorSerialiser_1 = require("../ErrorSerialiser");
 const RuntimeError_1 = require("./RuntimeError");
 /**
- * Thrown to indicate that an {@apilink Interaction}, a {@apilink Task} or a test scenario
+ * Thrown to indicate that an [`Interaction`](https://serenity-js.org/api/core/class/Interaction/), a [`Task`](https://serenity-js.org/api/core/class/Task/) or a test scenario
  * can't be executed due to a logical error.
  *
  * For example, it's not possible to assert on the last HTTP Response if the request
@@ -20,7 +20,7 @@ class LogicError extends RuntimeError_1.RuntimeError {
     }
     /**
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message, cause) {
         super(LogicError, message, cause);

package/lib/errors/model/OperationInterruptedError.d.ts

@@ -1,7 +1,7 @@
 import type { JSONObject } from 'tiny-types';
 import { RuntimeError } from './RuntimeError';
 /**
- * Thrown to indicate that a {@apilink Scheduler|scheduled operation}
+ * Thrown to indicate that a [scheduled operation](https://serenity-js.org/api/core/class/Scheduler/)
  * has been stopped before it was completed.
  *
  * @group Errors
@@ -13,7 +13,7 @@ export declare class OperationInterruptedError extends RuntimeError {
      *  Human-readable description of the error
      *
      * @param [cause]
-     *  The root cause of this {@apilink RuntimeError}, if any
+     *  The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message: string, cause?: Error);
 }

package/lib/errors/model/OperationInterruptedError.js

@@ -4,7 +4,7 @@ exports.OperationInterruptedError = void 0;
 const ErrorSerialiser_1 = require("../ErrorSerialiser");
 const RuntimeError_1 = require("./RuntimeError");
 /**
- * Thrown to indicate that a {@apilink Scheduler|scheduled operation}
+ * Thrown to indicate that a [scheduled operation](https://serenity-js.org/api/core/class/Scheduler/)
  * has been stopped before it was completed.
  *
  * @group Errors
@@ -20,7 +20,7 @@ class OperationInterruptedError extends RuntimeError_1.RuntimeError {
      *  Human-readable description of the error
      *
      * @param [cause]
-     *  The root cause of this {@apilink RuntimeError}, if any
+     *  The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message, cause) {
         super(OperationInterruptedError, message, cause);

package/lib/errors/model/RuntimeError.d.ts

@@ -34,7 +34,7 @@
  *   })
  * ```
  *
- * ## Registering a custom error with {@apilink ErrorSerialiser}
+ * ## Registering a custom error with [`ErrorSerialiser`](https://serenity-js.org/api/core/class/ErrorSerialiser/)
  *
  * ```ts
  * import { RuntimeError } from '@serenity-js/core'
@@ -68,7 +68,7 @@ export declare abstract class RuntimeError extends Error {
     /**
      * @param type - Constructor function used to instantiate a subclass of a RuntimeError
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     protected constructor(type: new (...args: any[]) => RuntimeError, message: string, cause?: Error);
     /**

package/lib/errors/model/RuntimeError.js

@@ -38,7 +38,7 @@ const tiny_types_1 = require("tiny-types");
  *   })
  * ```
  *
- * ## Registering a custom error with {@apilink ErrorSerialiser}
+ * ## Registering a custom error with [`ErrorSerialiser`](https://serenity-js.org/api/core/class/ErrorSerialiser/)
  *
  * ```ts
  * import { RuntimeError } from '@serenity-js/core'
@@ -72,7 +72,7 @@ class RuntimeError extends Error {
     /**
      * @param type - Constructor function used to instantiate a subclass of a RuntimeError
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(type, message, cause) {
         const errorMessage = message || '';

package/lib/errors/model/TestCompromisedError.d.ts

@@ -24,7 +24,7 @@ export declare class TestCompromisedError extends RuntimeError {
     static fromJSON(serialised: JSONObject): TestCompromisedError;
     /**
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message: string, cause?: Error);
 }

package/lib/errors/model/TestCompromisedError.js

@@ -31,7 +31,7 @@ class TestCompromisedError extends RuntimeError_1.RuntimeError {
     }
     /**
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message, cause) {
         super(TestCompromisedError, message, cause);

package/lib/errors/model/TimeoutExpiredError.d.ts

@@ -1,7 +1,7 @@
 import type { JSONObject } from 'tiny-types';
 import { RuntimeError } from './RuntimeError';
 /**
- * Thrown to indicate that an {@apilink Interaction}, a {@apilink Task} or a test scenario
+ * Thrown to indicate that an [`Interaction`](https://serenity-js.org/api/core/class/Interaction/), a [`Task`](https://serenity-js.org/api/core/class/Task/) or a test scenario
  * took longer to execute than the expected timeout.
  *
  * @group Errors
@@ -13,7 +13,7 @@ export declare class TimeoutExpiredError extends RuntimeError {
      *  Human-readable description of the error
      *
      * @param [cause]
-     *  The root cause of this {@apilink RuntimeError}, if any
+     *  The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message: string, cause?: Error);
 }

package/lib/errors/model/TimeoutExpiredError.js

@@ -4,7 +4,7 @@ exports.TimeoutExpiredError = void 0;
 const ErrorSerialiser_1 = require("../ErrorSerialiser");
 const RuntimeError_1 = require("./RuntimeError");
 /**
- * Thrown to indicate that an {@apilink Interaction}, a {@apilink Task} or a test scenario
+ * Thrown to indicate that an [`Interaction`](https://serenity-js.org/api/core/class/Interaction/), a [`Task`](https://serenity-js.org/api/core/class/Task/) or a test scenario
  * took longer to execute than the expected timeout.
  *
  * @group Errors
@@ -20,7 +20,7 @@ class TimeoutExpiredError extends RuntimeError_1.RuntimeError {
      *  Human-readable description of the error
      *
      * @param [cause]
-     *  The root cause of this {@apilink RuntimeError}, if any
+     *  The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message, cause) {
         super(TimeoutExpiredError, message, cause);

package/lib/errors/model/UnknownError.d.ts

@@ -9,7 +9,7 @@ export declare class UnknownError extends RuntimeError {
     static fromJSON(serialised: JSONObject): UnknownError;
     /**
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message: string, cause?: Error);
 }

package/lib/errors/model/UnknownError.js

@@ -16,7 +16,7 @@ class UnknownError extends RuntimeError_1.RuntimeError {
     }
     /**
      * @param message - Human-readable description of the error
-     * @param [cause] - The root cause of this {@apilink RuntimeError}, if any
+     * @param [cause] - The root cause of this [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/), if any
      */
     constructor(message, cause) {
         super(UnknownError, message, cause);

package/lib/events/ActivityFinished.d.ts

@@ -2,7 +2,7 @@ import type { ActivityDetails, CorrelationId, Outcome } from '../model';
 import type { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 /**
- * Emitted when an {@apilink Activity} is finished.
+ * Emitted when an [`Activity`](https://serenity-js.org/api/core/class/Activity/) is finished.
  *
  * @group Events
  */

package/lib/events/ActivityFinished.js

@@ -4,7 +4,7 @@ exports.ActivityFinished = void 0;
 const tiny_types_1 = require("tiny-types");
 const DomainEvent_1 = require("./DomainEvent");
 /**
- * Emitted when an {@apilink Activity} is finished.
+ * Emitted when an [`Activity`](https://serenity-js.org/api/core/class/Activity/) is finished.
  *
  * @group Events
  */

package/lib/events/ActivityStarts.d.ts

@@ -2,7 +2,7 @@ import type { ActivityDetails, CorrelationId } from '../model';
 import type { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 /**
- * Emitted when an {@apilink Activity} starts.
+ * Emitted when an [`Activity`](https://serenity-js.org/api/core/class/Activity/) starts.
  *
  * @group Events
  */

package/lib/events/ActivityStarts.js

@@ -4,7 +4,7 @@ exports.ActivityStarts = void 0;
 const tiny_types_1 = require("tiny-types");
 const DomainEvent_1 = require("./DomainEvent");
 /**
- * Emitted when an {@apilink Activity} starts.
+ * Emitted when an [`Activity`](https://serenity-js.org/api/core/class/Activity/) starts.
  *
  * @group Events
  */

package/lib/events/BusinessRuleDetected.d.ts

@@ -3,7 +3,7 @@ import { BusinessRule, CorrelationId, ScenarioDetails } from '../model';
 import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 /**
- * Emitted by [@serenity-js/cucumber](/api/cucumber)
+ * Emitted by [@serenity-js/cucumber](https://serenity-js.org/api/cucumber)
  * when a [business rule](https://cucumber.io/docs/gherkin/reference/#rule) is detected.
  *
  * @group Events

package/lib/events/BusinessRuleDetected.js

@@ -6,7 +6,7 @@ const model_1 = require("../model");
 const screenplay_1 = require("../screenplay");
 const DomainEvent_1 = require("./DomainEvent");
 /**
- * Emitted by [@serenity-js/cucumber](/api/cucumber)
+ * Emitted by [@serenity-js/cucumber](https://serenity-js.org/api/cucumber)
  * when a [business rule](https://cucumber.io/docs/gherkin/reference/#rule) is detected.
  *
  * @group Events

package/lib/events/SceneFinishes.d.ts

@@ -4,7 +4,8 @@ import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 /**
  * Emitted by a Serenity/JS test runner adapter, right before a test and all its associated test hooks finish.
- * Triggers any clean-up operations that might be required, such as discarding of the {@apilink Discardable} abilities.
+ * Triggers any clean-up operations that might be required, such as discarding of
+ * the [discardable](https://serenity-js.org/api/core/interface/Discardable/) abilities.
  *
  * @group Events
  */

package/lib/events/SceneFinishes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SceneFinishes.d.ts","sourceRoot":"","sources":["../../src/events/SceneFinishes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,WAAW;aAStB,OAAO,EAAE,aAAa;IAR1C,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,UAAU,GAAG,aAAa;gBAQzB,OAAO,EAAE,aAAa,EACtC,SAAS,CAAC,EAAE,SAAS;CAK5B"}
+{"version":3,"file":"SceneFinishes.d.ts","sourceRoot":"","sources":["../../src/events/SceneFinishes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,WAAW;aAStB,OAAO,EAAE,aAAa;IAR1C,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,UAAU,GAAG,aAAa;gBAQzB,OAAO,EAAE,aAAa,EACtC,SAAS,CAAC,EAAE,SAAS;CAK5B"}

package/lib/events/SceneFinishes.js

@@ -7,7 +7,8 @@ const screenplay_1 = require("../screenplay");
 const DomainEvent_1 = require("./DomainEvent");
 /**
  * Emitted by a Serenity/JS test runner adapter, right before a test and all its associated test hooks finish.
- * Triggers any clean-up operations that might be required, such as discarding of the {@apilink Discardable} abilities.
+ * Triggers any clean-up operations that might be required, such as discarding of
+ * the [discardable](https://serenity-js.org/api/core/interface/Discardable/) abilities.
  *
  * @group Events
  */

package/lib/events/SceneFinishes.js.map

@@ -1 +1 @@
-{"version":3,"file":"SceneFinishes.js","sourceRoot":"","sources":["../../src/events/SceneFinishes.ts"],"names":[],"mappings":";;;AACA,2CAA+C;AAE/C,oCAAyC;AACzC,8CAA0C;AAC1C,+CAA4C;AAE5C;;;;;GAKG;AACH,MAAa,aAAc,SAAQ,yBAAW;IAStB;IARpB,MAAM,CAAC,QAAQ,CAAC,CAAa;QACzB,OAAO,IAAI,aAAa,CACpB,qBAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAiB,CAAC,EAC3C,sBAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAmB,CAAC,CAC5C,CAAC;IACN,CAAC;IAED,YACoB,OAAsB,EACtC,SAAqB;QAErB,KAAK,CAAC,SAAS,CAAC,CAAC;QAHD,YAAO,GAAP,OAAO,CAAe;QAItC,IAAA,mBAAM,EAAC,SAAS,EAAE,OAAO,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;IAC5C,CAAC;CACJ;AAfD,sCAeC"}
+{"version":3,"file":"SceneFinishes.js","sourceRoot":"","sources":["../../src/events/SceneFinishes.ts"],"names":[],"mappings":";;;AACA,2CAA+C;AAE/C,oCAAyC;AACzC,8CAA0C;AAC1C,+CAA4C;AAE5C;;;;;;GAMG;AACH,MAAa,aAAc,SAAQ,yBAAW;IAStB;IARpB,MAAM,CAAC,QAAQ,CAAC,CAAa;QACzB,OAAO,IAAI,aAAa,CACpB,qBAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAiB,CAAC,EAC3C,sBAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAmB,CAAC,CAC5C,CAAC;IACN,CAAC;IAED,YACoB,OAAsB,EACtC,SAAqB;QAErB,KAAK,CAAC,SAAS,CAAC,CAAC;QAHD,YAAO,GAAP,OAAO,CAAe;QAItC,IAAA,mBAAM,EAAC,SAAS,EAAE,OAAO,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC;IAC5C,CAAC;CACJ;AAfD,sCAeC"}

package/lib/instance.d.ts

@@ -14,10 +14,10 @@ export declare const serenity: Serenity;
  * so this function should be called exactly once
  * in your test suite.
  *
- * This function is an alias for {@apilink Serenity.configure}.
+ * This function is an alias for [`Serenity.configure`](https://serenity-js.org/api/core/class/Serenity/#configure).
  *
  * :::tip configure vs engage
-  * If you want to retain the configuration but reset the {@apilink Cast|cast of actors}, use {@apilink engage} instead.
+  * If you want to retain the configuration but reset the [cast of actors](https://serenity-js.org/api/core/class/Cast/), use [`engage`](https://serenity-js.org/api/core/function/engage/) instead.
  * :::
  *
  * @param config
@@ -26,26 +26,26 @@ export declare const serenity: Serenity;
  */
 export declare function configure(config: SerenityConfig): void;
 /**
- * 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/).
  *
- * This function is an alias for {@apilink Serenity.engage},
- * which provides an alternative to calling {@apilink Actor.whoCan} directly in your tests
+ * This function is an alias for [`Serenity.engage`](https://serenity-js.org/api/core/class/Serenity/#engage),
+ * 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.
  *
  * :::tip configure vs engage
- * Calling {@apilink engage} replaces the currently configured {@apilink Cast|cast of actors},
+ * Calling [`engage`](https://serenity-js.org/api/core/function/engage/) replaces the currently configured [cast of actors](https://serenity-js.org/api/core/class/Cast/),
  * but doesn't affect any other configuration.
- * If you want to reset the Serenity/JS configuration completely, use {@apilink configure} instead.
+ * If you want to reset the Serenity/JS configuration completely, use [`configure`](https://serenity-js.org/api/core/function/configure/) instead.
  * :::
  *
- * 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,
@@ -108,8 +108,8 @@ export declare function configure(config: SerenityConfig): void;
  *
  * ### Using with Playwright Test runner
  *
- * [Serenity/JS Playwright Test module](/api/playwright-test) will configure the cast on your behalf,
- * so you don't need to call {@apilink engage}.
+ * [Serenity/JS Playwright Test module](https://serenity-js.org/api/playwright-test) will configure the cast on your behalf,
+ * so you don't need to call [`engage`](https://serenity-js.org/api/core/function/engage/).
  *
  * ```ts
  * import { describe, it, test } from '@serenity-js/playwright-test'
@@ -126,9 +126,9 @@ export declare function configure(config: SerenityConfig): void;
  * ```
  *
  * ## Learn more
- * - {@apilink Actor}
- * - {@apilink Cast}
- * - {@apilink Serenity.engage}
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
+ * - [`Serenity.engage`](https://serenity-js.org/api/core/class/Serenity/#engage)
  *
  * @param actors
  *
@@ -136,10 +136,10 @@ export declare function configure(config: SerenityConfig): void;
  */
 export declare function engage(actors: Cast): void;
 /**
- * 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.
  *
- * This method is an alias for {@apilink Serenity.theActorCalled}.
+ * This method is an alias for [`Serenity.theActorCalled`](https://serenity-js.org/api/core/class/Serenity/#theActorCalled).
  *
  * ## Usage with Cucumber
  *
@@ -188,9 +188,9 @@ export declare function engage(actors: Cast): void;
  *
  * ## Usage with Playwright Test
  *
- * When using [Serenity/JS with Playwright Test](/api/playwright-test/), you should use either
- * the default [`actor`](/api/playwright-test/interface/SerenityFixtures/#actorCalled) fixture
- * or the injected [`actorCalled`](/api/playwright-test/interface/SerenityFixtures/#actorCalled) function
+ * When using [Serenity/JS with Playwright Test](https://serenity-js.org/api/playwright-test/), you should use either
+ * the default [`actor`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#actorCalled) fixture
+ * or the injected [`actorCalled`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#actorCalled) function
  * instead of importing it from `@serenity-js/core`.
  *
  * ```typescript
@@ -208,10 +208,10 @@ export declare function engage(actors: Cast): void;
  *
  * ## Learn more
  *
- * - {@apilink engage}
- * - {@apilink Actor}
- * - {@apilink Cast}
- * - {@apilink Serenity.theActorCalled}
+ * - [`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/)
+ * - [`Serenity.theActorCalled`](https://serenity-js.org/api/core/class/Serenity/#theActorCalled)
  *
  * @param name
  *  The name of the actor to instantiate or retrieve
@@ -221,11 +221,11 @@ export declare function engage(actors: Cast): void;
 export declare function actorCalled(name: string): Actor;
 /**
  * Retrieves an actor who was last instantiated or retrieved
- * using {@apilink actorCalled}.
+ * using [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/).
  *
  * This function is particularly useful when automating Cucumber scenarios.
  *
- * This function is an alias for {@apilink Serenity.theActorInTheSpotlight}.
+ * This function is an alias for [`Serenity.theActorInTheSpotlight`](https://serenity-js.org/api/core/class/Serenity/#theActorInTheSpotlight).
  *
  * ## Usage with Cucumber
  *
@@ -246,10 +246,10 @@ export declare function actorCalled(name: string): Actor;
  *
  * ## Learn more
  *
- * - {@apilink engage}
- * - {@apilink actorCalled}
- * - {@apilink Actor}
- * - {@apilink Cast}
+ * - [`engage`](https://serenity-js.org/api/core/function/engage/)
+ * - [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
  *
  * @group Actors
  */