@serenity-js/assertions 3.25.0 → 3.25.2

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.25.2](https://github.com/serenity-js/serenity-js/compare/v3.25.1...v3.25.2) (2024-07-17)
+
+**Note:** Version bump only for package @serenity-js/assertions
+
+
+
+
+
+## [3.25.1](https://github.com/serenity-js/serenity-js/compare/v3.25.0...v3.25.1) (2024-07-10)
+
+
+### Bug Fixes
+
+* **core:** all the API docs now link to the online Serenity/JS API documentation ([f8f451d](https://github.com/serenity-js/serenity-js/commit/f8f451dffdb4caaa2e31a860f59d59470f4856ad))
+
+
+
+
+
 # [3.25.0](https://github.com/serenity-js/serenity-js/compare/v3.24.1...v3.25.0) (2024-07-03)
 
 **Note:** Version bump only for package @serenity-js/assertions

package/README.md

@@ -17,7 +17,7 @@ of complex software systems faster, more collaborative and easier to scale.
 👋 Join the Serenity/JS Community!
 - Meet other Serenity/JS developers and maintainers on the [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im),
 - Find answers to your Serenity/JS questions on the [Serenity/JS Forum](https://github.com/orgs/serenity-js/discussions/categories/how-do-i),
-- Learn how to [contribute to Serenity/JS](https://serenity-js.org/contributing),
+- Learn how to [contribute to Serenity/JS](https://serenity-js.org/community/contributing/),
 - Support the project and gain access to [Serenity/JS Playbooks](https://github.com/serenity-js/playbooks) by becoming a [Serenity/JS GitHub Sponsor](https://github.com/sponsors/serenity-js)!
 
 ## Serenity/JS Assertions

package/lib/Ensure.d.ts

@@ -2,10 +2,10 @@ import type { Answerable, AnswersQuestions, CollectsArtifacts, Expectation, Runt
 import { Interaction } from '@serenity-js/core';
 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.
  *
@@ -52,34 +52,32 @@ export declare class Ensure<Actual> extends Interaction {
     protected readonly actual: Answerable<Actual>;
     protected readonly expectation: Expectation<Actual>;
     /**
-     * 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>}
      */
     static that<Actual_Type>(actual: Answerable<Actual_Type>, expectation: Expectation<Actual_Type>): Ensure<Actual_Type>;
     /**
-     * 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>}
      */
@@ -95,11 +93,11 @@ export declare class Ensure<Actual> extends Interaction {
      */
     performAs(actor: UsesAbilities & AnswersQuestions & CollectsArtifacts): Promise<void>;
     /**
-     * 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/lib/Ensure.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Ensure.d.ts","sourceRoot":"","sources":["../src/Ensure.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,UAAU,EACV,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,aAAa,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAMH,WAAW,EAKd,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,qBAAa,MAAM,CAAC,MAAM,CAAE,SAAQ,WAAW;IA+CvC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC;IA9CvD;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC;IAIrH;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,WAAW,CAAC;IAIrI;;;;OAIG;IACH,OAAO;IAQP;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB3F;;;;;;;;;OASG;IACH,iBAAiB,CAAC,kBAAkB,EAAE,KAAK,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,KAAK,YAAY,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW;CAgB7H"}
+{"version":3,"file":"Ensure.d.ts","sourceRoot":"","sources":["../src/Ensure.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,UAAU,EACV,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,aAAa,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAMH,WAAW,EAKd,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,qBAAa,MAAM,CAAC,MAAM,CAAE,SAAQ,WAAW;IA6CvC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC;IA5CvD;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC;IAIrH;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,WAAW,CAAC;IAIrI;;;;OAIG;IACH,OAAO;IAQP;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB3F;;;;;;;;;OASG;IACH,iBAAiB,CAAC,kBAAkB,EAAE,KAAK,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,KAAK,YAAY,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW;CAgB7H"}

package/lib/Ensure.js

@@ -4,10 +4,10 @@ exports.Ensure = void 0;
 const core_1 = require("@serenity-js/core");
 const EnsureEventually_1 = require("./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.
  *
@@ -54,16 +54,16 @@ class Ensure extends core_1.Interaction {
     actual;
     expectation;
     /**
-     * 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>}
      */
@@ -71,19 +71,17 @@ class Ensure extends core_1.Interaction {
         return new Ensure(actual, expectation, core_1.Activity.callerLocation(5));
     }
     /**
-     * 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>}
      */
@@ -122,11 +120,11 @@ class Ensure extends core_1.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/lib/Ensure.js.map

@@ -1 +1 @@
-{"version":3,"file":"Ensure.js","sourceRoot":"","sources":["../src/Ensure.ts"],"names":[],"mappings":";;;AAQA,4CAW2B;AAG3B,yDAAsD;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAa,MAAe,SAAQ,kBAAW;IA+CpB;IACA;IA9CvB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,CAAc,MAA+B,EAAE,WAAqC;QAC3F,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,eAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,UAAU,CAAc,MAA+B,EAAE,WAAqC;QACjG,OAAO,IAAI,mCAAgB,CAAC,MAAM,EAAE,WAAW,EAAE,eAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,YACuB,MAA0B,EAC1B,WAAgC,EACnD,QAA4B;QAE5B,KAAK,CAAC,IAAA,UAAG,EAAA,uBAAwB,MAAO,SAAU,WAAY,EAAE,EAAE,QAAQ,CAAC,CAAC;QAJzD,WAAM,GAAN,MAAM,CAAoB;QAC1B,gBAAW,GAAX,WAAW,CAAqB;IAIvD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAA2D;QACvE,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAE3E,IAAI,OAAO,YAAY,wBAAiB,EAAE;YACtC,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,KAAK,SAAS;gBAC/C,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,eAAQ,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEhD,MAAM,OAAO,GAAG,YAAa,iBAAkB,OAAQ,OAAO,CAAC,OAAQ,EAAE,CAAC;YAE1E,MAAM,kBAAW,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,qBAAc,EAAE;gBAC/C,OAAO;gBACP,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,IAAI,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE;gBAC5D,QAAQ,EAAE,IAAI,CAAC,qBAAqB,EAAE;aACzC,CAAC,CAAC;SACN;QAED,IAAI,CAAE,CAAC,OAAO,YAAY,qBAAc,CAAC,EAAE;YACvC,MAAM,IAAI,iBAAU,CAAC,IAAA,QAAC,EAAA,wFAAyF,OAAQ,EAAE,CAAC,CAAC;SAC9H;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CAAC,kBAAwE,EAAE,OAAgB;QACxG,MAAM,QAAQ,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE9C,OAAO,kBAAW,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACpD,IAAI;gBACA,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;aAC/B;YACD,OAAO,KAAK,EAAE;gBACV,MAAM,kBAAW,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,kBAAkB,EAAE;oBACnD,OAAO,EAAE,OAAO,IAAI,KAAK,CAAC,OAAO;oBACjC,QAAQ;oBACR,KAAK,EAAE,KAAK;iBACf,CAAC,CAAC;aACN;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AA1GD,wBA0GC"}
+{"version":3,"file":"Ensure.js","sourceRoot":"","sources":["../src/Ensure.ts"],"names":[],"mappings":";;;AAQA,4CAW2B;AAG3B,yDAAsD;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAa,MAAe,SAAQ,kBAAW;IA6CpB;IACA;IA5CvB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,CAAc,MAA+B,EAAE,WAAqC;QAC3F,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,eAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,UAAU,CAAc,MAA+B,EAAE,WAAqC;QACjG,OAAO,IAAI,mCAAgB,CAAC,MAAM,EAAE,WAAW,EAAE,eAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,YACuB,MAA0B,EAC1B,WAAgC,EACnD,QAA4B;QAE5B,KAAK,CAAC,IAAA,UAAG,EAAA,uBAAwB,MAAO,SAAU,WAAY,EAAE,EAAE,QAAQ,CAAC,CAAC;QAJzD,WAAM,GAAN,MAAM,CAAoB;QAC1B,gBAAW,GAAX,WAAW,CAAqB;IAIvD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAA2D;QACvE,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAE3E,IAAI,OAAO,YAAY,wBAAiB,EAAE;YACtC,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,KAAK,SAAS;gBAC/C,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,eAAQ,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEhD,MAAM,OAAO,GAAG,YAAa,iBAAkB,OAAQ,OAAO,CAAC,OAAQ,EAAE,CAAC;YAE1E,MAAM,kBAAW,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,qBAAc,EAAE;gBAC/C,OAAO;gBACP,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,IAAI,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE;gBAC5D,QAAQ,EAAE,IAAI,CAAC,qBAAqB,EAAE;aACzC,CAAC,CAAC;SACN;QAED,IAAI,CAAE,CAAC,OAAO,YAAY,qBAAc,CAAC,EAAE;YACvC,MAAM,IAAI,iBAAU,CAAC,IAAA,QAAC,EAAA,wFAAyF,OAAQ,EAAE,CAAC,CAAC;SAC9H;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CAAC,kBAAwE,EAAE,OAAgB;QACxG,MAAM,QAAQ,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE9C,OAAO,kBAAW,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACpD,IAAI;gBACA,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;aAC/B;YACD,OAAO,KAAK,EAAE;gBACV,MAAM,kBAAW,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,kBAAkB,EAAE;oBACnD,OAAO,EAAE,OAAO,IAAI,KAAK,CAAC,OAAO;oBACjC,QAAQ;oBACR,KAAK,EAAE,KAAK;iBACf,CAAC,CAAC;aACN;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAxGD,wBAwGC"}

package/lib/EnsureEventually.d.ts

@@ -2,16 +2,16 @@ import type { Answerable, AnswersQuestions, CollectsArtifacts, Expectation, Runt
 import { Duration, Interaction } from '@serenity-js/core';
 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
@@ -74,7 +74,7 @@ export declare class EnsureEventually<Actual> extends Interaction {
      */
     constructor(actual: Answerable<Actual>, expectation: Expectation<Actual>, location: FileSystemLocation, timeout?: Duration);
     /**
-     * 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
      */
@@ -84,11 +84,11 @@ export declare class EnsureEventually<Actual> extends Interaction {
      */
     performAs(actor: UsesAbilities & AnswersQuestions & CollectsArtifacts): Promise<void>;
     /**
-     * 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/lib/EnsureEventually.js

@@ -3,16 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EnsureEventually = void 0;
 const core_1 = require("@serenity-js/core");
 /**
- * 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
@@ -80,7 +80,7 @@ class EnsureEventually extends core_1.Interaction {
         this.timeout = timeout;
     }
     /**
-     * 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
      */
@@ -117,11 +117,11 @@ class EnsureEventually extends core_1.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/lib/expectations/and.d.ts

@@ -1,6 +1,6 @@
 import { Expectation } 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/lib/expectations/and.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.and = void 0;
 const core_1 = require("@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/lib/expectations/contain.d.ts

@@ -1,6 +1,6 @@
 import { Expectation } 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` that is equal to the resolved value of `expected`.
  *
  * Note that the equality check performs comparison **by value**

package/lib/expectations/contain.js

@@ -4,7 +4,7 @@ exports.contain = void 0;
 const core_1 = require("@serenity-js/core");
 const objects_1 = require("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/lib/expectations/containAtLeastOneItemThat.d.ts

@@ -1,6 +1,6 @@
 import { Expectation } 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/lib/expectations/containAtLeastOneItemThat.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.containAtLeastOneItemThat = void 0;
 const core_1 = require("@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/lib/expectations/containItemsWhereEachItem.d.ts

@@ -1,6 +1,6 @@
 import { Expectation } 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/lib/expectations/containItemsWhereEachItem.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.containItemsWhereEachItem = void 0;
 const core_1 = require("@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/lib/expectations/endsWith.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
  * ends with the resolved value of `expected`.
  *
  * ## Ensuring that a given string ends with an expected substring

package/lib/expectations/endsWith.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.endsWith = 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
  * ends with the resolved value of `expected`.
  *
  * ## Ensuring that a given string ends with an expected substring

package/lib/expectations/equals.d.ts

@@ -1,6 +1,6 @@
 import { 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 equal to the resolved value of `expectedValue`.
  *
  * Note that the equality check performs comparison **by value**

package/lib/expectations/equals.js

@@ -4,7 +4,7 @@ exports.equals = void 0;
 const core_1 = require("@serenity-js/core");
 const objects_1 = require("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/lib/expectations/includes.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
  * includes a substring of `expected`.
  *
  * ## Ensuring that a given string includes the expected substring
@@ -16,7 +16,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/lib/expectations/includes.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.includes = 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
  * includes a substring of `expected`.
  *
  * ## Ensuring that a given string includes the expected substring
@@ -19,7 +19,7 @@ const core_1 = require("@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/lib/expectations/isAfter.d.ts

@@ -1,6 +1,6 @@
 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/lib/expectations/isAfter.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isAfter = void 0;
 const core_1 = require("@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/lib/expectations/isBefore.d.ts

@@ -1,6 +1,6 @@
 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/lib/expectations/isBefore.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isBefore = void 0;
 const core_1 = require("@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/lib/expectations/isCloseTo.d.ts

@@ -1,6 +1,6 @@
 import { 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/lib/expectations/isCloseTo.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isCloseTo = void 0;
 const core_1 = require("@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/lib/expectations/isFalse.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 `false`.
  *
  * ## Ensuring that a given value is false

package/lib/expectations/isFalse.js

@@ -4,7 +4,7 @@ exports.isFalse = 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 `false`.
  *
  * ## Ensuring that a given value is false

package/lib/expectations/isGreaterThan.d.ts

@@ -1,6 +1,6 @@
 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/lib/expectations/isGreaterThan.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isGreaterThan = void 0;
 const core_1 = require("@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/lib/expectations/isLessThan.d.ts

@@ -1,6 +1,6 @@
 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/lib/expectations/isLessThan.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isLessThan = void 0;
 const core_1 = require("@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/lib/expectations/isPresent.d.ts

@@ -1,9 +1,10 @@
 import { Expectation } 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/lib/expectations/isPresent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isPresent.d.ts","sourceRoot":"","sources":["../../src/expectations/isPresent.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAyD,MAAM,mBAAmB,CAAC;AAEvG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,wBAAgB,SAAS,CAAC,MAAM,KAAK,WAAW,CAAC,MAAM,CAAC,CAEvD"}
+{"version":3,"file":"isPresent.d.ts","sourceRoot":"","sources":["../../src/expectations/isPresent.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAyD,MAAM,mBAAmB,CAAC;AAEvG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,wBAAgB,SAAS,CAAC,MAAM,KAAK,WAAW,CAAC,MAAM,CAAC,CAEvD"}