@serenity-js/web 3.25.0 → 3.25.2

package/CHANGELOG.md

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

package/README.md

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

package/lib/errors/BrowserWindowClosedError.d.ts

@@ -4,8 +4,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/lib/errors/BrowserWindowClosedError.js

@@ -7,8 +7,8 @@ const core_1 = require("@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/lib/errors/CookieMissingError.d.ts

@@ -4,8 +4,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/lib/errors/CookieMissingError.js

@@ -7,8 +7,8 @@ const core_1 = require("@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/lib/errors/ModalDialogObstructsScreenshotError.d.ts

@@ -3,9 +3,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/lib/errors/ModalDialogObstructsScreenshotError.js

@@ -6,9 +6,9 @@ const core_1 = require("@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/lib/expectations/isActive.d.ts

@@ -1,18 +1,18 @@
 import { Expectation } from '@serenity-js/core';
 import type { PageElement } from '../screenplay';
 /**
- * {@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/lib/expectations/isActive.js

@@ -5,18 +5,18 @@ const assertions_1 = require("@serenity-js/assertions");
 const core_1 = require("@serenity-js/core");
 const isElementActive = core_1.Expectation.define('isActive', 'become active', (actual) => actual.isActive());
 /**
- * {@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/lib/expectations/isClickable.d.ts

@@ -1,18 +1,18 @@
 import { Expectation } from '@serenity-js/core';
 import type { PageElement } from '../screenplay';
 /**
- *  {@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/lib/expectations/isClickable.js

@@ -5,18 +5,18 @@ const assertions_1 = require("@serenity-js/assertions");
 const core_1 = require("@serenity-js/core");
 const isElementClickable = core_1.Expectation.define('isClickable', 'become clickable', (actual) => actual.isClickable());
 /**
- *  {@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/lib/expectations/isEnabled.d.ts

@@ -1,18 +1,18 @@
 import { Expectation } from '@serenity-js/core';
 import type { PageElement } from '../screenplay';
 /**
- *  {@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/lib/expectations/isEnabled.js

@@ -5,18 +5,18 @@ const assertions_1 = require("@serenity-js/assertions");
 const core_1 = require("@serenity-js/core");
 const isElementEnabled = core_1.Expectation.define('isEnabled', 'become enabled', (actual) => actual.isEnabled());
 /**
- *  {@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/lib/expectations/isSelected.d.ts

@@ -1,18 +1,18 @@
 import { Expectation } from '@serenity-js/core';
 import type { PageElement } from '../screenplay';
 /**
- *  {@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/lib/expectations/isSelected.js

@@ -5,18 +5,18 @@ const assertions_1 = require("@serenity-js/assertions");
 const core_1 = require("@serenity-js/core");
 const isElementSelected = core_1.Expectation.define('isSelected', 'become selected', (actual) => actual.isSelected());
 /**
- *  {@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/lib/expectations/isVisible.d.ts

@@ -1,18 +1,18 @@
 import { Expectation } from '@serenity-js/core';
 import type { PageElement } from '../screenplay';
 /**
- *  {@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/lib/expectations/isVisible.js

@@ -5,18 +5,18 @@ const assertions_1 = require("@serenity-js/assertions");
 const core_1 = require("@serenity-js/core");
 const isElementVisible = core_1.Expectation.define('isVisible', 'become visible', (actual) => actual.isVisible());
 /**
- *  {@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/lib/screenplay/abilities/BrowseTheWeb.d.ts

@@ -1,22 +1,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'
@@ -37,21 +37,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
@@ -69,10 +71,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
  */
@@ -80,16 +82,16 @@ export declare abstract class BrowseTheWeb<Native_Element_Type = any> extends Ab
     protected readonly session: BrowsingSession<Page<Native_Element_Type>>;
     constructor(session: BrowsingSession<Page<Native_Element_Type>>);
     /**
-     * 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.
      */
     currentPage(): Promise<Page<Native_Element_Type>>;
     /**
-     * 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>>>;
     /**
-     * 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.
      */
     browserCapabilities(): Promise<BrowserCapabilities>;
 }

package/lib/screenplay/abilities/BrowseTheWeb.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowseTheWeb.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWeb.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,8BAAsB,YAAY,CAAC,mBAAmB,GAAG,GAAG,CAAE,SAAQ,OAAO;IAE7D,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;gBAAnD,OAAO,EAAE,eAAe,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAIlF;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAIvD;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAIrD;;OAEG;IACG,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC;CAG5D"}
+{"version":3,"file":"BrowseTheWeb.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWeb.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG;AACH,8BAAsB,YAAY,CAAC,mBAAmB,GAAG,GAAG,CAAE,SAAQ,OAAO;IAE7D,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;gBAAnD,OAAO,EAAE,eAAe,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAIlF;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAIvD;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAIrD;;OAEG;IACG,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC;CAG5D"}