@serenity-js/web 3.25.0 → 3.25.2

package/src/screenplay/questions/Text.ts

@@ -6,10 +6,10 @@ import type { PageElements } from '../models';
 import { PageElement } from '../models';
 
 /**
- * Uses the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to retrieve
+ * Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to retrieve
  * the visible (i.e. not hidden by CSS) [`innerText`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText) of:
- * - a given {@apilink PageElement}
- * - a group of {@apilink PageElements}
+ * - a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ * - a group of [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
  *
  * The result includes the visible text of any sub-elements, without any leading or trailing whitespace.
  *
@@ -24,7 +24,7 @@ import { PageElement } from '../models';
  * </ul>
  * ```
  *
- * ## Retrieve text of a single {@apilink PageElement}
+ * ## Retrieve text of a single [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -42,7 +42,7 @@ import { PageElement } from '../models';
  *   )
  * ```
  *
- * ## Retrieve text of multiple {@apilink PageElements}
+ * ## Retrieve text of multiple [`PageElement`](https://serenity-js.org/api/web/class/PageElements/)
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -62,7 +62,7 @@ import { PageElement } from '../models';
  *   )
  * ```
  *
- * ## Using as filter in {@apilink PageElements|Page Element Query Language}
+ * ## Using as filter in [Page Element Query Language](https://serenity-js.org/handbook/web-testing/page-element-query-language/)
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -85,22 +85,22 @@ import { PageElement } from '../models';
  * ```
  *
  * ## Learn more
- * - {@apilink BrowseTheWeb}
- * - {@apilink MetaQuestion}
- * - {@apilink QuestionAdapter}
- * - {@apilink Question}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/)
+ * - [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
+ * - [`Question`](https://serenity-js.org/api/core/class/Question/)
  *
  * @group Questions
  */
 export class Text {
 
     /**
-     * Instantiates a {@apilink Question} that uses
-     * the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to retrieve
-     * the text of a single {@apilink PageElement}.
+     * Instantiates a [`Question`](https://serenity-js.org/api/core/class/Question/) that uses
+     * the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to retrieve
+     * the text of a single [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
      *
      * #### Learn more
-     * - {@apilink MetaQuestion}
+     * - [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/)
      *
      * @param pageElement
      */
@@ -117,12 +117,12 @@ export class Text {
     }
 
     /**
-     * Instantiates a {@apilink Question} that uses
-     * the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to retrieve
-     * the text of a group of {@apilink PageElements}.
+     * Instantiates a [`Question`](https://serenity-js.org/api/core/class/Question/) that uses
+     * the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to retrieve
+     * the text of a group of [`PageElement`](https://serenity-js.org/api/web/class/PageElements/).
      *
      * #### Learn more
-     * - {@apilink MetaQuestion}
+     * - [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/)
      *
      * @param pageElements
      */

package/src/screenplay/questions/Value.ts

@@ -4,15 +4,15 @@ import { Question, the } from '@serenity-js/core';
 import { PageElement } from '../models';
 
 /**
- * Uses the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to retrieve
- * the `value` attribute of a given {@apilink PageElement}.
+ * Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to retrieve
+ * the `value` attribute of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
  *
  * ## Example widget
  * ```html
  * <input type="text" id="username" value="Alice" />
  * ```
  *
- * ## Retrieve the `value` of a given {@apilink PageElement}
+ * ## Retrieve the `value` of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -29,7 +29,7 @@ import { PageElement } from '../models';
  *   )
  * ```
  *
- * ## Using Value as {@apilink QuestionAdapter}
+ * ## Using Value as [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
  *
  * ```ts
  * import { actorCalled } from '@serenity-js/core'
@@ -50,22 +50,22 @@ import { PageElement } from '../models';
  * ```
  *
  * ## Learn more
- * - {@apilink BrowseTheWeb}
- * - {@apilink MetaQuestion}
- * - {@apilink QuestionAdapter}
- * - {@apilink Question}
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/)
+ * - [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
+ * - [`Question`](https://serenity-js.org/api/core/class/Question/)
  *
  * @group Questions
  */
 export class Value {
 
     /**
-     * Instantiates a {@apilink Question} that uses
-     * the {@apilink Actor|actor's} {@apilink Ability|ability} to {@apilink BrowseTheWeb} to retrieve
-     * the `value` attribute of a given {@apilink PageElement}.
+     * Instantiates a [`Question`](https://serenity-js.org/api/core/class/Question/) that uses
+     * the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to retrieve
+     * the `value` attribute of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
      *
      * #### Learn more
-     * - {@apilink MetaQuestion}
+     * - [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/)
      *
      * @param pageElement
      */

package/src/stage/crew/photographer/Photographer.ts

@@ -6,8 +6,9 @@ import type { Stage, StageCrewMember } from '@serenity-js/core/lib/stage';
 import * as strategies from './strategies';
 
 /**
- * The Photographer is a {@apilink StageCrewMember} who takes screenshots
- * using the web browser associated with the {@apilink Actor} that is currently {@apilink actorInTheSpotlight|in the spotlight}.
+ * The Photographer is a [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) who takes screenshots
+ * using the web browser associated with the [actor](https://serenity-js.org/api/core/class/Actor/) that is
+ * currently [in the spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/).
  *
  * ## Registering Photographer programmatically
  *
@@ -53,7 +54,7 @@ import * as strategies from './strategies';
  * ```
  *
  * #### Learn more
- * - {@apilink SerenityOptions}
+ * - [`SerenityOptions`](https://serenity-js.org/api/playwright-test/interface/SerenityOptions/)
  *
  * ## Using Photographer with WebdriverIO
  *
@@ -144,30 +145,30 @@ import * as strategies from './strategies';
  * ```
  *
  * ## Learn more
- * - {@apilink Stage}
- * - {@apilink StageCrewMember}
- * - {@apilink TakePhotosBeforeAndAfterInteractions}
- * - {@apilink TakePhotosOfFailures}
- * - {@apilink TakePhotosOfInteractions}
+ * - [`Stage`](https://serenity-js.org/api/core/class/Stage/)
+ * - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
+ * - [`TakePhotosBeforeAndAfterInteractions`](https://serenity-js.org/api/web/class/TakePhotosBeforeAndAfterInteractions/)
+ * - [`TakePhotosOfFailures`](https://serenity-js.org/api/web/class/TakePhotosOfFailures/)
+ * - [`TakePhotosOfInteractions`](https://serenity-js.org/api/web/class/TakePhotosOfInteractions/)
  *
  * @group Stage
  */
 export class Photographer implements StageCrewMember {
 
     /**
-     * Instantiates a new {@apilink Photographer} configured to take photos (screenshots)
-     * as per the specified {@apilink PhotoTakingStrategy}.
+     * Instantiates a new [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) configured to take photos (screenshots)
+     * as per the specified [`PhotoTakingStrategy`](https://serenity-js.org/api/web/class/PhotoTakingStrategy/).
      *
      * @param strategy
-     *  A no-arg constructor function that instantiates a {@apilink PhotoTakingStrategy}
+     *  A no-arg constructor function that instantiates a [`PhotoTakingStrategy`](https://serenity-js.org/api/web/class/PhotoTakingStrategy/)
      */
     static whoWill(strategy: new () => strategies.PhotoTakingStrategy): StageCrewMember {
         return new Photographer(new strategy());
     }
 
     /**
-     * Instantiates a new {@apilink Photographer} configured to take photos (screenshots)
-     * as per the specified {@apilink PhotoTakingStrategy}.
+     * Instantiates a new [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) configured to take photos (screenshots)
+     * as per the specified [`PhotoTakingStrategy`](https://serenity-js.org/api/web/class/PhotoTakingStrategy/).
      *
      * @param config
      */
@@ -195,10 +196,10 @@ export class Photographer implements StageCrewMember {
     }
 
     /**
-     * Assigns this {@apilink StageCrewMember} to a given {@apilink Stage}.
+     * Assigns this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) to a given [`Stage`](https://serenity-js.org/api/core/class/Stage/).
      *
      * @param stage
-     *  An instance of a {@apilink Stage} this {@apilink StageCrewMember} will be assigned to
+     *  An instance of a [`Stage`](https://serenity-js.org/api/core/class/Stage/) this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) will be assigned to
      */
     assignedTo(stage: Stage): StageCrewMember {
         this.stage = stage;
@@ -206,8 +207,8 @@ export class Photographer implements StageCrewMember {
     }
 
     /**
-     * Handles {@apilink DomainEvent} objects emitted by the {@apilink Stage}
-     * this {@apilink StageCrewMember} is assigned to.
+     * Handles [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects emitted by the [`Stage`](https://serenity-js.org/api/core/class/Stage/)
+     * this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) is assigned to.
      *
      * @param event
      */

package/src/stage/crew/photographer/strategies/PhotoTakingStrategy.ts

@@ -7,8 +7,8 @@ import { CorrelationId, Description, Name, Photo } from '@serenity-js/core/lib/m
 import { BrowseTheWeb } from '../../../../screenplay';
 
 /**
- * Configures the {@apilink Photographer} to take {@apilink Photo|photos}, a.k.a. screenshots,
- * of the {@apilink Activity} performed by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos, a.k.a. screenshots,
+ * of the [`Activity`](https://serenity-js.org/api/core/class/Activity/) performed by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/)
  * when desired conditions are met.
  *
  * @group Stage
@@ -16,12 +16,12 @@ import { BrowseTheWeb } from '../../../../screenplay';
 export abstract class PhotoTakingStrategy {
 
     /**
-     * Takes a photo of the web browser used by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}.
+     * Takes a photo of the web browser used by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/).
      *
      * #### Learn more
-     * - {@apilink ActivityStarts}
-     * - {@apilink ActivityFinished}
-     * - {@apilink Stage}
+     * - [ActivityStarts](https://serenity-js.org/api/core-events/class/ActivityStarts/)
+     * - [ActivityFinished](https://serenity-js.org/api/core-events/class/ActivityFinished/)
+     * - [`Stage`](https://serenity-js.org/api/core/class/Stage/)
      *
      * @param event
      * @param stage

package/src/stage/crew/photographer/strategies/TakePhotosBeforeAndAfterInteractions.ts

@@ -4,9 +4,9 @@ import { InteractionFinished, InteractionStarts } from '@serenity-js/core/lib/ev
 import { PhotoTakingStrategy } from './PhotoTakingStrategy';
 
 /**
- * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots) **both before and after**
- * every single {@apilink Interaction} performed
- * by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}.
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos (a.k.a. screenshots) **both before and after**
+ * every single [`Interaction`](https://serenity-js.org/api/core/class/Interaction/) performed
+ * by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/).
  *
  * **Please note** that this strategy will result in _a lot_ of screenshots being taken,
  * which will seriously affect the performance of your tests.

package/src/stage/crew/photographer/strategies/TakePhotosOfFailures.ts

@@ -5,9 +5,9 @@ import { ImplementationPending } from '@serenity-js/core/lib/model';
 import { PhotoTakingStrategy } from './PhotoTakingStrategy';
 
 /**
- * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots)
- * when then {@apilink Interaction} performed
- * by the {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos (a.k.a. screenshots)
+ * when then [`Interaction`](https://serenity-js.org/api/core/class/Interaction/) performed
+ * by the [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/)
  * results in an error.
  *
  * This strategy works best when you are interested in the screenshots only when

package/src/stage/crew/photographer/strategies/TakePhotosOfInteractions.ts

@@ -4,9 +4,9 @@ import { InteractionFinished } from '@serenity-js/core/lib/events';
 import { PhotoTakingStrategy } from './PhotoTakingStrategy';
 
 /**
- * Configures the {@apilink Photographer} to take photos (a.k.a. screenshots)
- * when then {@apilink Actor} in the {@apilink actorInTheSpotlight|spotlight}
- * performs any {@apilink Interaction}.
+ * Configures the [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) to take photos (a.k.a. screenshots)
+ * when then [`Actor`](https://serenity-js.org/api/core/class/Actor/) in the [spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/)
+ * performs any [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
  *
  * This strategy works best when you want the results of your automated tests
  * to become comprehensive living documentation of your system.