@serenity-js/web 3.41.1 → 3.42.0

package/esm/screenplay/questions/CssClasses.d.ts

@@ -0,0 +1,110 @@
+import type { MetaQuestionAdapter, QuestionAdapter } from '@serenity-js/core';
+import { PageElement } from '../models/index.js';
+/**
+ * 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
+ * a list of [CSS classes](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#attr-class)
+ * of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+ *
+ * ## Example widget
+ *
+ * ```html
+ * <ul id="shopping-list" class="active favourite">
+ *   <li class="bought">Coffee<li>
+ *   <li class="buy">Honey<li>
+ *   <li class="buy">Chocolate<li>
+ * </ul>
+ * ```
+ *
+ * ## Retrieve CSS classes of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ * import { By, CssClasses, PageElement } from '@serenity-js/web'
+ *
+ * const shoppingList = () =>
+ *   PageElement.located(By.css('#shopping-list'))
+ *     .describedAs('shopping list')
+ *
+ * await actorCalled('Lisa')
+ *   .attemptsTo(
+ *     Ensure.that(
+ *       CssClasses.of(shoppingList()),
+ *       equals([ 'active', 'favourite' ])
+ *     ),
+ *   )
+ * ```
+ *
+ * ## Using CssClasses as [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ * import { By, CssClasses, PageElement } from '@serenity-js/web'
+ *
+ * const shoppingList = () =>
+ *   PageElement.located(By.css('#shopping-list'))
+ *     .describedAs('shopping list')
+ *
+ * await actorCalled('Lisa')
+ *   .attemptsTo(
+ *     Ensure.that(
+ *       CssClasses.of(shoppingList()).length,
+ *       equals(2)
+ *     ),
+ *     Ensure.that(
+ *       CssClasses.of(shoppingList())[0],
+ *       equals('active')
+ *     ),
+ *   )
+ * ```
+ *
+ * ## 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'
+ * import { Ensure, contain } from '@serenity-js/assertions'
+ * import { By, CssClasses, PageElement } from '@serenity-js/web'
+ *
+ * class ShoppingList {
+ *   static items = () =>
+ *     PageElements.located(By.css('#shopping-list li'))
+ *       .describedAs('items')
+ *
+ *   static outstandingItems = () =>
+ *     ShoppingList.items()
+ *       .where(CssClasses, contain('buy'))
+ * }
+ *
+ * await actorCalled('Lisa')
+ *   .attemptsTo(
+ *     Ensure.that(
+ *       Text.ofAll(ShoppingList.outstandingItems()),
+ *       equals([ 'Honey', 'Chocolate' ])
+ *     ),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - [`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 declare class CssClasses {
+    /**
+     * 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
+     * a list of [CSS classes](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#attr-class)
+     * of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+     *
+     * #### Learn more
+     * - [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/)
+     *
+     * @param pageElement
+     */
+    static of(pageElement: QuestionAdapter<PageElement> | PageElement): MetaQuestionAdapter<PageElement, string[]>;
+}
+//# sourceMappingURL=CssClasses.d.ts.map

package/esm/screenplay/questions/CssClasses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CssClasses.d.ts","sourceRoot":"","sources":["../../../src/screenplay/questions/CssClasses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,mBAAmB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAG1F,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4FG;AACH,qBAAa,UAAU;IAEnB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,WAAW,GAAG,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;CAkBjH"}

package/esm/screenplay/questions/CssClasses.js

@@ -0,0 +1,121 @@
+import { Question, the } from '@serenity-js/core';
+import { PageElement } from '../models/index.js';
+/**
+ * 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
+ * a list of [CSS classes](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#attr-class)
+ * of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+ *
+ * ## Example widget
+ *
+ * ```html
+ * <ul id="shopping-list" class="active favourite">
+ *   <li class="bought">Coffee<li>
+ *   <li class="buy">Honey<li>
+ *   <li class="buy">Chocolate<li>
+ * </ul>
+ * ```
+ *
+ * ## Retrieve CSS classes of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ * import { By, CssClasses, PageElement } from '@serenity-js/web'
+ *
+ * const shoppingList = () =>
+ *   PageElement.located(By.css('#shopping-list'))
+ *     .describedAs('shopping list')
+ *
+ * await actorCalled('Lisa')
+ *   .attemptsTo(
+ *     Ensure.that(
+ *       CssClasses.of(shoppingList()),
+ *       equals([ 'active', 'favourite' ])
+ *     ),
+ *   )
+ * ```
+ *
+ * ## Using CssClasses as [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ * import { By, CssClasses, PageElement } from '@serenity-js/web'
+ *
+ * const shoppingList = () =>
+ *   PageElement.located(By.css('#shopping-list'))
+ *     .describedAs('shopping list')
+ *
+ * await actorCalled('Lisa')
+ *   .attemptsTo(
+ *     Ensure.that(
+ *       CssClasses.of(shoppingList()).length,
+ *       equals(2)
+ *     ),
+ *     Ensure.that(
+ *       CssClasses.of(shoppingList())[0],
+ *       equals('active')
+ *     ),
+ *   )
+ * ```
+ *
+ * ## 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'
+ * import { Ensure, contain } from '@serenity-js/assertions'
+ * import { By, CssClasses, PageElement } from '@serenity-js/web'
+ *
+ * class ShoppingList {
+ *   static items = () =>
+ *     PageElements.located(By.css('#shopping-list li'))
+ *       .describedAs('items')
+ *
+ *   static outstandingItems = () =>
+ *     ShoppingList.items()
+ *       .where(CssClasses, contain('buy'))
+ * }
+ *
+ * await actorCalled('Lisa')
+ *   .attemptsTo(
+ *     Ensure.that(
+ *       Text.ofAll(ShoppingList.outstandingItems()),
+ *       equals([ 'Honey', 'Chocolate' ])
+ *     ),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - [`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 CssClasses {
+    /**
+     * 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
+     * a list of [CSS classes](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#attr-class)
+     * of a given [`PageElement`](https://serenity-js.org/api/web/class/PageElement/).
+     *
+     * #### Learn more
+     * - [`MetaQuestion`](https://serenity-js.org/api/core/interface/MetaQuestion/)
+     *
+     * @param pageElement
+     */
+    static of(pageElement) {
+        return Question.about(the `CSS classes of ${pageElement}`, async (actor) => {
+            const element = await actor.answer(pageElement);
+            return element.attribute('class')
+                .then(attribute => attribute ?? '')
+                .then(attribute => attribute
+                .replace(/\s+/, ' ')
+                .trim()
+                .split(' ')
+                .filter(cssClass => !!cssClass));
+        }, (parent) => CssClasses.of(PageElement.of(pageElement, parent)));
+    }
+}
+//# sourceMappingURL=CssClasses.js.map

package/esm/screenplay/questions/CssClasses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CssClasses.js","sourceRoot":"","sources":["../../../src/screenplay/questions/CssClasses.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4FG;AACH,MAAM,OAAO,UAAU;IAEnB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,CAAC,WAAuD;QAC7D,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAA,kBAAmB,WAAY,EAAE,EACtD,KAAK,EAAC,KAAK,EAAC,EAAE;YACV,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAEhD,OAAO,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;iBAC5B,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,IAAI,EAAE,CAAC;iBAClC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS;iBACvB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;iBACnB,IAAI,EAAE;iBACN,KAAK,CAAC,GAAG,CAAC;iBACV,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAE,QAAQ,CAAC,CACnC,CAAC;QACV,CAAC,EACD,CAAC,MAA+B,EAAE,EAAE,CAChC,UAAU,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CACzD,CAAC;IACN,CAAC;CACJ"}

package/esm/screenplay/questions/LastScriptExecution.d.ts

@@ -0,0 +1,50 @@
+import type { QuestionAdapter } from '@serenity-js/core';
+/**
+ * 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
+ * a returns the result of the last script executed via [`ExecuteScript`](https://serenity-js.org/api/web/class/ExecuteScript/).
+ *
+ * ## Executing a script and reading the result
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { ExecuteScript, LastScriptExecution } from '@serenity-js/web'
+ * import { Ensure, includes } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Joseph')
+ *   .attemptsTo(
+ *     ExecuteScript.sync(() => navigator.userAgent),
+ *     Ensure.that(LastScriptExecution.result<string>(), includes('Chrome')),
+ *   )
+ * ```
+ *
+ * ## Using LastScriptExecution as [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { ExecuteScript, LastScriptExecution } from '@serenity-js/web'
+ * import { Ensure, includes } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Joseph')
+ *   .attemptsTo(
+ *     ExecuteScript.sync(() => navigator.userAgent),
+ *     Ensure.that(
+ *       LastScriptExecution.result<string>().toLocaleLowerCase(),
+ *       includes('chrome')
+ *     ),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - [`ExecuteScript`](https://serenity-js.org/api/web/class/ExecuteScript/)
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
+ *
+ * @group Questions
+ */
+export declare class LastScriptExecution {
+    /**
+     * Enables asserting on the result of a function executed via [`ExecuteScript`](https://serenity-js.org/api/web/class/ExecuteScript/).
+     */
+    static result<R>(): QuestionAdapter<R>;
+}
+//# sourceMappingURL=LastScriptExecution.d.ts.map

package/esm/screenplay/questions/LastScriptExecution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LastScriptExecution.d.ts","sourceRoot":"","sources":["../../../src/screenplay/questions/LastScriptExecution.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAKzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,mBAAmB;IAE5B;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,eAAe,CAAC,CAAC,CAAC;CAMzC"}

package/esm/screenplay/questions/LastScriptExecution.js

@@ -0,0 +1,56 @@
+import { Question } from '@serenity-js/core';
+import { BrowseTheWeb } from '../abilities/index.js';
+/**
+ * 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
+ * a returns the result of the last script executed via [`ExecuteScript`](https://serenity-js.org/api/web/class/ExecuteScript/).
+ *
+ * ## Executing a script and reading the result
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { ExecuteScript, LastScriptExecution } from '@serenity-js/web'
+ * import { Ensure, includes } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Joseph')
+ *   .attemptsTo(
+ *     ExecuteScript.sync(() => navigator.userAgent),
+ *     Ensure.that(LastScriptExecution.result<string>(), includes('Chrome')),
+ *   )
+ * ```
+ *
+ * ## Using LastScriptExecution as [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core'
+ * import { ExecuteScript, LastScriptExecution } from '@serenity-js/web'
+ * import { Ensure, includes } from '@serenity-js/assertions'
+ *
+ * await actorCalled('Joseph')
+ *   .attemptsTo(
+ *     ExecuteScript.sync(() => navigator.userAgent),
+ *     Ensure.that(
+ *       LastScriptExecution.result<string>().toLocaleLowerCase(),
+ *       includes('chrome')
+ *     ),
+ *   )
+ * ```
+ *
+ * ## Learn more
+ * - [`ExecuteScript`](https://serenity-js.org/api/web/class/ExecuteScript/)
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
+ *
+ * @group Questions
+ */
+export class LastScriptExecution {
+    /**
+     * Enables asserting on the result of a function executed via [`ExecuteScript`](https://serenity-js.org/api/web/class/ExecuteScript/).
+     */
+    static result() {
+        return Question.about(`last script execution result`, async (actor) => {
+            const page = await BrowseTheWeb.as(actor).currentPage();
+            return page.lastScriptExecutionResult();
+        });
+    }
+}
+//# sourceMappingURL=LastScriptExecution.js.map

package/esm/screenplay/questions/LastScriptExecution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LastScriptExecution.js","sourceRoot":"","sources":["../../../src/screenplay/questions/LastScriptExecution.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,OAAO,mBAAmB;IAE5B;;OAEG;IACH,MAAM,CAAC,MAAM;QACT,OAAO,QAAQ,CAAC,KAAK,CAAC,8BAA8B,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAChE,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC,yBAAyB,EAAK,CAAC;QAC/C,CAAC,CAAC,CAAA;IACN,CAAC;CACJ"}

package/esm/screenplay/questions/Selected.d.ts

@@ -0,0 +1,216 @@
+import type { Answerable, QuestionAdapter } from '@serenity-js/core';
+import type { PageElement } from '../models/index.js';
+/**
+ * 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
+ * options and values selected in a
+ * [HTML `<select>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select).
+ *
+ * ## Learn more
+ * - [`Select`](https://serenity-js.org/api/web/class/Select/)
+ * - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
+ * - [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
+ * - [`Question`](https://serenity-js.org/api/core/class/Question/)
+ *
+ * @group Questions
+ */
+export declare class Selected {
+    /**
+     * 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
+     * a single [option](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
+     * selected in an [HTML `<select>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select).
+     *
+     * #### Example widget
+     *
+     * ```html
+     * <select multiple data-test='countries'>
+     *   <option value='UK'>United Kingdom</option>
+     *   <option value='PL'>Poland</option>
+     *   <option value='US'>United States</option>
+     * </select>
+     * ```
+     *
+     * #### Lean Page Object describing the widget
+     *
+     * ```ts
+     * import { By, PageElement } from '@serenity-js/web'
+     *
+     * class Countries {
+     *   static dropdown = () =>
+     *     PageElement.located(By.css('[data-test="countries"]'))
+     *       .describedAs('countries dropdown');
+     * }
+     * ```
+     *
+     * #### Retrieving the selected value
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Select, Selected } from '@serenity-js/web'
+     * import { Ensure, equals } from '@serenity-js/assertions'
+     *
+     * await actorCalled('Nick')
+     *   .whoCan(BrowseTheWeb.using(protractor.browser))
+     *   .attemptsTo(
+     *     Select.value('UK').from(Countries.dropdown),
+     *     Ensure.that(Selected.valueOf(Countries.dropdown), equals('UK')),
+     *   )
+     * ```
+     *
+     * #### Learn more
+     * - [`Select.value`](https://serenity-js.org/api/web/class/Select/#value)
+     *
+     * @param pageElement
+     *  A [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) identifying the `<select>` element of interest
+     */
+    static valueOf(pageElement: Answerable<PageElement>): QuestionAdapter<string>;
+    /**
+     * 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
+     * values of [options](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
+     * selected in an [HTML `<select multiple>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select#attr-multiple)
+     *
+     * #### Example widget
+     *
+     * ```html
+     * <select multiple data-test='countries'>
+     *   <option value='UK'>United Kingdom</option>
+     *   <option value='PL'>Poland</option>
+     *   <option value='US'>United States</option>
+     * </select>
+     * ```
+     *
+     * #### Lean Page Object describing the widget
+     *
+     * ```ts
+     * import { By, PageElement } from '@serenity-js/web'
+     *
+     * class Countries {
+     *   static dropdown = () =>
+     *     PageElement.located(By.css('[data-test="countries"]'))
+     *       .describedAs('countries dropdown')
+     * }
+     * ```
+     *
+     * #### Retrieving the selected value
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Select, Selected } from '@serenity-js/web'
+     * import { Ensure, equals } from '@serenity-js/assertions'
+     *
+     * await actorCalled('Nick')
+     *   .whoCan(BrowseTheWeb.using(protractor.browser))
+     *   .attemptsTo(
+     *     Select.values('UK').from(Countries.dropdown),
+     *     Ensure.that(Selected.valuesOf(Countries.dropdown), equals([ 'UK' ])),
+     *   )
+     * ```
+     *
+     * #### Learn more
+     * - [`Select.values`](https://serenity-js.org/api/web/class/Select/#values)
+     *
+     * @param pageElement
+     *  A [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) identifying the `<select>` element of interest
+     */
+    static valuesOf(pageElement: Answerable<PageElement>): QuestionAdapter<Array<string>>;
+    /**
+     * 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
+     * a single option selected in an [HTML `<select>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select#attr-multiple)
+     *
+     * #### Example widget
+     *
+     * ```html
+     * <select multiple data-test='countries'>
+     *   <option value='UK'>United Kingdom</option>
+     *   <option value='PL'>Poland</option>
+     *   <option value='US'>United States</option>
+     * </select>
+     * ```
+     *
+     * #### Lean Page Object describing the widget
+     *
+     * ```ts
+     * import { By, PageElement } from '@serenity-js/web'
+     *
+     * class Countries {
+     *   static dropdown = () =>
+     *     PageElement.located(By.css('[data-test="countries"]'))
+     *       .describedAs('countries dropdown')
+     * }
+     * ```
+     *
+     * #### Retrieving the selected value
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Select, Selected } from '@serenity-js/web'
+     * import { Ensure, equals } from '@serenity-js/assertions'
+     *
+     * await actorCalled('Nick')
+     *   .attemptsTo(
+     *     Select.option('Poland').from(Countries.dropdown),
+     *     Ensure.that(
+     *       Selected.optionIn(Countries.dropdown),
+     *       equals('Poland')
+     *     ),
+     *   )
+     * ```
+     *
+     * #### Learn more
+     * - [`Select.option`](https://serenity-js.org/api/web/class/Select/#option)
+     *
+     * @param pageElement
+     *  A [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) identifying the `<select>` element of interest
+     */
+    static optionIn(pageElement: Answerable<PageElement>): QuestionAdapter<string>;
+    /**
+     * 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
+     * options selected in an [HTML `<select multiple>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select#attr-multiple)
+     *
+     * #### Example widget
+     *
+     * ```html
+     * <select multiple data-test='countries'>
+     *   <option value='UK'>United Kingdom</option>
+     *   <option value='PL'>Poland</option>
+     *   <option value='US'>United States</option>
+     * </select>
+     * ```
+     *
+     * #### Lean Page Object describing the widget
+     *
+     * ```ts
+     * import { By, PageElement } from '@serenity-js/web'
+     *
+     * class Countries {
+     *   static dropdown = () =>
+     *     PageElement.located(By.css('[data-test="countries"]'))
+     *       .describedAs('countries dropdown')
+     * }
+     * ```
+     *
+     * #### Retrieving the selected value
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Select, Selected } from '@serenity-js/web'
+     * import { Ensure, equals } from '@serenity-js/assertions'
+     *
+     * await actorCalled('Nick')
+     *   .attemptsTo(
+     *     Select.options('Poland', 'United States').from(Countries.dropdown),
+     *     Ensure.that(
+     *       Selected.optionsIn(Countries.dropdown),
+     *       equals([ 'Poland', 'United States' ])
+     *     ),
+     *   )
+     * ```
+     *
+     * #### Learn more
+     * - [`Select.options`](https://serenity-js.org/api/web/class/Select/#options)
+     *
+     * @param pageElement
+     *  A [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) identifying the `<select>` element of interest
+     */
+    static optionsIn(pageElement: Answerable<PageElement>): QuestionAdapter<Array<string>>;
+}
+//# sourceMappingURL=Selected.d.ts.map

package/esm/screenplay/questions/Selected.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Selected.d.ts","sourceRoot":"","sources":["../../../src/screenplay/questions/Selected.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;;;;;;;;;GAYG;AACH,qBAAa,QAAQ;IAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC;IAW7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAYrF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC;IAY9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;CAWzF"}