@serenity-js/web 3.25.0 → 3.25.1

package/lib/stage/crew/photographer/Photographer.js

@@ -28,8 +28,9 @@ const core_1 = require("@serenity-js/core");
 const events_1 = require("@serenity-js/core/lib/events");
 const strategies = __importStar(require("./strategies"));
 /**
- * The Photographer is a {@apilink StageCrewMember} who takes screenshots
- * using the web browser associated with the {@apilink Actor} that is currently {@apilink actorInTheSpotlight|in the spotlight}.
+ * The Photographer is a [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) who takes screenshots
+ * using the web browser associated with the [actor](https://serenity-js.org/api/core/class/Actor/) that is
+ * currently [in the spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/).
  *
  * ## Registering Photographer programmatically
  *
@@ -75,7 +76,7 @@ const strategies = __importStar(require("./strategies"));
  * ```
  *
  * #### Learn more
- * - {@apilink SerenityOptions}
+ * - [`SerenityOptions`](https://serenity-js.org/api/playwright-test/interface/SerenityOptions/)
  *
  * ## Using Photographer with WebdriverIO
  *
@@ -166,11 +167,11 @@ const strategies = __importStar(require("./strategies"));
  * ```
  *
  * ## Learn more
- * - {@apilink Stage}
- * - {@apilink StageCrewMember}
- * - {@apilink TakePhotosBeforeAndAfterInteractions}
- * - {@apilink TakePhotosOfFailures}
- * - {@apilink TakePhotosOfInteractions}
+ * - [`Stage`](https://serenity-js.org/api/core/class/Stage/)
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
+ * - [`TakePhotosBeforeAndAfterInteractions`](https://serenity-js.org/api/web/class/TakePhotosBeforeAndAfterInteractions/)
+ * - [`TakePhotosOfFailures`](https://serenity-js.org/api/web/class/TakePhotosOfFailures/)
+ * - [`TakePhotosOfInteractions`](https://serenity-js.org/api/web/class/TakePhotosOfInteractions/)
  *
  * @group Stage
  */
@@ -178,18 +179,18 @@ class Photographer {
     photoTakingStrategy;
     stage;
     /**
-     * Instantiates a new {@apilink Photographer} configured to take photos (screenshots)
-     * as per the specified {@apilink PhotoTakingStrategy}.
+     * Instantiates a new [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) configured to take photos (screenshots)
+     * as per the specified [`PhotoTakingStrategy`](https://serenity-js.org/api/web/class/PhotoTakingStrategy/).
      *
      * @param strategy
-     *  A no-arg constructor function that instantiates a {@apilink PhotoTakingStrategy}
+     *  A no-arg constructor function that instantiates a [`PhotoTakingStrategy`](https://serenity-js.org/api/web/class/PhotoTakingStrategy/)
      */
     static whoWill(strategy) {
         return new Photographer(new strategy());
     }
     /**
-     * Instantiates a new {@apilink Photographer} configured to take photos (screenshots)
-     * as per the specified {@apilink PhotoTakingStrategy}.
+     * Instantiates a new [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) configured to take photos (screenshots)
+     * as per the specified [`PhotoTakingStrategy`](https://serenity-js.org/api/web/class/PhotoTakingStrategy/).
      *
      * @param config
      */
@@ -209,18 +210,18 @@ class Photographer {
         this.stage = stage;
     }
     /**
-     * Assigns this {@apilink StageCrewMember} to a given {@apilink Stage}.
+     * Assigns this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) to a given [`Stage`](https://serenity-js.org/api/core/class/Stage/).
      *
      * @param stage
-     *  An instance of a {@apilink Stage} this {@apilink StageCrewMember} will be assigned to
+     *  An instance of a [`Stage`](https://serenity-js.org/api/core/class/Stage/) this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) will be assigned to
      */
     assignedTo(stage) {
         this.stage = stage;
         return this;
     }
     /**
-     * Handles {@apilink DomainEvent} objects emitted by the {@apilink Stage}
-     * this {@apilink StageCrewMember} is assigned to.
+     * Handles [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects emitted by the [`Stage`](https://serenity-js.org/api/core/class/Stage/)
+     * this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) is assigned to.
      *
      * @param event
      */

package/lib/stage/crew/photographer/Photographer.js.map

@@ -1 +1 @@
-{"version":3,"file":"Photographer.js","sourceRoot":"","sources":["../../../../src/stage/crew/photographer/Photographer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAmE;AAEnE,yDAAgF;AAGhF,yDAA2C;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkJG;AACH,MAAa,YAAY;IAqCA;IACT;IApCZ;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAC,QAAkD;QAC7D,OAAO,IAAI,YAAY,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAA4E;QACxF,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE;YAC3B,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,KAAK,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA,CAAI,yBAAyB;YAErJ,IAAI,mBAAmB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAkB,CAAC,EAAE;gBACzD,OAAO,IAAI,YAAY,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,QAAkB,CAAC,EAAE,CAAC,CAAC;aACxE;YAED,MAAM,IAAI,yBAAkB,CACxB,IAAK,MAAM,CAAC,QAAS,6CAA6C;gBAClE,yBAA0B,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAE,GAAG,CAC/D,CAAC;SACL;QAED,OAAO,IAAI,YAAY,CAAC,IAAI,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,YACqB,mBAAmD,EAC5D,KAAa;QADJ,wBAAmB,GAAnB,mBAAmB,CAAgC;QAC5D,UAAK,GAAL,KAAK,CAAQ;IAEzB,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,KAAY;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,KAAkB;QACvB,IAAI,CAAE,IAAI,CAAC,KAAK,EAAE;YACd,MAAM,IAAI,iBAAU,CAAC,8FAA8F,CAAC,CAAC;SACxH;QAED,IAAI,CAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE;YAClC,OAAO,KAAK,CAAC,CAAC;SACjB;QAED,IAAI,KAAK,YAAY,uBAAc,IAAI,KAAK,YAAY,yBAAgB,EAAE;YACtE,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;SACnE;IACL,CAAC;CACJ;AAxED,oCAwEC"}
+{"version":3,"file":"Photographer.js","sourceRoot":"","sources":["../../../../src/stage/crew/photographer/Photographer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAmE;AAEnE,yDAAgF;AAGhF,yDAA2C;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmJG;AACH,MAAa,YAAY;IAqCA;IACT;IApCZ;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAC,QAAkD;QAC7D,OAAO,IAAI,YAAY,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,MAA4E;QACxF,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE;YAC3B,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,KAAK,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA,CAAI,yBAAyB;YAErJ,IAAI,mBAAmB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAkB,CAAC,EAAE;gBACzD,OAAO,IAAI,YAAY,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,QAAkB,CAAC,EAAE,CAAC,CAAC;aACxE;YAED,MAAM,IAAI,yBAAkB,CACxB,IAAK,MAAM,CAAC,QAAS,6CAA6C;gBAClE,yBAA0B,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAE,GAAG,CAC/D,CAAC;SACL;QAED,OAAO,IAAI,YAAY,CAAC,IAAI,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,YACqB,mBAAmD,EAC5D,KAAa;QADJ,wBAAmB,GAAnB,mBAAmB,CAAgC;QAC5D,UAAK,GAAL,KAAK,CAAQ;IAEzB,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,KAAY;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,KAAkB;QACvB,IAAI,CAAE,IAAI,CAAC,KAAK,EAAE;YACd,MAAM,IAAI,iBAAU,CAAC,8FAA8F,CAAC,CAAC;SACxH;QAED,IAAI,CAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE;YAClC,OAAO,KAAK,CAAC,CAAC;SACjB;QAED,IAAI,KAAK,YAAY,uBAAc,IAAI,KAAK,YAAY,yBAAgB,EAAE;YACtE,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;SACnE;IACL,CAAC;CACJ;AAxED,oCAwEC"}

package/lib/stage/crew/photographer/strategies/PhotoTakingStrategy.d.ts

@@ -1,20 +1,20 @@
 import type { Stage } from '@serenity-js/core';
 import type { ActivityFinished, ActivityStarts, DomainEvent } from '@serenity-js/core/lib/events';
 /**
- * Configures the {@apilink Photographer} to take {@apilink Photo|photos}, a.k.a. screenshots,
- * of the {@apilink Activity} performed by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos, a.k.a. screenshots,
+ * of the [`Activity`](https://serenity-js.org/api/core/class/Activity/) performed by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/)
  * when desired conditions are met.
  *
  * @group Stage
  */
 export declare abstract class PhotoTakingStrategy {
     /**
-     * Takes a photo of the web browser used by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}.
+     * Takes a photo of the web browser used by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/).
      *
      * #### Learn more
-     * - {@apilink ActivityStarts}
-     * - {@apilink ActivityFinished}
-     * - {@apilink Stage}
+     * - [ActivityStarts](https://serenity-js.org/api/core-events/class/ActivityStarts/)
+     * - [ActivityFinished](https://serenity-js.org/api/core-events/class/ActivityFinished/)
+     * - [`Stage`](https://serenity-js.org/api/core/class/Stage/)
      *
      * @param event
      * @param stage

package/lib/stage/crew/photographer/strategies/PhotoTakingStrategy.js

@@ -6,20 +6,20 @@ const events_1 = require("@serenity-js/core/lib/events");
 const model_1 = require("@serenity-js/core/lib/model");
 const screenplay_1 = require("../../../../screenplay");
 /**
- * Configures the {@apilink Photographer} to take {@apilink Photo|photos}, a.k.a. screenshots,
- * of the {@apilink Activity} performed by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos, a.k.a. screenshots,
+ * of the [`Activity`](https://serenity-js.org/api/core/class/Activity/) performed by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/)
  * when desired conditions are met.
  *
  * @group Stage
  */
 class PhotoTakingStrategy {
     /**
-     * Takes a photo of the web browser used by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}.
+     * Takes a photo of the web browser used by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/).
      *
      * #### Learn more
-     * - {@apilink ActivityStarts}
-     * - {@apilink ActivityFinished}
-     * - {@apilink Stage}
+     * - [ActivityStarts](https://serenity-js.org/api/core-events/class/ActivityStarts/)
+     * - [ActivityFinished](https://serenity-js.org/api/core-events/class/ActivityFinished/)
+     * - [`Stage`](https://serenity-js.org/api/core/class/Stage/)
      *
      * @param event
      * @param stage

package/lib/stage/crew/photographer/strategies/TakePhotosBeforeAndAfterInteractions.d.ts

@@ -2,9 +2,9 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
 import { InteractionFinished, InteractionStarts } from '@serenity-js/core/lib/events';
 import { PhotoTakingStrategy } from './PhotoTakingStrategy';
 /**
- * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots) **both before and after**
- * every single {@apilink Interaction} performed
- * by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}.
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos (a.k.a. screenshots) **both before and after**
+ * every single [`Interaction`](https://serenity-js.org/api/core/class/Interaction/) performed
+ * by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/).
  *
  * **Please note** that this strategy will result in _a lot_ of screenshots being taken,
  * which will seriously affect the performance of your tests.

package/lib/stage/crew/photographer/strategies/TakePhotosBeforeAndAfterInteractions.js

@@ -4,9 +4,9 @@ exports.TakePhotosBeforeAndAfterInteractions = void 0;
 const events_1 = require("@serenity-js/core/lib/events");
 const PhotoTakingStrategy_1 = require("./PhotoTakingStrategy");
 /**
- * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots) **both before and after**
- * every single {@apilink Interaction} performed
- * by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}.
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos (a.k.a. screenshots) **both before and after**
+ * every single [`Interaction`](https://serenity-js.org/api/core/class/Interaction/) performed
+ * by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/).
  *
  * **Please note** that this strategy will result in _a lot_ of screenshots being taken,
  * which will seriously affect the performance of your tests.

package/lib/stage/crew/photographer/strategies/TakePhotosOfFailures.d.ts

@@ -2,9 +2,9 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
 import { InteractionFinished } from '@serenity-js/core/lib/events';
 import { PhotoTakingStrategy } from './PhotoTakingStrategy';
 /**
- * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots)
- * when then {@apilink Interaction} performed
- * by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos (a.k.a. screenshots)
+ * when then [`Interaction`](https://serenity-js.org/api/core/class/Interaction/) performed
+ * by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/)
  * results in an error.
  *
  * This strategy works best when you are interested in the screenshots only when

package/lib/stage/crew/photographer/strategies/TakePhotosOfFailures.js

@@ -5,9 +5,9 @@ const events_1 = require("@serenity-js/core/lib/events");
 const model_1 = require("@serenity-js/core/lib/model");
 const PhotoTakingStrategy_1 = require("./PhotoTakingStrategy");
 /**
- * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots)
- * when then {@apilink Interaction} performed
- * by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos (a.k.a. screenshots)
+ * when then [`Interaction`](https://serenity-js.org/api/core/class/Interaction/) performed
+ * by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/)
  * results in an error.
  *
  * This strategy works best when you are interested in the screenshots only when

package/lib/stage/crew/photographer/strategies/TakePhotosOfInteractions.d.ts

@@ -2,9 +2,9 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
 import { InteractionFinished } from '@serenity-js/core/lib/events';
 import { PhotoTakingStrategy } from './PhotoTakingStrategy';
 /**
- * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots)
- * when then {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
- * performs any {@apilink Interaction}.
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos (a.k.a. screenshots)
+ * when then [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/)
+ * performs any [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
  *
  * This strategy works best when you want the results of your automated tests
  * to become comprehensive living documentation of your system.

package/lib/stage/crew/photographer/strategies/TakePhotosOfInteractions.js

@@ -4,9 +4,9 @@ exports.TakePhotosOfInteractions = void 0;
 const events_1 = require("@serenity-js/core/lib/events");
 const PhotoTakingStrategy_1 = require("./PhotoTakingStrategy");
 /**
- * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots)
- * when then {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
- * performs any {@apilink Interaction}.
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos (a.k.a. screenshots)
+ * when then [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/)
+ * performs any [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
  *
  * This strategy works best when you want the results of your automated tests
  * to become comprehensive living documentation of your system.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/web",
-  "version": "3.25.0",
+  "version": "3.25.1",
   "description": "Serenity/JS Screenplay Pattern APIs for the Web",
   "author": {
     "name": "Jan Molak",
@@ -45,8 +45,8 @@
     "node": "^16.13 || ^18.12 || ^20"
   },
   "dependencies": {
-    "@serenity-js/assertions": "3.25.0",
-    "@serenity-js/core": "3.25.0",
+    "@serenity-js/assertions": "3.25.1",
+    "@serenity-js/core": "3.25.1",
     "tiny-types": "1.22.0"
   },
   "devDependencies": {
@@ -59,5 +59,5 @@
     "ts-node": "10.9.2",
     "typescript": "5.2.2"
   },
-  "gitHead": "22657b685b6002f75b2569db54f4bea31ab91d12"
+  "gitHead": "450b994115cf9f1a1547ef92ac9387e0c57821ce"
 }

package/src/errors/BrowserWindowClosedError.ts

@@ -5,8 +5,8 @@ import { LogicError } from '@serenity-js/core';
  * that's already been closed.
  *
  * ## Learn more
- * - {@apilink TakeScreenshot}
- * - {@apilink Page.takeScreenshot}
+ * - [`TakeScreenshot`](https://serenity-js.org/api/web/class/TakeScreenshot/)
+ * - [`Page.takeScreenshot`](https://serenity-js.org/api/web/class/Page/#takeScreenshot)
  *
  * @group Errors
  */

package/src/errors/CookieMissingError.ts

@@ -5,8 +5,8 @@ import { RuntimeError } from '@serenity-js/core';
  * you're trying to retrieve has not been set yet.
  *
  * ## Learn more
- * - {@apilink Cookie}
- * - {@apilink RuntimeError}
+ * - [`Cookie`](https://serenity-js.org/api/web/class/Cookie/)
+ * - [`RuntimeError`](https://serenity-js.org/api/core/class/RuntimeError/)
  *
  * @group Errors
  */

package/src/errors/ModalDialogObstructsScreenshotError.ts

@@ -4,9 +4,9 @@ import { LogicError } from '@serenity-js/core';
  * Thrown when the presence of a JavaScript dialog obstructs taking a screenshot.
  *
  * ## Learn more
- * - {@apilink Photographer}
- * - {@apilink LogicError}
- * - {@apilink TakeScreenshot}
+ * - [`Photographer`](https://serenity-js.org/api/web/class/Photographer/)
+ * - [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
+ * - [`TakeScreenshot`](https://serenity-js.org/api/web/class/TakeScreenshot/)
  *
  * @group Errors
  */

package/src/expectations/isActive.ts

@@ -9,18 +9,18 @@ const isElementActive = Expectation.define(
 );
 
 /**
- * {@apilink Expectation} that an element is "active", which means it resolves to `true` when:
- *  - the element {@apilink isPresent|is present} in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
- *  - {@apilink PageElement.isActive} resolves to `true`
+ * [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) that an element is "active", which means it resolves to `true` when:
+ *  - the element [is present](https://serenity-js.org/api/assertions/function/isPresent/) in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
+ *  - [`PageElement.isActive`](https://serenity-js.org/api/web/class/PageElement/#isActive) resolves to `true`
  *
  *  If the above conditions are not met, the expectation resolves to `false`.
  *
  * ## Learn more
- * - {@apilink PageElement.isActive}
- * - {@apilink Expectation}
- * - {@apilink Check}
- * - {@apilink Ensure}
- * - {@apilink Wait}
+ * - [`PageElement.isActive`](https://serenity-js.org/api/web/class/PageElement/#isActive)
+ * - [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
+ * - [`Check`](https://serenity-js.org/api/core/class/Check/)
+ * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
+ * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
  *
  * @group Expectations
  */

package/src/expectations/isClickable.ts

@@ -9,18 +9,18 @@ const isElementClickable = Expectation.define(
 );
 
 /**
- *  {@apilink Expectation} that an element is clickable, which means it resolves to `true` when:
- *  - the element {@apilink isPresent|is present} in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
- *  - {@apilink PageElement.isClickable} resolves to `true`
+ *  [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) that an element is clickable, which means it resolves to `true` when:
+ *  - the element [is present](https://serenity-js.org/api/assertions/function/isPresent/) in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
+ *  - [`PageElement.isClickable`](https://serenity-js.org/api/web/class/PageElement/#isClickable) resolves to `true`
  *
  *  If the above conditions are not met, the expectation resolves to `false`.
  *
  * ## Learn more
- * - {@apilink PageElement.isClickable}
- * - {@apilink Expectation}
- * - {@apilink Check}
- * - {@apilink Ensure}
- * - {@apilink Wait}
+ * - [`PageElement.isClickable`](https://serenity-js.org/api/web/class/PageElement/#isClickable)
+ * - [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
+ * - [`Check`](https://serenity-js.org/api/core/class/Check/)
+ * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
+ * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
  *
  * @group Expectations
  */

package/src/expectations/isEnabled.ts

@@ -9,18 +9,18 @@ const isElementEnabled = Expectation.define(
 );
 
 /**
- *  {@apilink Expectation} that an element is enabled, which means it resolves to `true` when:
- *  - the element {@apilink isPresent|is present} in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
- *  - {@apilink PageElement.isEnabled} resolves to `true`
+ *  [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) that an element is enabled, which means it resolves to `true` when:
+ *  - the element [is present](https://serenity-js.org/api/assertions/function/isPresent/) in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
+ *  - [`PageElement.isEnabled`](https://serenity-js.org/api/web/class/PageElement/#isEnabled) resolves to `true`
  *
  *  If the above conditions are not met, the expectation resolves to `false`.
  *
  * ## Learn more
- * - {@apilink PageElement.isEnabled}
- * - {@apilink Expectation}
- * - {@apilink Check}
- * - {@apilink Ensure}
- * - {@apilink Wait}
+ * - [`PageElement.isEnabled`](https://serenity-js.org/api/web/class/PageElement/#isEnabled)
+ * - [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
+ * - [`Check`](https://serenity-js.org/api/core/class/Check/)
+ * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
+ * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
  *
  * @group Expectations
  */

package/src/expectations/isSelected.ts

@@ -9,18 +9,18 @@ const isElementSelected = Expectation.define(
 );
 
 /**
- *  {@apilink Expectation} that an `<option>` or `<input>` element is selected, which means it resolves to `true` when:
- *  - the element {@apilink isPresent|is present} in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
- *  - {@apilink PageElement.isSelected} resolves to `true`
+ *  [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) that an `<option>` or `<input>` element is selected, which means it resolves to `true` when:
+ *  - the element [is present](https://serenity-js.org/api/assertions/function/isPresent/) in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
+ *  - [`PageElement.isSelected`](https://serenity-js.org/api/web/class/PageElement/#isSelected) resolves to `true`
  *
  *  If the above conditions are not met, the expectation resolves to `false`.
  *
  * ## Learn more
- * - {@apilink PageElement.isSelected}
- * - {@apilink Expectation}
- * - {@apilink Check}
- * - {@apilink Ensure}
- * - {@apilink Wait}
+ * - [`PageElement.isSelected`](https://serenity-js.org/api/web/class/PageElement/#isSelected)
+ * - [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
+ * - [`Check`](https://serenity-js.org/api/core/class/Check/)
+ * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
+ * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
  *
  * @group Expectations
  */

package/src/expectations/isVisible.ts

@@ -9,18 +9,18 @@ const isElementVisible = Expectation.define(
 );
 
 /**
- *  {@apilink Expectation} that an element is visible, which means it resolves to `true` when:
- *  - the element {@apilink isPresent|is present} in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
- *  - {@apilink PageElement.isVisible} resolves to `true`
+ *  [`Expectation`](https://serenity-js.org/api/core/class/Expectation/) that an element is visible, which means it resolves to `true` when:
+ *  - the element [is present](https://serenity-js.org/api/assertions/function/isPresent/) in the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model)
+ *  - [`PageElement.isVisible`](https://serenity-js.org/api/web/class/PageElement/#isVisible) resolves to `true`
  *
  *  If the above conditions are not met, the expectation resolves to `false`.
  *
  * ## Learn more
- * - {@apilink PageElement.isVisible}
- * - {@apilink Expectation}
- * - {@apilink Check}
- * - {@apilink Ensure}
- * - {@apilink Wait}
+ * - [`PageElement.isVisible`](https://serenity-js.org/api/web/class/PageElement/#isVisible)
+ * - [`Expectation`](https://serenity-js.org/api/core/class/Expectation/)
+ * - [`Check`](https://serenity-js.org/api/core/class/Check/)
+ * - [`Ensure`](https://serenity-js.org/api/assertions/class/Ensure/)
+ * - [`Wait`](https://serenity-js.org/api/core/class/Wait/)
  *
  * @group Expectations
  */

package/src/screenplay/abilities/BrowseTheWeb.ts

@@ -3,22 +3,22 @@ import { Ability } from '@serenity-js/core';
 import type { BrowserCapabilities, BrowsingSession, Page } from '../models';
 
 /**
- * The {@apilink Ability|ability} to `BrowseTheWeb` enables an {@apilink Actor|actor}
- * to {@apilink Interaction|interact with} and {@apilink Question|retrieve information from} Web-based user interfaces.
+ * The [ability](https://serenity-js.org/api/core/class/Ability/) to `BrowseTheWeb` enables an [actor](https://serenity-js.org/api/core/class/Actor/)
+ * to [interact with](https://serenity-js.org/api/core/class/Interaction/) and [retrieve information from](https://serenity-js.org/api/core/class/Question/) Web-based user interfaces.
  *
- * `BrowseTheWeb` wraps test integration tools such as [Playwright](/api/playwright),
- * [Protractor](/api/protractor), or [WebdriverIO](/api/webdriverio),
- * and together with Serenity/JS Web models, such as {@apilink Page} or {@apilink PageElement} - offers a standardised way
+ * `BrowseTheWeb` wraps test integration tools such as [Playwright](https://serenity-js.org/api/playwright),
+ * [Protractor](https://serenity-js.org/api/protractor), or [WebdriverIO](https://serenity-js.org/api/webdriverio),
+ * and together with Serenity/JS Web models, such as [`Page`](https://serenity-js.org/api/web/class/Page/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) - offers a standardised way
  * to write Web-based tests following the Screenplay Pattern.
  *
- * The consistent and portable design of abstractions provided by the [`@serenity-js/web` module](/api/web)
+ * The consistent and portable design of abstractions provided by the [`@serenity-js/web` module](https://serenity-js.org/api/web)
  * also helps to make your tests portable across the various test integration tools and helps to make your test
  * code easier to reuse across projects and teams.
  *
  * ## Giving the actors an ability to `BrowseTheWeb`
  *
- * To give an {@apilink Actor|actor} an ability to `BrowseTheWeb`, provide the **integration tool-specific implementation**
- * via {@apilink Actor.whoCan} in {@apilink Cast.prepare}, or via {@apilink Cast.where}.
+ * To give an [actor](https://serenity-js.org/api/core/class/Actor/) an ability to `BrowseTheWeb`, provide the **integration tool-specific implementation**
+ * via [`Actor.whoCan`](https://serenity-js.org/api/core/class/Actor/#whoCan) in [`Cast.prepare`](https://serenity-js.org/api/core/class/Cast/#prepare), or via [`Cast.where`](https://serenity-js.org/api/core/class/Cast/#where).
  *
  * ```ts
  * import { beforeEach } from 'mocha'
@@ -39,21 +39,23 @@ import type { BrowserCapabilities, BrowsingSession, Page } from '../models';
  *
  * To learn more about using Serenity/JS with your chosen test integration tool, follow their respective documentation:
  *
- * - {@apilink BrowseTheWebWithPlaywright}
- * - {@apilink BrowseTheWebWithProtractor}
- * - {@apilink BrowseTheWebWithWebdriverIO}
+ * - [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
+ * - [`BrowseTheWebWithProtractor`](https://serenity-js.org/api/protractor/class/BrowseTheWebWithProtractor/)
+ * - [`BrowseTheWebWithWebdriverIO`](https://serenity-js.org/api/webdriverio/class/BrowseTheWebWithWebdriverIO/)
  *
  * ## Using the ability to `BrowseTheWeb`
  *
- * To use the ability to `BrowseTheWeb` in a custom {@apilink Interaction} or {@apilink Question}, use the **generic** method {@apilink BrowseTheWeb.as}
+ * To use the ability to `BrowseTheWeb` in a custom [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
+ * or [`Question`](https://serenity-js.org/api/core/class/Question/), use the **generic** method [`BrowseTheWeb.as`](https://serenity-js.org/api/core/class/Ability/#as)
  * to retrieve it.
  *
- * This generic method retrieves the integration tool-specific implementation of {@apilink BrowseTheWeb} present on the {@apilink Actor},
- * such as {@apilink BrowseTheWebWithPlaywright} or {@apilink BrowseTheWebWethWebdriverIO}, using {@apilink Actor.abilityTo}.
+ * This generic method retrieves the integration tool-specific implementation of [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) present on the [`Actor`](https://serenity-js.org/api/core/class/Actor/),
+ * such as [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
+ * or [`BrowseTheWebWithWebdriverIO`](https://serenity-js.org/api/webdriverio/class/BrowseTheWebWithWebdriverIO/), using [`Actor.abilityTo`](https://serenity-js.org/api/core/class/Actor/#abilityTo).
  *
  * This decoupling mechanism helps to make your test code portable across test integration tools,
  * since the only part of your test suite that needs to know about the test integration tool used are the actors.
- * The rest of your test code, so {@apilink Task|tasks}, {@apilink Interaction|interactions}, and {@apilink Question|questions},
+ * The rest of your test code, so [tasks](https://serenity-js.org/api/core/class/Task/), [interactions](https://serenity-js.org/api/core/class/Interaction/), and [questions](https://serenity-js.org/api/core/class/Question/),
  * remain fully agnostic of the underlying tool.
  *
  * ```ts
@@ -71,10 +73,10 @@ import type { BrowserCapabilities, BrowsingSession, Page } from '../models';
  *
  * ### Learn more
  *
- * - {@apilink Ability}
- * - {@apilink Actor.whoCan}
- * - {@apilink Cast.where}
- * - {@apilink Cast.prepare}
+ * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+ * - [`Actor.whoCan`](https://serenity-js.org/api/core/class/Actor/#whoCan)
+ * - [`Cast.where`](https://serenity-js.org/api/core/class/Cast/#where)
+ * - [`Cast.prepare`](https://serenity-js.org/api/core/class/Cast/#prepare)
  *
  * @group Abilities
  */
@@ -85,22 +87,22 @@ export abstract class BrowseTheWeb<Native_Element_Type = any> extends Ability {
     }
 
     /**
-     * Returns a {@apilink Page} representing the currently active browser tab.
+     * Returns a [`Page`](https://serenity-js.org/api/web/class/Page/) representing the currently active browser tab.
      */
     async currentPage(): Promise<Page<Native_Element_Type>> {
         return this.session.currentPage();
     }
 
     /**
-     * Returns an array of {@apilink Page|pages} representing all the browser tabs
-     * available in the current {@apilink BrowsingSession}.
+     * Returns an array of [pages](https://serenity-js.org/api/web/class/Page/) representing all the browser tabs
+     * available in the current [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
      */
     allPages(): Promise<Array<Page<Native_Element_Type>>> {
         return this.session.allPages();
     }
 
     /**
-     * Returns {@apilink BrowserCapabilities|basic meta-data} about the browser associated with this ability.
+     * Returns [basic meta-data](https://serenity-js.org/api/web/interface/BrowserCapabilities/) about the browser associated with this ability.
      */
     async browserCapabilities(): Promise<BrowserCapabilities> {
         return this.session.browserCapabilities();

package/src/screenplay/interactions/Clear.ts

@@ -5,7 +5,7 @@ import type { PageElement } from '../models';
 import { PageElementInteraction } from './PageElementInteraction';
 
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to clear the `value` of a [form `input` field](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
  *
  * ## Example widget
@@ -48,18 +48,18 @@ import { PageElementInteraction } from './PageElementInteraction';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink Enter}
- * - {@apilink Value}
- * - {@apilink PageElement}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Enter`](https://serenity-js.org/api/web/class/Enter/)
+ * - [`Value`](https://serenity-js.org/api/web/class/Value/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * @group Activities
  */
 export class Clear extends PageElementInteraction {
 
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to clear the value of an input `field`,
      *
      * @param field