@serenity-js/core 3.41.2 → 3.42.1

package/esm/screenplay/abilities/CanHaveAbilities.d.ts

@@ -0,0 +1,19 @@
+import type { Ability } from './Ability.js';
+import type { UsesAbilities } from './UsesAbilities.js';
+/**
+ * Describes an [`Actor`](https://serenity-js.org/api/core/class/Actor/) who can have an [`Ability`](https://serenity-js.org/api/core/class/Ability/) to perform some [`Activity`](https://serenity-js.org/api/core/class/Activity/).
+ *
+ * ## Learn more
+ *
+ * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ *
+ * @group Actors
+ */
+export interface CanHaveAbilities<Returned_Type = UsesAbilities> {
+    /**
+     * Assigns an [`Ability`](https://serenity-js.org/api/core/class/Ability/) or several abilities to the [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+     */
+    whoCan(...abilities: Ability[]): Returned_Type;
+}
+//# sourceMappingURL=CanHaveAbilities.d.ts.map

package/esm/screenplay/abilities/CanHaveAbilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CanHaveAbilities.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/CanHaveAbilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAgB,CAAC,aAAa,GAAG,aAAa;IAE3D;;OAEG;IACH,MAAM,CAAC,GAAG,SAAS,EAAE,OAAO,EAAE,GAAG,aAAa,CAAC;CAClD"}

package/esm/screenplay/abilities/CanHaveAbilities.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CanHaveAbilities.js.map

package/esm/screenplay/abilities/CanHaveAbilities.js.map

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

package/esm/screenplay/abilities/Discardable.d.ts

@@ -0,0 +1,26 @@
+/**
+ * An interface to be implemented by any [`Ability`](https://serenity-js.org/api/core/class/Ability/) that needs to free up
+ * the resources it uses, e.g. disconnect from a database.
+ *
+ * This [`Discardable.discard`](https://serenity-js.org/api/core/interface/Discardable/#discard) method is invoked directly by the [actor](https://serenity-js.org/api/core/class/Actor/), and indirectly by the [stage](https://serenity-js.org/api/core/class/Stage/):
+ * - when [SceneFinishes](https://serenity-js.org/api/core-events/class/SceneFinishes/), for actors instantiated after [SceneStarts](https://serenity-js.org/api/core-events/class/SceneStarts/) - e.g. within a test scenario or in a "before each" hook
+ * - when [`TestRunFinishes`](https://serenity-js.org/api/core-events/class/TestRunFinishes/), for actors instantiated before [SceneStarts](https://serenity-js.org/api/core-events/class/SceneStarts/) - e.g. in a "before all" hook
+ *
+ * Note that events such as [SceneFinishes](https://serenity-js.org/api/core-events/class/SceneFinishes/) and [`TestRunFinishes`](https://serenity-js.org/api/core-events/class/TestRunFinishes/) are emitted by Serenity/JS test runner adapters,
+ * such as `@serenity-js/cucumber`, `@serenity-js/mocha`, `@serenity-js/jasmine`, and so on.
+ * Consult their respective readmes to learn how to register them with your test runner of choice.
+ *
+ * ## Learn more
+ * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+ * - [`AbilityType`](https://serenity-js.org/api/core/#AbilityType)
+ * - [`Initialisable`](https://serenity-js.org/api/core/interface/Initialisable/)
+ *
+ * @group Abilities
+ */
+export interface Discardable {
+    /**
+     * Discards the resources associated with this ability.
+     */
+    discard(): Promise<void> | void;
+}
+//# sourceMappingURL=Discardable.d.ts.map

package/esm/screenplay/abilities/Discardable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Discardable.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/Discardable.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,WAAW;IAExB;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACnC"}

package/esm/screenplay/abilities/Discardable.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Discardable.js.map

package/esm/screenplay/abilities/Discardable.js.map

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

package/esm/screenplay/abilities/Initialisable.d.ts

@@ -0,0 +1,33 @@
+/**
+ * An interface to be implemented by any [`Ability`](https://serenity-js.org/api/core/class/Ability/) that needs to initialise
+ * the resources it uses, e.g. establish a database connection.
+ *
+ * The [`Initialisable.initialise`](https://serenity-js.org/api/core/interface/Initialisable/#initialise) method is invoked whenever [`Actor.attemptsTo`](https://serenity-js.org/api/core/class/Actor/#attemptsTo) method is called,
+ * but **only when** [`Initialisable.isInitialised`](https://serenity-js.org/api/core/interface/Initialisable/#isInitialised) returns false. This is to avoid initialising abilities more than once.
+ *
+ * ## Learn more
+ * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+ * - [`AbilityType`](https://serenity-js.org/api/core/#AbilityType)
+ * - [`Discardable`](https://serenity-js.org/api/core/interface/Discardable/)
+ *
+ * @group Abilities
+ */
+export interface Initialisable {
+    /**
+     * Initialises the ability. Invoked whenever [`Actor.attemptsTo`](https://serenity-js.org/api/core/class/Actor/#attemptsTo) method is called,
+     * but **only when** [`Initialisable.isInitialised`](https://serenity-js.org/api/core/interface/Initialisable/#isInitialised) returns false.
+     *
+     * Make sure to implement [`Initialisable.isInitialised`](https://serenity-js.org/api/core/interface/Initialisable/#isInitialised) so that it returns `true`
+     * when the ability has been successfully initialised.
+     */
+    initialise(): Promise<void> | void;
+    /**
+     * Should return `true` when all the resources that the given ability needs
+     * have been initialised. Should return `false` if the [`Actor`](https://serenity-js.org/api/core/class/Actor/) should
+     * initialise them again when [`Actor.attemptsTo`](https://serenity-js.org/api/core/class/Actor/#attemptsTo) is called.
+     *
+     * @returns {boolean}
+     */
+    isInitialised(): boolean;
+}
+//# sourceMappingURL=Initialisable.d.ts.map

package/esm/screenplay/abilities/Initialisable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Initialisable.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/Initialisable.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,aAAa;IAE1B;;;;;;OAMG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAEnC;;;;;;OAMG;IACH,aAAa,IAAI,OAAO,CAAC;CAC5B"}

package/esm/screenplay/abilities/Initialisable.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Initialisable.js.map

package/esm/screenplay/abilities/Initialisable.js.map

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

package/esm/screenplay/abilities/PerformActivities.d.ts

@@ -0,0 +1,30 @@
+import type { EmitsDomainEvents } from '../../events/index.js';
+import { type Outcome } from '../../model/index.js';
+import type { PerformsActivities } from '../activities/PerformsActivities.js';
+import type { Activity } from '../Activity.js';
+import type { AnswersQuestions } from '../questions/index.js';
+import { Ability } from './Ability.js';
+import type { UsesAbilities } from './UsesAbilities.js';
+/**
+ * An [`Ability`](https://serenity-js.org/api/core/class/Ability/) that enables an [`Actor`](https://serenity-js.org/api/core/class/Actor/) to perform a given [`Activity`](https://serenity-js.org/api/core/class/Activity/).
+ *
+ * [`PerformActivities`](https://serenity-js.org/api/core/class/PerformActivities/) is used internally by [`Actor.attemptsTo`](https://serenity-js.org/api/core/class/Actor/#attemptsTo), and it is unlikely you'll ever need to use it directly in your code.
+ * That is, unless you're building a custom Serenity/JS extension and want to override the default behaviour of the framework,
+ * in which case you should check out the [Contributor's Guide](https://serenity-js.org/community/contributing).
+ *
+ * @group Abilities
+ */
+export declare class PerformActivities extends Ability {
+    protected readonly actor: AnswersQuestions & UsesAbilities & PerformsActivities & {
+        name: string;
+    };
+    protected readonly stage: EmitsDomainEvents;
+    constructor(actor: AnswersQuestions & UsesAbilities & PerformsActivities & {
+        name: string;
+    }, stage: EmitsDomainEvents);
+    perform(activity: Activity): Promise<void>;
+    protected outcomeFor(error: Error | any): Outcome;
+    private detailsOf;
+    protected nameOf(activity: Activity): string;
+}
+//# sourceMappingURL=PerformActivities.d.ts.map

package/esm/screenplay/abilities/PerformActivities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PerformActivities.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/PerformActivities.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAG/D,OAAO,EAAoB,KAAK,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAUtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD;;;;;;;;GAQG;AACH,qBAAa,iBAAkB,SAAQ,OAAO;IAEtC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,gBAAgB,GAAG,aAAa,GAAG,kBAAkB,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAClG,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,iBAAiB;gBADxB,KAAK,EAAE,gBAAgB,GAAG,aAAa,GAAG,kBAAkB,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAC/E,KAAK,EAAE,iBAAiB;IAKzC,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAyChD,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,GAAG,GAAG,OAAO;IAsBjD,OAAO,CAAC,SAAS;IAOjB,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM;CAO/C"}

package/esm/screenplay/abilities/PerformActivities.js

@@ -0,0 +1,75 @@
+import { match } from 'tiny-types';
+import { AssertionError, ImplementationPendingError, TestCompromisedError } from '../../errors/index.js';
+import { InteractionFinished, InteractionStarts, TaskFinished, TaskStarts } from '../../events/index.js';
+import { ValueInspector } from '../../io/index.js';
+import { ExecutionSkipped } from '../../model/index.js';
+import { ActivityDetails, ExecutionCompromised, ExecutionFailedWithAssertionError, ExecutionFailedWithError, ExecutionSuccessful, ImplementationPending, Name } from '../../model/index.js';
+import { Interaction } from '../Interaction.js';
+import { Ability } from './Ability.js';
+/**
+ * An [`Ability`](https://serenity-js.org/api/core/class/Ability/) that enables an [`Actor`](https://serenity-js.org/api/core/class/Actor/) to perform a given [`Activity`](https://serenity-js.org/api/core/class/Activity/).
+ *
+ * [`PerformActivities`](https://serenity-js.org/api/core/class/PerformActivities/) is used internally by [`Actor.attemptsTo`](https://serenity-js.org/api/core/class/Actor/#attemptsTo), and it is unlikely you'll ever need to use it directly in your code.
+ * That is, unless you're building a custom Serenity/JS extension and want to override the default behaviour of the framework,
+ * in which case you should check out the [Contributor's Guide](https://serenity-js.org/community/contributing).
+ *
+ * @group Abilities
+ */
+export class PerformActivities extends Ability {
+    actor;
+    stage;
+    constructor(actor, stage) {
+        super();
+        this.actor = actor;
+        this.stage = stage;
+    }
+    async perform(activity) {
+        const sceneId = this.stage.currentSceneId();
+        const details = this.detailsOf(this.nameOf(activity), activity.instantiationLocation());
+        const activityId = this.stage.assignNewActivityId(details);
+        const [activityStarts, activityFinished] = activity instanceof Interaction
+            ? [InteractionStarts, InteractionFinished]
+            : [TaskStarts, TaskFinished];
+        try {
+            this.stage.announce(new activityStarts(sceneId, activityId, details, this.stage.currentTime()));
+            await activity.performAs(this.actor);
+            const name = await activity.describedBy(this.actor);
+            this.stage.announce(new activityFinished(sceneId, activityId, this.detailsOf(name, activity.instantiationLocation()), new ExecutionSuccessful(), this.stage.currentTime()));
+        }
+        catch (error) {
+            this.stage.announce(new activityFinished(sceneId, activityId, details, this.outcomeFor(error), this.stage.currentTime()));
+            throw error;
+        }
+        finally {
+            await this.stage.waitForNextCue();
+        }
+    }
+    outcomeFor(error) {
+        return match(error)
+            .when(ImplementationPendingError, _ => new ImplementationPending(error))
+            .when(TestCompromisedError, _ => new ExecutionCompromised(error))
+            .when(AssertionError, _ => new ExecutionFailedWithAssertionError(error))
+            .when(Error, _ => {
+            // Mocha
+            if (/AssertionError/.test(error.constructor.name)) {
+                return new ExecutionFailedWithAssertionError(error);
+            }
+            // Playwright Test
+            if (/TestSkipError/.test(error.constructor.name)) {
+                return new ExecutionSkipped(error);
+            }
+            return new ExecutionFailedWithError(error);
+        })
+            .else(_ => new ExecutionFailedWithError(error));
+    }
+    detailsOf(name, instantiationLocation) {
+        return new ActivityDetails(new Name(name), instantiationLocation);
+    }
+    nameOf(activity) {
+        const template = ValueInspector.hasItsOwnToString(activity)
+            ? activity.toString()
+            : `#actor performs ${activity.constructor.name}`;
+        return template.replaceAll('#actor', this.actor.name);
+    }
+}
+//# sourceMappingURL=PerformActivities.js.map

package/esm/screenplay/abilities/PerformActivities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PerformActivities.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/PerformActivities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAEzG,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACzG,OAAO,EAA2B,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAgB,MAAM,sBAAsB,CAAC;AACtE,OAAO,EACH,eAAe,EACf,oBAAoB,EACpB,iCAAiC,EACjC,wBAAwB,EACxB,mBAAmB,EACnB,qBAAqB,EACrB,IAAI,EACP,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;;;;;;;GAQG;AACH,MAAM,OAAO,iBAAkB,SAAQ,OAAO;IAEnB;IACA;IAFvB,YACuB,KAA+E,EAC/E,KAAwB;QAE3C,KAAK,EAAE,CAAC;QAHW,UAAK,GAAL,KAAK,CAA0E;QAC/E,UAAK,GAAL,KAAK,CAAmB;IAG/C,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,QAAkB;QAC5B,MAAM,OAAO,GAAM,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;QAC/C,MAAM,OAAO,GAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAC3F,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAE3D,MAAM,CAAE,cAAc,EAAE,gBAAgB,CAAE,GAAG,QAAQ,YAAY,WAAW;YACxE,CAAC,CAAC,CAAE,iBAAiB,EAAE,mBAAmB,CAAE;YAC5C,CAAC,CAAC,CAAE,UAAU,EAAE,YAAY,CAAE,CAAC;QAEnC,IAAI,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,QAAQ,CACf,IAAI,cAAc,CACd,OAAO,EACP,UAAU,EACV,OAAO,EACP,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CACJ,CAAC;YAEF,MAAM,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAErC,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAEpD,IAAI,CAAC,KAAK,CAAC,QAAQ,CACf,IAAI,gBAAgB,CAChB,OAAO,EACP,UAAU,EACV,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,qBAAqB,EAAE,CAAC,EACtD,IAAI,mBAAmB,EAAE,EACzB,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CACJ,CAAC;QACN,CAAC;QACD,OAAO,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YAC1H,MAAM,KAAK,CAAC;QAChB,CAAC;gBACO,CAAC;YACL,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;QACtC,CAAC;IACL,CAAC;IACS,UAAU,CAAC,KAAkB;QACnC,OAAO,KAAK,CAAiB,KAAK,CAAC;aAC9B,IAAI,CAAC,0BAA0B,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,qBAAqB,CAAC,KAAK,CAAC,CAAC;aACvE,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,oBAAoB,CAAC,KAAK,CAAC,CAAC;aAChE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,iCAAiC,CAAC,KAAK,CAAC,CAAC;aACvE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE;YAEb,QAAQ;YACR,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChD,OAAO,IAAI,iCAAiC,CAAC,KAAK,CAAC,CAAA;YACvD,CAAC;YAED,kBAAkB;YAClB,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/C,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC;YACvC,CAAC;YAED,OAAO,IAAI,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,CAAC;IAEO,SAAS,CAAC,IAAY,EAAE,qBAAyC;QACrE,OAAO,IAAI,eAAe,CACtB,IAAI,IAAI,CAAC,IAAI,CAAC,EACd,qBAAqB,CACxB,CAAA;IACL,CAAC;IAES,MAAM,CAAC,QAAkB;QAC/B,MAAM,QAAQ,GAAG,cAAc,CAAC,iBAAiB,CAAC,QAAQ,CAAC;YACvD,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACrB,CAAC,CAAC,mBAAoB,QAAQ,CAAC,WAAW,CAAC,IAAK,EAAE,CAAC;QAEvD,OAAO,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;CACJ"}

package/esm/screenplay/abilities/SerialisedAbility.d.ts

@@ -0,0 +1,10 @@
+import type { JSONValue } from 'tiny-types';
+/**
+ * @group Abilities
+ */
+export interface SerialisedAbility {
+    type: string;
+    class?: string;
+    options?: JSONValue;
+}
+//# sourceMappingURL=SerialisedAbility.d.ts.map

package/esm/screenplay/abilities/SerialisedAbility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SerialisedAbility.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/SerialisedAbility.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,SAAS,CAAC;CACvB"}

package/esm/screenplay/abilities/SerialisedAbility.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SerialisedAbility.js.map

package/esm/screenplay/abilities/SerialisedAbility.js.map

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

package/esm/screenplay/abilities/UsesAbilities.d.ts

@@ -0,0 +1,23 @@
+import type { Ability } from './Ability.js';
+import type { AbilityType } from './AbilityType.js';
+/**
+ * Describes an [`Actor`](https://serenity-js.org/api/core/class/Actor/) who can use their [abilities](https://serenity-js.org/api/core/class/Ability/) to perform an [`Activity`](https://serenity-js.org/api/core/class/Activity/)
+ * or answer a [`Question`](https://serenity-js.org/api/core/class/Question/).
+ *
+ * ## Learn more
+ *
+ * - [`Ability`](https://serenity-js.org/api/core/class/Ability/)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ *
+ * @group Actors
+ */
+export interface UsesAbilities {
+    /**
+     * Provides access to the [actor's](https://serenity-js.org/api/core/class/Actor/) [`Ability`](https://serenity-js.org/api/core/class/Ability/) to do something
+     *
+     * @param doSomething
+     *  The type of ability to look up, e.g. [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) or [`CallAnApi`](https://serenity-js.org/api/rest/class/CallAnApi/)
+     */
+    abilityTo<T extends Ability>(doSomething: AbilityType<T>): T;
+}
+//# sourceMappingURL=UsesAbilities.d.ts.map

package/esm/screenplay/abilities/UsesAbilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UsesAbilities.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/UsesAbilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAa;IAE1B;;;;;OAKG;IACH,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CAChE"}

package/esm/screenplay/abilities/UsesAbilities.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=UsesAbilities.js.map

package/esm/screenplay/abilities/UsesAbilities.js.map

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

package/esm/screenplay/abilities/index.d.ts

@@ -0,0 +1,10 @@
+export * from './Ability.js';
+export * from './AbilityType.js';
+export * from './AnswerQuestions.js';
+export * from './CanHaveAbilities.js';
+export * from './Discardable.js';
+export * from './Initialisable.js';
+export * from './PerformActivities.js';
+export * from './SerialisedAbility.js';
+export * from './UsesAbilities.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/screenplay/abilities/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC"}

package/esm/screenplay/abilities/index.js

@@ -0,0 +1,10 @@
+export * from './Ability.js';
+export * from './AbilityType.js';
+export * from './AnswerQuestions.js';
+export * from './CanHaveAbilities.js';
+export * from './Discardable.js';
+export * from './Initialisable.js';
+export * from './PerformActivities.js';
+export * from './SerialisedAbility.js';
+export * from './UsesAbilities.js';
+//# sourceMappingURL=index.js.map

package/esm/screenplay/abilities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC"}

package/esm/screenplay/activities/PerformsActivities.d.ts

@@ -0,0 +1,20 @@
+import type { Activity } from '../Activity.js';
+/**
+ * Describes an [`Actor`](https://serenity-js.org/api/core/class/Actor/) who can perform a sequence of [activities](https://serenity-js.org/api/core/class/Activity/),
+ * such as [tasks](https://serenity-js.org/api/core/class/Task/) or [interactions](https://serenity-js.org/api/core/class/Interaction/).
+ *
+ * ## Learn more
+ * - [`Activity`](https://serenity-js.org/api/core/class/Activity/)
+ * - [`Interaction`](https://serenity-js.org/api/core/class/Interaction/)
+ * - [`Task`](https://serenity-js.org/api/core/class/Task/)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ *
+ * @group Actors
+ */
+export interface PerformsActivities {
+    /**
+     * Makes the [`Actor`](https://serenity-js.org/api/core/class/Actor/) attempt to perform a sequence of [activities](https://serenity-js.org/api/core/class/Activity/).
+     */
+    attemptsTo: (...activities: Activity[]) => Promise<void>;
+}
+//# sourceMappingURL=PerformsActivities.d.ts.map

package/esm/screenplay/activities/PerformsActivities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PerformsActivities.d.ts","sourceRoot":"","sources":["../../../src/screenplay/activities/PerformsActivities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/C;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,kBAAkB;IAE/B;;OAEG;IACH,UAAU,EAAE,CAAC,GAAG,UAAU,EAAE,QAAQ,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5D"}

package/esm/screenplay/activities/PerformsActivities.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PerformsActivities.js.map

package/esm/screenplay/activities/PerformsActivities.js.map

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

package/esm/screenplay/activities/index.d.ts

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

package/esm/screenplay/activities/index.d.ts.map

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

package/esm/screenplay/activities/index.js

@@ -0,0 +1,2 @@
+export * from './PerformsActivities.js';
+//# sourceMappingURL=index.js.map

package/esm/screenplay/activities/index.js.map

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

package/esm/screenplay/artifacts/CollectsArtifacts.d.ts

@@ -0,0 +1,77 @@
+import type { Artifact, Name } from '../../model/index.js';
+/**
+ * Describes an [`Actor`](https://serenity-js.org/api/core/class/Actor/) who can collect artifacts, such as photos or `JSON` data.,
+ * while the scenario is being executed
+ *
+ * ## Learn more
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ *
+ * @group Actors
+ */
+export interface CollectsArtifacts {
+    /**
+     * Makes the [`Actor`](https://serenity-js.org/api/core/class/Actor/) collect an artifact so that it can be included in the test report.
+     *
+     * #### Implementing a custom interaction to attach artifacts
+     *
+     * ```ts
+     * import fs from 'node:fs';
+     * import { Answerable, Interaction, the } from '@serenity-js/core'
+     * import { Path } from '@serenity-js/core/io'
+     * import { Name, TextData } from '@serenity-js/core/model'
+     *
+     * export class Attach {
+     *
+     *   static contentsOf = (pathToFile: Path): Interaction =>
+     *     Interaction.where(`#actor attaches contents of ${ pathToFile.basename() }`, async actor => {
+     *       const data = fs.readFileSync(pathToFile.value).toString('utf-8');
+     *
+     *       actor.collect(
+     *         TextData.fromJSON({ contentType: 'text/plain', data }),
+     *         new Name(pathToFile.basename()),
+     *       )
+     *     })
+     *
+     *   static textData = (contents: Answerable<string>, name?: string): Interaction =>
+     *     Interaction.where(the`#actor attaches text data`, async actor => {
+     *       const data = await actor.answer(contents);
+     *
+     *       actor.collect(
+     *         TextData.fromJSON({ contentType: 'text/plain', data }),
+     *         name && new Name(name),
+     *       )
+     *     })
+     * }
+     * ```
+     *
+     * #### Attaching plain text
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Path } from '@serenity-js/core/io'
+     *
+     * actorCalled('Alice').attemptsTo(
+     *   Attach.textData('some text', 'some name'),
+     * )
+     * ```
+     *
+     * #### Attaching contents of a text file
+     *
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core'
+     * import { Log } from '@serenity-js/core'
+     *
+     * actorCalled('Alice').attemptsTo(
+     *   Attach.contentsOf(Path.from(__dirname, 'output/server.log')),
+     * )
+     * ```
+     *
+     * @param artifact
+     *  The artifact to be collected, such as `JSON` data.
+     *
+     * @param name
+     *  The name of the artifact to make it easy to recognise in the test report
+     */
+    collect(artifact: Artifact, name?: Name): void;
+}
+//# sourceMappingURL=CollectsArtifacts.d.ts.map

package/esm/screenplay/artifacts/CollectsArtifacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CollectsArtifacts.d.ts","sourceRoot":"","sources":["../../../src/screenplay/artifacts/CollectsArtifacts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAE3D;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CAClD"}

package/esm/screenplay/artifacts/CollectsArtifacts.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CollectsArtifacts.js.map

package/esm/screenplay/artifacts/CollectsArtifacts.js.map

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

package/esm/screenplay/artifacts/index.d.ts

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

package/esm/screenplay/artifacts/index.d.ts.map

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

package/esm/screenplay/artifacts/index.js

@@ -0,0 +1,2 @@
+export * from './CollectsArtifacts.js';
+//# sourceMappingURL=index.js.map

package/esm/screenplay/artifacts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/screenplay/artifacts/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC"}

package/esm/screenplay/debugging/Debug.d.ts

@@ -0,0 +1,108 @@
+import type { UsesAbilities } from '../abilities/index.js';
+import type { Answerable } from '../Answerable.js';
+import type { Answered } from '../Answered.js';
+import type { CollectsArtifacts } from '../artifacts/index.js';
+import { Interaction } from '../Interaction.js';
+import type { AnswersQuestions } from '../questions/index.js';
+import type { DebuggingResult } from './DebuggingResult.js';
+/**
+ * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to evaluate and [log](https://serenity-js.org/api/core/class/Log/) the provided [answerable](https://serenity-js.org/api/core/#Answerable) values.
+ *
+ * Since this interaction **accepts a callback function** that receives the evaluated results,
+ * the best way to use it is while **running the test scenario via a Node.js debugger**.
+ * See the links below to learn how to do it in popular IDEs.
+ *
+ * ## Debugging Answerable values
+ *
+ * [`Debug.values`](https://serenity-js.org/api/core/class/Debug/#values) accepts a callback function that receives an array of [`DebuggingResult`](https://serenity-js.org/api/core/interface/DebuggingResult/) objects,
+ * as well as the result of evaluating each provided [answerable](https://serenity-js.org/api/core/#Answerable) with [`Actor.answer`](https://serenity-js.org/api/core/class/Actor/#answer).
+ *
+ * ```typescript
+ * import { actorCalled, Debug } from '@serenity-js/core'
+ * import { Navigate, Page } from '@serenity-js/web'
+ *
+ * // Running the below through the Node.js debugger makes the actor resolve the provided values
+ * // and return them to the debugger function, where you can investigate their contents,
+ * // or inspect any Errors the evaluation has resulted with.
+ * await actorCalled('Debbie').attemptsTo(
+ *     Navigate.to('http://example.org'),
+ *     Debug.values((results, title, url) => {
+ *         // set a breakpoint here to view `results`, `title` and `url` in your IDE debugger
+ *     }, Page.current().title(), Page.current().url()), // accepts multiple values
+ * );
+ * ```
+ *
+ * ## Accessing Playwright Page
+ *
+ * [Playwright Test for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright)
+ * provides features that allow for [experimenting with web UI locators](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright#tune-locators)
+ * while the test is paused at breakpoint.
+ *
+ * Since this functionality is specific to [Playwright](https://serenity-js.org/api/playwright),
+ * you can use it by passing [`PlaywrightPage.current().nativePage()`](https://serenity-js.org/api/playwright/class/PlaywrightPage/#current)
+ * to Serenity/JS [`Debug.values`](https://serenity-js.org/api/core/class/Debug/#values). Also make sure to name the evaluated value `page`, as this is the variable name that the Playwright VSCode extension expects.
+ *
+ * ```typescript
+ * import { actorCalled, Debug } from '@serenity-js/core'
+ * import { PlaywrightPage } from '@serenity-js/playwright'
+ *
+ * // Running the below through the Node.js debugger makes the actor resolve the provided values
+ * // and return them to the debugger function, where you can investigate their contents,
+ * // or inspect any Errors the evaluation has resulted with.
+ * await actorCalled('Debbie').attemptsTo(
+ *     Navigate.to('http://example.org'),
+ *     Debug.values((results, page) => {
+ *         // set a breakpoint here to use Playwright locator debugging features
+ *         page.locator('.example-css-class')
+ *         // note that you can change this selector while having the test paused at breakpoint
+ *     }, PlaywrightPage.current().nativePage()),
+ * );
+ * ```
+ *
+ * ## Learn more
+ * - [Node.js debugging - Getting started](https://nodejs.org/en/docs/guides/debugging-getting-started/)
+ * - [Node.js debugging in VS Code](https://code.visualstudio.com/docs/nodejs/nodejs-debugging)
+ * - [Running and debugging Node.js in WebStorm](https://www.jetbrains.com/help/webstorm/running-and-debugging-node-js.html)
+ * - [Playwright Test for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright)
+ *
+ * @group Activities
+ */
+export declare class Debug<Values extends Array<Answerable<unknown>>> extends Interaction {
+    private readonly debuggerFunction;
+    private readonly values;
+    /**
+     * Instructs the [actor](https://serenity-js.org/api/core/class/Actor/) to evaluate the provided `values`,
+     * log the results, and then pass them to your `debuggerFunction`.
+     *
+     * To use this interaction, run your test scenario in the Node.js debugger
+     * and set a breakpoint inside the `debuggerFunction`.
+     *
+     * @param debuggerFunction
+     * @param values
+     */
+    static values<Values extends Array<Answerable<unknown>>>(debuggerFunction: (results: {
+        [Index in keyof Values]: DebuggingResult<Values[Index]>;
+    }, ...answers: {
+        [Index in keyof Values]: Answered<Values[Index]>;
+    }) => Promise<void> | void, ...values: Values): Interaction;
+    /**
+     * @param description
+     *  Description of this interaction
+     *
+     * @param debuggerFunction
+     *  Callback function to receive the results of debugging
+     *
+     * @param values
+     *  Value to be evaluated by the actor, and provided to debuggerFunction
+     */
+    protected constructor(description: string, debuggerFunction: (debuggingResults: {
+        [Index in keyof Values]: DebuggingResult<Values[Index]>;
+    }, ...args: {
+        [Index in keyof Values]: Answered<Values[Index]>;
+    }) => Promise<void> | void, values: Values);
+    /**
+     * @inheritDoc
+     */
+    performAs(actor: UsesAbilities & AnswersQuestions & CollectsArtifacts): Promise<void>;
+}
+//# sourceMappingURL=Debug.d.ts.map

package/esm/screenplay/debugging/Debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Debug.d.ts","sourceRoot":"","sources":["../../../src/screenplay/debugging/Debug.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,qBAAa,KAAK,CAAC,MAAM,SAAS,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAE,SAAQ,WAAW;IAmCzE,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAIjC,OAAO,CAAC,QAAQ,CAAC,MAAM;IArC3B;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,SAAS,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,gBAAgB,EAAE,CACvE,OAAO,EAAE;SAAI,KAAK,IAAI,MAAM,MAAM,GAAI,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;KAAE,EACtE,GAAG,OAAO,EAAE;SAAI,KAAK,IAAI,MAAM,MAAM,GAAI,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;KAAE,KACjE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,MAAM,EAAE,MAAM,GAAG,WAAW;IAQ1D;;;;;;;;;OASG;IACH,SAAS,aACL,WAAW,EAAE,MAAM,EACF,gBAAgB,EAAE,CAC/B,gBAAgB,EAAE;SAAI,KAAK,IAAI,MAAM,MAAM,GAAI,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;KAAE,EAC/E,GAAG,IAAI,EAAE;SAAI,KAAK,IAAI,MAAM,MAAM,GAAI,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;KAAE,KAC9D,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,EACR,MAAM,EAAE,MAAM;IAKnC;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;CAuC9F"}