@serenity-js/playwright - npm Package Compare versions

Comparing version 3.25.0 to 3.25.1

CHANGELOG.md

@@ -6,2 +6,13 @@ # Change Log
 
+## [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)
@@ -8,0 +19,0 @@

lib/PlaywrightOptions.d.ts

 import type * as playwright from 'playwright-core';
 /**
- * Playwright-specific options used to configure the ability to {@apilink BrowseTheWebWithPlaywright}
+ * Playwright-specific options used to configure the ability to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
  *
@@ -12,3 +12,3 @@ * ## Learn more
     /**
-     * Changes the default maximum navigation time for the browser context used by {@apilink BrowseTheWebWithPlaywright}
+     * Changes the default maximum navigation time for the browser context used by [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
      *
@@ -15,0 +15,0 @@ * #### Learn more

lib/screenplay/abilities/BrowseTheWebWithPlaywright.d.ts

@@ -6,9 +6,9 @@ import type { Discardable } from '@serenity-js/core';
 /**
- * This implementation of the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * enables the {@apilink Actor} to interact with web front-ends using [Playwright](https://playwright.dev/).
+ * This implementation of the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * enables the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to interact with web front-ends using [Playwright](https://playwright.dev/).
  *
  * ## Using Playwright to `BrowseTheWeb`
  *
- * In the example below, we configure the ability to {@apilink BrowseTheWebWithPlaywright} with a Playwright
- * [`Browser`](https://playwright.dev/docs/api/class-browser) so that Serenity/JS {@apilink Actor|actors}
+ * In the example below, we configure the ability to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/) with a Playwright
+ * [`Browser`](https://playwright.dev/docs/api/class-browser) so that Serenity/JS [actors](https://serenity-js.org/api/core/class/Actor/)
  * can create a new [`BrowserContext`](https://playwright.dev/docs/api/class-browsercontext) and
@@ -18,3 +18,3 @@ * instantiate Playwright [`page`s](https://playwright.dev/docs/api/class-page) as and when needed.
  * This configuration allows Serenity/JS to control the process of launching and shutting down browser instances
- * and is useful when your test runner, e.g. [Cucumber.js](/api/cucumber), doesn't offer this functionality.
+ * and is useful when your test runner, e.g. [Cucumber.js](https://serenity-js.org/api/cucumber), doesn't offer this functionality.
  *
@@ -45,13 +45,13 @@ * ```ts
  *
- * Test runners like [Playwright Test](/api/playwright-test/) manage Playwright browsers for you
+ * Test runners like [Playwright Test](https://serenity-js.org/api/playwright-test/) manage Playwright browsers for you
  * and offer a [`page`](https://playwright.dev/docs/api/class-page) instance you can
- * inject into the ability to {@apilink BrowseTheWebWithPlaywright}.
+ * inject into the ability to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/).
  *
- * Note that [Serenity/JS Playwright Test module](/api/playwright-test/)
- * automatically configures all your {@apilink Actor|actors}
- * with an ability to {@apilink BrowseTheWebWithPlaywright},
- * so you don't need to do it by hand unless you want to override the {@apilink SerenityOptions|default configuration}.
+ * Note that [Serenity/JS Playwright Test module](https://serenity-js.org/api/playwright-test/)
+ * automatically configures all your [actors](https://serenity-js.org/api/core/class/Actor/)
+ * with an ability to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/),
+ * so you don't need to do it by hand unless you want to override the [default configuration](https://serenity-js.org/api/playwright-test/interface/SerenityOptions/).
  *
- * The example below demonstrates how to use the {@apilink BrowseTheWebWithPlaywright.usingPage} API and
- * override the default {@apilink Cast} of actors.
+ * The example below demonstrates how to use the [`BrowseTheWebWithPlaywright.usingPage`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/#usingPage) API and
+ * override the default [cast](https://serenity-js.org/api/core/class/Cast/) of actors.
  *
@@ -95,8 +95,9 @@ * ```ts title="specs/example.spec.ts"
  *
- * If you're using Serenity/JS with [Playwright Test](/handbook/test-runners/playwright-test/),
+ * If you're using Serenity/JS with [Playwright Test](https://serenity-js.org/handbook/test-runners/playwright-test/),
  * Serenity/JS will automatically pick up your configuration from the [`playwright.config.ts`](https://playwright.dev/docs/test-configuration) file.
  *
- * With other [test runners](/handbook/test-runners/), you can configure Playwright by:
+ * With other [test runners](https://serenity-js.org/handbook/test-runners/), you can configure Playwright by:
  * - providing the browser-level configuration when calling [`BrowserType.launch`](https://playwright.dev/docs/api/class-browsertype#browser-type-launch),
- * - providing the browser context-level {@link PlaywrightOptions} when initialising the ability to `BrowseTheWebWithPlaywright`.
+ * - providing the browser context-level [`PlaywrightOptions`](https://serenity-js.org/api/playwright/interface/PlaywrightOptions/)
+ * when initialising the ability to `BrowseTheWebWithPlaywright`.
  *
@@ -141,3 +142,3 @@ * The code snippet below demonstrates how to configure the browser and some popular browser context options,
  *
- * Note that in addition to all the standard Playwright BrowserContextOptions, you can also provide several others defined in Serenity/JS {@apilink PlaywrightOptions}, such as:
+ * Note that in addition to all the standard Playwright BrowserContextOptions, you can also provide several others defined in Serenity/JS [`PlaywrightOptions`](https://serenity-js.org/api/playwright/interface/PlaywrightOptions/), such as:
  * - `defaultNavigationTimeout`, which changes the default maximum navigation timeout for the browser context,
@@ -149,5 +150,5 @@ * - `defaultTimeout`, which changes the default maximum time for all Playwright methods accepting the `timeout` option.
  * - [Playwright website](https://playwright.dev/)
- * - {@apilink BrowseTheWeb}
- * - {@apilink Ability}
- * - {@apilink Actor}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
  *
@@ -160,7 +161,7 @@ * @group Abilities
     /**
-     * Automatically closes any open {@apilink Page|Pages} when the {@apilink SceneFinishes}
+     * Automatically closes any open [pages](https://serenity-js.org/api/web/class/Page/) when the [SceneFinishes](https://serenity-js.org/api/core-events/class/SceneFinishes/)
      *
      * #### Learn more
-     * - {@apilink PlaywrightBrowsingSession.closeAllPages}
-     * - {@apilink Discardable}
+     * - [`PlaywrightBrowsingSession.closeAllPages`](https://serenity-js.org/api/playwright/class/PlaywrightBrowsingSession/#closeAllPages)
+     * - [`Discardable`](https://serenity-js.org/api/core/interface/Discardable/)
      */
@@ -167,0 +168,0 @@ discard(): Promise<void>;

lib/screenplay/abilities/BrowseTheWebWithPlaywright.js

@@ -31,9 +31,9 @@ "use strict";
 /**
- * This implementation of the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * enables the {@apilink Actor} to interact with web front-ends using [Playwright](https://playwright.dev/).
+ * This implementation of the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * enables the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to interact with web front-ends using [Playwright](https://playwright.dev/).
  *
  * ## Using Playwright to `BrowseTheWeb`
  *
- * In the example below, we configure the ability to {@apilink BrowseTheWebWithPlaywright} with a Playwright
- * [`Browser`](https://playwright.dev/docs/api/class-browser) so that Serenity/JS {@apilink Actor|actors}
+ * In the example below, we configure the ability to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/) with a Playwright
+ * [`Browser`](https://playwright.dev/docs/api/class-browser) so that Serenity/JS [actors](https://serenity-js.org/api/core/class/Actor/)
  * can create a new [`BrowserContext`](https://playwright.dev/docs/api/class-browsercontext) and
@@ -43,3 +43,3 @@ * instantiate Playwright [`page`s](https://playwright.dev/docs/api/class-page) as and when needed.
  * This configuration allows Serenity/JS to control the process of launching and shutting down browser instances
- * and is useful when your test runner, e.g. [Cucumber.js](/api/cucumber), doesn't offer this functionality.
+ * and is useful when your test runner, e.g. [Cucumber.js](https://serenity-js.org/api/cucumber), doesn't offer this functionality.
  *
@@ -70,13 +70,13 @@ * ```ts
  *
- * Test runners like [Playwright Test](/api/playwright-test/) manage Playwright browsers for you
+ * Test runners like [Playwright Test](https://serenity-js.org/api/playwright-test/) manage Playwright browsers for you
  * and offer a [`page`](https://playwright.dev/docs/api/class-page) instance you can
- * inject into the ability to {@apilink BrowseTheWebWithPlaywright}.
+ * inject into the ability to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/).
  *
- * Note that [Serenity/JS Playwright Test module](/api/playwright-test/)
- * automatically configures all your {@apilink Actor|actors}
- * with an ability to {@apilink BrowseTheWebWithPlaywright},
- * so you don't need to do it by hand unless you want to override the {@apilink SerenityOptions|default configuration}.
+ * Note that [Serenity/JS Playwright Test module](https://serenity-js.org/api/playwright-test/)
+ * automatically configures all your [actors](https://serenity-js.org/api/core/class/Actor/)
+ * with an ability to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/),
+ * so you don't need to do it by hand unless you want to override the [default configuration](https://serenity-js.org/api/playwright-test/interface/SerenityOptions/).
  *
- * The example below demonstrates how to use the {@apilink BrowseTheWebWithPlaywright.usingPage} API and
- * override the default {@apilink Cast} of actors.
+ * The example below demonstrates how to use the [`BrowseTheWebWithPlaywright.usingPage`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/#usingPage) API and
+ * override the default [cast](https://serenity-js.org/api/core/class/Cast/) of actors.
  *
@@ -120,8 +120,9 @@ * ```ts title="specs/example.spec.ts"
  *
- * If you're using Serenity/JS with [Playwright Test](/handbook/test-runners/playwright-test/),
+ * If you're using Serenity/JS with [Playwright Test](https://serenity-js.org/handbook/test-runners/playwright-test/),
  * Serenity/JS will automatically pick up your configuration from the [`playwright.config.ts`](https://playwright.dev/docs/test-configuration) file.
  *
- * With other [test runners](/handbook/test-runners/), you can configure Playwright by:
+ * With other [test runners](https://serenity-js.org/handbook/test-runners/), you can configure Playwright by:
  * - providing the browser-level configuration when calling [`BrowserType.launch`](https://playwright.dev/docs/api/class-browsertype#browser-type-launch),
- * - providing the browser context-level {@link PlaywrightOptions} when initialising the ability to `BrowseTheWebWithPlaywright`.
+ * - providing the browser context-level [`PlaywrightOptions`](https://serenity-js.org/api/playwright/interface/PlaywrightOptions/)
+ * when initialising the ability to `BrowseTheWebWithPlaywright`.
  *
@@ -166,3 +167,3 @@ * The code snippet below demonstrates how to configure the browser and some popular browser context options,
  *
- * Note that in addition to all the standard Playwright BrowserContextOptions, you can also provide several others defined in Serenity/JS {@apilink PlaywrightOptions}, such as:
+ * Note that in addition to all the standard Playwright BrowserContextOptions, you can also provide several others defined in Serenity/JS [`PlaywrightOptions`](https://serenity-js.org/api/playwright/interface/PlaywrightOptions/), such as:
  * - `defaultNavigationTimeout`, which changes the default maximum navigation timeout for the browser context,
@@ -174,5 +175,5 @@ * - `defaultTimeout`, which changes the default maximum time for all Playwright methods accepting the `timeout` option.
  * - [Playwright website](https://playwright.dev/)
- * - {@apilink BrowseTheWeb}
- * - {@apilink Ability}
- * - {@apilink Actor}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
  *
@@ -189,7 +190,7 @@ * @group Abilities
     /**
-     * Automatically closes any open {@apilink Page|Pages} when the {@apilink SceneFinishes}
+     * Automatically closes any open [pages](https://serenity-js.org/api/web/class/Page/) when the [SceneFinishes](https://serenity-js.org/api/core-events/class/SceneFinishes/)
      *
      * #### Learn more
-     * - {@apilink PlaywrightBrowsingSession.closeAllPages}
-     * - {@apilink Discardable}
+     * - [`PlaywrightBrowsingSession.closeAllPages`](https://serenity-js.org/api/playwright/class/PlaywrightBrowsingSession/#closeAllPages)
+     * - [`Discardable`](https://serenity-js.org/api/core/interface/Discardable/)
      */
@@ -196,0 +197,0 @@ async discard() {

lib/screenplay/models/locators/PlaywrightLocator.d.ts

@@ -6,3 +6,3 @@ import type { PageElement, RootLocator, Selector } from '@serenity-js/web';
 /**
- * Playwright-specific implementation of {@apilink Locator}.
+ * Playwright-specific implementation of [`Locator`](https://serenity-js.org/api/web/class/Locator/).
  *
@@ -9,0 +9,0 @@ * @group Models

lib/screenplay/models/locators/PlaywrightLocator.js

@@ -10,3 +10,3 @@ "use strict";
 /**
- * Playwright-specific implementation of {@apilink Locator}.
+ * Playwright-specific implementation of [`Locator`](https://serenity-js.org/api/web/class/Locator/).
  *
@@ -13,0 +13,0 @@ * @group Models

lib/screenplay/models/locators/PlaywrightRootLocator.d.ts

@@ -5,3 +5,3 @@ import { RootLocator } from '@serenity-js/web';
 /**
- * Playwright-specific implementation of {@apilink RootLocator}.
+ * Playwright-specific implementation of [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/).
  *
@@ -8,0 +8,0 @@ * @group Models

lib/screenplay/models/locators/PlaywrightRootLocator.js

@@ -8,3 +8,3 @@ "use strict";
 /**
- * Playwright-specific implementation of {@apilink RootLocator}.
+ * Playwright-specific implementation of [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/).
  *
@@ -11,0 +11,0 @@ * @group Models

lib/screenplay/models/PlaywrightBrowsingSession.d.ts

@@ -8,3 +8,3 @@ import type { BrowserCapabilities } from '@serenity-js/web';
 /**
- * Playwright-specific implementation of {@apilink BrowsingSession}.
+ * Playwright-specific implementation of [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
  *
@@ -20,3 +20,3 @@ * @group Models
     /**
-     * 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.
      *
@@ -23,0 +23,0 @@ * **Please note** that since Playwright does not expose information about the operating system

lib/screenplay/models/PlaywrightBrowsingSession.js

@@ -9,3 +9,3 @@ "use strict";
 /**
- * Playwright-specific implementation of {@apilink BrowsingSession}.
+ * Playwright-specific implementation of [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
  *
@@ -12,0 +12,0 @@ * @group Models

lib/screenplay/models/PlaywrightCookie.d.ts

@@ -5,3 +5,3 @@ import type { CookieData } from '@serenity-js/web';
 /**
- * Playwright-specific implementation of {@apilink Cookie}.
+ * Playwright-specific implementation of [`Cookie`](https://serenity-js.org/api/web/class/Cookie/).
  *
@@ -8,0 +8,0 @@ * @group Models

lib/screenplay/models/PlaywrightCookie.js

@@ -8,3 +8,3 @@ "use strict";
 /**
- * Playwright-specific implementation of {@apilink Cookie}.
+ * Playwright-specific implementation of [`Cookie`](https://serenity-js.org/api/web/class/Cookie/).
  *
@@ -11,0 +11,0 @@ * @group Models

lib/screenplay/models/PlaywrightModalDialogHandler.d.ts

 import { ModalDialogHandler } from '@serenity-js/web';
 import type * as playwright from 'playwright-core';
 /**
- * Playwright-specific implementation of {@apilink ModalDialogHandler}.
+ * Playwright-specific implementation of [`ModalDialogHandler`](https://serenity-js.org/api/web/class/ModalDialogHandler/).
  *
@@ -6,0 +6,0 @@ * @group Models

lib/screenplay/models/PlaywrightModalDialogHandler.js

@@ -6,3 +6,3 @@ "use strict";
 /**
- * Playwright-specific implementation of {@apilink ModalDialogHandler}.
+ * Playwright-specific implementation of [`ModalDialogHandler`](https://serenity-js.org/api/web/class/ModalDialogHandler/).
  *
@@ -9,0 +9,0 @@ * @group Models

lib/screenplay/models/PlaywrightPage.d.ts

@@ -11,3 +11,3 @@ /// <reference types="node" />
 /**
- * Playwright-specific implementation of {@apilink Page}.
+ * Playwright-specific implementation of [`Page`](https://serenity-js.org/api/web/class/Page/).
  *
@@ -14,0 +14,0 @@ * @group Models

lib/screenplay/models/PlaywrightPage.js

@@ -36,3 +36,3 @@ "use strict";
 /**
- * Playwright-specific implementation of {@apilink Page}.
+ * Playwright-specific implementation of [`Page`](https://serenity-js.org/api/web/class/Page/).
  *
@@ -39,0 +39,0 @@ * @group Models

lib/screenplay/models/PlaywrightPageElement.d.ts

@@ -5,3 +5,3 @@ import type { SwitchableOrigin } from '@serenity-js/web';
 /**
- * Playwright-specific implementation of {@apilink PageElement}.
+ * Playwright-specific implementation of [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
@@ -8,0 +8,0 @@ * @group Models

lib/screenplay/models/PlaywrightPageElement.js

@@ -32,3 +32,3 @@ "use strict";
 /**
- * Playwright-specific implementation of {@apilink PageElement}.
+ * Playwright-specific implementation of [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
@@ -35,0 +35,0 @@ * @group Models

package.json

 {
   "name": "@serenity-js/playwright",
-  "version": "3.25.0",
+  "version": "3.25.1",
   "description": "Serenity/JS Screenplay Pattern library for Playwright",
@@ -47,4 +47,4 @@ "author": {
   "dependencies": {
-    "@serenity-js/core": "3.25.0",
-    "@serenity-js/web": "3.25.0",
+    "@serenity-js/core": "3.25.1",
+    "@serenity-js/web": "3.25.1",
     "playwright-core": "1.45.1",
@@ -63,3 +63,3 @@ "tiny-types": "1.22.0"
   },
-  "gitHead": "22657b685b6002f75b2569db54f4bea31ab91d12"
+  "gitHead": "450b994115cf9f1a1547ef92ac9387e0c57821ce"
 }

README.md

@@ -20,3 +20,3 @@ # Serenity/JS
 - 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)!
@@ -23,0 +23,0 @@

src/PlaywrightOptions.ts

 import type * as playwright from 'playwright-core';
 
 /**
- * Playwright-specific options used to configure the ability to {@apilink BrowseTheWebWithPlaywright}
+ * Playwright-specific options used to configure the ability to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
  *
@@ -14,3 +14,3 @@ * ## Learn more
     /**
-     * Changes the default maximum navigation time for the browser context used by {@apilink BrowseTheWebWithPlaywright}
+     * Changes the default maximum navigation time for the browser context used by [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/)
      *
@@ -17,0 +17,0 @@ * #### Learn more

src/screenplay/abilities/BrowseTheWebWithPlaywright.ts

@@ -12,9 +12,9 @@ import type { Discardable } from '@serenity-js/core';
 /**
- * This implementation of the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * enables the {@apilink Actor} to interact with web front-ends using [Playwright](https://playwright.dev/).
+ * This implementation of the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * enables the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to interact with web front-ends using [Playwright](https://playwright.dev/).
  *
  * ## Using Playwright to `BrowseTheWeb`
  *
- * In the example below, we configure the ability to {@apilink BrowseTheWebWithPlaywright} with a Playwright
- * [`Browser`](https://playwright.dev/docs/api/class-browser) so that Serenity/JS {@apilink Actor|actors}
+ * In the example below, we configure the ability to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/) with a Playwright
+ * [`Browser`](https://playwright.dev/docs/api/class-browser) so that Serenity/JS [actors](https://serenity-js.org/api/core/class/Actor/)
  * can create a new [`BrowserContext`](https://playwright.dev/docs/api/class-browsercontext) and
@@ -24,3 +24,3 @@ * instantiate Playwright [`page`s](https://playwright.dev/docs/api/class-page) as and when needed.
  * This configuration allows Serenity/JS to control the process of launching and shutting down browser instances
- * and is useful when your test runner, e.g. [Cucumber.js](/api/cucumber), doesn't offer this functionality.
+ * and is useful when your test runner, e.g. [Cucumber.js](https://serenity-js.org/api/cucumber), doesn't offer this functionality.
  *
@@ -51,13 +51,13 @@ * ```ts
  *
- * Test runners like [Playwright Test](/api/playwright-test/) manage Playwright browsers for you
+ * Test runners like [Playwright Test](https://serenity-js.org/api/playwright-test/) manage Playwright browsers for you
  * and offer a [`page`](https://playwright.dev/docs/api/class-page) instance you can
- * inject into the ability to {@apilink BrowseTheWebWithPlaywright}.
+ * inject into the ability to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/).
  *
- * Note that [Serenity/JS Playwright Test module](/api/playwright-test/)
- * automatically configures all your {@apilink Actor|actors}
- * with an ability to {@apilink BrowseTheWebWithPlaywright},
- * so you don't need to do it by hand unless you want to override the {@apilink SerenityOptions|default configuration}.
+ * Note that [Serenity/JS Playwright Test module](https://serenity-js.org/api/playwright-test/)
+ * automatically configures all your [actors](https://serenity-js.org/api/core/class/Actor/)
+ * with an ability to [`BrowseTheWebWithPlaywright`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/),
+ * so you don't need to do it by hand unless you want to override the [default configuration](https://serenity-js.org/api/playwright-test/interface/SerenityOptions/).
  *
- * The example below demonstrates how to use the {@apilink BrowseTheWebWithPlaywright.usingPage} API and
- * override the default {@apilink Cast} of actors.
+ * The example below demonstrates how to use the [`BrowseTheWebWithPlaywright.usingPage`](https://serenity-js.org/api/playwright/class/BrowseTheWebWithPlaywright/#usingPage) API and
+ * override the default [cast](https://serenity-js.org/api/core/class/Cast/) of actors.
  *
@@ -101,8 +101,9 @@ * ```ts title="specs/example.spec.ts"
  *
- * If you're using Serenity/JS with [Playwright Test](/handbook/test-runners/playwright-test/),
+ * If you're using Serenity/JS with [Playwright Test](https://serenity-js.org/handbook/test-runners/playwright-test/),
  * Serenity/JS will automatically pick up your configuration from the [`playwright.config.ts`](https://playwright.dev/docs/test-configuration) file.
  *
- * With other [test runners](/handbook/test-runners/), you can configure Playwright by:
+ * With other [test runners](https://serenity-js.org/handbook/test-runners/), you can configure Playwright by:
  * - providing the browser-level configuration when calling [`BrowserType.launch`](https://playwright.dev/docs/api/class-browsertype#browser-type-launch),
- * - providing the browser context-level {@link PlaywrightOptions} when initialising the ability to `BrowseTheWebWithPlaywright`.
+ * - providing the browser context-level [`PlaywrightOptions`](https://serenity-js.org/api/playwright/interface/PlaywrightOptions/)
+ * when initialising the ability to `BrowseTheWebWithPlaywright`.
  *
@@ -147,3 +148,3 @@ * The code snippet below demonstrates how to configure the browser and some popular browser context options,
  *
- * Note that in addition to all the standard Playwright BrowserContextOptions, you can also provide several others defined in Serenity/JS {@apilink PlaywrightOptions}, such as:
+ * Note that in addition to all the standard Playwright BrowserContextOptions, you can also provide several others defined in Serenity/JS [`PlaywrightOptions`](https://serenity-js.org/api/playwright/interface/PlaywrightOptions/), such as:
  * - `defaultNavigationTimeout`, which changes the default maximum navigation timeout for the browser context,
@@ -155,5 +156,5 @@ * - `defaultTimeout`, which changes the default maximum time for all Playwright methods accepting the `timeout` option.
  * - [Playwright website](https://playwright.dev/)
- * - {@apilink BrowseTheWeb}
- * - {@apilink Ability}
- * - {@apilink Actor}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
  *
@@ -173,7 +174,7 @@ * @group Abilities
     /**
-     * Automatically closes any open {@apilink Page|Pages} when the {@apilink SceneFinishes}
+     * Automatically closes any open [pages](https://serenity-js.org/api/web/class/Page/) when the [SceneFinishes](https://serenity-js.org/api/core-events/class/SceneFinishes/)
      *
      * #### Learn more
-     * - {@apilink PlaywrightBrowsingSession.closeAllPages}
-     * - {@apilink Discardable}
+     * - [`PlaywrightBrowsingSession.closeAllPages`](https://serenity-js.org/api/playwright/class/PlaywrightBrowsingSession/#closeAllPages)
+     * - [`Discardable`](https://serenity-js.org/api/core/interface/Discardable/)
      */
@@ -180,0 +181,0 @@ async discard(): Promise<void> {

src/screenplay/models/locators/PlaywrightLocator.ts

@@ -12,3 +12,3 @@ import { f, LogicError } from '@serenity-js/core';
 /**
- * Playwright-specific implementation of {@apilink Locator}.
+ * Playwright-specific implementation of [`Locator`](https://serenity-js.org/api/web/class/Locator/).
  *
@@ -15,0 +15,0 @@ * @group Models

src/screenplay/models/locators/PlaywrightRootLocator.ts

@@ -9,3 +9,3 @@ import { RootLocator } from '@serenity-js/web';
 /**
- * Playwright-specific implementation of {@apilink RootLocator}.
+ * Playwright-specific implementation of [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/).
  *
@@ -12,0 +12,0 @@ * @group Models

src/screenplay/models/PlaywrightBrowsingSession.ts

@@ -11,3 +11,3 @@ import { CorrelationId } from '@serenity-js/core/lib/model';
 /**
- * Playwright-specific implementation of {@apilink BrowsingSession}.
+ * Playwright-specific implementation of [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
  *
@@ -29,3 +29,3 @@ * @group Models
     /**
-     * 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.
      *
@@ -32,0 +32,0 @@ * **Please note** that since Playwright does not expose information about the operating system

src/screenplay/models/PlaywrightCookie.ts

@@ -8,3 +8,3 @@ import { Timestamp } from '@serenity-js/core';
 /**
- * Playwright-specific implementation of {@apilink Cookie}.
+ * Playwright-specific implementation of [`Cookie`](https://serenity-js.org/api/web/class/Cookie/).
  *
@@ -11,0 +11,0 @@ * @group Models

src/screenplay/models/PlaywrightModalDialogHandler.ts

@@ -6,3 +6,3 @@ import type { ModalDialog} from '@serenity-js/web';
 /**
- * Playwright-specific implementation of {@apilink ModalDialogHandler}.
+ * Playwright-specific implementation of [`ModalDialogHandler`](https://serenity-js.org/api/web/class/ModalDialogHandler/).
  *
@@ -9,0 +9,0 @@ * @group Models

src/screenplay/models/PlaywrightPage.ts

@@ -17,3 +17,3 @@ import { List, LogicError, type QuestionAdapter } from '@serenity-js/core';
 /**
- * Playwright-specific implementation of {@apilink Page}.
+ * Playwright-specific implementation of [`Page`](https://serenity-js.org/api/web/class/Page/).
  *
@@ -20,0 +20,0 @@ * @group Models

src/screenplay/models/PlaywrightPageElement.ts

@@ -11,3 +11,3 @@ import { LogicError } from '@serenity-js/core';
 /**
- * Playwright-specific implementation of {@apilink PageElement}.
+ * Playwright-specific implementation of [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
@@ -14,0 +14,0 @@ * @group Models

No alert changes

Improved metrics

Total package byte prevSize

216096

increased by2.36%

Lines of code

2852

increased by0.11%

Dependency changes

• + Added@serenity-js/assertions@3.25.1(transitive)

• + Added@serenity-js/core@3.25.1(transitive)

• + Added@serenity-js/web@3.25.1(transitive)

• - Removed@serenity-js/assertions@3.25.0(transitive)

• - Removed@serenity-js/core@3.25.0(transitive)

• - Removed@serenity-js/web@3.25.0(transitive)

• Updated@serenity-js/core@3.25.1

• Updated@serenity-js/web@3.25.1