@serenity-js/core 3.0.0-rc.8 → 3.0.0

package/lib/screenplay/time/activities/Wait.d.ts

@@ -0,0 +1,212 @@
+import { UsesAbilities } from '../../abilities';
+import { Answerable } from '../../Answerable';
+import { Interaction } from '../../Interaction';
+import { AnswersQuestions, Expectation } from '../../questions';
+import { Duration } from '../models';
+/**
+ * `Wait` is a synchronisation statement that instructs the {@apilink Actor|actor}
+ * to wait before proceeding with their next {@apilink Activity|activity},
+ * either for a set {@apilink Duration|duration}, or until a given {@apilink Expectation|expectation} is met.
+ *
+ * You can configure the timeout of the interaction to {@apilink Wait.until}:
+ * - globally, using {@apilink SerenityConfig.interactionTimeout}
+ * - locally, on a per-interaction basis using {@apilink Wait.upTo}
+ *
+ * :::tip Portable waiting
+ * Serenity/JS implements `Wait` from scratch, so that the behaviour is consistent no matter the integration tool you use (Playwright, WebdriverIO, Selenium, etc.)
+ * or the type of testing you do (Web, REST API, component testing, etc.)
+ * :::
+ *
+ * ## Wait with Web-based tests
+ *
+ * ### Example widget
+ *
+ * ```html
+ * <!--
+ *     After about 1 second, the text will change from 'Loading...' to 'Ready!'
+ * -->
+ * <h1 id="status">Loading...</h1>
+ * <script>
+ *     (function () {
+ *         setTimeout(function () {
+ *             document.getElementById('status').textContent = 'Ready!'
+ *         }, 1000);
+ *     })();
+ * </script>
+ * ```
+ *
+ * ### Lean Page Object describing the widget
+ *
+ * ```ts
+ * import { By, PageElement, Text } from '@serenity-js/web'
+ *
+ * class App {
+ *   static status = () =>
+ *      Text.of(PageElement.located(By.id('status'))
+ *          .describedAs('status widget'))
+ *  }
+ * ```
+ *
+ * ### Waiting for a set duration
+ *
+ * ```ts
+ * import { actorCalled, Duration, Wait } from '@serenity-js/core'
+ * import { BrowseTheWebWithPlaywright } from '@serenity-js/playwright'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ * import { Browser, chromium } from 'playwright'
+ *
+ * const browser = await chromium.launch({ headless: true })
+ *
+ * await actorCalled('Inês')
+ *   .whoCan(BrowseTheWebWithPlaywright.using(browser))
+ *   .attemptsTo(
+ *       Wait.for(Duration.ofMilliseconds(1_500)),
+ *       Ensure.that(App.status(), equals('Ready!')),
+ *   );
+ * ```
+ *
+ * **Please note** that while the above implementation works,
+ * this approach is inefficient because at best
+ * the actor might wait too long and at worst the test
+ * might become "flaky" if any external interference
+ * (like network glitches, animations taking a bit too long etc.)
+ * makes the actor wait not long enough.
+ *
+ * ### Waiting until a condition is met
+ *
+ * ```ts
+ * import { actorCalled, Wait } from '@serenity-js/core'
+ * import { BrowseTheWebWithPlaywright } from '@serenity-js/playwright'
+ * import { equals } from '@serenity-js/assertions'
+ * import { Browser, chromium } from 'playwright'
+ *
+ * const browser = await chromium.launch({ headless: true })
+ *
+ * await actorCalled('Wendy')
+ *     .whoCan(BrowseTheWebWithPlaywright.using(browser))
+ *     .attemptsTo(
+ *         Wait.until(App.status(), equals('Ready!')),
+ *         // app is ready, proceed with the scenario
+ *     );
+ * ```
+ *
+ * `Wait.until` makes the {@apilink Actor} keep asking the {@apilink Question},
+ * in this case `Text.of(App.status)`, until the answer meets
+ * the expectation, or a timeout expires (default: 5s).
+ *
+ * **Please note** that both Ensure and Wait can be used with
+ * the same expectations, like `equals` or `includes`.
+ *
+ * ### Changing the default timeout
+ *
+ * ```ts
+ *  import { actorCalled, Duration, Wait } from '@serenity-js/core';
+ *  import { BrowseTheWebWithPlaywright } from '@serenity-js/playwright';
+ *  import { equals } from '@serenity-js/assertions';
+ *  import { Browser, chromium } from 'playwright';
+ *
+ *  const browser: Browser = await chromium.launch({ headless: true });
+ *
+ *  await actorCalled('Polly')
+ *      .whoCan(BrowseTheWebWithPlaywright.using(browser))
+ *      .attemptsTo(
+ *          Wait.upTo(Duration.ofSeconds(3))
+ *              .until(App.status(), equals('Ready!')),
+ *          // app is ready, proceed with the scenario
+ *      );
+ * ```
+ *
+ * ## Learn more
+ * - {@apilink SerenityConfig.interactionTimeout}
+ * - {@apilink Duration}
+ * - {@apilink Expectation}
+ *
+ * @group Time
+ */
+export declare class Wait {
+    /**
+     * Minimum timeout that can be used with {@apilink Wait.until},
+     * defaults to 250 milliseconds,
+     */
+    static readonly minimumTimeout: Duration;
+    /**
+     * The amount of time {@apilink Wait.until} should wait between condition checks,
+     * defaults to 500ms.
+     *
+     * Use {@apilink WaitUntil.pollingEvery} to override it for a given interaction.
+     *
+     * @type {Duration}
+     */
+    static readonly defaultPollingInterval: Duration;
+    /**
+     * Minimum polling interval of 50ms between condition checks, used with {@apilink Wait.until}.
+     */
+    static readonly minimumPollingInterval: Duration;
+    /**
+     * Instantiates a version of this {@apilink Interaction}
+     * configured to wait for a set duration.
+     *
+     * @param duration
+     *  A set duration the {@apilink Actor} should wait for before proceeding.
+     */
+    static for(duration: Answerable<Duration>): Interaction;
+    /**
+     * Instantiates a version of this {@apilink Interaction}
+     * configured to wait until the answer to the question `actual` meets the `expectation`,
+     * or the `timeout` expires.
+     *
+     * @param timeout
+     *  Custom timeout to override {@apilink SerenityConfig.interactionTimeout}
+     */
+    static upTo(timeout: Duration): {
+        until: <Actual>(actual: Answerable<Actual>, expectation: Expectation<Actual>) => WaitUntil<Actual>;
+    };
+    /**
+     * Instantiates a version of this {@apilink Interaction} configured to
+     * poll every {@apilink Wait.defaultPollingInterval} for the result of the provided
+     * question (`actual`) until it meets the `expectation`,
+     * or the timeout expires.
+     *
+     * @param actual
+     *  An {@apilink Answerable} that the {@apilink Actor} will keep answering
+     *  until the answer meets the {@apilink Expectation} provided, or the timeout expires.
+     *
+     * @param expectation
+     *  An {@apilink Expectation} to be met before proceeding
+     */
+    static until<Actual>(actual: Answerable<Actual>, expectation: Expectation<Actual>): WaitUntil<Actual>;
+}
+/**
+ * Synchronisation statement that instructs the {@apilink Actor} to wait before proceeding until a given {@apilink Expectation} is met.
+ *
+ * :::tip
+ * To instantiate {@apilink Interaction|interaction} to {@apilink WaitUntil}, use the factory method {@apilink Wait.until}.
+ * :::
+ *
+ * ## Learn more
+ * * {@apilink Wait.until}
+ *
+ * @group Time
+ */
+export declare class WaitUntil<Actual> extends Interaction {
+    private readonly actual;
+    private readonly expectation;
+    private readonly pollingInterval;
+    private readonly timeout?;
+    constructor(actual: Answerable<Actual>, expectation: Expectation<Actual>, pollingInterval: Duration, timeout?: Duration);
+    /**
+     * Configure how frequently the {@apilink Actor} should check if the answer meets the expectation.
+     *
+     * Note that the polling interval defines the delay between subsequent attempts
+     * to evaluate the expected value, and doesn't include the amount of time
+     * it take the actor to evaluate the value itself.
+     *
+     * @param interval
+     */
+    pollingEvery(interval: Duration): Interaction;
+    /**
+     * @inheritDoc
+     */
+    performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>;
+}
+//# sourceMappingURL=Wait.d.ts.map

package/lib/screenplay/time/activities/Wait.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Wait.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/time/activities/Wait.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAsC,MAAM,iBAAiB,CAAC;AAEpG,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuHG;AACH,qBAAa,IAAI;IAEb;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,cAAc,WAAgC;IAE9D;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,WAAgC;IAEtE;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,WAA+B;IAErE;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,WAAW;IAIvD;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG;QAAE,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC,MAAM,CAAC,CAAA;KAAE;IAOtI;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC;CAGxG;AAiBD;;;;;;;;;;;GAWG;AACH,qBAAa,SAAS,CAAC,MAAM,CAAE,SAAQ,WAAW;IAE1C,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAHR,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAC1B,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,EAChC,eAAe,EAAE,QAAQ,EACzB,OAAO,CAAC,EAAE,QAAQ;IAYvC;;;;;;;;OAQG;IACH,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW;IAI7C;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAmC1E"}

package/lib/screenplay/time/activities/Wait.js

@@ -0,0 +1,270 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WaitUntil = exports.Wait = void 0;
+const tiny_types_1 = require("tiny-types");
+const errors_1 = require("../../../errors");
+const io_1 = require("../../../io");
+const Interaction_1 = require("../../Interaction");
+const questions_1 = require("../../questions");
+const abilities_1 = require("../abilities");
+const models_1 = require("../models");
+/**
+ * `Wait` is a synchronisation statement that instructs the {@apilink Actor|actor}
+ * to wait before proceeding with their next {@apilink Activity|activity},
+ * either for a set {@apilink Duration|duration}, or until a given {@apilink Expectation|expectation} is met.
+ *
+ * You can configure the timeout of the interaction to {@apilink Wait.until}:
+ * - globally, using {@apilink SerenityConfig.interactionTimeout}
+ * - locally, on a per-interaction basis using {@apilink Wait.upTo}
+ *
+ * :::tip Portable waiting
+ * Serenity/JS implements `Wait` from scratch, so that the behaviour is consistent no matter the integration tool you use (Playwright, WebdriverIO, Selenium, etc.)
+ * or the type of testing you do (Web, REST API, component testing, etc.)
+ * :::
+ *
+ * ## Wait with Web-based tests
+ *
+ * ### Example widget
+ *
+ * ```html
+ * <!--
+ *     After about 1 second, the text will change from 'Loading...' to 'Ready!'
+ * -->
+ * <h1 id="status">Loading...</h1>
+ * <script>
+ *     (function () {
+ *         setTimeout(function () {
+ *             document.getElementById('status').textContent = 'Ready!'
+ *         }, 1000);
+ *     })();
+ * </script>
+ * ```
+ *
+ * ### Lean Page Object describing the widget
+ *
+ * ```ts
+ * import { By, PageElement, Text } from '@serenity-js/web'
+ *
+ * class App {
+ *   static status = () =>
+ *      Text.of(PageElement.located(By.id('status'))
+ *          .describedAs('status widget'))
+ *  }
+ * ```
+ *
+ * ### Waiting for a set duration
+ *
+ * ```ts
+ * import { actorCalled, Duration, Wait } from '@serenity-js/core'
+ * import { BrowseTheWebWithPlaywright } from '@serenity-js/playwright'
+ * import { Ensure, equals } from '@serenity-js/assertions'
+ * import { Browser, chromium } from 'playwright'
+ *
+ * const browser = await chromium.launch({ headless: true })
+ *
+ * await actorCalled('Inês')
+ *   .whoCan(BrowseTheWebWithPlaywright.using(browser))
+ *   .attemptsTo(
+ *       Wait.for(Duration.ofMilliseconds(1_500)),
+ *       Ensure.that(App.status(), equals('Ready!')),
+ *   );
+ * ```
+ *
+ * **Please note** that while the above implementation works,
+ * this approach is inefficient because at best
+ * the actor might wait too long and at worst the test
+ * might become "flaky" if any external interference
+ * (like network glitches, animations taking a bit too long etc.)
+ * makes the actor wait not long enough.
+ *
+ * ### Waiting until a condition is met
+ *
+ * ```ts
+ * import { actorCalled, Wait } from '@serenity-js/core'
+ * import { BrowseTheWebWithPlaywright } from '@serenity-js/playwright'
+ * import { equals } from '@serenity-js/assertions'
+ * import { Browser, chromium } from 'playwright'
+ *
+ * const browser = await chromium.launch({ headless: true })
+ *
+ * await actorCalled('Wendy')
+ *     .whoCan(BrowseTheWebWithPlaywright.using(browser))
+ *     .attemptsTo(
+ *         Wait.until(App.status(), equals('Ready!')),
+ *         // app is ready, proceed with the scenario
+ *     );
+ * ```
+ *
+ * `Wait.until` makes the {@apilink Actor} keep asking the {@apilink Question},
+ * in this case `Text.of(App.status)`, until the answer meets
+ * the expectation, or a timeout expires (default: 5s).
+ *
+ * **Please note** that both Ensure and Wait can be used with
+ * the same expectations, like `equals` or `includes`.
+ *
+ * ### Changing the default timeout
+ *
+ * ```ts
+ *  import { actorCalled, Duration, Wait } from '@serenity-js/core';
+ *  import { BrowseTheWebWithPlaywright } from '@serenity-js/playwright';
+ *  import { equals } from '@serenity-js/assertions';
+ *  import { Browser, chromium } from 'playwright';
+ *
+ *  const browser: Browser = await chromium.launch({ headless: true });
+ *
+ *  await actorCalled('Polly')
+ *      .whoCan(BrowseTheWebWithPlaywright.using(browser))
+ *      .attemptsTo(
+ *          Wait.upTo(Duration.ofSeconds(3))
+ *              .until(App.status(), equals('Ready!')),
+ *          // app is ready, proceed with the scenario
+ *      );
+ * ```
+ *
+ * ## Learn more
+ * - {@apilink SerenityConfig.interactionTimeout}
+ * - {@apilink Duration}
+ * - {@apilink Expectation}
+ *
+ * @group Time
+ */
+class Wait {
+    /**
+     * Instantiates a version of this {@apilink Interaction}
+     * configured to wait for a set duration.
+     *
+     * @param duration
+     *  A set duration the {@apilink Actor} should wait for before proceeding.
+     */
+    static for(duration) {
+        return new WaitFor(duration);
+    }
+    /**
+     * Instantiates a version of this {@apilink Interaction}
+     * configured to wait until the answer to the question `actual` meets the `expectation`,
+     * or the `timeout` expires.
+     *
+     * @param timeout
+     *  Custom timeout to override {@apilink SerenityConfig.interactionTimeout}
+     */
+    static upTo(timeout) {
+        return {
+            until: (actual, expectation) => new WaitUntil(actual, expectation, Wait.defaultPollingInterval.isLessThan(timeout) ? Wait.defaultPollingInterval : timeout, timeout),
+        };
+    }
+    /**
+     * Instantiates a version of this {@apilink Interaction} configured to
+     * poll every {@apilink Wait.defaultPollingInterval} for the result of the provided
+     * question (`actual`) until it meets the `expectation`,
+     * or the timeout expires.
+     *
+     * @param actual
+     *  An {@apilink Answerable} that the {@apilink Actor} will keep answering
+     *  until the answer meets the {@apilink Expectation} provided, or the timeout expires.
+     *
+     * @param expectation
+     *  An {@apilink Expectation} to be met before proceeding
+     */
+    static until(actual, expectation) {
+        return new WaitUntil(actual, expectation, Wait.defaultPollingInterval);
+    }
+}
+exports.Wait = Wait;
+/**
+ * Minimum timeout that can be used with {@apilink Wait.until},
+ * defaults to 250 milliseconds,
+ */
+Wait.minimumTimeout = models_1.Duration.ofMilliseconds(250);
+/**
+ * The amount of time {@apilink Wait.until} should wait between condition checks,
+ * defaults to 500ms.
+ *
+ * Use {@apilink WaitUntil.pollingEvery} to override it for a given interaction.
+ *
+ * @type {Duration}
+ */
+Wait.defaultPollingInterval = models_1.Duration.ofMilliseconds(500);
+/**
+ * Minimum polling interval of 50ms between condition checks, used with {@apilink Wait.until}.
+ */
+Wait.minimumPollingInterval = models_1.Duration.ofMilliseconds(50);
+/**
+ * @package
+ */
+class WaitFor extends Interaction_1.Interaction {
+    constructor(duration) {
+        super((0, io_1.d) `#actor waits for ${duration}`);
+        this.duration = duration;
+    }
+    async performAs(actor) {
+        const duration = await actor.answer(this.duration);
+        return abilities_1.ScheduleWork.as(actor).waitFor(duration);
+    }
+}
+/**
+ * Synchronisation statement that instructs the {@apilink Actor} to wait before proceeding until a given {@apilink Expectation} is met.
+ *
+ * :::tip
+ * To instantiate {@apilink Interaction|interaction} to {@apilink WaitUntil}, use the factory method {@apilink Wait.until}.
+ * :::
+ *
+ * ## Learn more
+ * * {@apilink Wait.until}
+ *
+ * @group Time
+ */
+class WaitUntil extends Interaction_1.Interaction {
+    constructor(actual, expectation, pollingInterval, timeout) {
+        super((0, io_1.d) `#actor waits until ${actual} does ${expectation}`);
+        this.actual = actual;
+        this.expectation = expectation;
+        this.pollingInterval = pollingInterval;
+        this.timeout = timeout;
+        if (timeout) {
+            (0, tiny_types_1.ensure)('Timeout', timeout.inMilliseconds(), (0, tiny_types_1.isGreaterThanOrEqualTo)(Wait.minimumTimeout.inMilliseconds()));
+            (0, tiny_types_1.ensure)('Polling interval', pollingInterval.inMilliseconds(), (0, tiny_types_1.isInRange)(Wait.minimumPollingInterval.inMilliseconds(), timeout.inMilliseconds()));
+        }
+        (0, tiny_types_1.ensure)('Polling interval', pollingInterval.inMilliseconds(), (0, tiny_types_1.isGreaterThanOrEqualTo)(Wait.minimumPollingInterval.inMilliseconds()));
+    }
+    /**
+     * Configure how frequently the {@apilink Actor} should check if the answer meets the expectation.
+     *
+     * Note that the polling interval defines the delay between subsequent attempts
+     * to evaluate the expected value, and doesn't include the amount of time
+     * it take the actor to evaluate the value itself.
+     *
+     * @param interval
+     */
+    pollingEvery(interval) {
+        return new WaitUntil(this.actual, this.expectation, interval, this.timeout);
+    }
+    /**
+     * @inheritDoc
+     */
+    async performAs(actor) {
+        await abilities_1.ScheduleWork.as(actor).repeatUntil(() => actor.answer(this.expectation.isMetFor(this.actual)), {
+            exitCondition: outcome => outcome instanceof questions_1.ExpectationMet,
+            delayBetweenInvocations: (invocation) => invocation === 0
+                ? models_1.Duration.ofMilliseconds(0)
+                : this.pollingInterval,
+            timeout: this.timeout,
+            errorHandler: (error, outcome) => {
+                if (error instanceof errors_1.ListItemNotFoundError) {
+                    return; // ignore, lists might get populated later
+                }
+                if (error instanceof errors_1.TimeoutExpiredError) {
+                    throw errors_1.RaiseErrors.as(actor).create(errors_1.AssertionError, {
+                        message: error.message + (0, io_1.d) ` while waiting for ${this.actual} to ${this.expectation}`,
+                        expectation: outcome === null || outcome === void 0 ? void 0 : outcome.expectation,
+                        diff: outcome && { expected: outcome === null || outcome === void 0 ? void 0 : outcome.expected, actual: outcome === null || outcome === void 0 ? void 0 : outcome.actual },
+                        location: this.instantiationLocation(),
+                        cause: error,
+                    });
+                }
+                throw error;
+            }
+        });
+    }
+}
+exports.WaitUntil = WaitUntil;
+//# sourceMappingURL=Wait.js.map

package/lib/screenplay/time/activities/Wait.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Wait.js","sourceRoot":"","sources":["../../../../src/screenplay/time/activities/Wait.ts"],"names":[],"mappings":";;;AAAA,2CAAuE;AAEvE,4CAA0G;AAC1G,oCAAgC;AAGhC,mDAAgD;AAChD,+CAAoG;AACpG,4CAA4C;AAC5C,sCAAqC;AAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuHG;AACH,MAAa,IAAI;IAuBb;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,CAAC,QAA8B;QACrC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,OAAiB;QACzB,OAAO;YACH,KAAK,EAAE,CAAS,MAA0B,EAAE,WAAgC,EAAqB,EAAE,CAC/F,IAAI,SAAS,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC;SAC3I,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,KAAK,CAAS,MAA0B,EAAE,WAAgC;QAC7E,OAAO,IAAI,SAAS,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAC3E,CAAC;;AAhEL,oBAiEC;AA/DG;;;GAGG;AACa,mBAAc,GAAG,iBAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;AAE9D;;;;;;;GAOG;AACa,2BAAsB,GAAG,iBAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;AAEtE;;GAEG;AACa,2BAAsB,GAAG,iBAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;AA8CzE;;GAEG;AACH,MAAM,OAAQ,SAAQ,yBAAW;IAC7B,YAA6B,QAA8B;QACvD,KAAK,CAAC,IAAA,MAAC,EAAA,oBAAqB,QAAS,EAAE,CAAC,CAAC;QADhB,aAAQ,GAAR,QAAQ,CAAsB;IAE3D,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAuC;QACnD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEnD,OAAO,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;CACJ;AAED;;;;;;;;;;;GAWG;AACH,MAAa,SAAkB,SAAQ,yBAAW;IAC9C,YACqB,MAA0B,EAC1B,WAAgC,EAChC,eAAyB,EACzB,OAAkB;QAEnC,KAAK,CAAC,IAAA,MAAC,EAAA,sBAAuB,MAAO,SAAU,WAAY,EAAE,CAAC,CAAC;QAL9C,WAAM,GAAN,MAAM,CAAoB;QAC1B,gBAAW,GAAX,WAAW,CAAqB;QAChC,oBAAe,GAAf,eAAe,CAAU;QACzB,YAAO,GAAP,OAAO,CAAW;QAInC,IAAI,OAAO,EAAE;YACT,IAAA,mBAAM,EAAC,SAAS,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,IAAA,mCAAsB,EAAC,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;YAC1G,IAAA,mBAAM,EAAC,kBAAkB,EAAE,eAAe,CAAC,cAAc,EAAE,EAAE,IAAA,sBAAS,EAAC,IAAI,CAAC,sBAAsB,CAAC,cAAc,EAAE,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;SACnJ;QAED,IAAA,mBAAM,EAAC,kBAAkB,EAAE,eAAe,CAAC,cAAc,EAAE,EAAE,IAAA,mCAAsB,EAAC,IAAI,CAAC,sBAAsB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACvI,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CAAC,QAAkB;QAC3B,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAuC;QAEnD,MAAM,wBAAY,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,CACpC,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAC1D;YACI,aAAa,EAAE,OAAO,CAAC,EAAE,CACrB,OAAO,YAAY,0BAAc;YAErC,uBAAuB,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,KAAK,CAAC;gBACrD,CAAC,CAAC,iBAAQ,CAAC,cAAc,CAAC,CAAC,CAAC;gBAC5B,CAAC,CAAC,IAAI,CAAC,eAAe;YAE1B,OAAO,EAAE,IAAI,CAAC,OAAO;YAErB,YAAY,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;gBAC7B,IAAI,KAAK,YAAY,8BAAqB,EAAE;oBACxC,OAAO,CAAC,0CAA0C;iBACrD;gBAED,IAAI,KAAK,YAAY,4BAAmB,EAAE;oBAEtC,MAAM,oBAAW,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,uBAAc,EAAE;wBAC/C,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,IAAA,MAAC,EAAA,sBAAuB,IAAI,CAAC,MAAO,OAAQ,IAAI,CAAC,WAAY,EAAE;wBACxF,WAAW,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW;wBACjC,IAAI,EAAE,OAAO,IAAI,EAAE,QAAQ,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE;wBACzE,QAAQ,EAAE,IAAI,CAAC,qBAAqB,EAAE;wBACtC,KAAK,EAAE,KAAK;qBACf,CAAC,CAAC;iBACN;gBAED,MAAM,KAAK,CAAC;YAChB,CAAC;SACJ,CACJ,CAAC;IACN,CAAC;CACJ;AApED,8BAoEC"}

package/lib/screenplay/time/activities/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Wait';
+//# sourceMappingURL=index.d.ts.map

package/lib/screenplay/time/activities/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/time/activities/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA"}

package/lib/screenplay/{interactions → time/activities}/index.js

@@ -1,7 +1,11 @@
 "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]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -10,6 +14,5 @@ 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("./Log"), exports);
-__exportStar(require("./TakeNote"), exports);
+__exportStar(require("./Wait"), exports);
 //# sourceMappingURL=index.js.map

package/lib/screenplay/time/activities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/screenplay/time/activities/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB"}

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

@@ -0,0 +1,4 @@
+export * from './abilities';
+export * from './activities';
+export * from './models';
+//# sourceMappingURL=index.d.ts.map

package/lib/screenplay/time/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/screenplay/time/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC"}

package/lib/screenplay/time/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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("./abilities"), exports);
+__exportStar(require("./activities"), exports);
+__exportStar(require("./models"), exports);
+//# sourceMappingURL=index.js.map

package/lib/screenplay/time/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/time/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,+CAA6B;AAC7B,2CAAyB"}

package/lib/screenplay/time/models/Clock.d.ts

@@ -0,0 +1,24 @@
+import { Timestamp } from './Timestamp';
+/**
+ * A {@apilink Clock} tells the time. This abstraction allows Serenity/JS to have a single place
+ * in the framework responsible for telling the time, and one that can be easily mocked for internal testing.
+ *
+ * ```ts
+ * const now: Timestamp = new Clock().now()
+ * ```
+ *
+ * ## Learn more
+ * - {@apilink Timestamp}
+ * - {@apilink Duration}
+ *
+ * @group Time
+ */
+export declare class Clock {
+    private readonly checkTime;
+    constructor(checkTime?: () => Date);
+    /**
+     * Returns current time
+     */
+    now(): Timestamp;
+}
+//# sourceMappingURL=Clock.d.ts.map

package/lib/screenplay/time/models/Clock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Clock.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/time/models/Clock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;;;;;;;GAaG;AACH,qBAAa,KAAK;IAEF,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,GAAE,MAAM,IAAuB;IAGrE;;OAEG;IACH,GAAG,IAAI,SAAS;CAGnB"}

package/lib/screenplay/time/models/Clock.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Clock = void 0;
+const Timestamp_1 = require("./Timestamp");
+/**
+ * A {@apilink Clock} tells the time. This abstraction allows Serenity/JS to have a single place
+ * in the framework responsible for telling the time, and one that can be easily mocked for internal testing.
+ *
+ * ```ts
+ * const now: Timestamp = new Clock().now()
+ * ```
+ *
+ * ## Learn more
+ * - {@apilink Timestamp}
+ * - {@apilink Duration}
+ *
+ * @group Time
+ */
+class Clock {
+    constructor(checkTime = () => new Date()) {
+        this.checkTime = checkTime;
+    }
+    /**
+     * Returns current time
+     */
+    now() {
+        return new Timestamp_1.Timestamp(this.checkTime());
+    }
+}
+exports.Clock = Clock;
+//# sourceMappingURL=Clock.js.map

package/lib/screenplay/time/models/Clock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Clock.js","sourceRoot":"","sources":["../../../../src/screenplay/time/models/Clock.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AAExC;;;;;;;;;;;;;GAaG;AACH,MAAa,KAAK;IAEd,YAA6B,YAAwB,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;QAAxC,cAAS,GAAT,SAAS,CAA+B;IACrE,CAAC;IAED;;OAEG;IACH,GAAG;QACC,OAAO,IAAI,qBAAS,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3C,CAAC;CACJ;AAXD,sBAWC"}

package/lib/screenplay/time/models/DelayedCallback.d.ts

@@ -0,0 +1,11 @@
+import { Timestamp } from './Timestamp';
+/**
+ * @group Time
+ */
+export interface DelayedCallback<Result> {
+    (stats: {
+        currentTime: Timestamp;
+        i: number;
+    }): Promise<Result> | Result;
+}
+//# sourceMappingURL=DelayedCallback.d.ts.map

package/lib/screenplay/time/models/DelayedCallback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DelayedCallback.d.ts","sourceRoot":"","sources":["../../../../src/screenplay/time/models/DelayedCallback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,MAAM;IACnC,CAAC,KAAK,EAAE;QAAE,WAAW,EAAE,SAAS,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;CAC5E"}

package/lib/screenplay/time/models/DelayedCallback.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DelayedCallback.js.map

package/lib/screenplay/time/models/DelayedCallback.js.map

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