@serenity-js/web 3.25.0 → 3.25.1

package/lib/screenplay/models/CookieData.d.ts

@@ -1,11 +1,11 @@
 import type { Timestamp } from '@serenity-js/core';
 /**
- * A data structure describing a {@apilink Cookie} to be set, or one that's been read.
+ * A data structure describing a [`Cookie`](https://serenity-js.org/api/web/class/Cookie/) to be set, or one that's been read.
  *
  * ## Learn more
  *
- * - {@apilink Cookie}
- * - {@apilink Page.cookie}
+ * - [`Cookie`](https://serenity-js.org/api/web/class/Cookie/)
+ * - [`Page.cookie`](https://serenity-js.org/api/web/class/Page/#cookie)
  *
  * @group Models
  */
@@ -29,7 +29,7 @@ export interface CookieData {
      */
     path?: string;
     /**
-     * The {@apilink Timestamp} describing the point in time when this cookie expires.
+     * The [timestamp](https://serenity-js.org/api/core/class/Timestamp/) describing the point in time when this cookie expires.
      */
     expiry?: Timestamp;
     /**

package/lib/screenplay/models/Key.d.ts

@@ -1,13 +1,13 @@
 /**
- * Represents keyboard keys that aren't text, and that can be used with the {@apilink Interaction|interaction} to {@apilink Press}.
+ * Represents keyboard keys that aren't text, and that can be used with the [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Press`](https://serenity-js.org/api/web/class/Press/).
  *
- * **Note:** Modifier keys like {@apilink Key.Shift}, {@apilink Key.Alt} and {@apilink Key.Meta} (a.k.a. "Command" on Mac) will stay pressed,
+ * **Note:** Modifier keys like [`Key.Shift`](https://serenity-js.org/api/web/class/Key/#Shift), [`Key.Alt`](https://serenity-js.org/api/web/class/Key/#Alt) and [`Key.Meta`](https://serenity-js.org/api/web/class/Key/#Meta) (a.k.a. "Command" on Mac) will stay pressed,
  * so there's no need to depress them.
  *
  * ## Learn more
  *
- * - {@apilink Press}
- * - {@apilink Page.sendKeys}
+ * - [`Press`](https://serenity-js.org/api/web/class/Press/)
+ * - [`Page.sendKeys`](https://serenity-js.org/api/web/class/Page/#sendKeys)
  * - [W3C WebDriver Spec: Keyboard Actions](https://w3c.github.io/webdriver/webdriver-spec.html#keyboard-actions)
  * - [Selenium WebDriver: Inputs](https://github.com/SeleniumHQ/selenium/blob/trunk/javascript/node/selenium-webdriver/lib/input.js#L46)
  * - [WebdriverIO: Constants](https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-utils/src/constants.ts#L5)

package/lib/screenplay/models/Key.js

@@ -2,15 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Key = void 0;
 /**
- * Represents keyboard keys that aren't text, and that can be used with the {@apilink Interaction|interaction} to {@apilink Press}.
+ * Represents keyboard keys that aren't text, and that can be used with the [interaction](https://serenity-js.org/api/core/class/Interaction/) to [`Press`](https://serenity-js.org/api/web/class/Press/).
  *
- * **Note:** Modifier keys like {@apilink Key.Shift}, {@apilink Key.Alt} and {@apilink Key.Meta} (a.k.a. "Command" on Mac) will stay pressed,
+ * **Note:** Modifier keys like [`Key.Shift`](https://serenity-js.org/api/web/class/Key/#Shift), [`Key.Alt`](https://serenity-js.org/api/web/class/Key/#Alt) and [`Key.Meta`](https://serenity-js.org/api/web/class/Key/#Meta) (a.k.a. "Command" on Mac) will stay pressed,
  * so there's no need to depress them.
  *
  * ## Learn more
  *
- * - {@apilink Press}
- * - {@apilink Page.sendKeys}
+ * - [`Press`](https://serenity-js.org/api/web/class/Press/)
+ * - [`Page.sendKeys`](https://serenity-js.org/api/web/class/Page/#sendKeys)
  * - [W3C WebDriver Spec: Keyboard Actions](https://w3c.github.io/webdriver/webdriver-spec.html#keyboard-actions)
  * - [Selenium WebDriver: Inputs](https://github.com/SeleniumHQ/selenium/blob/trunk/javascript/node/selenium-webdriver/lib/input.js#L46)
  * - [WebdriverIO: Constants](https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-utils/src/constants.ts#L5)

package/lib/screenplay/models/Locator.d.ts

@@ -4,14 +4,14 @@ import type { PageElement } from './PageElement';
 import { RootLocator } from './RootLocator';
 import { ByCss, type Selector } from './selectors';
 /**
- * {@apilink Locator} uses a {@apilink Selector} to locate a {@apilink PageElement} or {@apilink PageElements}
- * within the {@apilink Page}.
+ * [`Locator`](https://serenity-js.org/api/web/class/Locator/) uses a [`Selector`](https://serenity-js.org/api/web/class/Selector/) to locate a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
+ * within the [`Page`](https://serenity-js.org/api/web/class/Page/).
  *
  * ## Learn more
- * - {@apilink RootLocator}
- * - {@apilink Page.locate}
- * - {@apilink PageElement}
- * - {@apilink PageElements}
+ * - [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/)
+ * - [`Page.locate`](https://serenity-js.org/api/web/class/Page/#locate)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
  *
  * @group Models
  */
@@ -29,10 +29,10 @@ export declare abstract class Locator<Native_Element_Type, Native_Selector_Type
     abstract closestTo(child: Locator<Native_Element_Type>): Locator<Native_Element_Type>;
     abstract locate(child: Locator<Native_Element_Type>): Locator<Native_Element_Type>;
     /**
-     * Expresses {@apilink ByCss}, {@apilink ById}, or {@apilink ByTagName} as a {@apilink ByCss} selector.
+     * Expresses [`ByCss`](https://serenity-js.org/api/web/class/ByCss/), [`ById`](https://serenity-js.org/api/web/class/ById/), or [`ByTagName`](https://serenity-js.org/api/web/class/ByTagName/) as a [`ByCss`](https://serenity-js.org/api/web/class/ByCss/) selector.
      *
      * @throws LogicError
-     *  if the `selector` can't be expressed as {@apilink ByCss}
+     *  if the `selector` can't be expressed as [`ByCss`](https://serenity-js.org/api/web/class/ByCss/)
      *
      * @param selector
      * @protected

package/lib/screenplay/models/Locator.js

@@ -30,14 +30,14 @@ const util = __importStar(require("util")); // eslint-disable-line unicorn/impor
 const RootLocator_1 = require("./RootLocator");
 const selectors_1 = require("./selectors");
 /**
- * {@apilink Locator} uses a {@apilink Selector} to locate a {@apilink PageElement} or {@apilink PageElements}
- * within the {@apilink Page}.
+ * [`Locator`](https://serenity-js.org/api/web/class/Locator/) uses a [`Selector`](https://serenity-js.org/api/web/class/Selector/) to locate a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
+ * within the [`Page`](https://serenity-js.org/api/web/class/Page/).
  *
  * ## Learn more
- * - {@apilink RootLocator}
- * - {@apilink Page.locate}
- * - {@apilink PageElement}
- * - {@apilink PageElements}
+ * - [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/)
+ * - [`Page.locate`](https://serenity-js.org/api/web/class/Page/#locate)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
  *
  * @group Models
  */
@@ -59,10 +59,10 @@ class Locator extends RootLocator_1.RootLocator {
         await this.parent.switchToMainFrame();
     }
     /**
-     * Expresses {@apilink ByCss}, {@apilink ById}, or {@apilink ByTagName} as a {@apilink ByCss} selector.
+     * Expresses [`ByCss`](https://serenity-js.org/api/web/class/ByCss/), [`ById`](https://serenity-js.org/api/web/class/ById/), or [`ByTagName`](https://serenity-js.org/api/web/class/ByTagName/) as a [`ByCss`](https://serenity-js.org/api/web/class/ByCss/) selector.
      *
      * @throws LogicError
-     *  if the `selector` can't be expressed as {@apilink ByCss}
+     *  if the `selector` can't be expressed as [`ByCss`](https://serenity-js.org/api/web/class/ByCss/)
      *
      * @param selector
      * @protected

package/lib/screenplay/models/Page.d.ts

@@ -119,10 +119,10 @@ import type { SwitchableOrigin } from './SwitchableOrigin';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
- * - {@apilink Optional}
- * - {@apilink Switchable}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`Optional`](https://serenity-js.org/api/core/interface/Optional/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
  *
  * @group Models
  */
@@ -132,12 +132,12 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
     protected modalDialogHandler: ModalDialogHandler;
     readonly id: CorrelationId;
     /**
-     * Creates a {@apilink QuestionAdapter} representing the currently active {@apilink Page}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) representing the currently active [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     static current(): QuestionAdapter<Page>;
     /**
-     * Creates a {@apilink QuestionAdapter} that resolves to a {@apilink Page} which {@apilink Page.name}
-     * meets the {@apilink Expectation|`expectation`}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to a [`Page`](https://serenity-js.org/api/web/class/Page/) which [`Page.name`](https://serenity-js.org/api/web/class/Page/#name)
+     * meets the [expectation](https://serenity-js.org/api/core/class/Expectation/).
      *
      * #### Switching to a page with the desired name
      *
@@ -155,8 +155,8 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
      */
     static whichName(expectation: Expectation<string>): QuestionAdapter<Page>;
     /**
-     * Creates a {@apilink QuestionAdapter} that resolves to a {@apilink Page} which {@apilink Page.title}
-     * meets the {@apilink Expectation|`expectation`}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to a [`Page`](https://serenity-js.org/api/web/class/Page/) which [`Page.title`](https://serenity-js.org/api/web/class/Page/#title)
+     * meets the [expectation](https://serenity-js.org/api/core/class/Expectation/).
      *
      * #### Switching to a page with the desired title
      *
@@ -174,8 +174,8 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
      */
     static whichTitle(expectation: Expectation<string>): QuestionAdapter<Page>;
     /**
-     * Creates a {@apilink QuestionAdapter} that resolves to a {@apilink Page} which {@apilink Page.url}
-     * meets the {@apilink Expectation|`expectation`}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to a [`Page`](https://serenity-js.org/api/web/class/Page/) which [`Page.url`](https://serenity-js.org/api/web/class/Page/#url)
+     * meets the [expectation](https://serenity-js.org/api/core/class/Expectation/).
      *
      * #### Switching to a page with the desired URL
      *
@@ -195,19 +195,19 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
     private static findMatchingPage;
     constructor(session: BrowsingSession<Page<Native_Element_Type>>, rootLocator: RootLocator<Native_Element_Type>, modalDialogHandler: ModalDialogHandler, id: CorrelationId);
     /**
-     * Creates a {@apilink PageElement} wrapping a native element.
+     * Creates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) wrapping a native element.
      *
      * @param nativeElement
      */
     abstract createPageElement(nativeElement: Native_Element_Type): PageElement<Native_Element_Type>;
     /**
-     * Creates a {@apilink PageElement}, retrieving an element located by {@apilink Selector}.
+     * Creates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/), retrieving an element located by [`Selector`](https://serenity-js.org/api/web/class/Selector/).
      *
      * @param selector
      */
     abstract locate(selector: Selector): PageElement<Native_Element_Type>;
     /**
-     * Creates {@apilink PageElements}, retrieving a collection of elements located by {@apilink Selector}.
+     * Creates [`PageElement`](https://serenity-js.org/api/web/class/PageElements/), retrieving a collection of elements located by [`Selector`](https://serenity-js.org/api/web/class/Selector/).
      *
      * @param selector
      */
@@ -228,7 +228,7 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
     abstract navigateTo(destination: string): Promise<void>;
     /**
      * Causes the browser to traverse one step backward in the joint session history
-     * of the current {@apilink Page} (the current top-level browsing context).
+     * of the current [`Page`](https://serenity-js.org/api/web/class/Page/) (the current top-level browsing context).
      *
      * This is equivalent to pressing the back button in the browser UI,
      * or calling [`window.history.back`](https://developer.mozilla.org/en-US/docs/Web/API/History/back).
@@ -236,18 +236,18 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
     abstract navigateBack(): Promise<void>;
     /**
      * Causes the browser to traverse one step forward in the joint session history
-     * of the current {@apilink Page} (the current top-level browsing context).
+     * of the current [`Page`](https://serenity-js.org/api/web/class/Page/) (the current top-level browsing context).
      *
      * This is equivalent to pressing the back button in the browser UI,
      * or calling [`window.history.forward`](https://developer.mozilla.org/en-US/docs/Web/API/History/forward).
      */
     abstract navigateForward(): Promise<void>;
     /**
-     * Causes the browser to reload the {@apilink Page} in the current top-level browsing context.
+     * Causes the browser to reload the [`Page`](https://serenity-js.org/api/web/class/Page/) in the current top-level browsing context.
      */
     abstract reload(): Promise<void>;
     /**
-     * Send a sequence of {@apilink Key} strokes to the active element.
+     * Send a sequence of [`Key`](https://serenity-js.org/api/web/class/Key/) strokes to the active element.
      *
      * @param keys
      *  Keys to enter
@@ -273,7 +273,7 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
      * If the script has a return value (i.e. if the script contains a `return` statement),
      * then the following steps will be taken for resolving this functions return value:
      *
-     * - For a {@apilink PageElement}, the value will resolve to a [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)
+     * - For a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/), the value will resolve to a [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)
      * - `null` and `undefined` return values will resolve to `null`
      * - `boolean`, `number`, and `string` values will resolve as is
      * - Functions will resolve to their string representation
@@ -291,7 +291,7 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
      *
      * #### Learn more
      * - [Selenium WebDriver: JavaScript Executor](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/JavascriptExecutor.html#executeAsyncScript-java.lang.String-java.lang.Object...-)
-     * - {@apilink Page.lastScriptExecutionResult}
+     * - [`Page.lastScriptExecutionResult`](https://serenity-js.org/api/web/class/Page/#lastScriptExecutionResult)
      *
      * @param script
      * @param args
@@ -309,7 +309,7 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
      * Arrays and objects may also be used as script arguments as long as each item adheres
      * to the types previously mentioned.
      *
-     * Unlike executing synchronous JavaScript with {@apilink Page.executeScript},
+     * Unlike executing synchronous JavaScript with [`Page.executeScript`](https://serenity-js.org/api/web/class/Page/#executeScript),
      * scripts executed with this function must explicitly signal they are finished by invoking the provided callback.
      *
      * This callback will always be injected into the executed function as the last argument,
@@ -318,7 +318,7 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
      * The following steps will be taken for resolving this functions return value against
      * the first argument to the script's callback function:
      *
-     * - For a {@apilink PageElement}, the value will resolve to a [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)
+     * - For a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/), the value will resolve to a [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)
      * - `null` and `undefined` return values will resolve to `null`
      * - `boolean`, `number`, and `string` values will resolve as is
      * - Functions will resolve to their string representation
@@ -347,21 +347,21 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
      *
      * #### Learn more
      * - [Selenium WebDriver: JavaScript Executor](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/JavascriptExecutor.html#executeAsyncScript-java.lang.String-java.lang.Object...-)
-     * - {@apilink Page.lastScriptExecutionResult}
+     * - [`Page.lastScriptExecutionResult`](https://serenity-js.org/api/web/class/Page/#lastScriptExecutionResult)
      *
      * @param script
      * @param args
      */
     abstract executeAsyncScript<Result, Parameters extends any[]>(script: string | ((...args: [...parameters: Parameters, callback: (result: Result) => void]) => void), ...args: Parameters): Promise<Result>;
     /**
-     * Returns the last result of calling {@apilink Page.executeAsyncScript}
-     * or {@apilink Page.executeScript}
+     * Returns the last result of calling [`Page.executeAsyncScript`](https://serenity-js.org/api/web/class/Page/#executeAsyncScript)
+     * or [`Page.executeScript`](https://serenity-js.org/api/web/class/Page/#executeScript)
      */
     abstract lastScriptExecutionResult<R = any>(): R;
     /**
      * Take a screenshot of the top-level browsing context's viewport.
      *
-     * @throws {@apilink BrowserWindowClosedError}
+     * @throws [`BrowserWindowClosedError`](https://serenity-js.org/api/web/class/BrowserWindowClosedError/)
      *  When the page you're trying to take the screenshot of has already been closed
      *
      * @return
@@ -369,14 +369,14 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
      */
     abstract takeScreenshot(): Promise<string>;
     /**
-     * Retrieves a cookie identified by `name` and visible to this {@apilink Page}.
+     * Retrieves a cookie identified by `name` and visible to this [`Page`](https://serenity-js.org/api/web/class/Page/).
      *
      * @param name
      */
     abstract cookie(name: string): Promise<Cookie>;
     /**
-     * Adds a single cookie with {@apilink CookieData} to the cookie store associated
-     * with the active {@apilink Page}'s address.
+     * Adds a single cookie with [`CookieData`](https://serenity-js.org/api/web/interface/CookieData/) to the cookie store associated
+     * with the active [`Page`](https://serenity-js.org/api/web/class/Page/)'s address.
      *
      * @param cookieData
      */
@@ -427,8 +427,8 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
      * to the previous context when needed.
      *
      * ## Learn more
-     * - {@apilink Switch}
-     * - {@apilink Switchable}
+     * - [`Switch`](https://serenity-js.org/api/web/class/Switch/)
+     * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
      */
     switchTo(): Promise<SwitchableOrigin>;
     /**
@@ -440,7 +440,7 @@ export declare abstract class Page<Native_Element_Type = any> implements Optiona
      */
     abstract closeOthers(): Promise<void>;
     /**
-     * Returns the {@apilink ModalDialogHandler} for the current {@apilink Page}.
+     * Returns the [`ModalDialogHandler`](https://serenity-js.org/api/web/class/ModalDialogHandler/) for the current [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     modalDialog(): ModalDialogHandler;
     /**

package/lib/screenplay/models/Page.js

@@ -110,10 +110,10 @@ const abilities_1 = require("../abilities");
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink PageElement}
- * - {@apilink Optional}
- * - {@apilink Switchable}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`Optional`](https://serenity-js.org/api/core/interface/Optional/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
  *
  * @group Models
  */
@@ -123,7 +123,7 @@ class Page {
     modalDialogHandler;
     id;
     /**
-     * Creates a {@apilink QuestionAdapter} representing the currently active {@apilink Page}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) representing the currently active [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     static current() {
         return core_1.Question.about('current page', actor => {
@@ -131,8 +131,8 @@ class Page {
         });
     }
     /**
-     * Creates a {@apilink QuestionAdapter} that resolves to a {@apilink Page} which {@apilink Page.name}
-     * meets the {@apilink Expectation|`expectation`}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to a [`Page`](https://serenity-js.org/api/web/class/Page/) which [`Page.name`](https://serenity-js.org/api/web/class/Page/#name)
+     * meets the [expectation](https://serenity-js.org/api/core/class/Expectation/).
      *
      * #### Switching to a page with the desired name
      *
@@ -155,8 +155,8 @@ class Page {
         });
     }
     /**
-     * Creates a {@apilink QuestionAdapter} that resolves to a {@apilink Page} which {@apilink Page.title}
-     * meets the {@apilink Expectation|`expectation`}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to a [`Page`](https://serenity-js.org/api/web/class/Page/) which [`Page.title`](https://serenity-js.org/api/web/class/Page/#title)
+     * meets the [expectation](https://serenity-js.org/api/core/class/Expectation/).
      *
      * #### Switching to a page with the desired title
      *
@@ -179,8 +179,8 @@ class Page {
         });
     }
     /**
-     * Creates a {@apilink QuestionAdapter} that resolves to a {@apilink Page} which {@apilink Page.url}
-     * meets the {@apilink Expectation|`expectation`}.
+     * Creates a [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to a [`Page`](https://serenity-js.org/api/web/class/Page/) which [`Page.url`](https://serenity-js.org/api/web/class/Page/#url)
+     * meets the [expectation](https://serenity-js.org/api/core/class/Expectation/).
      *
      * #### Switching to a page with the desired URL
      *
@@ -227,8 +227,8 @@ class Page {
      * to the previous context when needed.
      *
      * ## Learn more
-     * - {@apilink Switch}
-     * - {@apilink Switchable}
+     * - [`Switch`](https://serenity-js.org/api/web/class/Switch/)
+     * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
      */
     async switchTo() {
         const originalPage = await this.session.currentPage();
@@ -240,7 +240,7 @@ class Page {
         };
     }
     /**
-     * Returns the {@apilink ModalDialogHandler} for the current {@apilink Page}.
+     * Returns the [`ModalDialogHandler`](https://serenity-js.org/api/web/class/ModalDialogHandler/) for the current [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     modalDialog() {
         return this.modalDialogHandler;

package/lib/screenplay/models/PageElement.d.ts

@@ -5,13 +5,13 @@ import type { Selector } from './selectors';
 import type { Switchable } from './Switchable';
 import type { SwitchableOrigin } from './SwitchableOrigin';
 /**
- * Uses the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to identify
- * a single Web element located by {@apilink Selector}.
+ * Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to identify
+ * a single Web element located by [`Selector`](https://serenity-js.org/api/web/class/Selector/).
  *
  * ## Learn more
- * - [Page Element Query Language](/handbook/web-testing/page-element-query-language)
- * - {@apilink Optional}
- * - {@apilink Switchable}
+ * - [Page Element Query Language](https://serenity-js.org/handbook/web-testing/page-element-query-language)
+ * - [`Optional`](https://serenity-js.org/api/core/interface/Optional/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
  *
  * @group Models
  */
@@ -21,7 +21,7 @@ export declare abstract class PageElement<Native_Element_Type = any> implements
     static located<NET>(selector: Answerable<Selector>): MetaQuestionAdapter<PageElement<NET>, PageElement<NET>>;
     static of<NET>(childElement: MetaQuestionAdapter<PageElement<NET>, PageElement<NET>> | PageElement<NET>, parentElement: Answerable<PageElement<NET>>): MetaQuestionAdapter<PageElement<NET>, PageElement<NET>>;
     /**
-     * A static method producing a {@apilink MetaQuestion} that can be used with {@apilink PageElements.eachMappedTo} method
+     * A static method producing a [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/) that can be used with [`PageElements.eachMappedTo`](https://serenity-js.org/api/web/class/PageElements/#eachMappedTo) method
      * to extract the HTML of each element in a collection.
      *
      * #### Example
@@ -54,7 +54,7 @@ export declare abstract class PageElement<Native_Element_Type = any> implements
     abstract of(parentElement: PageElement<Native_Element_Type>): PageElement<Native_Element_Type>;
     /**
      * Traverses the element and its parents, heading toward the document root,
-     * until it finds a parent {@apilink PageElement} that matches its associated CSS selector.
+     * until it finds a parent [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) that matches its associated CSS selector.
      *
      * #### Example
      *
@@ -89,9 +89,9 @@ export declare abstract class PageElement<Native_Element_Type = any> implements
      * :::info
      * This method relies on [Element: closest() API](https://developer.mozilla.org/en-US/docs/Web/API/Element/closest),
      * and so is only compatible with locating parent elements specified using the following CSS selectors:
-     * - {@apilink ByCss}
-     * - {@apilink ById}
-     * - {@apilink ByTagName}
+     * - [`ByCss`](https://serenity-js.org/api/web/class/ByCss/)
+     * - [`ById`](https://serenity-js.org/api/web/class/ById/)
+     * - [`ByTagName`](https://serenity-js.org/api/web/class/ByTagName/)
      * :::
      *
      * @param childElement
@@ -150,8 +150,8 @@ export declare abstract class PageElement<Native_Element_Type = any> implements
      *  to the previous context if needed.
      *
      * #### Learn more
-     * - {@apilink Switch}
-     * - {@apilink Switchable}
+     * - [`Switch`](https://serenity-js.org/api/web/class/Switch/)
+     * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
      */
     abstract switchTo(): Promise<SwitchableOrigin>;
     /**
@@ -174,7 +174,7 @@ export declare abstract class PageElement<Native_Element_Type = any> implements
      */
     abstract isEnabled(): Promise<boolean>;
     /**
-     * Returns a {@apilink Promise} that resolves to `true` when the element
+     * Returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that resolves to `true` when the element
      * is present in the [Document Object Model (DOM)](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model),
      * `false` otherwise.
      */

package/lib/screenplay/models/PageElement.js

@@ -5,13 +5,13 @@ const core_1 = require("@serenity-js/core");
 const tiny_types_1 = require("tiny-types");
 const abilities_1 = require("../abilities");
 /**
- * Uses the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to identify
- * a single Web element located by {@apilink Selector}.
+ * Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to identify
+ * a single Web element located by [`Selector`](https://serenity-js.org/api/web/class/Selector/).
  *
  * ## Learn more
- * - [Page Element Query Language](/handbook/web-testing/page-element-query-language)
- * - {@apilink Optional}
- * - {@apilink Switchable}
+ * - [Page Element Query Language](https://serenity-js.org/handbook/web-testing/page-element-query-language)
+ * - [`Optional`](https://serenity-js.org/api/core/interface/Optional/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
  *
  * @group Models
  */
@@ -38,7 +38,7 @@ class PageElement {
         });
     }
     /**
-     * A static method producing a {@apilink MetaQuestion} that can be used with {@apilink PageElements.eachMappedTo} method
+     * A static method producing a [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/) that can be used with [`PageElements.eachMappedTo`](https://serenity-js.org/api/web/class/PageElements/#eachMappedTo) method
      * to extract the HTML of each element in a collection.
      *
      * #### Example
@@ -81,7 +81,7 @@ class PageElement {
         return `PageElement located ${this.locator.toString()}`;
     }
     /**
-     * Returns a {@apilink Promise} that resolves to `true` when the element
+     * Returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that resolves to `true` when the element
      * is present in the [Document Object Model (DOM)](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model),
      * `false` otherwise.
      */

package/lib/screenplay/models/PageElements.d.ts

@@ -3,15 +3,15 @@ import { MetaList } from '@serenity-js/core';
 import type { PageElement } from './PageElement';
 import type { Selector } from './selectors';
 /**
- * Uses the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to identify
- * a group of Web elements located by {@apilink Selector}.
+ * Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to identify
+ * a group of Web elements located by [`Selector`](https://serenity-js.org/api/web/class/Selector/).
  *
  * ## Learn more
  *
- * - [Page Element Query Language](/handbook/web-testing/page-element-query-language)
- * - {@apilink MetaList}
- * - {@apilink List}
- * - {@apilink ChainableMetaQuestion}
+ * - [Page Element Query Language](https://serenity-js.org/handbook/web-testing/page-element-query-language)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)}
+ * - [`List`](https://serenity-js.org/api/core/class/List/)
+ * - [`ChainableMetaQuestion`](https://serenity-js.org/api/core/interface/ChainableMetaQuestion/)
  *
  * @group Models
  */

package/lib/screenplay/models/PageElements.js

@@ -4,15 +4,15 @@ exports.PageElements = void 0;
 const core_1 = require("@serenity-js/core");
 const PageElementsLocator_1 = require("./PageElementsLocator");
 /**
- * Uses the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to identify
- * a group of Web elements located by {@apilink Selector}.
+ * Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to identify
+ * a group of Web elements located by [`Selector`](https://serenity-js.org/api/web/class/Selector/).
  *
  * ## Learn more
  *
- * - [Page Element Query Language](/handbook/web-testing/page-element-query-language)
- * - {@apilink MetaList}
- * - {@apilink List}
- * - {@apilink ChainableMetaQuestion}
+ * - [Page Element Query Language](https://serenity-js.org/handbook/web-testing/page-element-query-language)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)}
+ * - [`List`](https://serenity-js.org/api/core/class/List/)
+ * - [`ChainableMetaQuestion`](https://serenity-js.org/api/core/interface/ChainableMetaQuestion/)
  *
  * @group Models
  */

package/lib/screenplay/models/RootLocator.d.ts

@@ -2,14 +2,14 @@
 import type { Optional } from '@serenity-js/core';
 import * as util from 'util';
 /**
- * {@apilink RootLocator} represents the context in which {@apilink Locator} looks for {@apilink PageElement} or {@apilink PageElements}.
+ * [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/) represents the context in which [`Locator`](https://serenity-js.org/api/web/class/Locator/) looks for [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElements/).
  * This context is either a parent element, or some representation of the top-level browsing context.
  *
  * ## Learn more
- * - {@apilink Locator}
- * - {@apilink Page.locate}
- * - {@apilink PageElement}
- * - {@apilink PageElements}
+ * - [`Locator`](https://serenity-js.org/api/web/class/Locator/)
+ * - [`Page.locate`](https://serenity-js.org/api/web/class/Page/#locate)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
  *
  * @group Models
  */

package/lib/screenplay/models/RootLocator.js

@@ -27,14 +27,14 @@ exports.RootLocator = void 0;
 const io_1 = require("@serenity-js/core/lib/io");
 const util = __importStar(require("util")); // eslint-disable-line unicorn/import-style
 /**
- * {@apilink RootLocator} represents the context in which {@apilink Locator} looks for {@apilink PageElement} or {@apilink PageElements}.
+ * [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/) represents the context in which [`Locator`](https://serenity-js.org/api/web/class/Locator/) looks for [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) or [`PageElement`](https://serenity-js.org/api/web/class/PageElements/).
  * This context is either a parent element, or some representation of the top-level browsing context.
  *
  * ## Learn more
- * - {@apilink Locator}
- * - {@apilink Page.locate}
- * - {@apilink PageElement}
- * - {@apilink PageElements}
+ * - [`Locator`](https://serenity-js.org/api/web/class/Locator/)
+ * - [`Page.locate`](https://serenity-js.org/api/web/class/Page/#locate)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
  *
  * @group Models
  */