@serenity-js/web 3.25.0 → 3.25.2

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
  */

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

@@ -5,10 +5,10 @@ import { TinyType } from 'tiny-types';
  *
  * ## Learn more
  *
- * - {@apilink Select}
- * - {@apilink Selected}
- * - {@apilink PageElement.selectOptions}
- * - {@apilink PageElement.selectedOptions}
+ * - [`Select`](https://serenity-js.org/api/web/class/Select/)
+ * - [`Selected`](https://serenity-js.org/api/web/class/Selected/)
+ * - [`PageElement.selectOptions`](https://serenity-js.org/api/web/class/PageElement/#selectOptions)
+ * - [`PageElement.selectedOptions`](https://serenity-js.org/api/web/class/PageElement/#selectedOptions)
  *
  * @group Models
  */

package/lib/screenplay/models/SelectOption.js

@@ -8,10 +8,10 @@ const tiny_types_1 = require("tiny-types");
  *
  * ## Learn more
  *
- * - {@apilink Select}
- * - {@apilink Selected}
- * - {@apilink PageElement.selectOptions}
- * - {@apilink PageElement.selectedOptions}
+ * - [`Select`](https://serenity-js.org/api/web/class/Select/)
+ * - [`Selected`](https://serenity-js.org/api/web/class/Selected/)
+ * - [`PageElement.selectOptions`](https://serenity-js.org/api/web/class/PageElement/#selectOptions)
+ * - [`PageElement.selectedOptions`](https://serenity-js.org/api/web/class/PageElement/#selectedOptions)
  *
  * @group Models
  */

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

@@ -1,21 +1,21 @@
 import type { SwitchableOrigin } from './SwitchableOrigin';
 /**
  * Describes a Serenity/JS model object that can be switched _to_ and switched back _from_
- * using the {@apilink Task|task} to {@apilink Switch}.
+ * using the [task](https://serenity-js.org/api/core/class/Task/) to [`Switch`](https://serenity-js.org/api/web/class/Switch/).
  *
- * Examples of switchable models include a {@apilink Page} and {@apilink PageElement}.
+ * Examples of switchable models include a [`Page`](https://serenity-js.org/api/web/class/Page/) and [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * ## Learn more
- * - {@apilink Page}
- * - {@apilink PageElement}
- * - {@apilink Switch}
+ * - [`Page`](https://serenity-js.org/api/web/class/Page/)
+ * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - [`Switch`](https://serenity-js.org/api/web/class/Switch/)
  *
  * @group Models
  */
 export interface Switchable {
     /**
      * Switches the context to the object implementing this interface
-     * and returns {@apilink SwitchableOrigin} that allows for the context to be switched
+     * and returns [`SwitchableOrigin`](https://serenity-js.org/api/web/interface/SwitchableOrigin/) that allows for the context to be switched
      * back when needed.
      */
     switchTo(): Promise<SwitchableOrigin>;

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

@@ -1,17 +1,17 @@
 /**
- * Enables the {@apilink Task} to {@apilink Switch} to perform a sequence of activities
+ * Enables the [`Task`](https://serenity-js.org/api/core/class/Task/) to [`Switch`](https://serenity-js.org/api/web/class/Switch/) to perform a sequence of activities
  * and switch back to the original context afterwards.
  *
  * ## Learn more
  *
- * - {@apilink Switch}
- * - {@apilink Switchable}
+ * - [`Switch`](https://serenity-js.org/api/web/class/Switch/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
  *
  * @group Models
  */
 export interface SwitchableOrigin {
     /**
-     * Switches the context back to the original {@apilink Switchable}
+     * Switches the context back to the original [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
      */
     switchBack(): Promise<void>;
 }

package/lib/screenplay/models/dialogs/AbsentModalDialog.d.ts

@@ -1,10 +1,10 @@
 import { ModalDialog } from './ModalDialog';
 /**
  * `AbsentModalDialog` is a [null object](https://en.wikipedia.org/wiki/Null_object_pattern)
- * representing a {@apilink ModalDialog} that hasn't appeared yet.
+ * representing a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that hasn't appeared yet.
  *
  * ## Learn more
- * - {@apilink ModalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
  *
  * @group Models
  */

package/lib/screenplay/models/dialogs/AbsentModalDialog.js

@@ -5,10 +5,10 @@ const core_1 = require("@serenity-js/core");
 const ModalDialog_1 = require("./ModalDialog");
 /**
  * `AbsentModalDialog` is a [null object](https://en.wikipedia.org/wiki/Null_object_pattern)
- * representing a {@apilink ModalDialog} that hasn't appeared yet.
+ * representing a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that hasn't appeared yet.
  *
  * ## Learn more
- * - {@apilink ModalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
  *
  * @group Models
  */

package/lib/screenplay/models/dialogs/AcceptedModalDialog.d.ts

@@ -1,10 +1,10 @@
 import { ModalDialog } from './ModalDialog';
 /**
- * `AcceptedModalDialog` represents a {@apilink ModalDialog} that has been accepted
- * via {@apilink ModalDialog.acceptNext}.
+ * `AcceptedModalDialog` represents a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that has been accepted
+ * via [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext).
  *
  * ## Learn more
- * - {@apilink ModalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
  *
  * @group Models
  */

package/lib/screenplay/models/dialogs/AcceptedModalDialog.js

@@ -4,11 +4,11 @@ exports.AcceptedModalDialog = void 0;
 const tiny_types_1 = require("tiny-types");
 const ModalDialog_1 = require("./ModalDialog");
 /**
- * `AcceptedModalDialog` represents a {@apilink ModalDialog} that has been accepted
- * via {@apilink ModalDialog.acceptNext}.
+ * `AcceptedModalDialog` represents a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that has been accepted
+ * via [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext).
  *
  * ## Learn more
- * - {@apilink ModalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
  *
  * @group Models
  */

package/lib/screenplay/models/dialogs/DismissedModalDialog.d.ts

@@ -1,10 +1,10 @@
 import { ModalDialog } from './ModalDialog';
 /**
- * `DismissedModalDialog` represents a {@apilink ModalDialog} that has been dismissed
- * via {@apilink ModalDialog.dismissNext}.
+ * `DismissedModalDialog` represents a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that has been dismissed
+ * via [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext).
  *
  * ## Learn more
- * - {@apilink ModalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
  *
  * @group Models
  */

package/lib/screenplay/models/dialogs/DismissedModalDialog.js

@@ -4,11 +4,11 @@ exports.DismissedModalDialog = void 0;
 const tiny_types_1 = require("tiny-types");
 const ModalDialog_1 = require("./ModalDialog");
 /**
- * `DismissedModalDialog` represents a {@apilink ModalDialog} that has been dismissed
- * via {@apilink ModalDialog.dismissNext}.
+ * `DismissedModalDialog` represents a [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) that has been dismissed
+ * via [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext).
  *
  * ## Learn more
- * - {@apilink ModalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
  *
  * @group Models
  */

package/lib/screenplay/models/dialogs/ModalDialog.d.ts

@@ -10,7 +10,10 @@ import type { Answerable, Interaction, Optional, Question, QuestionAdapter } fro
  * consistent across the various Web integration tools (such as Playwright, Puppeteer,
  * WebdriverIO or Selenium), Serenity/JS works as follows:
  * - Serenity/JS dismisses any modal dialogs by default and stores their message so that it can be asserted on.
- * - This behaviour can be changed by invoking {@apilink ModalDialog.acceptNext}, {@apilink ModalDialog.acceptNextWithValue]], or [[ModalDialog.dismissNext} before the dialog is triggered, as per the below examples.
+ * - This behaviour can be changed by invoking [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext),
+ *   [`ModalDialog.acceptNextWithValue`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNextWithValue),
+ *   or [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext)
+ *   before the dialog is triggered, as per the below examples.
  * - Serenity/JS also allows you to `Wait.until(ModalDialog, isPresent())` so that you can synchronise your tests
  *   with modal dialogs that appear after a delay.
  *
@@ -89,7 +92,7 @@ import type { Answerable, Interaction, Optional, Question, QuestionAdapter } fro
  * ```
  *
  * ## Learn more
- * - {@apilink Optional}
+ * - [`Optional`](https://serenity-js.org/api/core/interface/Optional/)
  *
  * @group Models
  */
@@ -118,35 +121,35 @@ export declare abstract class ModalDialog implements Optional {
      */
     static isPresent(): Question<Promise<boolean>>;
     /**
-     * Produces an {@apilink Interaction|interaction} that invokes {@apilink ModalDialog.acceptNext}.
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext).
      */
     static acceptNext(): Interaction;
     /**
-     * Produces an {@apilink Interaction|interaction} that invokes {@apilink ModalDialog.acceptNextWithValue}.
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.acceptNextWithValue`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNextWithValue).
      *
      * @param value
      */
     static acceptNextWithValue(value: Answerable<string | number>): Interaction;
     /**
-     * Produces an {@apilink Interaction|interaction} that invokes {@apilink ModalDialog.dismissNext}.
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext).
      */
     static dismissNext(): Interaction;
     /**
-     * {@apilink QuestionAdapter} that resolves to {@apilink ModalDialog.message} for the current {@apilink Page}.
+     * [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`ModalDialog.message`](https://serenity-js.org/api/web/class/ModalDialog/#message) for the current [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     static lastDialogMessage(): QuestionAdapter<string>;
     /**
-     * {@apilink QuestionAdapter} that resolves to {@apilink ModalDialog.state} for the current {@apilink Page}.
+     * [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`ModalDialog.state`](https://serenity-js.org/api/web/class/ModalDialog/#state) for the current [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     static lastDialogState(): QuestionAdapter<string>;
     /**
      * Returns the message of the last modal dialog handled,
-     * or rejects the promise with a {@apilink LogicError}
+     * or rejects the promise with a [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      * when no modal dialogs have been observed yet.
      *
      * @returns
      *  Message of the last handled dialog, or a `Promise`
-     *  rejected with a {@apilink LogicError}
+     *  rejected with a [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      *  when no dialog has been handled yet.
      */
     abstract message(): Promise<string>;

package/lib/screenplay/models/dialogs/ModalDialog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModalDialog.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/models/dialogs/ModalDialog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAKtG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6FG;AACH,8BAAsB,WAAY,YAAW,QAAQ;IAEjD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,SAAS,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAI9C;;OAEG;IACH,MAAM,CAAC,UAAU,IAAI,WAAW;IAKhC;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,WAAW;IAK3E;;OAEG;IACH,MAAM,CAAC,WAAW,IAAI,WAAW;IAKjC;;OAEG;IACH,MAAM,CAAC,iBAAiB,IAAI,eAAe,CAAC,MAAM,CAAC;IAKnD;;OAEG;IACH,MAAM,CAAC,eAAe,IAAI,eAAe,CAAC,MAAM,CAAC;IAKjD;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAEnC;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAEtC;;;OAGG;IACH,KAAK,IAAI,MAAM;CAKlB"}
+{"version":3,"file":"ModalDialog.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/models/dialogs/ModalDialog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAKtG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgGG;AACH,8BAAsB,WAAY,YAAW,QAAQ;IAEjD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,SAAS,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAI9C;;OAEG;IACH,MAAM,CAAC,UAAU,IAAI,WAAW;IAKhC;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,WAAW;IAK3E;;OAEG;IACH,MAAM,CAAC,WAAW,IAAI,WAAW;IAKjC;;OAEG;IACH,MAAM,CAAC,iBAAiB,IAAI,eAAe,CAAC,MAAM,CAAC;IAKnD;;OAEG;IACH,MAAM,CAAC,eAAe,IAAI,eAAe,CAAC,MAAM,CAAC;IAKjD;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAEnC;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAEtC;;;OAGG;IACH,KAAK,IAAI,MAAM;CAKlB"}

package/lib/screenplay/models/dialogs/ModalDialog.js

@@ -14,7 +14,10 @@ const Page_1 = require("../Page");
  * consistent across the various Web integration tools (such as Playwright, Puppeteer,
  * WebdriverIO or Selenium), Serenity/JS works as follows:
  * - Serenity/JS dismisses any modal dialogs by default and stores their message so that it can be asserted on.
- * - This behaviour can be changed by invoking {@apilink ModalDialog.acceptNext}, {@apilink ModalDialog.acceptNextWithValue]], or [[ModalDialog.dismissNext} before the dialog is triggered, as per the below examples.
+ * - This behaviour can be changed by invoking [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext),
+ *   [`ModalDialog.acceptNextWithValue`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNextWithValue),
+ *   or [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext)
+ *   before the dialog is triggered, as per the below examples.
  * - Serenity/JS also allows you to `Wait.until(ModalDialog, isPresent())` so that you can synchronise your tests
  *   with modal dialogs that appear after a delay.
  *
@@ -93,7 +96,7 @@ const Page_1 = require("../Page");
  * ```
  *
  * ## Learn more
- * - {@apilink Optional}
+ * - [`Optional`](https://serenity-js.org/api/core/interface/Optional/)
  *
  * @group Models
  */
@@ -124,14 +127,14 @@ class ModalDialog {
         return Page_1.Page.current().modalDialog().last().isPresent();
     }
     /**
-     * Produces an {@apilink Interaction|interaction} that invokes {@apilink ModalDialog.acceptNext}.
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.acceptNext`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNext).
      */
     static acceptNext() {
         return Page_1.Page.current().modalDialog().acceptNext()
             .describedAs('#actor accepts next modal dialog window');
     }
     /**
-     * Produces an {@apilink Interaction|interaction} that invokes {@apilink ModalDialog.acceptNextWithValue}.
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.acceptNextWithValue`](https://serenity-js.org/api/web/class/ModalDialog/#acceptNextWithValue).
      *
      * @param value
      */
@@ -140,21 +143,21 @@ class ModalDialog {
             .describedAs((0, core_1.the) `#actor accepts next modal dialog window with value ${value}`);
     }
     /**
-     * Produces an {@apilink Interaction|interaction} that invokes {@apilink ModalDialog.dismissNext}.
+     * Produces an [interaction](https://serenity-js.org/api/core/class/Interaction/) that invokes [`ModalDialog.dismissNext`](https://serenity-js.org/api/web/class/ModalDialog/#dismissNext).
      */
     static dismissNext() {
         return Page_1.Page.current().modalDialog().dismissNext()
             .describedAs((0, core_1.the) `#actor dismisses next modal dialog window`);
     }
     /**
-     * {@apilink QuestionAdapter} that resolves to {@apilink ModalDialog.message} for the current {@apilink Page}.
+     * [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`ModalDialog.message`](https://serenity-js.org/api/web/class/ModalDialog/#message) for the current [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     static lastDialogMessage() {
         return Page_1.Page.current().modalDialog().last().message()
             .describedAs(`last dialog message`);
     }
     /**
-     * {@apilink QuestionAdapter} that resolves to {@apilink ModalDialog.state} for the current {@apilink Page}.
+     * [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) that resolves to [`ModalDialog.state`](https://serenity-js.org/api/web/class/ModalDialog/#state) for the current [`Page`](https://serenity-js.org/api/web/class/Page/).
      */
     static lastDialogState() {
         return Page_1.Page.current().modalDialog().last().state()

package/lib/screenplay/models/dialogs/ModalDialog.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModalDialog.js","sourceRoot":"","sources":["../../../../src/screenplay/models/dialogs/ModalDialog.ts"],"names":[],"mappings":";;;AACA,4CAAwC;AAExC,kCAA+B;AAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6FG;AACH,MAAsB,WAAW;IAE7B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,SAAS;QACZ,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAU;QACb,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE;aAC3C,WAAW,CAAC,yCAAyC,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,KAAkC;QACzD,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC;aACzD,WAAW,CAAC,IAAA,UAAG,EAAA,sDAAuD,KAAM,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAW;QACd,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE;aAC5C,WAAW,CAAC,IAAA,UAAG,EAAA,2CAA2C,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,iBAAiB;QACpB,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE;aAC/C,WAAW,CAAC,qBAAqB,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,eAAe;QAClB,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE;aAC7C,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAC1C,CAAC;IAwBD;;;OAGG;IACH,KAAK;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI;aACvB,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC;aAC1B,WAAW,EAAE,CAAC;IACvB,CAAC;CACJ;AArGD,kCAqGC"}
+{"version":3,"file":"ModalDialog.js","sourceRoot":"","sources":["../../../../src/screenplay/models/dialogs/ModalDialog.ts"],"names":[],"mappings":";;;AACA,4CAAwC;AAExC,kCAA+B;AAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgGG;AACH,MAAsB,WAAW;IAE7B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,SAAS;QACZ,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAU;QACb,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE;aAC3C,WAAW,CAAC,yCAAyC,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,KAAkC;QACzD,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC;aACzD,WAAW,CAAC,IAAA,UAAG,EAAA,sDAAuD,KAAM,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAW;QACd,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE;aAC5C,WAAW,CAAC,IAAA,UAAG,EAAA,2CAA2C,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,iBAAiB;QACpB,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE;aAC/C,WAAW,CAAC,qBAAqB,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,eAAe;QAClB,OAAO,WAAI,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE;aAC7C,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAC1C,CAAC;IAwBD;;;OAGG;IACH,KAAK;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI;aACvB,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC;aAC1B,WAAW,EAAE,CAAC;IACvB,CAAC;CACJ;AArGD,kCAqGC"}

package/lib/screenplay/models/dialogs/ModalDialogHandler.d.ts

@@ -1,11 +1,11 @@
 import type { ModalDialog } from './ModalDialog';
 /**
- * Represent the strategy to use with any upcoming {@apilink ModalDialog} windows.
+ * Represent the strategy to use with any upcoming [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) windows.
  *
  * ## Learn more
  *
- * - {@apilink ModalDialog}
- * - {@apilink Page.modalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
+ * - [`Page.modalDialog`](https://serenity-js.org/api/web/class/Page/#modalDialog)
  *
  * @group Models
  */
@@ -30,8 +30,8 @@ export declare abstract class ModalDialogHandler {
      */
     abstract reset(): Promise<void>;
     /**
-     * Returns the most recently handled {@apilink ModalDialog},
-     * or {@apilink AbsentModalDialog} when no dialogs have been handled yet.
+     * Returns the most recently handled [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/),
+     * or [`AbsentModalDialog`](https://serenity-js.org/api/web/class/AbsentModalDialog/) when no dialogs have been handled yet.
      */
     last(): Promise<ModalDialog>;
 }

package/lib/screenplay/models/dialogs/ModalDialogHandler.js

@@ -4,12 +4,12 @@ exports.ModalDialogHandler = void 0;
 const tiny_types_1 = require("tiny-types");
 const AbsentModalDialog_1 = require("./AbsentModalDialog");
 /**
- * Represent the strategy to use with any upcoming {@apilink ModalDialog} windows.
+ * Represent the strategy to use with any upcoming [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/) windows.
  *
  * ## Learn more
  *
- * - {@apilink ModalDialog}
- * - {@apilink Page.modalDialog}
+ * - [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/)
+ * - [`Page.modalDialog`](https://serenity-js.org/api/web/class/Page/#modalDialog)
  *
  * @group Models
  */
@@ -20,8 +20,8 @@ class ModalDialogHandler {
         (0, tiny_types_1.ensure)('modalDialog', modalDialog, (0, tiny_types_1.isDefined)());
     }
     /**
-     * Returns the most recently handled {@apilink ModalDialog},
-     * or {@apilink AbsentModalDialog} when no dialogs have been handled yet.
+     * Returns the most recently handled [`ModalDialog`](https://serenity-js.org/api/web/class/ModalDialog/),
+     * or [`AbsentModalDialog`](https://serenity-js.org/api/web/class/AbsentModalDialog/) when no dialogs have been handled yet.
      */
     async last() {
         return this.modalDialog;