Merge 04a9f17 into 5f411ef

integration/web-specs/spec/screenplay/interactions/Enter.spec.ts

@@ -43,7 +43,7 @@ describe('Enter', () => {
 
     it('provides a sensible and masked description of the interaction being performed', () => {
         expect(Enter.theValue(Masked.valueOf(actorCalled('Bernie').name)).into(Form.field).toString())
-            .to.equal(`#actor enters '[a masked value]' into the name field`);
+            .to.equal(`#actor enters '[MASKED]' into the name field`);
     });
 
     it('correctly detects its invocation location', () => {

packages/core/spec/screenplay/questions/Masked.spec.ts

@@ -19,12 +19,14 @@ describe('Masked', () => {
     it('should return the sensitive value when answered by an actor', async () => {
         const sensitiveValue = 'your_masked_value';
         const answer = await Masked.valueOf(sensitiveValue).answeredBy(Fiona);
+
         expect(answer).to.equal(sensitiveValue);
     });
 
     it('should return masked value in description when using valueOf', async () => {
         const sensitiveValue = 'your_masked_value';
         const maskedDescription =  Masked.valueOf(sensitiveValue).toString();
-        expect(maskedDescription).to.equal('[a masked value]');
+
+        expect(maskedDescription).to.equal('[MASKED]');
     });
 });

packages/core/src/screenplay/questions/Masked.ts

@@ -1,5 +1,7 @@
+import type { UsesAbilities } from '../abilities';
 import { type Answerable } from '../Answerable';
-import { Question, type QuestionAdapter } from '../Question';
+import { Question } from '../Question';
+import type { AnswersQuestions } from './AnswersQuestions';
 
 /**
  * This question masks sensitive data handled by the actors and prevents
@@ -12,7 +14,27 @@ import { Question, type QuestionAdapter } from '../Question';
  *
  * @group Questions
  */
-export class Masked {
+export class Masked extends Question<Promise<string>> {
+
+    private subject: string;
+
+    private constructor(private readonly value: Answerable<string>) {
+        super();
+        this.subject = `[MASKED]`;
+    }
+
+    toString(): string {
+        return this.subject;
+    }
+
+    describedAs(subject: string): this {
+        this.subject = subject;
+        return this;
+    }
+
+    answeredBy(actor: AnswersQuestions & UsesAbilities): Promise<string> {
+        return actor.answer(this.value);
+    }
 
     /**
      * Retrieves the value of a sensitive parameter and mask it in any report.
@@ -32,7 +54,7 @@ export class Masked {
      * @param parameter - An {@link Answerable} representing the masked value.
      * @returns A {@link QuestionAdapter} representing the masked value.
      */
-    static valueOf(parameter: Answerable<string>): QuestionAdapter<string> {
-        return Question.about('[a masked value]', async actor => actor.answer(parameter));
+    static valueOf(parameter: Answerable<string>): Question<Promise<string>> {
+        return new Masked(parameter);
     }
 }

packages/web/src/screenplay/interactions/Enter.ts

@@ -54,7 +54,7 @@ import { PageElementInteraction } from './PageElementInteraction';
  *     Enter.theValue(Masked.valueOf('your little secret').into(Form.exampleInputField()),
  *   )
  *
- *   // Gets reported as: "Esme enters [a masked value] into the example input field"
+ *   // Gets reported as: "Esme enters [MASKED] into the example input field"
  * ```
  * 
  * ## Learn more