@serenity-js/core 2.32.5 → 3.0.0-rc.0

package/lib/screenplay/questions/mappings/string/trim.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.trim = void 0;
-/* eslint-disable unicorn/consistent-function-scoping */
-const tiny_types_1 = require("tiny-types");
-/**
- * @desc
- *  Removes whitespace from both ends of a string.
- *  Whitespace in this context is all the whitespace characters (space, tab, no-break space, etc.)
- *  and all the line terminator characters (LF, CR, etc.).
- *
- * @returns {AnswerMappingFunction<string, string>}
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trim
- */
-function trim() {
-    return (actor) => (value) => (0, tiny_types_1.ensure)('The value to be mapped', value, (0, tiny_types_1.isDefined)(), (0, tiny_types_1.isString)())
-        .trim();
-}
-exports.trim = trim;
-//# sourceMappingURL=trim.js.map

package/lib/screenplay/questions/mappings/string/trim.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"trim.js","sourceRoot":"","sources":["../../../../../src/screenplay/questions/mappings/string/trim.ts"],"names":[],"mappings":";;;AAAA,wDAAwD;AACxD,2CAAyD;AAKzD;;;;;;;;;GASG;AACH,SAAgB,IAAI;IAChB,OAAO,CAAC,KAAuB,EAAE,EAAE,CAC/B,CAAC,KAAa,EAAE,EAAE,CACd,IAAA,mBAAM,EAAC,wBAAwB,EAAE,KAAK,EAAE,IAAA,sBAAS,GAAE,EAAE,IAAA,qBAAQ,GAAE,CAAC;SAC3D,IAAI,EAAE,CAAC;AACxB,CAAC;AALD,oBAKC"}

package/lib/screenplay/questions/proxies/PropertyPathKey.d.ts

@@ -1,4 +0,0 @@
-/**
- * @package
- */
-export declare type PropertyPathKey = string | symbol | number;

package/lib/screenplay/questions/proxies/PropertyPathKey.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PropertyPathKey.js","sourceRoot":"","sources":["../../../../src/screenplay/questions/proxies/PropertyPathKey.ts"],"names":[],"mappings":""}

package/lib/screenplay/questions/proxies/createMetaQuestionProxy.d.ts

@@ -1,14 +0,0 @@
-import { Answerable } from '../../Answerable';
-import { Question } from '../../Question';
-import { MetaQuestion } from '../MetaQuestion';
-import { PropertyPathKey } from './PropertyPathKey';
-/**
- * @package
- */
-export declare type WithPropertiesAsMetaQuestions<Original_Type, Nested_Type = Original_Type> = {
-    [Key in keyof Nested_Type]: Nested_Type[Key] extends object ? Question<Promise<Nested_Type[Key]>> & MetaQuestion<Answerable<Original_Type>, Promise<Nested_Type[Key]>> & WithPropertiesAsMetaQuestions<Original_Type, Nested_Type[Key]> : Question<Promise<Nested_Type[Key]>> & MetaQuestion<Answerable<Original_Type>, Promise<Nested_Type[Key]>>;
-};
-/**
- * @package
- */
-export declare function createMetaQuestionProxy<Original_Type extends object>(path?: PropertyPathKey[]): WithPropertiesAsMetaQuestions<Original_Type>;

package/lib/screenplay/questions/proxies/createMetaQuestionProxy.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMetaQuestionProxy = void 0;
-/* eslint-disable @typescript-eslint/ban-types */
-const io_1 = require("../../../io");
-const Question_1 = require("../../Question");
-const describePath_1 = require("./describePath");
-const key_1 = require("./key");
-/**
- * @package
- */
-function createMetaQuestionProxy(path = []) {
-    const empty = {};
-    return new Proxy(empty, {
-        get(target, name) {
-            if ((0, key_1.key)(name).isOneOf('of')) {
-                return function of(subject) {
-                    return Question_1.Question.about((0, io_1.formatted) `property ${(0, describePath_1.describePath)(path)} of ${subject}`, actor => {
-                        return actor.answer(subject).then(answer => {
-                            return path.reduce((subObject, keyName, index) => {
-                                if (keyName in subObject) {
-                                    return subObject[keyName];
-                                }
-                                throw new Error((0, io_1.formatted) `property ${(0, describePath_1.describePath)(path.slice(0, index + 1))} of ${subject} doesn't exist`);
-                            }, answer);
-                        });
-                    });
-                };
-            }
-            return createMetaQuestionProxy(path.concat(name));
-        }
-    });
-}
-exports.createMetaQuestionProxy = createMetaQuestionProxy;
-//# sourceMappingURL=createMetaQuestionProxy.js.map

package/lib/screenplay/questions/proxies/createMetaQuestionProxy.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createMetaQuestionProxy.js","sourceRoot":"","sources":["../../../../src/screenplay/questions/proxies/createMetaQuestionProxy.ts"],"names":[],"mappings":";;;AAAA,iDAAiD;AACjD,oCAAwC;AAExC,6CAA0C;AAE1C,iDAA8C;AAC9C,+BAA4B;AAY5B;;GAEG;AACH,SAAgB,uBAAuB,CAA+B,OAA0B,EAAE;IAE9F,MAAM,KAAK,GAAG,EAAE,CAAC;IAEjB,OAAO,IAAI,KAAK,CAAgB,KAAY,EAAE;QAC1C,GAAG,CAAC,MAAe,EAAE,IAAqB;YAEtC,IAAI,IAAA,SAAG,EAAC,IAAI,CAAC,CAAC,OAAO,CAAwD,IAAI,CAAC,EAAE;gBAEhF,OAAO,SAAS,EAAE,CAAC,OAAkC;oBAEjD,OAAO,mBAAQ,CAAC,KAAK,CAAC,IAAA,cAAS,EAAC,YAAa,IAAA,2BAAY,EAAC,IAAI,CAAE,OAAQ,OAAQ,EAAE,EAAE,KAAK,CAAC,EAAE;wBACxF,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;4BAEvC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;gCAC7C,IAAI,OAAO,IAAI,SAAS,EAAE;oCACtB,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;iCAC7B;gCACD,MAAM,IAAI,KAAK,CAAC,IAAA,cAAS,EAAC,YAAa,IAAA,2BAAY,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAE,OAAQ,OAAQ,gBAAgB,CAAC,CAAC;4BACpH,CAAC,EAAE,MAAM,CAAC,CAAC;wBAEf,CAAC,CAAC,CAAC;oBACP,CAAC,CAAC,CAAC;gBACP,CAAC,CAAA;aACJ;YAED,OAAO,uBAAuB,CAAgB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QACrE,CAAC;KACJ,CAAiD,CAAC;AACvD,CAAC;AA7BD,0DA6BC"}

package/lib/screenplay/questions/proxies/createQuestionProxy.d.ts

@@ -1,13 +0,0 @@
-import { Answerable } from '../../Answerable';
-import { Question } from '../../Question';
-import { PropertyPathKey } from './PropertyPathKey';
-/**
- * @package
- */
-export declare type WithPropertiesAsQuestions<Original_Type> = {
-    [Key in keyof Original_Type]: Original_Type[Key] extends object ? Question<Promise<Original_Type[Key]>> & WithPropertiesAsQuestions<Original_Type[Key]> : Question<Promise<Original_Type[Key]>>;
-};
-/**
- * @package
- */
-export declare function createQuestionProxy<Original_Type extends object>(subject: Answerable<Original_Type>, path?: PropertyPathKey[]): WithPropertiesAsQuestions<Original_Type>;

package/lib/screenplay/questions/proxies/createQuestionProxy.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createQuestionProxy = void 0;
-/* eslint-disable @typescript-eslint/ban-types */
-const io_1 = require("../../../io");
-const Question_1 = require("../../Question");
-const describePath_1 = require("./describePath");
-const key_1 = require("./key");
-/**
- * @package
- */
-function createQuestionProxy(subject, path = []) {
-    const empty = {};
-    return new Proxy(empty, {
-        get(target, name) {
-            if ((0, key_1.key)(name).isOneOf('answeredBy', 'describedAs', 'map', 'toString')) {
-                const question = Question_1.Question.about((0, io_1.formatted) `property ${(0, describePath_1.describePath)(path)} of ${subject}`, actor => {
-                    return actor.answer(subject).then(answer => {
-                        return path.reduce((subObject, keyName, index) => {
-                            if (keyName in subObject) {
-                                return subObject[keyName];
-                            }
-                            throw new Error((0, io_1.formatted) `property ${(0, describePath_1.describePath)(path.slice(0, index + 1))} of ${subject} doesn't exist`);
-                        }, answer);
-                    });
-                });
-                return question[name].bind(question); // eslint-disable-line unicorn/prefer-prototype-methods
-            }
-            return createQuestionProxy(subject, path.concat(name));
-        }
-    });
-}
-exports.createQuestionProxy = createQuestionProxy;
-//# sourceMappingURL=createQuestionProxy.js.map

package/lib/screenplay/questions/proxies/createQuestionProxy.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createQuestionProxy.js","sourceRoot":"","sources":["../../../../src/screenplay/questions/proxies/createQuestionProxy.ts"],"names":[],"mappings":";;;AAAA,iDAAiD;AACjD,oCAAwC;AAExC,6CAA0C;AAC1C,iDAA8C;AAC9C,+BAA4B;AAY5B;;GAEG;AACH,SAAgB,mBAAmB,CAA+B,OAAkC,EAAE,OAA0B,EAAE;IAE9H,MAAM,KAAK,GAAG,EAAE,CAAC;IAEjB,OAAO,IAAI,KAAK,CAAgB,KAAY,EAAE;QAC1C,GAAG,CAAC,MAAe,EAAE,IAAqB;YAEtC,IAAI,IAAA,SAAG,EAAC,IAAI,CAAC,CAAC,OAAO,CAAgB,YAAY,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,CAAC,EAAE;gBAElF,MAAM,QAAQ,GAAG,mBAAQ,CAAC,KAAK,CAAC,IAAA,cAAS,EAAC,YAAa,IAAA,2BAAY,EAAC,IAAI,CAAE,OAAQ,OAAQ,EAAE,EAAE,KAAK,CAAC,EAAE;oBAClG,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;wBAEvC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;4BAC7C,IAAI,OAAO,IAAI,SAAS,EAAE;gCACtB,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;6BAC7B;4BACD,MAAM,IAAI,KAAK,CAAC,IAAA,cAAS,EAAC,YAAa,IAAA,2BAAY,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAE,OAAQ,OAAQ,gBAAgB,CAAC,CAAC;wBACpH,CAAC,EAAE,MAAM,CAAC,CAAC;oBAEf,CAAC,CAAC,CAAA;gBACN,CAAC,CAAC,CAAC;gBAEH,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAG,uDAAuD;aAClG;YAED,OAAO,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3D,CAAC;KACJ,CAA6C,CAAC;AACnD,CAAC;AA5BD,kDA4BC"}

package/lib/screenplay/questions/proxies/describePath.d.ts

@@ -1,5 +0,0 @@
-import { PropertyPathKey } from './PropertyPathKey';
-/**
- * @package
- */
-export declare function describePath(parts: PropertyPathKey[]): string;

package/lib/screenplay/questions/proxies/describePath.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.describePath = void 0;
-/**
- * @package
- */
-function describePath(parts) {
-    return parts.reduce((acc, segment) => acc.concat(isNumber(segment)
-        ? `[${segment}]`
-        : segment), []).join('.');
-}
-exports.describePath = describePath;
-/**
- * @private
- */
-function isNumber(segment) {
-    return Number.parseInt(String(segment), 10).toString() === segment;
-}
-//# sourceMappingURL=describePath.js.map

package/lib/screenplay/questions/proxies/describePath.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"describePath.js","sourceRoot":"","sources":["../../../../src/screenplay/questions/proxies/describePath.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,SAAgB,YAAY,CAAC,KAAwB;IACjD,OAAO,KAAK,CAAC,MAAM,CACf,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CACb,GAAG,CAAC,MAAM,CACN,QAAQ,CAAC,OAAO,CAAC;QACb,CAAC,CAAC,IAAK,OAAQ,GAAG;QAClB,CAAC,CAAC,OAAO,CAChB,EACL,EAAE,CACL,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChB,CAAC;AAVD,oCAUC;AAED;;GAEG;AACH,SAAS,QAAQ,CAAC,OAAwB;IACtC,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,KAAK,OAAO,CAAC;AACvE,CAAC"}

package/lib/screenplay/questions/proxies/index.d.ts

@@ -1,2 +0,0 @@
-export * from './createMetaQuestionProxy';
-export * from './createQuestionProxy';

package/lib/screenplay/questions/proxies/index.js

@@ -1,15 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./createMetaQuestionProxy"), exports);
-__exportStar(require("./createQuestionProxy"), exports);
-//# sourceMappingURL=index.js.map

package/lib/screenplay/questions/proxies/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/screenplay/questions/proxies/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4DAA0C;AAC1C,wDAAsC"}

package/lib/screenplay/questions/proxies/key.d.ts

@@ -1,8 +0,0 @@
-import { PropertyPathKey } from './PropertyPathKey';
-/**
- * @package
- * @param {PropertyPathKey} keyName
- */
-export declare function key(keyName: PropertyPathKey): {
-    isOneOf<T extends object = object>(...keys: (keyof T)[]): boolean;
-};

package/lib/screenplay/questions/proxies/key.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.key = void 0;
-/**
- * @package
- * @param {PropertyPathKey} keyName
- */
-function key(keyName) {
-    return {
-        isOneOf(...keys) {
-            return !!~keys.indexOf(keyName);
-        }
-    };
-}
-exports.key = key;
-//# sourceMappingURL=key.js.map

package/lib/screenplay/questions/proxies/key.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"key.js","sourceRoot":"","sources":["../../../../src/screenplay/questions/proxies/key.ts"],"names":[],"mappings":";;;AAGA;;;GAGG;AACH,SAAgB,GAAG,CAAC,OAAwB;IACxC,OAAO;QACH,OAAO,CAA4B,GAAG,IAAoB;YACtD,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAc,CAAC,CAAC;QAC3C,CAAC;KACJ,CAAA;AACL,CAAC;AAND,kBAMC"}

package/lib/screenplay/tasks/Loop.d.ts

@@ -1,198 +0,0 @@
-import { Reducible } from '../../io';
-import { Activity } from '../Activity';
-import { AnswersQuestions, PerformsActivities, UsesAbilities } from '../actor';
-import { Answerable } from '../Answerable';
-import { Question } from '../Question';
-import { Task } from '../Task';
-/**
- * @desc
- *  Enables the {@link Actor} to iterate over a list of items produced by any {@link Answerable}.
- *
- *  You can think of `Loop` as a more sophisticated Screenplay-style equivalent of
- *  [`Array.forEach`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach).
- *  `Loop` is capable of working with both synchronous data structures,
- *  such as [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
- *  and `Question<Array<T>>`,
- *  as well as asynchronous ones, so `Promise<Array<T>>` and `Question<Promise<Array<T>>>`.
- *
- *  Use {@link Loop.item} to access the current item being processed by {@link Loop}, and {@link Loop.index}
- *  to access the index of {@link Loop.item} in the list.
- *
- * @example <caption>Basic scenario - Iterating over a static list of items</caption>
- *  import { actorCalled, Loop, Log } from '@serenity-js/core';
- *
- *  actorCalled('Joe').attemptsTo(
- *      Loop.over([ 'apple', 'banana', 'candy' ]).to(
- *          Log.the('current element', Loop.item<string>()),
- *          Log.the('current index', Loop.index()),
- *      ),
- *  );
- *
- * @example <caption>API scenario - Iterating over items in an API response</caption>
- *
- *  import { actorCalled, Loop } from '@serenity-js/core';
- *  import { Send, GetRequest, CallAnApi, LastResponse } from '@serenity-js/rest';
- *  import { Ensure, property, isGreaterThan } from '@serenity-js/assertions';
- *
- *  interface TodoItem {
- *      userId: number;
- *      id: number;
- *      title: string;
- *      completed: boolean;
- *  }
- *
- *  actorCalled('Joe').whoCan(
- *      CallAnApi.at('https://jsonplaceholder.typicode.com')
- *  ).attemptsTo(
- *      Send.a(GetRequest.to('/todos')),
- *      Loop.over(LastResponse.body<TodoItem[]>()).to(
- *          Ensure.that(
- *              Loop.item<TodoItem>(),
- *              property('userId', isGreaterThan(0)),
- *          ),
- *      )
- *  );
- *
- * @example <caption>UI scenario - Example widget</caption>
- *  <nav>
- *      <div data-test="cookies">
- *          <label for="functional-cookies">
- *              <input type="checkbox" id="functional-cookies" />Allow functional cookies
- *          </label>
- *          <label for="performance-cookies">
- *              <input type="checkbox" id="performance-cookies" />Allow performance cookies
- *          </label>
- *          <label for="advertising-cookies">
- *              <input type="checkbox" id="advertising-cookies" />Allow advertising cookies
- *          </label>
- *      </div>
- *  </nav>
- *
- * @example <caption>UI scenario - Lean Page Object</caption>
- *  import { Target } from '@serenity-js/protractor';
- *  import { browser, by } from 'protractor';
- *
- *  class Cookies {
- *      static labels = Target.all('cookie options')
- *          .located(by.css('[data-test="cookies"]'));
- *
- *      static checkbox = Target.the('checkbox')
- *          .located(by.tagName('input')),
- *  }
- *
- * @example <caption>UI scenario - Performing the same set of activities with each element</caption>
- *  import { actorCalled, Loop } from '@serenity-js/core';
- *  import { Click, Text, isSelected } from '@serenity-js/protractor';
- *  import { Ensure, startsWith } from '@serenity-js/assertions';
- *  import { protractor } from 'protractor';
- *
- *  actorCalled('Joe')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Loop.over(Cookies.labels).to(
- *               Ensure.that(
- *                  Text.of(Loop.item<ElementFinder>()),
- *                  startsWith('Allow'),
- *              ),
- *
- *              Click.on(Loop.item<ElementFinder>()),
- *              Ensure.that(
- *                  Cookies.checkbox.of(Loop.item<ElementFinder>()),
- *                  isSelected(),
- *              ),
- *          ),
- *      );
- *
- * @extends {Task}
- *
- * @see {@link Loop.item}
- * @see {@link Loop.index}
- * @see {@link Question}
- */
-export declare class Loop<Item> extends Task {
-    private readonly items;
-    private readonly activities;
-    private static currentItem;
-    private static currentIndex;
-    /**
-     * @desc
-     *  Instantiates a {@link Task} to {@link Loop}
-     *  that enables the {@link Actor} to iterate over `items`
-     *  to perform some `activities`.
-     *
-     * @param {items: Answerable<ReducibleCollection>} items
-     * @returns {LoopBuilder}
-     */
-    static over<T>(items: Answerable<Reducible>): {
-        to: (...activities: Activity[]) => Loop<T>;
-    };
-    /**
-     * @desc
-     *  Returns the current item being processed by {@link Loop.over}.
-     *
-     *  **Please note** that in order for the TypeScript transpiler to understand the exact `ExpectedType`
-     *  of the {@link Question} produced by this method you can optionally configure it with
-     *  a [_type variable_](https://www.typescriptlang.org/docs/handbook/generics.html).
-     *
-     *  For example, configuring the method with type variable of `string`, so `Loop.item<string>()`,
-     *  tells the transpiler that a `Question<string>` will be returned.
-     *
-     *  If the type variable is not configured, the transpiler assumes that returned type is a
-     *  `Question<any>`. This means that while your code could still work, you'd miss out
-     *  on checking provided by TypeScript.
-     *
-     * @returns {Question<ExpectedType>}
-     */
-    static item<ExpectedType = any>(): Question<ExpectedType>;
-    /**
-     * @desc
-     *  Returns the index of current {@link Loop.item} in the `Answerable<Array>` given to {@link Loop.over}.
-     *
-     *  The index starts at `0`.
-     *
-     * @returns {Question<number>}
-     */
-    static index(): Question<number>;
-    /**
-     * @param {Answerable<Reducible>} items
-     * @param {Activity[]} activities
-     */
-    constructor(items: Answerable<Reducible>, activities: Activity[]);
-    /**
-     * @desc
-     *  Makes the provided {@link Actor}
-     *  perform this {@link Task}.
-     *
-     * @param {PerformsActivities & UsesAbilities & AnswersQuestions} actor
-     * @returns {Promise<void>}
-     *
-     * @see {@link Actor}
-     * @see {@link PerformsActivities}
-     * @see {@link UsesAbilities}
-     * @see {@link AnswersQuestions}
-     */
-    performAs(actor: PerformsActivities & UsesAbilities & AnswersQuestions): PromiseLike<void> | PromiseLike<any>;
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link Activity}.
-     *
-     * @returns {string}
-     */
-    toString(): string;
-}
-/**
- * @typedef {Object} LoopBuilder
- * @property {function(...activities: Activity[]): Loop} to
- *
- * @example <caption>Basic scenario - Iterating over a static list of items</caption>
- *  import { actorCalled, Loop, Log } from '@serenity-js/core';
- *
- *  actorCalled('Joe').attemptsTo(
- *      Loop.over([ 'apple', 'banana', 'candy' ]).to(
- *          Log.the('current element', Loop.item<string>()),
- *      ),
- *  );
- *
- * @see {@link Loop}
- * @see {@link Loop.over}
- */

package/lib/screenplay/tasks/Loop.js

@@ -1,222 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Loop = void 0;
-const io_1 = require("../../io");
-const Question_1 = require("../Question");
-const Task_1 = require("../Task");
-/**
- * @desc
- *  Enables the {@link Actor} to iterate over a list of items produced by any {@link Answerable}.
- *
- *  You can think of `Loop` as a more sophisticated Screenplay-style equivalent of
- *  [`Array.forEach`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach).
- *  `Loop` is capable of working with both synchronous data structures,
- *  such as [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
- *  and `Question<Array<T>>`,
- *  as well as asynchronous ones, so `Promise<Array<T>>` and `Question<Promise<Array<T>>>`.
- *
- *  Use {@link Loop.item} to access the current item being processed by {@link Loop}, and {@link Loop.index}
- *  to access the index of {@link Loop.item} in the list.
- *
- * @example <caption>Basic scenario - Iterating over a static list of items</caption>
- *  import { actorCalled, Loop, Log } from '@serenity-js/core';
- *
- *  actorCalled('Joe').attemptsTo(
- *      Loop.over([ 'apple', 'banana', 'candy' ]).to(
- *          Log.the('current element', Loop.item<string>()),
- *          Log.the('current index', Loop.index()),
- *      ),
- *  );
- *
- * @example <caption>API scenario - Iterating over items in an API response</caption>
- *
- *  import { actorCalled, Loop } from '@serenity-js/core';
- *  import { Send, GetRequest, CallAnApi, LastResponse } from '@serenity-js/rest';
- *  import { Ensure, property, isGreaterThan } from '@serenity-js/assertions';
- *
- *  interface TodoItem {
- *      userId: number;
- *      id: number;
- *      title: string;
- *      completed: boolean;
- *  }
- *
- *  actorCalled('Joe').whoCan(
- *      CallAnApi.at('https://jsonplaceholder.typicode.com')
- *  ).attemptsTo(
- *      Send.a(GetRequest.to('/todos')),
- *      Loop.over(LastResponse.body<TodoItem[]>()).to(
- *          Ensure.that(
- *              Loop.item<TodoItem>(),
- *              property('userId', isGreaterThan(0)),
- *          ),
- *      )
- *  );
- *
- * @example <caption>UI scenario - Example widget</caption>
- *  <nav>
- *      <div data-test="cookies">
- *          <label for="functional-cookies">
- *              <input type="checkbox" id="functional-cookies" />Allow functional cookies
- *          </label>
- *          <label for="performance-cookies">
- *              <input type="checkbox" id="performance-cookies" />Allow performance cookies
- *          </label>
- *          <label for="advertising-cookies">
- *              <input type="checkbox" id="advertising-cookies" />Allow advertising cookies
- *          </label>
- *      </div>
- *  </nav>
- *
- * @example <caption>UI scenario - Lean Page Object</caption>
- *  import { Target } from '@serenity-js/protractor';
- *  import { browser, by } from 'protractor';
- *
- *  class Cookies {
- *      static labels = Target.all('cookie options')
- *          .located(by.css('[data-test="cookies"]'));
- *
- *      static checkbox = Target.the('checkbox')
- *          .located(by.tagName('input')),
- *  }
- *
- * @example <caption>UI scenario - Performing the same set of activities with each element</caption>
- *  import { actorCalled, Loop } from '@serenity-js/core';
- *  import { Click, Text, isSelected } from '@serenity-js/protractor';
- *  import { Ensure, startsWith } from '@serenity-js/assertions';
- *  import { protractor } from 'protractor';
- *
- *  actorCalled('Joe')
- *      .whoCan(BrowseTheWeb.using(protractor.browser))
- *      .attemptsTo(
- *          Loop.over(Cookies.labels).to(
- *               Ensure.that(
- *                  Text.of(Loop.item<ElementFinder>()),
- *                  startsWith('Allow'),
- *              ),
- *
- *              Click.on(Loop.item<ElementFinder>()),
- *              Ensure.that(
- *                  Cookies.checkbox.of(Loop.item<ElementFinder>()),
- *                  isSelected(),
- *              ),
- *          ),
- *      );
- *
- * @extends {Task}
- *
- * @see {@link Loop.item}
- * @see {@link Loop.index}
- * @see {@link Question}
- */
-class Loop extends Task_1.Task {
-    /**
-     * @param {Answerable<Reducible>} items
-     * @param {Activity[]} activities
-     */
-    constructor(items, activities) {
-        super();
-        this.items = items;
-        this.activities = activities;
-    }
-    /**
-     * @desc
-     *  Instantiates a {@link Task} to {@link Loop}
-     *  that enables the {@link Actor} to iterate over `items`
-     *  to perform some `activities`.
-     *
-     * @param {items: Answerable<ReducibleCollection>} items
-     * @returns {LoopBuilder}
-     */
-    static over(items) {
-        return {
-            to: (...activities) => new Loop(items, activities)
-        };
-    }
-    /**
-     * @desc
-     *  Returns the current item being processed by {@link Loop.over}.
-     *
-     *  **Please note** that in order for the TypeScript transpiler to understand the exact `ExpectedType`
-     *  of the {@link Question} produced by this method you can optionally configure it with
-     *  a [_type variable_](https://www.typescriptlang.org/docs/handbook/generics.html).
-     *
-     *  For example, configuring the method with type variable of `string`, so `Loop.item<string>()`,
-     *  tells the transpiler that a `Question<string>` will be returned.
-     *
-     *  If the type variable is not configured, the transpiler assumes that returned type is a
-     *  `Question<any>`. This means that while your code could still work, you'd miss out
-     *  on checking provided by TypeScript.
-     *
-     * @returns {Question<ExpectedType>}
-     */
-    static item() {
-        return Question_1.Question.about(`current loop item`, actor => Loop.currentItem);
-    }
-    /**
-     * @desc
-     *  Returns the index of current {@link Loop.item} in the `Answerable<Array>` given to {@link Loop.over}.
-     *
-     *  The index starts at `0`.
-     *
-     * @returns {Question<number>}
-     */
-    static index() {
-        return Question_1.Question.about(`current loop index`, actor => Loop.currentIndex);
-    }
-    /**
-     * @desc
-     *  Makes the provided {@link Actor}
-     *  perform this {@link Task}.
-     *
-     * @param {PerformsActivities & UsesAbilities & AnswersQuestions} actor
-     * @returns {Promise<void>}
-     *
-     * @see {@link Actor}
-     * @see {@link PerformsActivities}
-     * @see {@link UsesAbilities}
-     * @see {@link AnswersQuestions}
-     */
-    performAs(actor) {
-        return actor.answer(this.items)
-            .then(items => items.reduce((previous, current, index) => {
-            return previous.then(() => {
-                Loop.currentIndex = index;
-                Loop.currentItem = current;
-                return actor.attemptsTo(...this.activities);
-            });
-        }, Promise.resolve(void 0)));
-    }
-    /**
-     * @desc
-     *  Generates a description to be used when reporting this {@link Activity}.
-     *
-     * @returns {string}
-     */
-    toString() {
-        const description = Array.isArray(this.items)
-            ? `a list of ${this.items.length} item${this.items.length !== 1 ? 's' : ''}`
-            : (0, io_1.formatted) `${this.items}`;
-        return `#actor loops over ${description}`;
-    }
-}
-exports.Loop = Loop;
-Loop.currentItem = undefined;
-Loop.currentIndex = 0;
-/**
- * @typedef {Object} LoopBuilder
- * @property {function(...activities: Activity[]): Loop} to
- *
- * @example <caption>Basic scenario - Iterating over a static list of items</caption>
- *  import { actorCalled, Loop, Log } from '@serenity-js/core';
- *
- *  actorCalled('Joe').attemptsTo(
- *      Loop.over([ 'apple', 'banana', 'candy' ]).to(
- *          Log.the('current element', Loop.item<string>()),
- *      ),
- *  );
- *
- * @see {@link Loop}
- * @see {@link Loop.over}
- */
-//# sourceMappingURL=Loop.js.map

package/lib/screenplay/tasks/Loop.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Loop.js","sourceRoot":"","sources":["../../../src/screenplay/tasks/Loop.ts"],"names":[],"mappings":";;;AAAA,iCAAgD;AAIhD,0CAAuC;AACvC,kCAA+B;AAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwGG;AACH,MAAa,IAAW,SAAQ,WAAI;IAyDhC;;;OAGG;IACH,YACqB,KAA4B,EAC5B,UAAsB;QAEvC,KAAK,EAAE,CAAC;QAHS,UAAK,GAAL,KAAK,CAAuB;QAC5B,eAAU,GAAV,UAAU,CAAY;IAG3C,CAAC;IA9DD;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,CAAI,KAA4B;QACvC,OAAO;YACH,EAAE,EAAE,CAAC,GAAG,UAAsB,EAAE,EAAE,CAC9B,IAAI,IAAI,CAAI,KAAK,EAAE,UAAU,CAAC;SACrC,CAAA;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI;QACP,OAAO,mBAAQ,CAAC,KAAK,CAAe,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAC7D,IAAI,CAAC,WAA2B,CACnC,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK;QACR,OAAO,mBAAQ,CAAC,KAAK,CAAS,oBAAoB,EAAE,KAAK,CAAC,EAAE,CACxD,IAAI,CAAC,YAAY,CACpB,CAAC;IACN,CAAC;IAaD;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,KAA4D;QAClE,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;aAC1B,IAAI,CAAC,KAAK,CAAC,EAAE,CACV,KAAK,CAAC,MAAM,CAAC,CAAC,QAAuB,EAAE,OAAa,EAAE,KAAa,EAAE,EAAE;YACnE,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;gBAC1B,IAAI,CAAC,WAAW,GAAI,OAAO,CAAC;gBAE5B,OAAO,KAAK,CAAC,UAAU,CACnB,GAAG,IAAI,CAAC,UAAU,CACrB,CAAC;YACN,CAAC,CAAC,CAAC;QACP,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAC9B,CAAC;IACV,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,MAAM,WAAW,GAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1C,CAAC,CAAC,aAAc,IAAI,CAAC,KAAK,CAAC,MAAO,QAAS,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAG,EAAE;YAChF,CAAC,CAAC,IAAA,cAAS,EAAC,GAAI,IAAI,CAAC,KAAM,EAAE,CAAC;QAElC,OAAO,qBAAsB,WAAY,EAAE,CAAC;IAChD,CAAC;;AA7GL,oBA8GC;AA7GkB,gBAAW,GAAY,SAAS,CAAC;AACjC,iBAAY,GAAG,CAAC,CAAC;AA8GpC;;;;;;;;;;;;;;;GAeG"}

package/lib/screenplay/tasks/index.d.ts

@@ -1 +0,0 @@
-export * from './Loop';