@serenity-js/playwright 3.25.0 → 3.25.1

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [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 Playwright

package/lib/PlaywrightOptions.d.ts

@@ -1,6 +1,6 @@
 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/)
  *
  * ## Learn more
  * - [Playwright `Browser.newContext` options](https://playwright.dev/docs/api/class-browser#browser-new-context)
@@ -9,7 +9,7 @@ import type * as playwright from 'playwright-core';
  */
 export interface PlaywrightOptions extends playwright.BrowserContextOptions {
     /**
-     * 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/)
      *
      * #### Learn more
      * - [Playwright `browserContext.setDefaultNavigationTimeout(timeout)`](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-navigation-timeout)

package/lib/screenplay/abilities/BrowseTheWebWithPlaywright.d.ts

@@ -3,18 +3,18 @@ import { BrowseTheWeb } from '@serenity-js/web';
 import * as playwright from 'playwright-core';
 import type { PlaywrightOptions } from '../../PlaywrightOptions';
 /**
- * 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
  * 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.
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -40,17 +40,17 @@ import type { PlaywrightOptions } from '../../PlaywrightOptions';
  *
  * ## Using `BrowseTheWeb` with an existing Playwright `page`
  *
- * 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.
  *
  * ```ts title="specs/example.spec.ts"
  * import { describe, it, test } from '@playwright/playwright-test'
@@ -89,12 +89,13 @@ import type { PlaywrightOptions } from '../../PlaywrightOptions';
  *
  * ## Configuring Playwright
  *
- * 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`.
  *
  * The code snippet below demonstrates how to configure the browser and some popular browser context options,
  * such as
@@ -134,16 +135,16 @@ import type { PlaywrightOptions } from '../../PlaywrightOptions';
  *   )
  * ```
  *
- * 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,
  * - `defaultTimeout`, which changes the default maximum time for all Playwright methods accepting the `timeout` option.
  *
  * ## Learn more
  * - [Full list of Playwright `BrowserContextOptions`](https://playwright.dev/docs/api/class-browser#browser-new-context)
  * - [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/)
  *
  * @group Abilities
  */
@@ -151,11 +152,11 @@ export declare class BrowseTheWebWithPlaywright extends BrowseTheWeb<playwright.
     static using(browser: playwright.Browser, options?: PlaywrightOptions): BrowseTheWebWithPlaywright;
     static usingPage(page: playwright.Page, options?: PlaywrightOptions): BrowseTheWebWithPlaywright;
     /**
-     * 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/)
      */
     discard(): Promise<void>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"BrowseTheWebWithPlaywright.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWebWithPlaywright.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAE9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAMjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgJG;AACH,qBAAa,0BAA2B,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,CAAE,YAAW,WAAW;IAEnG,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,0BAA0B;IAIlG,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,0BAA0B;IAIhG;;;;;;OAMG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAGjC"}
+{"version":3,"file":"BrowseTheWebWithPlaywright.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWebWithPlaywright.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAE9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAMjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiJG;AACH,qBAAa,0BAA2B,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,CAAE,YAAW,WAAW;IAEnG,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,0BAA0B;IAIlG,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,0BAA0B;IAIhG;;;;;;OAMG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAGjC"}

package/lib/screenplay/abilities/BrowseTheWebWithPlaywright.js

@@ -28,18 +28,18 @@ const web_1 = require("@serenity-js/web");
 const playwright = __importStar(require("playwright-core"));
 const models_1 = require("../models");
 /**
- * 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
  * 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.
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -65,17 +65,17 @@ const models_1 = require("../models");
  *
  * ## Using `BrowseTheWeb` with an existing Playwright `page`
  *
- * 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.
  *
  * ```ts title="specs/example.spec.ts"
  * import { describe, it, test } from '@playwright/playwright-test'
@@ -114,12 +114,13 @@ const models_1 = require("../models");
  *
  * ## Configuring Playwright
  *
- * 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`.
  *
  * The code snippet below demonstrates how to configure the browser and some popular browser context options,
  * such as
@@ -159,16 +160,16 @@ const models_1 = require("../models");
  *   )
  * ```
  *
- * 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,
  * - `defaultTimeout`, which changes the default maximum time for all Playwright methods accepting the `timeout` option.
  *
  * ## Learn more
  * - [Full list of Playwright `BrowserContextOptions`](https://playwright.dev/docs/api/class-browser#browser-new-context)
  * - [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/)
  *
  * @group Abilities
  */
@@ -180,11 +181,11 @@ class BrowseTheWebWithPlaywright extends web_1.BrowseTheWeb {
         return new BrowseTheWebWithPlaywright(new models_1.PlaywrightBrowsingSessionWithPage(page, options, playwright.selectors));
     }
     /**
-     * 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/)
      */
     async discard() {
         await this.session.closeAllPages();

package/lib/screenplay/abilities/BrowseTheWebWithPlaywright.js.map

@@ -1 +1 @@
-{"version":3,"file":"BrowseTheWebWithPlaywright.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWebWithPlaywright.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,0CAAgD;AAChD,4DAA8C;AAG9C,sCAGmB;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgJG;AACH,MAAa,0BAA2B,SAAQ,kBAAgC;IAE5E,MAAM,CAAC,KAAK,CAAC,OAA2B,EAAE,OAA2B;QACjE,OAAO,IAAI,0BAA0B,CAAC,IAAI,6CAAoC,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5H,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,IAAqB,EAAE,OAA2B;QAC/D,OAAO,IAAI,0BAA0B,CAAC,IAAI,0CAAiC,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IACtH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO;QACT,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;IACvC,CAAC;CACJ;AApBD,gEAoBC"}
+{"version":3,"file":"BrowseTheWebWithPlaywright.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/BrowseTheWebWithPlaywright.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,0CAAgD;AAChD,4DAA8C;AAG9C,sCAGmB;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiJG;AACH,MAAa,0BAA2B,SAAQ,kBAAgC;IAE5E,MAAM,CAAC,KAAK,CAAC,OAA2B,EAAE,OAA2B;QACjE,OAAO,IAAI,0BAA0B,CAAC,IAAI,6CAAoC,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5H,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,IAAqB,EAAE,OAA2B;QAC/D,OAAO,IAAI,0BAA0B,CAAC,IAAI,0CAAiC,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IACtH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO;QACT,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;IACvC,CAAC;CACJ;AApBD,gEAoBC"}

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

@@ -5,7 +5,7 @@ import { type PlaywrightOptions } from '../../PlaywrightOptions';
 import { SerenitySelectorEngines } from '../../selector-engines';
 import { PlaywrightPage } from '../models';
 /**
- * Playwright-specific implementation of {@apilink BrowsingSession}.
+ * Playwright-specific implementation of [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
  *
  * @group Models
  */
@@ -16,7 +16,7 @@ export declare abstract class PlaywrightBrowsingSession extends BrowsingSession<
     private currentPlaywrightBrowserContext;
     protected constructor(browserContextOptions: PlaywrightOptions, selectors: playwright.Selectors);
     /**
-     * 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.
      *
      * **Please note** that since Playwright does not expose information about the operating system
      * the tests are running on, **Serenity/JS assumes that the tests are running locally**

package/lib/screenplay/models/PlaywrightBrowsingSession.js

@@ -6,7 +6,7 @@ const web_1 = require("@serenity-js/web");
 const selector_engines_1 = require("../../selector-engines");
 const models_1 = require("../models");
 /**
- * Playwright-specific implementation of {@apilink BrowsingSession}.
+ * Playwright-specific implementation of [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
  *
  * @group Models
  */

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

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

package/lib/screenplay/models/PlaywrightCookie.js

@@ -5,7 +5,7 @@ const core_1 = require("@serenity-js/core");
 const web_1 = require("@serenity-js/web");
 const tiny_types_1 = require("tiny-types");
 /**
- * Playwright-specific implementation of {@apilink Cookie}.
+ * Playwright-specific implementation of [`Cookie`](https://serenity-js.org/api/web/class/Cookie/).
  *
  * @group Models
  */

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

@@ -1,7 +1,7 @@
 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/).
  *
  * @group Models
  */

package/lib/screenplay/models/PlaywrightModalDialogHandler.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlaywrightModalDialogHandler = void 0;
 const web_1 = require("@serenity-js/web");
 /**
- * Playwright-specific implementation of {@apilink ModalDialogHandler}.
+ * Playwright-specific implementation of [`ModalDialogHandler`](https://serenity-js.org/api/web/class/ModalDialogHandler/).
  *
  * @group Models
  */

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

@@ -8,7 +8,7 @@ import { URL } from 'url';
 import type { PlaywrightOptions } from '../../PlaywrightOptions';
 import type { PlaywrightBrowsingSession } from './PlaywrightBrowsingSession';
 /**
- * Playwright-specific implementation of {@apilink Page}.
+ * Playwright-specific implementation of [`Page`](https://serenity-js.org/api/web/class/Page/).
  *
  * @group Models
  */

package/lib/screenplay/models/PlaywrightPage.js

@@ -33,7 +33,7 @@ const locators_1 = require("./locators");
 const PlaywrightModalDialogHandler_1 = require("./PlaywrightModalDialogHandler");
 const PlaywrightPageElement_1 = require("./PlaywrightPageElement");
 /**
- * Playwright-specific implementation of {@apilink Page}.
+ * Playwright-specific implementation of [`Page`](https://serenity-js.org/api/web/class/Page/).
  *
  * @group Models
  */

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

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

package/lib/screenplay/models/PlaywrightPageElement.js

@@ -29,7 +29,7 @@ const web_1 = require("@serenity-js/web");
 const scripts = __importStar(require("@serenity-js/web/lib/scripts"));
 const tiny_types_1 = require("tiny-types");
 /**
- * Playwright-specific implementation of {@apilink PageElement}.
+ * Playwright-specific implementation of [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * @group Models
  */

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

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

package/lib/screenplay/models/locators/PlaywrightLocator.js

@@ -7,7 +7,7 @@ const selector_engines_1 = require("../../../selector-engines");
 const promised_1 = require("../../promised");
 const PlaywrightPageElement_1 = require("../PlaywrightPageElement");
 /**
- * Playwright-specific implementation of {@apilink Locator}.
+ * Playwright-specific implementation of [`Locator`](https://serenity-js.org/api/web/class/Locator/).
  *
  * @group Models
  */

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

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

package/lib/screenplay/models/locators/PlaywrightRootLocator.js

@@ -5,7 +5,7 @@ const web_1 = require("@serenity-js/web");
 const tiny_types_1 = require("tiny-types");
 const promised_1 = require("../../promised");
 /**
- * Playwright-specific implementation of {@apilink RootLocator}.
+ * Playwright-specific implementation of [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/).
  *
  * @group Models
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/playwright",
-  "version": "3.25.0",
+  "version": "3.25.1",
   "description": "Serenity/JS Screenplay Pattern library for Playwright",
   "author": {
     "name": "Jan Molak",
@@ -44,8 +44,8 @@
     "node": "^16.13 || ^18.12 || ^20"
   },
   "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",
     "tiny-types": "1.22.0"
   },
@@ -59,5 +59,5 @@
     "ts-node": "10.9.2",
     "typescript": "5.2.2"
   },
-  "gitHead": "22657b685b6002f75b2569db54f4bea31ab91d12"
+  "gitHead": "450b994115cf9f1a1547ef92ac9387e0c57821ce"
 }

package/src/PlaywrightOptions.ts

@@ -1,7 +1,7 @@
 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/)
  *
  * ## Learn more
  * - [Playwright `Browser.newContext` options](https://playwright.dev/docs/api/class-browser#browser-new-context)
@@ -11,7 +11,7 @@ import type * as playwright from 'playwright-core';
 export interface PlaywrightOptions extends playwright.BrowserContextOptions {
 
     /**
-     * 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/)
      *
      * #### Learn more
      * - [Playwright `browserContext.setDefaultNavigationTimeout(timeout)`](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-navigation-timeout)

package/src/screenplay/abilities/BrowseTheWebWithPlaywright.ts

@@ -9,18 +9,18 @@ import {
 } from '../models';
 
 /**
- * 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
  * 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.
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -46,17 +46,17 @@ import {
  *
  * ## Using `BrowseTheWeb` with an existing Playwright `page`
  *
- * 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.
  *
  * ```ts title="specs/example.spec.ts"
  * import { describe, it, test } from '@playwright/playwright-test'
@@ -95,12 +95,13 @@ import {
  *
  * ## Configuring Playwright
  *
- * 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`.
  *
  * The code snippet below demonstrates how to configure the browser and some popular browser context options,
  * such as
@@ -140,16 +141,16 @@ import {
  *   )
  * ```
  *
- * 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,
  * - `defaultTimeout`, which changes the default maximum time for all Playwright methods accepting the `timeout` option.
  *
  * ## Learn more
  * - [Full list of Playwright `BrowserContextOptions`](https://playwright.dev/docs/api/class-browser#browser-new-context)
  * - [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/)
  *
  * @group Abilities
  */
@@ -164,11 +165,11 @@ export class BrowseTheWebWithPlaywright extends BrowseTheWeb<playwright.Locator>
     }
 
     /**
-     * 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/)
      */
     async discard(): Promise<void> {
         await this.session.closeAllPages();

package/src/screenplay/models/PlaywrightBrowsingSession.ts

@@ -8,7 +8,7 @@ import { SerenitySelectorEngines } from '../../selector-engines';
 import { PlaywrightCookie, PlaywrightPage } from '../models';
 
 /**
- * Playwright-specific implementation of {@apilink BrowsingSession}.
+ * Playwright-specific implementation of [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
  *
  * @group Models
  */
@@ -25,7 +25,7 @@ export abstract class PlaywrightBrowsingSession extends BrowsingSession<Playwrig
     }
 
     /**
-     * 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.
      *
      * **Please note** that since Playwright does not expose information about the operating system
      * the tests are running on, **Serenity/JS assumes that the tests are running locally**

package/src/screenplay/models/PlaywrightCookie.ts

@@ -5,7 +5,7 @@ import type * as playwright from 'playwright-core';
 import { ensure, isDefined } from 'tiny-types';
 
 /**
- * Playwright-specific implementation of {@apilink Cookie}.
+ * Playwright-specific implementation of [`Cookie`](https://serenity-js.org/api/web/class/Cookie/).
  *
  * @group Models
  */

package/src/screenplay/models/PlaywrightModalDialogHandler.ts

@@ -3,7 +3,7 @@ import { AbsentModalDialog, AcceptedModalDialog, DismissedModalDialog, ModalDial
 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/).
  *
  * @group Models
  */

package/src/screenplay/models/PlaywrightPage.ts

@@ -14,7 +14,7 @@ import { PlaywrightModalDialogHandler } from './PlaywrightModalDialogHandler';
 import { PlaywrightPageElement } from './PlaywrightPageElement';
 
 /**
- * Playwright-specific implementation of {@apilink Page}.
+ * Playwright-specific implementation of [`Page`](https://serenity-js.org/api/web/class/Page/).
  *
  * @group Models
  */

package/src/screenplay/models/PlaywrightPageElement.ts

@@ -8,7 +8,7 @@ import { ensure, isDefined } from 'tiny-types';
 import type { PlaywrightLocator } from './locators';
 
 /**
- * Playwright-specific implementation of {@apilink PageElement}.
+ * Playwright-specific implementation of [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * @group Models
  */

package/src/screenplay/models/locators/PlaywrightLocator.ts

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

package/src/screenplay/models/locators/PlaywrightRootLocator.ts

@@ -6,7 +6,7 @@ import { ensure, isDefined } from 'tiny-types';
 import { promised } from '../../promised';
 
 /**
- * Playwright-specific implementation of {@apilink RootLocator}.
+ * Playwright-specific implementation of [`RootLocator`](https://serenity-js.org/api/web/class/RootLocator/).
  *
  * @group Models
  */