@serenity-js/web 3.25.0 → 3.25.2

package/lib/screenplay/interactions/Select.d.ts

@@ -1,19 +1,19 @@
 import { type Answerable, Interaction } from '@serenity-js/core';
 import type { PageElement } from '../models';
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to select an option from a [HTML `<select>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select),
  * either by its display name, or by value.
  *
  * ## Learn more
- * - {@apilink Selected}
+ * - [`Selected`](https://serenity-js.org/api/web/class/Selected/)
  *
  * @group Activities
  */
 export declare class Select {
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to select a single [`<option>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * with a given [`value`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option#attr-value).,
      *
@@ -54,19 +54,19 @@ export declare class Select {
      * ```
      *
      * #### Learn more
-     * - {@apilink Selected.valueOf}
-     * - {@apilink PageElement}
+     * - [`Selected.valueOf`](https://serenity-js.org/api/web/class/Selected/#valueOf)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param value
      *  A value of the [`option` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static value(value: Answerable<string>): {
         from: (pageElement: Answerable<PageElement>) => Interaction;
     };
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to select multiple [`<option>` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * identified by their [`value`s](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option#attr-value).
      *
@@ -108,19 +108,19 @@ export declare class Select {
      *
      * #### Learn more
      *
-     * - {@apilink Selected.valuesOf}
-     * - {@apilink PageElement}
+     * - [`Selected.valuesOf`](https://serenity-js.org/api/web/class/Selected/#valuesOf)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param values
      *  Values of the [`option` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static values(...values: Array<Answerable<string[] | string>>): {
         from: (pageElement: Answerable<PageElement>) => Interaction;
     };
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to select a single [`<option>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * with a given description.
      *
@@ -164,19 +164,19 @@ export declare class Select {
      * ```
      *
      * #### Learn more
-     * - {@apilink Selected.optionIn}
-     * - {@apilink PageElement}
+     * - [`Selected.optionIn`](https://serenity-js.org/api/web/class/Selected/#optionIn)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param value
      *  Text of the [`option` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static option(value: Answerable<string>): {
         from: (pageElement: Answerable<PageElement>) => Interaction;
     };
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to select multiple [`<option>` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * identified by their descriptions.
      *
@@ -221,12 +221,12 @@ export declare class Select {
      * ```
      *
      * #### Learn more
-     * - {@apilink Selected.optionsIn}
-     * - {@apilink PageElement}
+     * - [`Selected.optionsIn`](https://serenity-js.org/api/web/class/Selected/#optionsIn)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param values
      *  Text of the [`option` elements  ](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static options(...values: Array<Answerable<string[] | string>>): {
         from: (pageElement: Answerable<PageElement>) => Interaction;

package/lib/screenplay/interactions/Select.js

@@ -6,19 +6,19 @@ const io_1 = require("@serenity-js/core/lib/io");
 const stringified_1 = require("@serenity-js/core/lib/io/stringified");
 const models_1 = require("../models");
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
  * to select an option from a [HTML `<select>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select),
  * either by its display name, or by value.
  *
  * ## Learn more
- * - {@apilink Selected}
+ * - [`Selected`](https://serenity-js.org/api/web/class/Selected/)
  *
  * @group Activities
  */
 class Select {
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to select a single [`<option>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * with a given [`value`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option#attr-value).,
      *
@@ -59,12 +59,12 @@ class Select {
      * ```
      *
      * #### Learn more
-     * - {@apilink Selected.valueOf}
-     * - {@apilink PageElement}
+     * - [`Selected.valueOf`](https://serenity-js.org/api/web/class/Selected/#valueOf)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param value
      *  A value of the [`option` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static value(value) {
         return {
@@ -76,8 +76,8 @@ class Select {
         };
     }
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to select multiple [`<option>` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * identified by their [`value`s](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option#attr-value).
      *
@@ -119,12 +119,12 @@ class Select {
      *
      * #### Learn more
      *
-     * - {@apilink Selected.valuesOf}
-     * - {@apilink PageElement}
+     * - [`Selected.valuesOf`](https://serenity-js.org/api/web/class/Selected/#valuesOf)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param values
      *  Values of the [`option` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static values(...values) {
         return {
@@ -137,8 +137,8 @@ class Select {
         };
     }
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to select a single [`<option>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * with a given description.
      *
@@ -182,12 +182,12 @@ class Select {
      * ```
      *
      * #### Learn more
-     * - {@apilink Selected.optionIn}
-     * - {@apilink PageElement}
+     * - [`Selected.optionIn`](https://serenity-js.org/api/web/class/Selected/#optionIn)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param value
      *  Text of the [`option` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static option(value) {
         return {
@@ -199,8 +199,8 @@ class Select {
         };
     }
     /**
-     * Instantiates an {@apilink Interaction|interaction}
-     * that instructs the {@apilink Actor|actor}
+     * Instantiates an [interaction](https://serenity-js.org/api/core/class/Interaction/)
+     * that instructs the [actor](https://serenity-js.org/api/core/class/Actor/)
      * to select multiple [`<option>` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
      * identified by their descriptions.
      *
@@ -245,12 +245,12 @@ class Select {
      * ```
      *
      * #### Learn more
-     * - {@apilink Selected.optionsIn}
-     * - {@apilink PageElement}
+     * - [`Selected.optionsIn`](https://serenity-js.org/api/web/class/Selected/#optionsIn)
+     * - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
      *
      * @param values
      *  Text of the [`option` elements  ](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
-     *  for the {@apilink Actor} to select
+     *  for the [`Actor`](https://serenity-js.org/api/core/class/Actor/) to select
      */
     static options(...values) {
         return {

package/lib/screenplay/interactions/Switch.d.ts

@@ -2,17 +2,17 @@ import type { Activity, Answerable, AnswersQuestions, UsesAbilities } from '@ser
 import { Interaction, Task } from '@serenity-js/core';
 import type { Switchable } from '../models';
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to switch the context for future activities to a {@apilink Switchable}, such as a {@apilink Page} or a {@apilink PageElement}.
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to switch the context for future activities to a [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/), such as a [`Page`](https://serenity-js.org/api/web/class/Page/) or a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
- * Please note that when the {@apilink PageElement} implementing {@apilink Switchable} represents an {@apilink iframe},
- * using {@apilink Switch} will result in switching the top-level browsing context to that {@apilink iframe}.
+ * Please note that when the [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) implementing [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/) represents an [`iframe`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe),
+ * using [`Switch`](https://serenity-js.org/api/web/class/Switch/) will result in switching the top-level browsing context to that [`iframe`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe).
  *
- * When the {@apilink PageElement} represents any other [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement),
- * using {@apilink Switch} sets [`HTMLElement#focus`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus)
+ * When the [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) represents any other [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement),
+ * using [`Switch`](https://serenity-js.org/api/web/class/Switch/) sets [`HTMLElement#focus`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus)
  * on the specified element. Assuming it can be focused.
  *
- * **Note:** The focused element is the element which will receive keyboard {@apilink Press} events by default.
+ * **Note:** The focused element is the element which will receive keyboard [press](https://serenity-js.org/api/web/class/Press/) events by default.
  *
  * ## Perform activities in the context of an iframe
  *
@@ -95,27 +95,27 @@ import type { Switchable } from '../models';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink Switchable}
- * - {@apilink SwitchableOrigin}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
+ * - [`SwitchableOrigin`](https://serenity-js.org/api/web/interface/SwitchableOrigin/)
  *
  * @group Activities
  */
 export declare class Switch extends Interaction {
     private readonly switchable;
     /**
-     * Instructs the {@apilink Actor}
-     * to switch the context for future activities to a {@apilink Switchable},
-     * such as a {@apilink Page} or a {@apilink PageElement}.
+     * Instructs the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     * to switch the context for future activities to a [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/),
+     * such as a [`Page`](https://serenity-js.org/api/web/class/Page/) or a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
      *
      * @param switchable
      */
     static to(switchable: Answerable<Switchable>): Switch;
     protected constructor(switchable: Answerable<Switchable>);
     /**
-     * Instructs the {@apilink Actor}
-     * to switch the context for future activities to a {@apilink Switchable},
-     * such as a {@apilink Page} or a {@apilink PageElement},
+     * Instructs the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     * to switch the context for future activities to a [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/),
+     * such as a [`Page`](https://serenity-js.org/api/web/class/Page/) or a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/),
      * perform a sequence of `activities`, and then switch the context back.
      *
      * @param activities

package/lib/screenplay/interactions/Switch.js

@@ -3,17 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Switch = void 0;
 const core_1 = require("@serenity-js/core");
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to switch the context for future activities to a {@apilink Switchable}, such as a {@apilink Page} or a {@apilink PageElement}.
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/) who has the [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to switch the context for future activities to a [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/), such as a [`Page`](https://serenity-js.org/api/web/class/Page/) or a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
- * Please note that when the {@apilink PageElement} implementing {@apilink Switchable} represents an {@apilink iframe},
- * using {@apilink Switch} will result in switching the top-level browsing context to that {@apilink iframe}.
+ * Please note that when the [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) implementing [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/) represents an [`iframe`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe),
+ * using [`Switch`](https://serenity-js.org/api/web/class/Switch/) will result in switching the top-level browsing context to that [`iframe`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe).
  *
- * When the {@apilink PageElement} represents any other [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement),
- * using {@apilink Switch} sets [`HTMLElement#focus`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus)
+ * When the [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) represents any other [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement),
+ * using [`Switch`](https://serenity-js.org/api/web/class/Switch/) sets [`HTMLElement#focus`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus)
  * on the specified element. Assuming it can be focused.
  *
- * **Note:** The focused element is the element which will receive keyboard {@apilink Press} events by default.
+ * **Note:** The focused element is the element which will receive keyboard [press](https://serenity-js.org/api/web/class/Press/) events by default.
  *
  * ## Perform activities in the context of an iframe
  *
@@ -96,18 +96,18 @@ const core_1 = require("@serenity-js/core");
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink Switchable}
- * - {@apilink SwitchableOrigin}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/)
+ * - [`SwitchableOrigin`](https://serenity-js.org/api/web/interface/SwitchableOrigin/)
  *
  * @group Activities
  */
 class Switch extends core_1.Interaction {
     switchable;
     /**
-     * Instructs the {@apilink Actor}
-     * to switch the context for future activities to a {@apilink Switchable},
-     * such as a {@apilink Page} or a {@apilink PageElement}.
+     * Instructs the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     * to switch the context for future activities to a [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/),
+     * such as a [`Page`](https://serenity-js.org/api/web/class/Page/) or a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
      *
      * @param switchable
      */
@@ -119,9 +119,9 @@ class Switch extends core_1.Interaction {
         this.switchable = switchable;
     }
     /**
-     * Instructs the {@apilink Actor}
-     * to switch the context for future activities to a {@apilink Switchable},
-     * such as a {@apilink Page} or a {@apilink PageElement},
+     * Instructs the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     * to switch the context for future activities to a [`Switchable`](https://serenity-js.org/api/web/interface/Switchable/),
+     * such as a [`Page`](https://serenity-js.org/api/web/class/Page/) or a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/),
      * perform a sequence of `activities`, and then switch the context back.
      *
      * @param activities

package/lib/screenplay/interactions/TakeScreenshot.d.ts

@@ -1,10 +1,12 @@
 import type { Answerable, AnswersQuestions, CollectsArtifacts, UsesAbilities } from '@serenity-js/core';
 import { Interaction } from '@serenity-js/core';
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to take a screenshot and emit an {@apilink Artifact},
- * which can then be persisted by {@apilink ArtifactArchiver}
- * and reported by [Serenity BDD reporter](/api/serenity-bdd).
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/)
+ * who has the [ability](https://serenity-js.org/api/core/class/Ability/)
+ * to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to take a screenshot and emit an artifact,
+ * which can then be persisted by [`ArtifactArchiver`](https://serenity-js.org/api/core/class/ArtifactArchiver/)
+ * and reported by [Serenity BDD reporter](https://serenity-js.org/api/serenity-bdd).
  *
  * #### Taking a screenshot
  *
@@ -21,20 +23,19 @@ import { Interaction } from '@serenity-js/core';
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink CollectsArtifacts}
- * - {@apilink Artifact}
- * - {@apilink ArtifactArchiver}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`CollectsArtifacts`](https://serenity-js.org/api/core/interface/CollectsArtifacts/)
+ * - [`ArtifactArchiver`](https://serenity-js.org/api/core/class/ArtifactArchiver/)
  *
  * @group Activities
  */
 export declare class TakeScreenshot extends Interaction {
     private readonly name;
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param name
-     *  The name to give the emitted {@apilink Artifact}
+     *  The name to give the emitted artifact
      */
     static of(name: Answerable<string>): Interaction;
     protected constructor(name: Answerable<string>);

package/lib/screenplay/interactions/TakeScreenshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TakeScreenshot.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/TakeScreenshot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACxG,OAAO,EAAE,WAAW,EAAO,MAAM,mBAAmB,CAAC;AAKrD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAYrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAV3C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW;IAIhD,SAAS,aAA8B,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC;IAI/D;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;CAU9F"}
+{"version":3,"file":"TakeScreenshot.d.ts","sourceRoot":"","sources":["../../../src/screenplay/interactions/TakeScreenshot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACxG,OAAO,EAAE,WAAW,EAAO,MAAM,mBAAmB,CAAC;AAKrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAYrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAV3C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW;IAIhD,SAAS,aAA8B,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC;IAI/D;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;CAU9F"}

package/lib/screenplay/interactions/TakeScreenshot.js

@@ -5,10 +5,12 @@ const core_1 = require("@serenity-js/core");
 const model_1 = require("@serenity-js/core/lib/model");
 const abilities_1 = require("../abilities");
 /**
- * Instructs an {@apilink Actor|actor} who has the {@apilink Ability|ability} to {@apilink BrowseTheWeb}
- * to take a screenshot and emit an {@apilink Artifact},
- * which can then be persisted by {@apilink ArtifactArchiver}
- * and reported by [Serenity BDD reporter](/api/serenity-bdd).
+ * Instructs an [actor](https://serenity-js.org/api/core/class/Actor/)
+ * who has the [ability](https://serenity-js.org/api/core/class/Ability/)
+ * to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * to take a screenshot and emit an artifact,
+ * which can then be persisted by [`ArtifactArchiver`](https://serenity-js.org/api/core/class/ArtifactArchiver/)
+ * and reported by [Serenity BDD reporter](https://serenity-js.org/api/serenity-bdd).
  *
  * #### Taking a screenshot
  *
@@ -25,20 +27,19 @@ const abilities_1 = require("../abilities");
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb}
- * - {@apilink CollectsArtifacts}
- * - {@apilink Artifact}
- * - {@apilink ArtifactArchiver}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`CollectsArtifacts`](https://serenity-js.org/api/core/interface/CollectsArtifacts/)
+ * - [`ArtifactArchiver`](https://serenity-js.org/api/core/class/ArtifactArchiver/)
  *
  * @group Activities
  */
 class TakeScreenshot extends core_1.Interaction {
     name;
     /**
-     * Instantiates this {@apilink Interaction}.
+     * Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
      *
      * @param name
-     *  The name to give the emitted {@apilink Artifact}
+     *  The name to give the emitted artifact
      */
     static of(name) {
         return new TakeScreenshot(name);

package/lib/screenplay/interactions/TakeScreenshot.js.map

@@ -1 +1 @@
-{"version":3,"file":"TakeScreenshot.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/TakeScreenshot.ts"],"names":[],"mappings":";;;AACA,4CAAqD;AACrD,uDAA0D;AAE1D,4CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,cAAe,SAAQ,kBAAW;IAYJ;IAVvC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,IAAwB;QAC9B,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,YAAuC,IAAwB;QAC3D,KAAK,CAAC,IAAA,UAAG,EAAA,gCAAiC,IAAK,EAAE,CAAC,CAAC;QADhB,SAAI,GAAJ,IAAI,CAAoB;IAE/D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAA2D;QACvE,MAAM,IAAI,GAAY,MAAM,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QACjE,MAAM,UAAU,GAAM,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,IAAI,GAAY,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEpD,KAAK,CAAC,OAAO,CACT,aAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAC5B,IAAI,YAAI,CAAC,IAAI,CAAC,CACjB,CAAC;IACN,CAAC;CACJ;AA7BD,wCA6BC"}
+{"version":3,"file":"TakeScreenshot.js","sourceRoot":"","sources":["../../../src/screenplay/interactions/TakeScreenshot.ts"],"names":[],"mappings":";;;AACA,4CAAqD;AACrD,uDAA0D;AAE1D,4CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAa,cAAe,SAAQ,kBAAW;IAYJ;IAVvC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,IAAwB;QAC9B,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,YAAuC,IAAwB;QAC3D,KAAK,CAAC,IAAA,UAAG,EAAA,gCAAiC,IAAK,EAAE,CAAC,CAAC;QADhB,SAAI,GAAJ,IAAI,CAAoB;IAE/D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAA2D;QACvE,MAAM,IAAI,GAAY,MAAM,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QACjE,MAAM,UAAU,GAAM,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,IAAI,GAAY,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEpD,KAAK,CAAC,OAAO,CACT,aAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAC5B,IAAI,YAAI,CAAC,IAAI,CAAC,CACjB,CAAC;IACN,CAAC;CACJ;AA7BD,wCA6BC"}

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

@@ -3,7 +3,7 @@
  *
  * ## Learn more
  *
- * - {@apilink BrowseTheWeb.browserCapabilities}
+ * - [`BrowseTheWeb.browserCapabilities`](https://serenity-js.org/api/web/class/BrowseTheWeb/#browserCapabilities)
  *
  * @group Models
  */

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

@@ -14,41 +14,41 @@ export declare abstract class BrowsingSession<Page_Type extends Page> {
     protected readonly pages: Map<CorrelationId, Page_Type>;
     closePagesOtherThan(pageOfInterest: Page_Type): Promise<void>;
     /**
-     * Opens a new browser page and associates it with a {@apilink Page} object.
+     * Opens a new browser page and associates it with a [`Page`](https://serenity-js.org/api/web/class/Page/) object.
      */
     protected abstract registerCurrentPage(): Promise<Page_Type>;
     /**
-     * Returns {@apilink BrowserCapabilities|basic meta-data} about the browser associated with this browsing session.
+     * Returns [basic meta-data](https://serenity-js.org/api/web/interface/BrowserCapabilities/) about the browser associated with this browsing session.
      */
     abstract browserCapabilities(): Promise<BrowserCapabilities>;
     /**
-     * Returns a {@apilink Page} representing the currently active top-level browsing context.
+     * Returns a [`Page`](https://serenity-js.org/api/web/class/Page/) representing the currently active top-level browsing context.
      */
     currentPage(): Promise<Page_Type>;
     /**
-     * Registers specified {@apilink Page|pages} to be managed by this {@apilink BrowsingSession}.
+     * Registers specified [pages](https://serenity-js.org/api/web/class/Page/) to be managed by this [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
      *
      * @param pages
      */
     register(...pages: Page_Type[]): void;
     /**
-     * Informs this {@apilink BrowsingSession} that it should no longer manage {@apilink Page|pages}
+     * Informs this [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/) that it should no longer manage [pages](https://serenity-js.org/api/web/class/Page/)
      * identified by the given `pageIds`.
      *
      * @param pageIds
      */
     deregister(...pageIds: CorrelationId[]): void;
     /**
-     * Returns a {@apilink Page|pages} representing all the available
+     * Returns a [pages](https://serenity-js.org/api/web/class/Page/) representing all the available
      * top-level browsing context, e.g. all the open browser tabs.
      */
     allPages(): Promise<Array<Page_Type>>;
     /**
-     * Returns the ids of any {@apilink Page|pages} this {@apilink BrowsingSession} is aware of.
+     * Returns the ids of any [pages](https://serenity-js.org/api/web/class/Page/) this [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/) is aware of.
      */
     registeredPageIds(): Array<CorrelationId>;
     /**
-     * Informs the {@apilink BrowsingSession} that the "current page" has changed to `page`.
+     * Informs the [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/) that the "current page" has changed to `page`.
      *
      * Please note that different Web integration tools have a different definition of what a "current page" is.
      * For example, Selenium or WebdriverIO use a single "focused" window that a developer

package/lib/screenplay/models/BrowsingSession.js

@@ -22,7 +22,7 @@ class BrowsingSession {
         await this.changeCurrentPageTo(pageOfInterest);
     }
     /**
-     * Returns a {@apilink Page} representing the currently active top-level browsing context.
+     * Returns a [`Page`](https://serenity-js.org/api/web/class/Page/) representing the currently active top-level browsing context.
      */
     async currentPage() {
         if (!this.currentBrowserPage || !await this.currentBrowserPage.isPresent()) {
@@ -31,7 +31,7 @@ class BrowsingSession {
         return this.currentBrowserPage;
     }
     /**
-     * Registers specified {@apilink Page|pages} to be managed by this {@apilink BrowsingSession}.
+     * Registers specified [pages](https://serenity-js.org/api/web/class/Page/) to be managed by this [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/).
      *
      * @param pages
      */
@@ -41,7 +41,7 @@ class BrowsingSession {
         }
     }
     /**
-     * Informs this {@apilink BrowsingSession} that it should no longer manage {@apilink Page|pages}
+     * Informs this [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/) that it should no longer manage [pages](https://serenity-js.org/api/web/class/Page/)
      * identified by the given `pageIds`.
      *
      * @param pageIds
@@ -52,20 +52,20 @@ class BrowsingSession {
         }
     }
     /**
-     * Returns a {@apilink Page|pages} representing all the available
+     * Returns a [pages](https://serenity-js.org/api/web/class/Page/) representing all the available
      * top-level browsing context, e.g. all the open browser tabs.
      */
     async allPages() {
         return Array.from(this.pages.values());
     }
     /**
-     * Returns the ids of any {@apilink Page|pages} this {@apilink BrowsingSession} is aware of.
+     * Returns the ids of any [pages](https://serenity-js.org/api/web/class/Page/) this [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/) is aware of.
      */
     registeredPageIds() {
         return Array.from(this.pages.keys());
     }
     /**
-     * Informs the {@apilink BrowsingSession} that the "current page" has changed to `page`.
+     * Informs the [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/) that the "current page" has changed to `page`.
      *
      * Please note that different Web integration tools have a different definition of what a "current page" is.
      * For example, Selenium or WebdriverIO use a single "focused" window that a developer