@serenity-js/web 3.35.0 → 3.35.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.35.1](https://github.com/serenity-js/serenity-js/compare/v3.35.0...v3.35.1) (2025-09-28)
+
+**Note:** Version bump only for package @serenity-js/web
+
+
+
+
+
 # [3.35.0](https://github.com/serenity-js/serenity-js/compare/v3.34.2...v3.35.0) (2025-09-07)
 
 

package/lib/screenplay/models/selectors/ByRole.d.ts

@@ -1,10 +1,24 @@
 import { Selector } from './Selector';
+/**
+ * @group Models
+ */
 export type ByRoleSelectorValue = 'alert' | 'alertdialog' | 'application' | 'article' | 'banner' | 'blockquote' | 'button' | 'caption' | 'cell' | 'checkbox' | 'code' | 'columnheader' | 'combobox' | 'complementary' | 'contentinfo' | 'definition' | 'deletion' | 'dialog' | 'directory' | 'document' | 'emphasis' | 'feed' | 'figure' | 'form' | 'generic' | 'grid' | 'gridcell' | 'group' | 'heading' | 'img' | 'insertion' | 'link' | 'list' | 'listbox' | 'listitem' | 'log' | 'main' | 'marquee' | 'math' | 'meter' | 'menu' | 'menubar' | 'menuitem' | 'menuitemcheckbox' | 'menuitemradio' | 'navigation' | 'none' | 'note' | 'option' | 'paragraph' | 'presentation' | 'progressbar' | 'radio' | 'radiogroup' | 'region' | 'row' | 'rowgroup' | 'rowheader' | 'scrollbar' | 'search' | 'searchbox' | 'separator' | 'slider' | 'spinbutton' | 'status' | 'strong' | 'subscript' | 'superscript' | 'switch' | 'tab' | 'table' | 'tablist' | 'tabpanel' | 'term' | 'textbox' | 'time' | 'timer' | 'toolbar' | 'tooltip' | 'tree' | 'treegrid' | 'treeitem';
+/**
+ * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) by its [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles),
+ * [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
+ *
+ * **Pro tip:** Instantiate using [`By.role`](https://serenity-js.org/api/web/class/By/#role)
+ *
+ * @group Models
+ */
 export declare class ByRole extends Selector {
     readonly value: ByRoleSelectorValue;
     readonly options: ByRoleSelectorOptions;
     constructor(value: ByRoleSelectorValue, options: ByRoleSelectorOptions);
 }
+/**
+ * @group Models
+ */
 export interface ByRoleSelectorOptions {
     /**
      * An attribute that is usually set by [`aria-checked`](https://www.w3.org/TR/wai-aria-1.2/#aria-checked) or

package/lib/screenplay/models/selectors/ByRole.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ByRole.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/models/selectors/ByRole.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,MAAM,mBAAmB,GACzB,OAAO,GACP,aAAa,GACb,aAAa,GACb,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,cAAc,GACd,UAAU,GACV,eAAe,GACf,aAAa,GACb,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,WAAW,GACX,UAAU,GACV,UAAU,GACV,MAAM,GACN,QAAQ,GACR,MAAM,GACN,SAAS,GACT,MAAM,GACN,UAAU,GACV,OAAO,GACP,SAAS,GACT,KAAK,GACL,WAAW,GACX,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,KAAK,GACL,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,GACP,MAAM,GACN,SAAS,GACT,UAAU,GACV,kBAAkB,GAClB,eAAe,GACf,YAAY,GACZ,MAAM,GACN,MAAM,GACN,QAAQ,GACR,WAAW,GACX,cAAc,GACd,aAAa,GACb,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,KAAK,GACL,UAAU,GACV,WAAW,GACX,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,aAAa,GACb,QAAQ,GACR,KAAK,GACL,OAAO,GACP,SAAS,GACT,UAAU,GACV,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,GACP,SAAS,GACT,SAAS,GACT,MAAM,GACN,UAAU,GACV,UAAU,CAAA;AAEhB,qBAAa,MAAO,SAAQ,QAAQ;aACJ,KAAK,EAAE,mBAAmB;aAAkB,OAAO,EAAE,qBAAqB;gBAA1E,KAAK,EAAE,mBAAmB,EAAkB,OAAO,EAAE,qBAAqB;CAGzG;AAED,MAAM,WAAW,qBAAqB;IAElC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB"}
+{"version":3,"file":"ByRole.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/models/selectors/ByRole.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,mBAAmB,GACzB,OAAO,GACP,aAAa,GACb,aAAa,GACb,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,cAAc,GACd,UAAU,GACV,eAAe,GACf,aAAa,GACb,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,WAAW,GACX,UAAU,GACV,UAAU,GACV,MAAM,GACN,QAAQ,GACR,MAAM,GACN,SAAS,GACT,MAAM,GACN,UAAU,GACV,OAAO,GACP,SAAS,GACT,KAAK,GACL,WAAW,GACX,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,KAAK,GACL,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,GACP,MAAM,GACN,SAAS,GACT,UAAU,GACV,kBAAkB,GAClB,eAAe,GACf,YAAY,GACZ,MAAM,GACN,MAAM,GACN,QAAQ,GACR,WAAW,GACX,cAAc,GACd,aAAa,GACb,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,KAAK,GACL,UAAU,GACV,WAAW,GACX,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,aAAa,GACb,QAAQ,GACR,KAAK,GACL,OAAO,GACP,SAAS,GACT,UAAU,GACV,MAAM,GACN,SAAS,GACT,MAAM,GACN,OAAO,GACP,SAAS,GACT,SAAS,GACT,MAAM,GACN,UAAU,GACV,UAAU,CAAA;AAEhB;;;;;;;GAOG;AACH,qBAAa,MAAO,SAAQ,QAAQ;aACJ,KAAK,EAAE,mBAAmB;aAAkB,OAAO,EAAE,qBAAqB;gBAA1E,KAAK,EAAE,mBAAmB,EAAkB,OAAO,EAAE,qBAAqB;CAGzG;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAElC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/lib/screenplay/models/selectors/ByRole.js

@@ -2,6 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ByRole = void 0;
 const Selector_1 = require("./Selector");
+/**
+ * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) by its [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles),
+ * [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
+ *
+ * **Pro tip:** Instantiate using [`By.role`](https://serenity-js.org/api/web/class/By/#role)
+ *
+ * @group Models
+ */
 class ByRole extends Selector_1.Selector {
     value;
     options;

package/lib/screenplay/models/selectors/ByRole.js.map

@@ -1 +1 @@
-{"version":3,"file":"ByRole.js","sourceRoot":"","sources":["../../../../src/screenplay/models/selectors/ByRole.ts"],"names":[],"mappings":";;;AAAA,yCAAsC;AAsFtC,MAAa,MAAO,SAAQ,mBAAQ;IACJ;IAA4C;IAAxE,YAA4B,KAA0B,EAAkB,OAA8B;QAClG,KAAK,EAAE,CAAC;QADgB,UAAK,GAAL,KAAK,CAAqB;QAAkB,YAAO,GAAP,OAAO,CAAuB;IAEtG,CAAC;CACJ;AAJD,wBAIC"}
+{"version":3,"file":"ByRole.js","sourceRoot":"","sources":["../../../../src/screenplay/models/selectors/ByRole.ts"],"names":[],"mappings":";;;AAAA,yCAAsC;AAyFtC;;;;;;;GAOG;AACH,MAAa,MAAO,SAAQ,mBAAQ;IACJ;IAA4C;IAAxE,YAA4B,KAA0B,EAAkB,OAA8B;QAClG,KAAK,EAAE,CAAC;QADgB,UAAK,GAAL,KAAK,CAAqB;QAAkB,YAAO,GAAP,OAAO,CAAuB;IAEtG,CAAC;CACJ;AAJD,wBAIC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/web",
-  "version": "3.35.0",
+  "version": "3.35.1",
   "description": "Serenity/JS Screenplay Pattern library offering a flexible, web driver-agnostic approach for interacting with web-based user interfaces and components, suitable for various testing contexts",
   "author": {
     "name": "Jan Molak",
@@ -53,8 +53,8 @@
     "node": "^18.12 || ^20 || ^22"
   },
   "dependencies": {
-    "@serenity-js/assertions": "3.35.0",
-    "@serenity-js/core": "3.35.0",
+    "@serenity-js/assertions": "3.35.1",
+    "@serenity-js/core": "3.35.1",
     "tiny-types": "1.24.1"
   },
   "devDependencies": {
@@ -67,5 +67,5 @@
     "ts-node": "10.9.2",
     "typescript": "5.9.2"
   },
-  "gitHead": "b87c48f8c67c0a51173cd5c29eb6e8599ca131ca"
+  "gitHead": "f8b08ebf12dbf37a3176d4a27c67afd466ed9b92"
 }

package/src/screenplay/models/selectors/ByRole.ts

@@ -1,5 +1,8 @@
 import { Selector } from './Selector';
 
+/**
+ * @group Models
+ */
 export type ByRoleSelectorValue =
     | 'alert'
     | 'alertdialog'
@@ -84,12 +87,23 @@ export type ByRoleSelectorValue =
     | 'treegrid'
     | 'treeitem'
 
+/**
+ * Locates a [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) by its [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles),
+ * [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
+ *
+ * **Pro tip:** Instantiate using [`By.role`](https://serenity-js.org/api/web/class/By/#role)
+ *
+ * @group Models
+ */
 export class ByRole extends Selector {
     constructor(public readonly value: ByRoleSelectorValue, public readonly options: ByRoleSelectorOptions) {
         super();
     }
 }
 
+/**
+ * @group Models
+ */
 export interface ByRoleSelectorOptions {
 
     /**