@serenity-js/core 2.32.7 → 3.0.0-rc.10

package/lib/screenplay/questions/List.d.ts

@@ -1,196 +1,26 @@
-import { AnswersQuestions, UsesAbilities } from '../actor';
+import { Actor, AnswersQuestions, UsesAbilities } from '../actor';
 import { Answerable } from '../Answerable';
-import { Question } from '../Question';
+import { Question, QuestionAdapter } from '../Question';
+import { Task } from '../Task';
 import { Expectation } from './Expectation';
-import { ArrayListAdapter, ListAdapter } from './lists';
 import { MetaQuestion } from './MetaQuestion';
-/**
- * @desc
- *  Filters an {@link Answerable} list of items based on the criteria provided.
- *  Instantiate via {@link List.of}
- *
- * @example <caption>Example data structure</caption>
- *  interface TestAccount {
- *      username: string;
- *      role: string;
- *      environments: string[];
- *  }
- *
- *  const testAccounts: TestAccount[] = [
- *      {
- *          "username": "tester.one@example.com",
- *          "role": "test-automation"
- *          "environments": [ "dev", "sit" ],
- *      },
- *      {
- *          "username": "tester.two@example.com",
- *          "role": "test-automation"
- *          "environments": [ "dev", "sit", "prod" ],
- *      },
- *      {
- *          "username": "release.bot@example.com",
- *          "role": "release-automation"
- *          "environments": [ "dev", "sit", "prod" ],
- *      }
- *  ]
- *
- * @example <caption>Using with Property</caption>
- *  import { actorCalled, List, Property } from '@serenity-js/core';
- *  import { contain, Ensure, equals } from '@serenity-js/assertions';
- *
- *  actorCalled('Lisa').attemptsTo(
- *      Ensure.that(
- *          Property.of(
- *              List.of(testAccounts)
- *                  .where(Property.at<TestAccount>().environments, contain('prod'))
- *                  .where(Property.at<TestAccount>().role, equals('test-automation'))
- *                  .first()
- *              ).username,
- *          equals('tester.two@example.com')
- *      )
- *  )
- *
- * @extends {Question}
- * @see {@link MetaQuestion}
- */
-export declare class List<List_Adapter_Type extends ListAdapter<Item_Type, Collection_Type, Item_Return_Type, Collection_Return_Type>, Item_Type, Collection_Type, Item_Return_Type = Item_Type, Collection_Return_Type = Collection_Type> extends Question<Collection_Return_Type> {
-    private readonly collection;
-    /**
-     * @desc
-     *  Instantiates a new {@link List} configured to support standard {@link Array}.
-     *
-     *  **Please note:** Don't use `List.of` to wrap `Question<ElementArrayFinder>` returned by
-     *  [`Target.all`](/modules/protractor/class/src/screenplay/questions/targets/Target.ts~Target.html#static-method-all).
-     *  Instead, use [`Target.all(...).located(...).where(...)`](/modules/protractor/class/src/screenplay/questions/targets/Target.ts~Target.html),
-     *  which uses a Protractor-specific {@link ListAdapter}.
-     *
-     * @param {Answerable<Item_Type[]>} items
-     *
-     * @returns {List<ArrayListAdapter<Item_Type>, Item_Type, Item_Type[], Promise<Item_Type>, Promise<Item_Type[]>>}
-     */
-    static of<Item_Type>(items: Answerable<Item_Type[]>): List<ArrayListAdapter<Item_Type>, Item_Type, Item_Type[], Promise<Item_Type>, Promise<Item_Type[]>>;
-    /**
-     * @param {List_Adapter_Type} collection
-     */
-    constructor(collection: List_Adapter_Type);
-    /**
-     * @desc
-     *  Returns the number of items left after applying any filters,
-     *
-     * @example <caption>Counting items</caption>
-     *  import { actorCalled, List } from '@serenity-js/core';
-     *  import { Ensure, equals, property } from '@serenity-js/assertions';
-     *
-     *  actorCalled('Lisa').attemptsTo(
-     *      Ensure.that(
-     *          List.of(testAccounts).count(),
-     *          equals(3)
-     *      )
-     *  )
-     *
-     * @returns {Question<Promise<number>>}
-     *
-     * @see {@link List#where}
-     */
-    count(): Question<Promise<number>>;
-    /**
-     * @desc
-     *  Returns the first of items left after applying any filters,
-     *
-     * @example <caption>Retrieving the first item</caption>
-     *  import { actorCalled, List } from '@serenity-js/core';
-     *  import { Ensure, equals, property } from '@serenity-js/assertions';
-     *
-     *  actorCalled('Lisa').attemptsTo(
-     *      Ensure.that(
-     *          List.of(testAccounts).first(),
-     *          property('username', equals('tester.one@example.com'))
-     *      )
-     *  )
-     *
-     * @returns {Question<Item_Return_Type>}
-     *
-     * @see {@link List#where}
-     */
-    first(): Question<Item_Return_Type>;
-    /**
-     * @desc
-     *  Returns the last of items left after applying any filters,
-     *
-     * @example <caption>Retrieving the last item</caption>
-     *  import { actorCalled, List } from '@serenity-js/core';
-     *  import { Ensure, equals, property } from '@serenity-js/assertions';
-     *
-     *  actorCalled('Lisa').attemptsTo(
-     *      Ensure.that(
-     *          List.of(testAccounts).last(),
-     *          property('username', equals('release.bot@example.com'))
-     *      )
-     *  )
-     *
-     * @returns {Question<Item_Return_Type>}
-     *
-     * @see {@link List#where}
-     */
-    last(): Question<Item_Return_Type>;
-    /**
-     * @desc
-     *  Returns the nth of the items left after applying any filters,
-     *
-     * @example <caption>Retrieving the nth item</caption>
-     *  import { actorCalled, List } from '@serenity-js/core';
-     *  import { Ensure, equals, property } from '@serenity-js/assertions';
-     *
-     *  actorCalled('Lisa').attemptsTo(
-     *      Ensure.that(
-     *          List.of(testAccounts).get(1),
-     *          property('username', equals('tester.two@example.com'))
-     *      )
-     *  )
-     *
-     * @param {number} index
-     *  Zero-based index of the item to return
-     *
-     * @returns {Question<Item_Return_Type>}
-     *
-     * @see {@link List#where}
-     */
-    get(index: number): Question<Item_Return_Type>;
-    /**
-     * @desc
-     *  Filters the underlying collection so that the result contains only those elements that meet the {@link Expectation}
-     *
-     * @example <caption>Filtering a list</caption>
-     *  import { actorCalled, List, Property } from '@serenity-js/core';
-     *  import { contain, Ensure, equals, property } from '@serenity-js/assertions';
-     *
-     *  actorCalled('Lisa').attemptsTo(
-     *      Ensure.that(
-     *          List.of(testAccounts)
-     *              .where(Property.at<TestAccount>().environments, contain('prod'))
-     *              .where(Property.at<TestAccount>().role, equals('test-automation'))
-     *              .first(),
-     *          property('username', equals('tester.two@example.com'))
-     *      )
-     *  )
-     *
-     * @param {MetaQuestion<Item_Type, Promise<Answer_Type> | Answer_Type>} question
-     * @param {Expectation<any, Answer_Type>} expectation
-     *
-     * @returns {List<List_Adapter_Type, Item_Type, Collection_Type, Item_Return_Type, Collection_Return_Type>}
-     */
-    where<Answer_Type>(question: MetaQuestion<Item_Type, Promise<Answer_Type> | Answer_Type>, expectation: Expectation<any, Answer_Type>): List<List_Adapter_Type, Item_Type, Collection_Type, Item_Return_Type, Collection_Return_Type>;
-    /**
-     * @desc
-     *  Makes the provided {@link Actor} answer this {@link Question} and return the underlying collection.
-     *
-     * @param {AnswersQuestions & UsesAbilities} actor
-     * @returns {Collection_Return_Type}
-     *
-     * @see {@link Actor}
-     * @see {@link AnswersQuestions}
-     * @see {@link UsesAbilities}
-     */
-    answeredBy(actor: AnswersQuestions & UsesAbilities): Collection_Return_Type;
-    private static ordinalSuffixOf;
+export declare class List<Item_Type> extends Question<Promise<Item_Type[]>> {
+    protected readonly collection: Answerable<Array<Item_Type>>;
+    private subject;
+    static of<IT>(collection: Answerable<Array<IT>>): List<IT>;
+    constructor(collection: Answerable<Array<Item_Type>>);
+    eachMappedTo<Mapped_Item_Type>(question: MetaQuestion<Item_Type, Promise<Mapped_Item_Type> | Mapped_Item_Type>): List<Mapped_Item_Type>;
+    forEach(callback: (current: CurrentItem<Item_Type>, index: number, items: Array<Item_Type>) => Promise<void> | void): Task;
+    where<Answer_Type>(question: MetaQuestion<Item_Type, Promise<Answer_Type> | Answer_Type>, expectation: Expectation<Answer_Type>): this;
+    count(): QuestionAdapter<number>;
+    first(): QuestionAdapter<Item_Type>;
+    last(): QuestionAdapter<Item_Type>;
+    get(index: number): QuestionAdapter<Item_Type>;
+    answeredBy(actor: AnswersQuestions & UsesAbilities): Promise<Array<Item_Type>>;
+    describedAs(subject: string): this;
+    toString(): string;
+}
+export interface CurrentItem<Item_Type> {
+    item: Item_Type;
+    actor: Actor;
 }

package/lib/screenplay/questions/List.js

@@ -1,226 +1,178 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.List = void 0;
+const errors_1 = require("../../errors");
 const io_1 = require("../../io");
 const Question_1 = require("../Question");
-const lists_1 = require("./lists");
-/**
- * @desc
- *  Filters an {@link Answerable} list of items based on the criteria provided.
- *  Instantiate via {@link List.of}
- *
- * @example <caption>Example data structure</caption>
- *  interface TestAccount {
- *      username: string;
- *      role: string;
- *      environments: string[];
- *  }
- *
- *  const testAccounts: TestAccount[] = [
- *      {
- *          "username": "tester.one@example.com",
- *          "role": "test-automation"
- *          "environments": [ "dev", "sit" ],
- *      },
- *      {
- *          "username": "tester.two@example.com",
- *          "role": "test-automation"
- *          "environments": [ "dev", "sit", "prod" ],
- *      },
- *      {
- *          "username": "release.bot@example.com",
- *          "role": "release-automation"
- *          "environments": [ "dev", "sit", "prod" ],
- *      }
- *  ]
- *
- * @example <caption>Using with Property</caption>
- *  import { actorCalled, List, Property } from '@serenity-js/core';
- *  import { contain, Ensure, equals } from '@serenity-js/assertions';
- *
- *  actorCalled('Lisa').attemptsTo(
- *      Ensure.that(
- *          Property.of(
- *              List.of(testAccounts)
- *                  .where(Property.at<TestAccount>().environments, contain('prod'))
- *                  .where(Property.at<TestAccount>().role, equals('test-automation'))
- *                  .first()
- *              ).username,
- *          equals('tester.two@example.com')
- *      )
- *  )
- *
- * @extends {Question}
- * @see {@link MetaQuestion}
- */
+const Task_1 = require("../Task");
+const expectations_1 = require("./expectations");
 class List extends Question_1.Question {
-    /**
-     * @param {List_Adapter_Type} collection
-     */
     constructor(collection) {
-        super((0, io_1.formatted) `${collection}`);
+        super();
         this.collection = collection;
+        this.subject = (0, io_1.d) `${collection}`;
+    }
+    static of(collection) {
+        return new List(collection);
+    }
+    eachMappedTo(question) {
+        return new List(new EachMappedTo(this.collection, question, this.subject));
+    }
+    forEach(callback) {
+        return new ForEachLoop(this.collection, this.subject, callback);
+    }
+    where(question, expectation) {
+        return new List(new Where(this.collection, question, expectation, this.subject));
     }
-    /**
-     * @desc
-     *  Instantiates a new {@link List} configured to support standard {@link Array}.
-     *
-     *  **Please note:** Don't use `List.of` to wrap `Question<ElementArrayFinder>` returned by
-     *  [`Target.all`](/modules/protractor/class/src/screenplay/questions/targets/Target.ts~Target.html#static-method-all).
-     *  Instead, use [`Target.all(...).located(...).where(...)`](/modules/protractor/class/src/screenplay/questions/targets/Target.ts~Target.html),
-     *  which uses a Protractor-specific {@link ListAdapter}.
-     *
-     * @param {Answerable<Item_Type[]>} items
-     *
-     * @returns {List<ArrayListAdapter<Item_Type>, Item_Type, Item_Type[], Promise<Item_Type>, Promise<Item_Type[]>>}
-     */
-    static of(items) {
-        return new List(new lists_1.ArrayListAdapter(items));
-    }
-    /**
-     * @desc
-     *  Returns the number of items left after applying any filters,
-     *
-     * @example <caption>Counting items</caption>
-     *  import { actorCalled, List } from '@serenity-js/core';
-     *  import { Ensure, equals, property } from '@serenity-js/assertions';
-     *
-     *  actorCalled('Lisa').attemptsTo(
-     *      Ensure.that(
-     *          List.of(testAccounts).count(),
-     *          equals(3)
-     *      )
-     *  )
-     *
-     * @returns {Question<Promise<number>>}
-     *
-     * @see {@link List#where}
-     */
     count() {
-        return Question_1.Question.about(`the number of ${this.collection.toString()}`, actor => this.collection.count(actor));
-    }
-    /**
-     * @desc
-     *  Returns the first of items left after applying any filters,
-     *
-     * @example <caption>Retrieving the first item</caption>
-     *  import { actorCalled, List } from '@serenity-js/core';
-     *  import { Ensure, equals, property } from '@serenity-js/assertions';
-     *
-     *  actorCalled('Lisa').attemptsTo(
-     *      Ensure.that(
-     *          List.of(testAccounts).first(),
-     *          property('username', equals('tester.one@example.com'))
-     *      )
-     *  )
-     *
-     * @returns {Question<Item_Return_Type>}
-     *
-     * @see {@link List#where}
-     */
+        return Question_1.Question.about(`the number of ${this.subject}`, async (actor) => {
+            const items = await this.answeredBy(actor);
+            return items.length;
+        });
+    }
     first() {
-        return Question_1.Question.about(`the first of ${this.collection.toString()}`, actor => this.collection.first(actor));
-    }
-    /**
-     * @desc
-     *  Returns the last of items left after applying any filters,
-     *
-     * @example <caption>Retrieving the last item</caption>
-     *  import { actorCalled, List } from '@serenity-js/core';
-     *  import { Ensure, equals, property } from '@serenity-js/assertions';
-     *
-     *  actorCalled('Lisa').attemptsTo(
-     *      Ensure.that(
-     *          List.of(testAccounts).last(),
-     *          property('username', equals('release.bot@example.com'))
-     *      )
-     *  )
-     *
-     * @returns {Question<Item_Return_Type>}
-     *
-     * @see {@link List#where}
-     */
+        return Question_1.Question.about(`the first of ${this.subject}`, async (actor) => {
+            const items = await this.answeredBy(actor);
+            if (items.length === 0) {
+                throw new errors_1.LogicError((0, io_1.d) `Can't retrieve the first item from a list with 0 items: ${items}`);
+            }
+            return items[0];
+        });
+    }
     last() {
-        return Question_1.Question.about(`the last of ${this.collection.toString()}`, actor => this.collection.last(actor));
-    }
-    /**
-     * @desc
-     *  Returns the nth of the items left after applying any filters,
-     *
-     * @example <caption>Retrieving the nth item</caption>
-     *  import { actorCalled, List } from '@serenity-js/core';
-     *  import { Ensure, equals, property } from '@serenity-js/assertions';
-     *
-     *  actorCalled('Lisa').attemptsTo(
-     *      Ensure.that(
-     *          List.of(testAccounts).get(1),
-     *          property('username', equals('tester.two@example.com'))
-     *      )
-     *  )
-     *
-     * @param {number} index
-     *  Zero-based index of the item to return
-     *
-     * @returns {Question<Item_Return_Type>}
-     *
-     * @see {@link List#where}
-     */
+        return Question_1.Question.about(`the last of ${this.subject}`, async (actor) => {
+            const items = await this.answeredBy(actor);
+            if (items.length === 0) {
+                throw new errors_1.LogicError((0, io_1.d) `Can't retrieve the last item from a list with 0 items: ${items}`);
+            }
+            return items[items.length - 1];
+        });
+    }
     get(index) {
-        return Question_1.Question.about(`the ${List.ordinalSuffixOf(index + 1)} of ${this.collection}`, actor => this.collection.get(actor, index));
-    }
-    /**
-     * @desc
-     *  Filters the underlying collection so that the result contains only those elements that meet the {@link Expectation}
-     *
-     * @example <caption>Filtering a list</caption>
-     *  import { actorCalled, List, Property } from '@serenity-js/core';
-     *  import { contain, Ensure, equals, property } from '@serenity-js/assertions';
-     *
-     *  actorCalled('Lisa').attemptsTo(
-     *      Ensure.that(
-     *          List.of(testAccounts)
-     *              .where(Property.at<TestAccount>().environments, contain('prod'))
-     *              .where(Property.at<TestAccount>().role, equals('test-automation'))
-     *              .first(),
-     *          property('username', equals('tester.two@example.com'))
-     *      )
-     *  )
-     *
-     * @param {MetaQuestion<Item_Type, Promise<Answer_Type> | Answer_Type>} question
-     * @param {Expectation<any, Answer_Type>} expectation
-     *
-     * @returns {List<List_Adapter_Type, Item_Type, Collection_Type, Item_Return_Type, Collection_Return_Type>}
-     */
-    where(question, expectation) {
-        return new List(this.collection.withFilter(question, expectation));
-    }
-    /**
-     * @desc
-     *  Makes the provided {@link Actor} answer this {@link Question} and return the underlying collection.
-     *
-     * @param {AnswersQuestions & UsesAbilities} actor
-     * @returns {Collection_Return_Type}
-     *
-     * @see {@link Actor}
-     * @see {@link AnswersQuestions}
-     * @see {@link UsesAbilities}
-     */
-    answeredBy(actor) {
-        return this.collection.items(actor);
-    }
-    static ordinalSuffixOf(index) {
-        const lastDigit = index % 10, lastTwoDigits = index % 100;
-        switch (true) {
-            case (lastDigit === 1 && lastTwoDigits !== 11):
-                return index + 'st';
-            case (lastDigit === 2 && lastTwoDigits !== 12):
-                return index + 'nd';
-            case (lastDigit === 3 && lastTwoDigits !== 13):
-                return index + 'rd';
-            default:
-                return index + 'th';
+        return Question_1.Question.about(`the ${ordinal(index + 1)} of ${this.subject}`, async (actor) => {
+            const items = await this.answeredBy(actor);
+            if (index < 0 || items.length <= index) {
+                throw new errors_1.LogicError(`Can't retrieve the ${ordinal(index)} item from a list with ${items.length} items: ` + (0, io_1.d) `${items}`);
+            }
+            return items[index];
+        });
+    }
+    async answeredBy(actor) {
+        const collection = await actor.answer(this.collection);
+        if (!Array.isArray(collection)) {
+            throw new errors_1.LogicError((0, io_1.d) `A List has to wrap an Array-compatible object. ${collection} given.`);
         }
+        return collection;
+    }
+    describedAs(subject) {
+        this.subject = subject;
+        return this;
+    }
+    toString() {
+        return this.subject;
     }
 }
 exports.List = List;
+/**
+ * @package
+ * @param {number} index
+ */
+function ordinal(index) {
+    const lastDigit = Math.abs(index) % 10, lastTwoDigits = Math.abs(index) % 100;
+    switch (true) {
+        case (lastDigit === 1 && lastTwoDigits !== 11):
+            return index + 'st';
+        case (lastDigit === 2 && lastTwoDigits !== 12):
+            return index + 'nd';
+        case (lastDigit === 3 && lastTwoDigits !== 13):
+            return index + 'rd';
+        default:
+            return index + 'th';
+    }
+}
+/**
+ * @package
+ */
+class Where extends Question_1.Question {
+    constructor(collection, question, expectation, originalSubject) {
+        super();
+        this.collection = collection;
+        this.question = question;
+        this.expectation = expectation;
+        const prefix = this.collection instanceof Where
+            ? ' and'
+            : ' where';
+        this.subject = originalSubject + prefix + (0, io_1.d) ` ${question} does ${expectation}`;
+    }
+    async answeredBy(actor) {
+        try {
+            const collection = await actor.answer(this.collection);
+            const results = [];
+            for (const item of collection) {
+                const actual = this.question.of(item);
+                const expectationOutcome = await actor.answer(this.expectation.isMetFor(actual));
+                if (expectationOutcome instanceof expectations_1.ExpectationMet) {
+                    results.push(item);
+                }
+            }
+            return results;
+        }
+        catch (error) {
+            throw new errors_1.LogicError((0, io_1.d) `Couldn't check if ${this.question} of an item of ${this.collection} does ${this.expectation}`, error);
+        }
+    }
+    describedAs(subject) {
+        this.subject = subject;
+        return this;
+    }
+    toString() {
+        return this.subject;
+    }
+}
+/**
+ * @package
+ */
+class EachMappedTo extends Question_1.Question {
+    constructor(collection, mapping, originalSubject) {
+        super();
+        this.collection = collection;
+        this.mapping = mapping;
+        this.subject = originalSubject + (0, io_1.d) ` mapped to ${this.mapping}`;
+    }
+    async answeredBy(actor) {
+        const collection = await actor.answer(this.collection);
+        const mapped = [];
+        for (const item of collection) {
+            mapped.push(await actor.answer(this.mapping.of(item)));
+        }
+        return mapped;
+    }
+    describedAs(subject) {
+        this.subject = subject;
+        return this;
+    }
+    toString() {
+        return this.subject;
+    }
+}
+/**
+ * @package
+ */
+class ForEachLoop extends Task_1.Task {
+    constructor(collection, subject, fn) {
+        super();
+        this.collection = collection;
+        this.subject = subject;
+        this.fn = fn;
+    }
+    async performAs(actor) {
+        const collection = await actor.answer(this.collection);
+        for (const [index, item] of collection.entries()) {
+            await this.fn({ actor, item }, index, collection);
+        }
+    }
+    toString() {
+        return `#actor iterates over ${this.subject}`;
+    }
+}
 //# sourceMappingURL=List.js.map

package/lib/screenplay/questions/List.js.map

@@ -1 +1 @@
-{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../src/screenplay/questions/List.ts"],"names":[],"mappings":";;;AAAA,iCAAqC;AAGrC,0CAAuC;AAEvC,mCAAwD;AAGxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAa,IAOT,SAAQ,mBAAgC;IAsBxC;;OAEG;IACH,YAA6B,UAA6B;QACtD,KAAK,CAAC,IAAA,cAAS,EAAA,GAAI,UAAW,EAAE,CAAC,CAAC;QADT,eAAU,GAAV,UAAU,CAAmB;IAE1D,CAAC;IAxBD;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,CAAY,KAA8B;QAC/C,OAAO,IAAI,IAAI,CACX,IAAI,wBAAgB,CAAC,KAAK,CAAC,CAC9B,CAAC;IACN,CAAC;IASD;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK;QACD,OAAO,mBAAQ,CAAC,KAAK,CAAC,iBAAkB,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAG,EAAE,EAAE,KAAK,CAAC,EAAE,CAC3E,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAC/B,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK;QACD,OAAO,mBAAQ,CAAC,KAAK,CAAC,gBAAiB,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAG,EAAE,EAAE,KAAK,CAAC,EAAE,CAC1E,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAC/B,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI;QACA,OAAO,mBAAQ,CAAC,KAAK,CAAC,eAAgB,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAG,EAAE,EAAE,KAAK,CAAC,EAAE,CACzE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAC9B,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,GAAG,CAAC,KAAa;QACb,OAAO,mBAAQ,CAAC,KAAK,CAAC,OAAQ,IAAI,CAAC,eAAe,CAAC,KAAK,GAAG,CAAC,CAAE,OAAQ,IAAI,CAAC,UAAW,EAAE,EAAE,KAAK,CAAC,EAAE,CAC9F,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CACpC,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CACD,QAAqE,EACrE,WAA0C;QAE1C,OAAO,IAAI,IAAI,CACX,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAsB,CACzE,CAAC;IACN,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,KAAuC;QAC9C,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,KAAa;QACxC,MACI,SAAS,GAAG,KAAK,GAAG,EAAE,EACtB,aAAa,GAAG,KAAK,GAAG,GAAG,CAAC;QAEhC,QAAQ,IAAI,EAAE;YACV,KAAK,CAAC,SAAS,KAAK,CAAC,IAAI,aAAa,KAAK,EAAE,CAAC;gBAC1C,OAAO,KAAK,GAAG,IAAI,CAAC;YACxB,KAAK,CAAC,SAAS,KAAK,CAAC,IAAI,aAAa,KAAK,EAAE,CAAC;gBAC1C,OAAO,KAAK,GAAG,IAAI,CAAC;YACxB,KAAK,CAAC,SAAS,KAAK,CAAC,IAAI,aAAa,KAAK,EAAE,CAAC;gBAC1C,OAAO,KAAK,GAAG,IAAI,CAAC;YACxB;gBACI,OAAO,KAAK,GAAG,IAAI,CAAC;SAC3B;IACL,CAAC;CACJ;AA1MD,oBA0MC"}
+{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../src/screenplay/questions/List.ts"],"names":[],"mappings":";;;AAAA,yCAA0C;AAC1C,iCAA6B;AAG7B,0CAAwD;AACxD,kCAA+B;AAE/B,iDAAgD;AAGhD,MAAa,IAAgB,SAAQ,mBAA8B;IAO/D,YACuB,UAAwC;QAE3D,KAAK,EAAE,CAAC;QAFW,eAAU,GAAV,UAAU,CAA8B;QAG3D,IAAI,CAAC,OAAO,GAAG,IAAA,MAAC,EAAA,GAAI,UAAW,EAAE,CAAC;IACtC,CAAC;IATD,MAAM,CAAC,EAAE,CAAK,UAAiC;QAC3C,OAAO,IAAI,IAAI,CAAK,UAAU,CAAC,CAAC;IACpC,CAAC;IASD,YAAY,CACR,QAA+E;QAE/E,OAAO,IAAI,IAAI,CACX,IAAI,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAC5D,CAAC;IACN,CAAC;IAED,OAAO,CAAC,QAA2G;QAC/G,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CACD,QAAqE,EACrE,WAAqC;QAErC,OAAO,IAAI,IAAI,CACX,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,CAC1D,CAAC;IACd,CAAC;IAED,KAAK;QACD,OAAO,mBAAQ,CAAC,KAAK,CAAC,iBAAkB,IAAI,CAAC,OAAQ,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACnE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC3C,OAAO,KAAK,CAAC,MAAM,CAAC;QACxB,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK;QACD,OAAO,mBAAQ,CAAC,KAAK,CAAC,gBAAiB,IAAI,CAAC,OAAQ,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YAClE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAE3C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACpB,MAAM,IAAI,mBAAU,CAAC,IAAA,MAAC,EAAA,2DAA4D,KAAM,EAAE,CAAC,CAAA;aAC9F;YAED,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACP,CAAC;IAED,IAAI;QACA,OAAO,mBAAQ,CAAC,KAAK,CAAC,eAAgB,IAAI,CAAC,OAAQ,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACjE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAE3C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACpB,MAAM,IAAI,mBAAU,CAAC,IAAA,MAAC,EAAA,0DAA2D,KAAM,EAAE,CAAC,CAAA;aAC7F;YAED,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC;IAED,GAAG,CAAC,KAAa;QACb,OAAO,mBAAQ,CAAC,KAAK,CAAC,OAAQ,OAAO,CAAC,KAAK,GAAG,CAAC,CAAE,OAAQ,IAAI,CAAC,OAAQ,EAAE,EAAE,KAAK,EAAC,KAAK,EAAC,EAAE;YACpF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAE3C,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,EAAE;gBACpC,MAAM,IAAI,mBAAU,CAAC,sBAAuB,OAAO,CAAC,KAAK,CAAE,0BAA2B,KAAK,CAAC,MAAO,UAAU,GAAG,IAAA,MAAC,EAAA,GAAI,KAAM,EAAE,CAAC,CAAA;aACjI;YAED,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAuC;QACpD,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEvD,IAAI,CAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC7B,MAAM,IAAI,mBAAU,CAAC,IAAA,MAAC,EAAA,kDAAmD,UAAW,SAAS,CAAC,CAAC;SAClG;QAED,OAAO,UAAU,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,OAAe;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;CACJ;AAhGD,oBAgGC;AAED;;;GAGG;AACH,SAAS,OAAO,CAAC,KAAa;IAC1B,MACI,SAAS,GAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,EACpC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;IAE1C,QAAQ,IAAI,EAAE;QACV,KAAK,CAAC,SAAS,KAAK,CAAC,IAAI,aAAa,KAAK,EAAE,CAAC;YAC1C,OAAO,KAAK,GAAG,IAAI,CAAC;QACxB,KAAK,CAAC,SAAS,KAAK,CAAC,IAAI,aAAa,KAAK,EAAE,CAAC;YAC1C,OAAO,KAAK,GAAG,IAAI,CAAC;QACxB,KAAK,CAAC,SAAS,KAAK,CAAC,IAAI,aAAa,KAAK,EAAE,CAAC;YAC1C,OAAO,KAAK,GAAG,IAAI,CAAC;QACxB;YACI,OAAO,KAAK,GAAG,IAAI,CAAC;KAC3B;AACL,CAAC;AAED;;GAEG;AACH,MAAM,KACF,SAAQ,mBAAmC;IAI3C,YACqB,UAAwC,EACxC,QAAqE,EACrE,WAAqC,EACtD,eAAuB;QAEvB,KAAK,EAAE,CAAC;QALS,eAAU,GAAV,UAAU,CAA8B;QACxC,aAAQ,GAAR,QAAQ,CAA6D;QACrE,gBAAW,GAAX,WAAW,CAA0B;QAKtD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,YAAY,KAAK;YAC3C,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,QAAQ,CAAC;QAEf,IAAI,CAAC,OAAO,GAAG,eAAe,GAAG,MAAM,GAAG,IAAA,MAAC,EAAA,IAAK,QAAS,SAAU,WAAY,EAAE,CAAC;IACtF,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAuC;QACpD,IAAI;YACA,MAAM,UAAU,GAAM,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1D,MAAM,OAAO,GAAgB,EAAE,CAAC;YAEhC,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE;gBAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAA4B,CAAC;gBACjE,MAAM,kBAAkB,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;gBAEjF,IAAI,kBAAkB,YAAY,6BAAc,EAAE;oBAC9C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACtB;aACJ;YAED,OAAO,OAAO,CAAC;SAClB;QAAC,OAAO,KAAK,EAAE;YACZ,MAAM,IAAI,mBAAU,CAAC,IAAA,MAAC,EAAA,qBAAsB,IAAI,CAAC,QAAS,kBAAmB,IAAI,CAAC,UAAW,SAAU,IAAI,CAAC,WAAY,EAAE,EAAE,KAAK,CAAC,CAAC;SACtI;IACL,CAAC;IAED,WAAW,CAAC,OAAe;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,YAA0C,SAAQ,mBAA0C;IAI9F,YACqB,UAAwC,EACxC,OAA8E,EAC/F,eAAuB;QAEvB,KAAK,EAAE,CAAC;QAJS,eAAU,GAAV,UAAU,CAA8B;QACxC,YAAO,GAAP,OAAO,CAAuE;QAK/F,IAAI,CAAC,OAAO,GAAG,eAAe,GAAG,IAAA,MAAC,EAAA,cAAe,IAAI,CAAC,OAAQ,EAAE,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAuC;QACpD,MAAM,UAAU,GAAqB,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEzE,MAAM,MAAM,GAAuB,EAAE,CAAC;QAEtC,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE;YAC3B,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACzD;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,WAAW,CAAC,OAAe;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,WAAuB,SAAQ,WAAI;IAErC,YACqB,UAAwC,EACxC,OAAe,EACf,EAAqG;QAEtH,KAAK,EAAE,CAAC;QAJS,eAAU,GAAV,UAAU,CAA8B;QACxC,YAAO,GAAP,OAAO,CAAQ;QACf,OAAE,GAAF,EAAE,CAAmG;IAG1H,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAY;QACxB,MAAM,UAAU,GAAqB,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEzE,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE;YAC9C,MAAM,IAAI,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;SACrD;IACL,CAAC;IAED,QAAQ;QACJ,OAAO,wBAAyB,IAAI,CAAC,OAAQ,EAAE,CAAC;IACpD,CAAC;CACJ"}

package/lib/screenplay/questions/Note.d.ts

@@ -40,6 +40,7 @@ import { Question } from '../Question';
  */
 export declare class Note<Answer> extends Question<Promise<Answer>> {
     private readonly topic;
+    private subject;
     /**
      * @desc
      *  Retrieves the previously recorded answer to a given {@link Question}
@@ -66,4 +67,13 @@ export declare class Note<Answer> extends Question<Promise<Answer>> {
      * @see {@link UsesAbilities}
      */
     answeredBy(actor: AnswersQuestions & UsesAbilities): Promise<Answer>;
+    /**
+     * @desc
+     *  Changes the description of this question's subject.
+     *
+     * @param {string} subject
+     * @returns {Question<T>}
+     */
+    describedAs(subject: string): this;
+    toString(): string;
 }