@serenity-js/web
Version:
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
97 lines • 3.24 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Enter = void 0;
const core_1 = require("@serenity-js/core");
const io_1 = require("@serenity-js/core/lib/io");
const PageElementInteraction_1 = require("./PageElementInteraction");
/**
* 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 enter a value into a [form `input`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) field.
*
* ## Example widget
* ```html
* <form>
* <input type="text" name="example" id="example" />
* </form>
* ```
*
* ## Lean Page Object describing the widget
*
* ```ts
* import { By, PageElement } from '@serenity-js/web'
*
* class Form {
* static exampleInput = () =>
* PageElement.located(By.id('example'))
* .describedAs('example input')
* }
* ```
*
* ## Entering the value into a form field
*
* ```ts
* import { actorCalled } from '@serenity-js/core';
* import { Enter } from '@serenity-js/web';
*
* await actorCalled('Esme')
* .attemptsTo(
* Enter.theValue('Hello world!').into(Form.exampleInput()),
* )
* ```
*
* ## Handling sensitive information
*
* By design, any data handled by an actor appears in Serenity/JS reports.
* To prevent the exposure of any sensitive information, such as passwords or tokens, you should use [`Masked`](https://serenity-js.org/api/core/class/Masked/).
*
* ```ts
* import { actorCalled, Masked } from '@serenity-js/core'
* import { Enter } from '@serenity-js/web'
*
* await actorCalled('Esme')
* .attemptsTo(
* Enter.theValue(Masked.valueOf('your little secret').into(Form.exampleInputField()),
* )
*
* // Gets reported as: "Esme enters [a masked value] into the example input field"
* ```
*
* ## Learn more
*
* - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
* - [`PageElement`](https://serenity-js.org/api/web/class/PageElement/)
*
* @group Activities
*/
class Enter extends PageElementInteraction_1.PageElementInteraction {
values;
field;
/**
* Instantiates this [`Interaction`](https://serenity-js.org/api/core/class/Interaction/).
*
* @param values
* The text value to be entered
*/
static theValue(...values) {
return {
into: (field /* todo Question<AlertPromise> | AlertPromise */) => new Enter(values, field),
};
}
constructor(values, field /* todo | Question<AlertPromise> | AlertPromise */) {
super(values.length === 1
? (0, core_1.the) `#actor enters ${values[0]} into ${field}`
: (0, core_1.the) `#actor enters ${core_1.Question.fromArray(values)} into ${field}`);
this.values = values;
this.field = field;
}
/**
* @inheritDoc
*/
async performAs(actor) {
const field = await this.resolve(actor, this.field);
const valuesToEnter = await (0, io_1.asyncMap)(this.values, value => actor.answer(value));
return field.enterValue(valuesToEnter.flat());
}
}
exports.Enter = Enter;
//# sourceMappingURL=Enter.js.map