@serenity-js/assertions 3.24.1 → 3.25.1

package/lib/expectations/isPresent.js

@@ -3,10 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isPresent = void 0;
 const core_1 = require("@serenity-js/core");
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the `actual` value is not undefined or null.
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the `actual` value is not undefined or null.
  *
- * Also, when the `actual` implements {@apilink Optional}, the expectation is met when calling {@apilink Optional.isPresent()}
- * returns an {@apilink Answerable} that resolves to `true`
+ * Also, when the `actual` implements [`Optional`](https://serenity-js.org/api/core/interface/Optional/),
+ * the expectation is met when calling [`Optional.isPresent`](https://serenity-js.org/api/core/interface/Optional/#isPresent)
+ * returns an [`Answerable`](https://serenity-js.org/api/core/#Answerable) that resolves to `true`
  *
  * ## Ensuring that a value is defined
  *

package/lib/expectations/isPresent.js.map

@@ -1 +1 @@
-{"version":3,"file":"isPresent.js","sourceRoot":"","sources":["../../src/expectations/isPresent.ts"],"names":[],"mappings":";;;AACA,4CAAuG;AAEvG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,SAAgB,SAAS;IACrB,OAAO,IAAI,SAAS,EAAU,CAAC;AACnC,CAAC;AAFD,8BAEC;AAED,MAAM,SAAkB,SAAQ,kBAAmB;IACvC,MAAM,CAAC,UAAU,CAAC,KAAU;QAChC,OAAO,KAAK,KAAK,SAAS;eACnB,KAAK,KAAK,IAAI;eACd,OAAO,KAAK,CAAC,SAAS,KAAK,UAAU,CAAC;IACjD,CAAC;IAEO,MAAM,CAAC,YAAY,CAAI,MAAqB,EAAE,KAAuB;QACzE,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YAC9B,OAAO,MAAM,CAAC;SACjB;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAI,KAAoB,EAAE,KAAuB;QAC3E,IAAI,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;YAC7B,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;SAC1C;QAED,OAAO,KAAK,KAAK,SAAS;eACnB,KAAK,KAAK,IAAI,CAAC;IAC1B,CAAC;IAED;QACI,KAAK,CACD,WAAW,EACX,gBAAgB,EAChB,KAAK,EAAE,KAAuB,EAAE,MAA0B,EAAE,EAAE;YAE1D,MAAM,KAAK,GAAI,MAAM,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAEvD,OAAO,MAAM;gBACT,CAAC,CAAC,IAAI,qBAAc,CAAC,gBAAgB,EAAE,yBAAkB,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC;gBACxF,CAAC,CAAC,IAAI,wBAAiB,CAAC,gBAAgB,EAAE,yBAAkB,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACpG,CAAC,CACJ,CAAC;IACN,CAAC;CACJ"}
+{"version":3,"file":"isPresent.js","sourceRoot":"","sources":["../../src/expectations/isPresent.ts"],"names":[],"mappings":";;;AACA,4CAAuG;AAEvG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,SAAgB,SAAS;IACrB,OAAO,IAAI,SAAS,EAAU,CAAC;AACnC,CAAC;AAFD,8BAEC;AAED,MAAM,SAAkB,SAAQ,kBAAmB;IACvC,MAAM,CAAC,UAAU,CAAC,KAAU;QAChC,OAAO,KAAK,KAAK,SAAS;eACnB,KAAK,KAAK,IAAI;eACd,OAAO,KAAK,CAAC,SAAS,KAAK,UAAU,CAAC;IACjD,CAAC;IAEO,MAAM,CAAC,YAAY,CAAI,MAAqB,EAAE,KAAuB;QACzE,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YAC9B,OAAO,MAAM,CAAC;SACjB;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAI,KAAoB,EAAE,KAAuB;QAC3E,IAAI,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;YAC7B,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;SAC1C;QAED,OAAO,KAAK,KAAK,SAAS;eACnB,KAAK,KAAK,IAAI,CAAC;IAC1B,CAAC;IAED;QACI,KAAK,CACD,WAAW,EACX,gBAAgB,EAChB,KAAK,EAAE,KAAuB,EAAE,MAA0B,EAAE,EAAE;YAE1D,MAAM,KAAK,GAAI,MAAM,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAEvD,OAAO,MAAM;gBACT,CAAC,CAAC,IAAI,qBAAc,CAAC,gBAAgB,EAAE,yBAAkB,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC;gBACxF,CAAC,CAAC,IAAI,wBAAiB,CAAC,gBAAgB,EAAE,yBAAkB,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACpG,CAAC,CACJ,CAAC;IACN,CAAC;CACJ"}

package/lib/expectations/isTrue.d.ts

@@ -1,6 +1,6 @@
 import { Expectation } from '@serenity-js/core';
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `boolean` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `boolean` value
  * is `true`.
  *
  * ## Ensuring that a given value is true

package/lib/expectations/isTrue.js

@@ -4,7 +4,7 @@ exports.isTrue = void 0;
 const core_1 = require("@serenity-js/core");
 const equals_1 = require("./equals");
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `boolean` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `boolean` value
  * is `true`.
  *
  * ## Ensuring that a given value is true

package/lib/expectations/matches.d.ts

@@ -1,6 +1,6 @@
 import { Expectation } from '@serenity-js/core';
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `string` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `string` value
  * matches the `expected` regular expression.
  *
  * ## Ensuring that a given string matches a regular expression

package/lib/expectations/matches.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.matches = void 0;
 const core_1 = require("@serenity-js/core");
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `string` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `string` value
  * matches the `expected` regular expression.
  *
  * ## Ensuring that a given string matches a regular expression

package/lib/expectations/not.d.ts

@@ -1,6 +1,6 @@
 import { Expectation } from '@serenity-js/core';
 /**
- * Produces an {@apilink Expectation|expectation} that negates the provided `expectation`.
+ * Produces an [expectation](https://serenity-js.org/api/core/class/Expectation/) that negates the provided `expectation`.
  *
  * ## Ensuring that the actual value does not equal the expected value
  *

package/lib/expectations/not.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.not = void 0;
 const core_1 = require("@serenity-js/core");
 /**
- * Produces an {@apilink Expectation|expectation} that negates the provided `expectation`.
+ * Produces an [expectation](https://serenity-js.org/api/core/class/Expectation/) that negates the provided `expectation`.
  *
  * ## Ensuring that the actual value does not equal the expected value
  *

package/lib/expectations/or.d.ts

@@ -1,6 +1,6 @@
 import { Expectation } from '@serenity-js/core';
 /**
- * Creates an {@apilink Expectation|expectation} that is met when at least one of the `expectations` is met for the given actual value.
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when at least one of the `expectations` is met for the given actual value.
  *
  * Use `or` to combine several expectations using logical "or",
  *

package/lib/expectations/or.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.or = void 0;
 const core_1 = require("@serenity-js/core");
 /**
- * Creates an {@apilink Expectation|expectation} that is met when at least one of the `expectations` is met for the given actual value.
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when at least one of the `expectations` is met for the given actual value.
  *
  * Use `or` to combine several expectations using logical "or",
  *

package/lib/expectations/property.d.ts

@@ -1,6 +1,6 @@
 import { Expectation } from '@serenity-js/core';
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the value of
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the value of
  * the `actual[propertyName]` meets the `expectation`.
  *
  * ## Ensuring that an array has an item

package/lib/expectations/property.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.property = void 0;
 const core_1 = require("@serenity-js/core");
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the value of
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the value of
  * the `actual[propertyName]` meets the `expectation`.
  *
  * ## Ensuring that an array has an item

package/lib/expectations/startsWith.d.ts

@@ -1,6 +1,6 @@
 import { Expectation } from '@serenity-js/core';
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `string` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `string` value
  * starts with the resolved value of `expected`.
  *
  * ## Ensuring that a given string starts with an expected substring

package/lib/expectations/startsWith.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.startsWith = void 0;
 const core_1 = require("@serenity-js/core");
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `string` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `string` value
  * starts with the resolved value of `expected`.
  *
  * ## Ensuring that a given string starts with an expected substring

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/assertions",
-  "version": "3.24.1",
+  "version": "3.25.1",
   "description": "Screenplay-style assertion library",
   "author": {
     "name": "Jan Molak",
@@ -44,7 +44,7 @@
     "node": "^16.13 || ^18.12 || ^20"
   },
   "dependencies": {
-    "@serenity-js/core": "3.24.1",
+    "@serenity-js/core": "3.25.1",
     "tiny-types": "1.22.0"
   },
   "devDependencies": {
@@ -52,10 +52,10 @@
     "@types/chai": "4.3.16",
     "@types/mocha": "10.0.7",
     "c8": "10.1.2",
-    "mocha": "10.5.1",
+    "mocha": "10.6.0",
     "mocha-multi": "1.1.7",
     "ts-node": "10.9.2",
     "typescript": "5.2.2"
   },
-  "gitHead": "f7378fd85f00f055322f4d28624735ba3d2e2782"
+  "gitHead": "450b994115cf9f1a1547ef92ac9387e0c57821ce"
 }

package/src/Ensure.ts

@@ -23,10 +23,10 @@ import type { FileSystemLocation } from '@serenity-js/core/lib/io';
 import { EnsureEventually } from './EnsureEventually';
 
 /**
- * The {@apilink Interaction|interaction} to `Ensure`
- * verifies if the resolved value of the provided {@apilink Answerable}
- * meets the specified {@apilink Expectation}.
- * If not, it throws an {@apilink AssertionError}.
+ * The [interaction](https://serenity-js.org/api/core/class/Interaction/) to `Ensure`
+ * verifies if the resolved value of the provided [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+ * meets the specified [`Expectation`](https://serenity-js.org/api/core/class/Expectation/).
+ * If not, it throws an [`AssertionError`](https://serenity-js.org/api/core/class/AssertionError/).
  *
  * Use `Ensure` to verify the state of the system under test.
  *
@@ -72,16 +72,16 @@ import { EnsureEventually } from './EnsureEventually';
 export class Ensure<Actual> extends Interaction {
 
     /**
-     * Creates an {@apilink Interaction|interaction} to `Ensure`, which
-     * verifies if the resolved value of the provided {@apilink Answerable}
-     * meets the specified {@apilink Expectation}.
-     * If not, it immediately throws an {@apilink AssertionError}.
+     * Creates an [interaction](https://serenity-js.org/api/core/class/Interaction/) to `Ensure`, which
+     * verifies if the resolved value of the provided [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * meets the specified [`Expectation`](https://serenity-js.org/api/core/class/Expectation/).
+     * If not, it immediately throws an [`AssertionError`](https://serenity-js.org/api/core/class/AssertionError/).
      *
      * @param {Answerable<Actual_Type>} actual
-     *  An {@apilink Answerable} describing the actual state of the system.
+     *  An [`Answerable`](https://serenity-js.org/api/core/#Answerable) describing the actual state of the system.
      *
      * @param {Expectation<Actual_Type>} expectation
-     *  An {@apilink Expectation} you expect the `actual` value to meet
+     *  An [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) you expect the `actual` value to meet
      *
      * @returns {Ensure<Actual_Type>}
      */
@@ -90,19 +90,17 @@ export class Ensure<Actual> extends Interaction {
     }
 
     /**
-     * Creates an {@apilink Interaction|interaction} to {@apilink EnsureEventually}, which
-     * verifies if the resolved value of the provided {@apilink Answerable}
-     * meets the specified {@apilink Expectation} within the expected timeframe.
+     * Creates an [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`EnsureEventually`](https://serenity-js.org/api/assertions/class/EnsureEventually/),
+     * which verifies if the resolved value of the provided [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+     * meets the specified [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) within the expected timeframe.
      *
-     * If the expectation is not met by the time the timeout expires, the interaction throws an {@apilink AssertionError}.
-     * `EnsureEventually` ignores retries the evaluation if resolving the `actual` results in an {@apilink OptionalNotPresentError},
-     * but rethrows any other errors.
+     * If the expectation is not met by the time the timeout expires, the interaction throws an [`AssertionError`](https://serenity-js.org/api/core/class/AssertionError/).
      *
      * @param {Answerable<Actual_Type>} actual
-     *  An {@apilink Answerable} describing the actual state of the system.
+     *  An [`Answerable`](https://serenity-js.org/api/core/#Answerable) describing the actual state of the system.
      *
      * @param {Expectation<Actual_Type>} expectation
-     *  An {@apilink Expectation} you expect the `actual` value to meet
+     *  An [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) you expect the `actual` value to meet
      *
      * @returns {Ensure<Actual_Type>}
      */
@@ -150,11 +148,11 @@ export class Ensure<Actual> extends Interaction {
     }
 
     /**
-     * Overrides the default {@apilink AssertionError} thrown when
+     * Overrides the default [`AssertionError`](https://serenity-js.org/api/core/class/AssertionError/) thrown when
      * the actual value does not meet the expectation.
      *
      * @param typeOfRuntimeError
-     *  A constructor function producing a subtype of {@apilink RuntimeError} to throw, e.g. {@apilink TestCompromisedError}
+     *  A constructor function producing a subtype of [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/) to throw, e.g. [`TestCompromisedError`](https://serenity-js.org/api/core/class/TestCompromisedError/)
      *
      * @param message
      *  The message explaining the failure

package/src/EnsureEventually.ts

@@ -22,16 +22,16 @@ import {
 import type { FileSystemLocation } from '@serenity-js/core/lib/io';
 
 /**
- * The {@apilink Interaction|interaction} to `EnsureEventually`
- * verifies if the resolved value of the provided {@apilink Answerable}
- * meets the specified {@apilink Expectation} within the expected timeframe.
+ * The [interaction](https://serenity-js.org/api/core/class/Interaction/) to `EnsureEventually`
+ * verifies if the resolved value of the provided [`Answerable`](https://serenity-js.org/api/core/#Answerable)
+ * meets the specified [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) within the expected timeframe.
  *
- * If the expectation is not met by the time the timeout expires, the interaction throws an {@apilink AssertionError}.
- * `EnsureEventually` retries the evaluation if resolving the `actual` results in an {@apilink ListItemNotFoundError},
+ * If the expectation is not met by the time the timeout expires, the interaction throws an [`AssertionError`](https://serenity-js.org/api/core/class/AssertionError/).
+ * `EnsureEventually` retries the evaluation if resolving the `actual` results in an [`ListItemNotFoundError`](https://serenity-js.org/api/core/class/ListItemNotFoundError/),
  * but rethrows any other errors.
  *
  * :::tip Use the factory method
- * Use the factory method {@apilink Ensure.eventually} to instantiate this interaction.
+ * Use the factory method [`Ensure.eventually`](https://serenity-js.org/api/assertions/class/Ensure/#eventually] to instantiate this interaction.
  * :::
  *
  * ## Basic usage with dynamic values
@@ -99,7 +99,7 @@ export class EnsureEventually<Actual> extends Interaction {
     }
 
     /**
-     * Override the default timeout set via {@apilink SerenityConfig.interactionTimeout}.
+     * Override the default timeout set via [`SerenityConfig.interactionTimeout`](https://serenity-js.org/api/core/class/SerenityConfig/#interactionTimeout).
      *
      * @param timeout
      */
@@ -149,11 +149,11 @@ export class EnsureEventually<Actual> extends Interaction {
     }
 
     /**
-     * Overrides the default {@apilink AssertionError} thrown when
+     * Overrides the default [`AssertionError`](https://serenity-js.org/api/core/class/AssertionError/) thrown when
      * the actual value does not meet the expectation.
      *
      * @param typeOfRuntimeError
-     *  A constructor function producing a subtype of {@apilink RuntimeError} to throw, e.g. {@apilink TestCompromisedError}
+     *  A constructor function producing a subtype of [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/) to throw, e.g. [`TestCompromisedError`](https://serenity-js.org/api/core/class/TestCompromisedError/)
      *
      * @param message
      *  The message explaining the failure

package/src/expectations/and.ts

@@ -2,7 +2,7 @@ import type { Answerable, AnswersQuestions, ExpectationOutcome } from '@serenity
 import { Expectation, ExpectationMet, ExpectationNotMet } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when all the `expectations` are met for the given actual value.
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when all the `expectations` are met for the given actual value.
  *
  * Use `and` to combine several expectations using logical "and",
  *

package/src/expectations/contain.ts

@@ -2,7 +2,7 @@ import { Expectation } from '@serenity-js/core';
 import { equal } from 'tiny-types/lib/objects';
 
 /**
- * Produces an {@apilink Expectation|expectation} that is met when the actual array of `Item[]` contains
+ * Produces an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual array of `Item[]` contains
  * at least one `Item` that is equal to the resolved value of `expected`.
  *
  * Note that the equality check performs comparison **by value**

package/src/expectations/containAtLeastOneItemThat.ts

@@ -2,7 +2,7 @@ import type { Answerable, AnswersQuestions, ExpectationOutcome} from '@serenity-
 import { d, Expectation, ExpectationDetails, ExpectationMet, ExpectationNotMet, Unanswered } from '@serenity-js/core';
 
 /**
- * Produces an {@apilink Expectation|expectation} that is met when the actual array of `Item[]` contains
+ * Produces an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual array of `Item[]` contains
  * at least one `Item` for which the `expectation` is met.
  *
  * ## Ensuring that at least one item in an array meets the expectation

package/src/expectations/containItemsWhereEachItem.ts

@@ -2,7 +2,7 @@ import type { Answerable, AnswersQuestions, ExpectationOutcome} from '@serenity-
 import { d, Expectation, ExpectationDetails, ExpectationMet, ExpectationNotMet, Unanswered } from '@serenity-js/core';
 
 /**
- * Produces an {@apilink Expectation|expectation} that is met when all the items of the actual array of `Item[]`
+ * Produces an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when all the items of the actual array of `Item[]`
  * meet the `expectation`.
  *
  * ## Ensuring that all the items in an array meet the expectation

package/src/expectations/endsWith.ts

@@ -1,7 +1,7 @@
 import { Expectation } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `string` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `string` value
  * ends with the resolved value of `expected`.
  *
  * ## Ensuring that a given string ends with an expected substring

package/src/expectations/equals.ts

@@ -2,7 +2,7 @@ import { Expectation } from '@serenity-js/core';
 import { equal } from 'tiny-types/lib/objects';
 
 /**
- * Produces an {@apilink Expectation|expectation} that is met when the actual value
+ * Produces an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual value
  * is equal to the resolved value of `expectedValue`.
  *
  * Note that the equality check performs comparison **by value**

package/src/expectations/includes.ts

@@ -1,7 +1,7 @@
 import { Expectation } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `string` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `string` value
  * includes a substring of `expected`.
  *
  * ## Ensuring that a given string includes the expected substring
@@ -17,7 +17,7 @@ import { Expectation } from '@serenity-js/core';
  *
  * ## Ensuring that page URL includes the expected substring
  *
- * {@apilink Page.url|Page.current().url()} returns a {@apilink QuestionAdapter|`QuestionAdapter<URL>`},
+ * [`Page.current().url()`](https://serenity-js.org/api/web/class/Page/#url) returns a [`QuestionAdapter<URL>`](https://serenity-js.org/api/core/#QuestionAdapter)
  * a proxy object around the standard Node.js [URL](https://nodejs.org/api/url.html) class,
  * offering access to `string` properties such as [`hostname`](https://nodejs.org/api/url.html#urlobjecthostname),
  * [`pathname`](https://nodejs.org/api/url.html#urlobjectpathname), and so on.

package/src/expectations/isAfter.ts

@@ -1,7 +1,7 @@
 import { Expectation, type Timestamp } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual value of type `Date`
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual value of type `Date`
  * is after the expected `Date`.
  *
  * ## Ensuring that a given date is after the expected date

package/src/expectations/isBefore.ts

@@ -1,7 +1,7 @@
 import { Expectation, type Timestamp } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual value of type `Date`
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual value of type `Date`
  * is before the expected `Date`.
  *
  * ## Ensuring that a given date is after the expected date

package/src/expectations/isCloseTo.ts

@@ -1,7 +1,7 @@
 import { d, Expectation } from '@serenity-js/core';
 
 /**
- * Produces an {@apilink Expectation|expectation} that is met when the actual value
+ * Produces an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual value
  * is within a given ± `absoluteTolerance` range of the `expected` value.
  *
  * ## Ensuring that a given floating point number is close to the expected number

package/src/expectations/isFalse.ts

@@ -3,7 +3,7 @@ import { Expectation } from '@serenity-js/core';
 import { equals } from './equals';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `boolean` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `boolean` value
  * is `false`.
  *
  * ## Ensuring that a given value is false

package/src/expectations/isGreaterThan.ts

@@ -1,7 +1,7 @@
 import { Expectation } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual value of type `number`
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual value of type `number`
  * is greater than the expected `number`.
  *
  * ## Ensuring that a given number is greater than the expected number

package/src/expectations/isLessThan.ts

@@ -1,7 +1,7 @@
 import { Expectation } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual value of type `number`
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual value of type `number`
  * is less than the expected `number`.
  *
  * ## Ensuring that a given number is less than the expected number

package/src/expectations/isPresent.ts

@@ -2,10 +2,11 @@ import type { Answerable, AnswersQuestions, Optional } from '@serenity-js/core';
 import { Expectation, ExpectationDetails, ExpectationMet, ExpectationNotMet } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the `actual` value is not undefined or null.
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the `actual` value is not undefined or null.
  *
- * Also, when the `actual` implements {@apilink Optional}, the expectation is met when calling {@apilink Optional.isPresent()}
- * returns an {@apilink Answerable} that resolves to `true`
+ * Also, when the `actual` implements [`Optional`](https://serenity-js.org/api/core/interface/Optional/),
+ * the expectation is met when calling [`Optional.isPresent`](https://serenity-js.org/api/core/interface/Optional/#isPresent)
+ * returns an [`Answerable`](https://serenity-js.org/api/core/#Answerable) that resolves to `true`
  *
  * ## Ensuring that a value is defined
  *

package/src/expectations/isTrue.ts

@@ -3,7 +3,7 @@ import { Expectation } from '@serenity-js/core';
 import { equals } from './equals';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `boolean` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `boolean` value
  * is `true`.
  *
  * ## Ensuring that a given value is true

package/src/expectations/matches.ts

@@ -1,7 +1,7 @@
 import { Expectation } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `string` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `string` value
  * matches the `expected` regular expression.
  *
  * ## Ensuring that a given string matches a regular expression

package/src/expectations/not.ts

@@ -2,7 +2,7 @@ import type { Answerable, AnswersQuestions} from '@serenity-js/core';
 import { Expectation, ExpectationDetails, ExpectationMet, ExpectationNotMet } from '@serenity-js/core';
 
 /**
- * Produces an {@apilink Expectation|expectation} that negates the provided `expectation`.
+ * Produces an [expectation](https://serenity-js.org/api/core/class/Expectation/) that negates the provided `expectation`.
  *
  * ## Ensuring that the actual value does not equal the expected value
  *

package/src/expectations/or.ts

@@ -2,7 +2,7 @@ import type { Answerable, AnswersQuestions, ExpectationOutcome} from '@serenity-
 import { Expectation, ExpectationMet, ExpectationNotMet, LogicError } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when at least one of the `expectations` is met for the given actual value.
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when at least one of the `expectations` is met for the given actual value.
  *
  * Use `or` to combine several expectations using logical "or",
  *

package/src/expectations/property.ts

@@ -2,7 +2,7 @@ import type { Answerable, AnswersQuestions} from '@serenity-js/core';
 import { Expectation, ExpectationDetails, ExpectationMet, ExpectationNotMet } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the value of
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the value of
  * the `actual[propertyName]` meets the `expectation`.
  *
  * ## Ensuring that an array has an item

package/src/expectations/startsWith.ts

@@ -1,7 +1,7 @@
 import { Expectation } from '@serenity-js/core';
 
 /**
- * Creates an {@apilink Expectation|expectation} that is met when the actual `string` value
+ * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `string` value
  * starts with the resolved value of `expected`.
  *
  * ## Ensuring that a given string starts with an expected substring