@serenity-js/core 3.41.2 → 3.42.1

package/esm/events/actor/ActorStageExitFailed.d.ts

@@ -0,0 +1,17 @@
+import type { JSONObject } from 'tiny-types';
+import { AsyncOperationFailed } from '../AsyncOperationFailed.js';
+/**
+ * Emitted when [releasing](https://serenity-js.org/api/core/interface/Discardable/) an
+ * [`Actor`](https://serenity-js.org/api/core/class/Actor/) or its abilities
+ * resulted in an error either
+ * upon the [`SceneFinishes`](https://serenity-js.org/api/core-events/class/SceneFinishes/) event
+ * for actors initialised within the scope of a test scenario,
+ * or upon the [`TestRunFinishes`](https://serenity-js.org/api/core-events/class/TestRunFinishes/) event
+ * for actors initialised within the scope of a test suite.
+ *
+ * @group Events
+ */
+export declare class ActorStageExitFailed extends AsyncOperationFailed {
+    static fromJSON(o: JSONObject): ActorStageExitFailed;
+}
+//# sourceMappingURL=ActorStageExitFailed.d.ts.map

package/esm/events/actor/ActorStageExitFailed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActorStageExitFailed.d.ts","sourceRoot":"","sources":["../../../src/events/actor/ActorStageExitFailed.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAK7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE;;;;;;;;;;GAUG;AACH,qBAAa,oBAAqB,SAAQ,oBAAoB;IAC1D,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,UAAU,GAAG,oBAAoB;CAOvD"}

package/esm/events/actor/ActorStageExitFailed.js

@@ -0,0 +1,21 @@
+import { ErrorSerialiser } from '../../errors/index.js';
+import { CorrelationId } from '../../model/index.js';
+import { Timestamp } from '../../screenplay/index.js';
+import { AsyncOperationFailed } from '../AsyncOperationFailed.js';
+/**
+ * Emitted when [releasing](https://serenity-js.org/api/core/interface/Discardable/) an
+ * [`Actor`](https://serenity-js.org/api/core/class/Actor/) or its abilities
+ * resulted in an error either
+ * upon the [`SceneFinishes`](https://serenity-js.org/api/core-events/class/SceneFinishes/) event
+ * for actors initialised within the scope of a test scenario,
+ * or upon the [`TestRunFinishes`](https://serenity-js.org/api/core-events/class/TestRunFinishes/) event
+ * for actors initialised within the scope of a test suite.
+ *
+ * @group Events
+ */
+export class ActorStageExitFailed extends AsyncOperationFailed {
+    static fromJSON(o) {
+        return new ActorStageExitFailed(ErrorSerialiser.deserialise(o.error), CorrelationId.fromJSON(o.correlationId), Timestamp.fromJSON(o.timestamp));
+    }
+}
+//# sourceMappingURL=ActorStageExitFailed.js.map

package/esm/events/actor/ActorStageExitFailed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActorStageExitFailed.js","sourceRoot":"","sources":["../../../src/events/actor/ActorStageExitFailed.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE;;;;;;;;;;GAUG;AACH,MAAM,OAAO,oBAAqB,SAAQ,oBAAoB;IAC1D,MAAM,CAAC,QAAQ,CAAC,CAAa;QACzB,OAAO,IAAI,oBAAoB,CAC3B,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,KAAe,CAAC,EAC9C,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAuB,CAAC,EACjD,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAmB,CAAC,CAC5C,CAAC;IACN,CAAC;CACJ"}

package/esm/events/actor/ActorStageExitStarts.d.ts

@@ -0,0 +1,20 @@
+import type { JSONObject } from 'tiny-types';
+import { CorrelationId } from '../../model/index.js';
+import { type SerialisedActor, Timestamp } from '../../screenplay/index.js';
+import { DomainEvent } from '../DomainEvent.js';
+/**
+ * Emitted upon the [`SceneFinishes`](https://serenity-js.org/api/core-events/class/SceneFinishes/) and
+ * [`TestRunFinishes`](https://serenity-js.org/api/core-events/class/TestRunFinishes/) events
+ * to notify the [stage crew members](https://serenity-js.org/api/core/interface/StageCrewMember/)
+ * about the final state of the [actors](https://serenity-js.org/api/core/class/Actor/) and their abilities
+ * before they're [released](https://serenity-js.org/api/core/interface/Discardable/).
+ *
+ * @group Events
+ */
+export declare class ActorStageExitStarts extends DomainEvent {
+    readonly sceneId: CorrelationId;
+    readonly actor: SerialisedActor;
+    static fromJSON(o: JSONObject): ActorStageExitStarts;
+    constructor(sceneId: CorrelationId, actor: SerialisedActor, timestamp?: Timestamp);
+}
+//# sourceMappingURL=ActorStageExitStarts.d.ts.map

package/esm/events/actor/ActorStageExitStarts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActorStageExitStarts.d.ts","sourceRoot":"","sources":["../../../src/events/actor/ActorStageExitStarts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,KAAK,eAAe,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;GAQG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;aAU7B,OAAO,EAAE,aAAa;aACtB,KAAK,EAAE,eAAe;IAV1C,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,UAAU,GAAG,oBAAoB;gBAShC,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,eAAe,EACtC,SAAS,CAAC,EAAE,SAAS;CAM5B"}

package/esm/events/actor/ActorStageExitStarts.js

@@ -0,0 +1,28 @@
+import { ensure, isDefined } from 'tiny-types';
+import { CorrelationId } from '../../model/index.js';
+import { Timestamp } from '../../screenplay/index.js';
+import { DomainEvent } from '../DomainEvent.js';
+/**
+ * Emitted upon the [`SceneFinishes`](https://serenity-js.org/api/core-events/class/SceneFinishes/) and
+ * [`TestRunFinishes`](https://serenity-js.org/api/core-events/class/TestRunFinishes/) events
+ * to notify the [stage crew members](https://serenity-js.org/api/core/interface/StageCrewMember/)
+ * about the final state of the [actors](https://serenity-js.org/api/core/class/Actor/) and their abilities
+ * before they're [released](https://serenity-js.org/api/core/interface/Discardable/).
+ *
+ * @group Events
+ */
+export class ActorStageExitStarts extends DomainEvent {
+    sceneId;
+    actor;
+    static fromJSON(o) {
+        return new ActorStageExitStarts(CorrelationId.fromJSON(o.sceneId), o.actor, Timestamp.fromJSON(o.timestamp));
+    }
+    constructor(sceneId, actor, timestamp) {
+        super(timestamp);
+        this.sceneId = sceneId;
+        this.actor = actor;
+        ensure('sceneId', sceneId, isDefined());
+        ensure('actor', actor, isDefined());
+    }
+}
+//# sourceMappingURL=ActorStageExitStarts.js.map

package/esm/events/actor/ActorStageExitStarts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActorStageExitStarts.js","sourceRoot":"","sources":["../../../src/events/actor/ActorStageExitStarts.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAwB,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;GAQG;AACH,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAU7B;IACA;IAVpB,MAAM,CAAC,QAAQ,CAAC,CAAa;QACzB,OAAO,IAAI,oBAAoB,CAC3B,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAiB,CAAC,EAC3C,CAAC,CAAC,KAAmC,EACrC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAmB,CAAC,CAC5C,CAAC;IACN,CAAC;IAED,YACoB,OAAsB,EACtB,KAAsB,EACtC,SAAqB;QAErB,KAAK,CAAC,SAAS,CAAC,CAAC;QAJD,YAAO,GAAP,OAAO,CAAe;QACtB,UAAK,GAAL,KAAK,CAAiB;QAItC,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QACxC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACxC,CAAC;CACJ"}

package/esm/events/actor/index.d.ts

@@ -0,0 +1,7 @@
+export * from './ActorEntersStage.js';
+export * from './ActorSpotlighted.js';
+export * from './ActorStageExitAttempted.js';
+export * from './ActorStageExitCompleted.js';
+export * from './ActorStageExitFailed.js';
+export * from './ActorStageExitStarts.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/events/actor/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/events/actor/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC"}

package/esm/events/actor/index.js

@@ -0,0 +1,7 @@
+export * from './ActorEntersStage.js';
+export * from './ActorSpotlighted.js';
+export * from './ActorStageExitAttempted.js';
+export * from './ActorStageExitCompleted.js';
+export * from './ActorStageExitFailed.js';
+export * from './ActorStageExitStarts.js';
+//# sourceMappingURL=index.js.map

package/esm/events/actor/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/events/actor/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC"}

package/esm/events/index.d.ts

@@ -0,0 +1,36 @@
+export * from './ActivityFinished.js';
+export * from './ActivityRelatedArtifactArchived.js';
+export * from './ActivityRelatedArtifactGenerated.js';
+export * from './ActivityStarts.js';
+export * from './actor/index.js';
+export * from './ArtifactArchived.js';
+export * from './ArtifactGenerated.js';
+export * from './AsyncOperationAborted.js';
+export * from './AsyncOperationAttempted.js';
+export * from './AsyncOperationCompleted.js';
+export * from './AsyncOperationFailed.js';
+export * from './BusinessRuleDetected.js';
+export * from './DomainEvent.js';
+export * from './EmitsDomainEvents.js';
+export * from './FeatureNarrativeDetected.js';
+export * from './InteractionFinished.js';
+export * from './InteractionStarts.js';
+export * from './RetryableSceneDetected.js';
+export * from './SceneBackgroundDetected.js';
+export * from './SceneDescriptionDetected.js';
+export * from './SceneFinished.js';
+export * from './SceneFinishes.js';
+export * from './SceneParametersDetected.js';
+export * from './SceneSequenceDetected.js';
+export * from './SceneStarts.js';
+export * from './SceneTagged.js';
+export * from './SceneTemplateDetected.js';
+export * from './TaskFinished.js';
+export * from './TaskStarts.js';
+export * from './TestRunFinished.js';
+export * from './TestRunFinishes.js';
+export * from './TestRunnerDetected.js';
+export * from './TestRunStarts.js';
+export * from './TestSuiteFinished.js';
+export * from './TestSuiteStarts.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/events/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC"}

package/esm/events/index.js

@@ -0,0 +1,36 @@
+export * from './ActivityFinished.js';
+export * from './ActivityRelatedArtifactArchived.js';
+export * from './ActivityRelatedArtifactGenerated.js';
+export * from './ActivityStarts.js';
+export * from './actor/index.js';
+export * from './ArtifactArchived.js';
+export * from './ArtifactGenerated.js';
+export * from './AsyncOperationAborted.js';
+export * from './AsyncOperationAttempted.js';
+export * from './AsyncOperationCompleted.js';
+export * from './AsyncOperationFailed.js';
+export * from './BusinessRuleDetected.js';
+export * from './DomainEvent.js';
+export * from './EmitsDomainEvents.js';
+export * from './FeatureNarrativeDetected.js';
+export * from './InteractionFinished.js';
+export * from './InteractionStarts.js';
+export * from './RetryableSceneDetected.js';
+export * from './SceneBackgroundDetected.js';
+export * from './SceneDescriptionDetected.js';
+export * from './SceneFinished.js';
+export * from './SceneFinishes.js';
+export * from './SceneParametersDetected.js';
+export * from './SceneSequenceDetected.js';
+export * from './SceneStarts.js';
+export * from './SceneTagged.js';
+export * from './SceneTemplateDetected.js';
+export * from './TaskFinished.js';
+export * from './TaskStarts.js';
+export * from './TestRunFinished.js';
+export * from './TestRunFinishes.js';
+export * from './TestRunnerDetected.js';
+export * from './TestRunStarts.js';
+export * from './TestSuiteFinished.js';
+export * from './TestSuiteStarts.js';
+//# sourceMappingURL=index.js.map

package/esm/events/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC"}

package/esm/index.d.ts

@@ -0,0 +1,8 @@
+export * from './config/index.js';
+export * from './errors/index.js';
+export * from './instance.js';
+export { d, f, format } from './io/index.js';
+export * from './screenplay/index.js';
+export * from './Serenity.js';
+export * from './stage/index.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC"}

package/esm/index.js

@@ -0,0 +1,8 @@
+export * from './config/index.js';
+export * from './errors/index.js';
+export * from './instance.js';
+export { d, f, format } from './io/index.js';
+export * from './screenplay/index.js';
+export * from './Serenity.js';
+export * from './stage/index.js';
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC"}

package/esm/instance.d.ts

@@ -0,0 +1,253 @@
+import type { SerenityConfig } from './config/index.js';
+import type { Actor } from './screenplay/index.js';
+import { Serenity } from './Serenity.js';
+import type { Cast } from './stage/index.js';
+/**
+ * Serenity object is the root object of the Serenity/JS framework.
+ *
+ * @group Serenity
+ */
+export declare const serenity: Serenity;
+/**
+ * Configures Serenity/JS. Every call to this function replaces the previous configuration provided,
+ * so this function should be called exactly once in your test suite.
+ *
+ * This function is an alias for [`Serenity.configure`](https://serenity-js.org/api/core/class/Serenity/#configure).
+ *
+ * :::tip configure vs engage
+  * If you want to retain the configuration but reset the [cast of actors](https://serenity-js.org/api/core/class/Cast/), use [`engage`](https://serenity-js.org/api/core/function/engage/) instead.
+ * :::
+ *
+ * @param config
+ *
+ * @group Serenity
+ */
+export declare function configure(config: SerenityConfig): void;
+/**
+ * Re-configures Serenity/JS with a new [cast](https://serenity-js.org/api/core/class/Cast/) of [actors](https://serenity-js.org/api/core/class/Actor/)
+ * you want to use in any subsequent calls to [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/).
+ *
+ * This function is an alias for [`Serenity.engage`](https://serenity-js.org/api/core/class/Serenity/#engage),
+ * which provides an alternative to calling [`Actor.whoCan`](https://serenity-js.org/api/core/class/Actor/#whoCan) directly in your tests
+ * and is typically invoked in a "before all" or "before each" hook of your test runner of choice.
+ *
+ * :::tip configure vs engage
+ * Calling [`engage`](https://serenity-js.org/api/core/function/engage/) replaces the currently configured [cast of actors](https://serenity-js.org/api/core/class/Cast/),
+ * but doesn't affect any other configuration.
+ * If you want to reset the Serenity/JS configuration completely, use [`configure`](https://serenity-js.org/api/core/function/configure/) instead.
+ * :::
+ *
+ * If your implementation of the [cast](https://serenity-js.org/api/core/class/Cast/) interface is stateless,
+ * you can invoke this function just once before your entire test suite is executed, see
+ * - [`beforeAll`](https://jasmine.github.io/api/3.6/global.html#beforeAll) in Jasmine,
+ * - [`before`](https://mochajs.org/#hooks) in Mocha,
+ * - [`BeforeAll`](https://github.com/cucumber/cucumber-js/blob/master/docs/support_files/hooks.md#beforeall--afterall) in Cucumber.js
+ *
+ * However, if your [cast](https://serenity-js.org/api/core/class/Cast/) holds state that you want to reset before each scenario,
+ * it's better to invoke `engage` before each test using:
+ * - [`beforeEach`](https://jasmine.github.io/api/3.6/global.html#beforeEach) in Jasmine
+ * - [`beforeEach`](https://mochajs.org/#hooks) in Mocha,
+ * - [`Before`](https://github.com/cucumber/cucumber-js/blob/master/docs/support_files/hooks.md#hooks) in Cucumber.js
+ *
+ * ## Engaging a cast of actors
+ *
+ * ```ts
+ * import { Actor, Cast } from '@serenity-js/core';
+ *
+ * class Actors implements Cast {
+ *   prepare(actor: Actor) {
+ *     return actor.whoCan(
+ *       // ... abilities you'd like the Actor to have
+ *     );
+ *   }
+ * }
+ *
+ * engage(new Actors());
+ * ```
+ *
+ * ### Using with Mocha test runner
+ *
+ * ```ts
+ * import { beforeEach } from 'mocha'
+ *
+ * beforeEach(() => engage(new Actors()))
+ * ```
+ *
+ * ### Using with Jasmine test runner
+ *
+ * ```typescript
+ * import 'jasmine'
+ *
+ * describe('My feature', () => {
+ *   beforeEach(() => engage(new Actors()))
+ * })
+ * ```
+ *
+ * ### Using with Cucumber.js test runner
+ *
+ * Engage `Actors` [before](https://github.com/cucumber/cucumber-js/blob/main/docs/support_files/hooks.md)
+ * each test scenario:
+ *
+ * ```typescript
+ * import { Before } from '@cucumber/cucumber'
+ *
+ * Before(() => engage(new Actors()))
+ * ```
+ *
+ * Engage `Actors` before scenarios with [specific tags](https://github.com/cucumber/cucumber-js/blob/main/docs/support_files/hooks.md#tagged-hooks):
+ *
+ * ```typescript
+ * import { Before } from '@cucumber/cucumber'
+ *
+ * Before('@web', () => engage(new Actors()))
+ * ```
+ *
+ * ### Using with Playwright Test runner
+ *
+ * [Serenity/JS Playwright Test module](https://serenity-js.org/api/playwright-test) will configure the cast on your behalf,
+ * so you don't need to call [`engage`](https://serenity-js.org/api/core/function/engage/).
+ *
+ * ```ts
+ * import { describe, it, test } from '@serenity-js/playwright-test'
+ *
+ * describe('My feature', () => {
+ *
+ *   this.use({
+ *     actors: new Actors()
+ *   })
+ *
+ *   // test scenarios
+ *
+ * })
+ * ```
+ *
+ * ## Learn more
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
+ * - [`Serenity.engage`](https://serenity-js.org/api/core/class/Serenity/#engage)
+ *
+ * @param actors
+ *
+ * @group Serenity
+ */
+export declare function engage(actors: Cast): void;
+/**
+ * Instantiates or retrieves an [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ * called `name` if one has already been instantiated.
+ *
+ * This method is an alias for [`Serenity.theActorCalled`](https://serenity-js.org/api/core/class/Serenity/#theActorCalled).
+ *
+ * ## Usage with Cucumber
+ *
+ * ```typescript
+ * import { actorCalled } from '@serenity-js/core';
+ * import { Given } from '@cucumber/cucumber';
+ *
+ * Given(/(.*?) is a registered user/, async (name: string) => {
+ *   await actorCalled(name).attemptsTo(
+ *     // ... activities
+ *   )
+ * })
+ * ```
+ *
+ * ## Usage with Jasmine
+ *
+ * ```typescript
+ * import 'jasmine';
+ * import { actorCalled } from '@serenity-js/core';
+ *
+ * describe('Feature', () => {
+ *
+ *     it('should have some behaviour', async () {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
+ * ```
+ *
+ * ## Usage with Mocha
+ *
+ * ```typescript
+ * import { describe, it } from 'mocha';
+ * import { actorCalled } from '@serenity-js/core';
+ *
+ * describe('Feature', () => {
+ *
+ *     it('should have some behaviour', async () => {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
+ * ```
+ *
+ * ## Usage with Playwright Test
+ *
+ * When using [Serenity/JS with Playwright Test](https://serenity-js.org/api/playwright-test/), you should use either
+ * the default [`actor`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/#actor) fixture
+ * or the injected [`actorCalled`](https://serenity-js.org/api/playwright-test/interface/SerenityWorkerFixtures/#actorCalled) function
+ * instead of importing it from `@serenity-js/core`.
+ *
+ * ```typescript
+ * import { describe, it } from '@serenity-js/playwright-test';
+ *
+ * describe('Feature', () => {
+ *
+ *     it('should have some behaviour', async ({ actorCalled }) => {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`engage`](https://serenity-js.org/api/core/function/engage/)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
+ * - [`Serenity.theActorCalled`](https://serenity-js.org/api/core/class/Serenity/#theActorCalled)
+ *
+ * @param name
+ *  The name of the actor to instantiate or retrieve
+ *
+ * @group Actors
+ */
+export declare function actorCalled(name: string): Actor;
+/**
+ * Retrieves an actor who was last instantiated or retrieved
+ * using [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/).
+ *
+ * This function is particularly useful when automating Cucumber scenarios.
+ *
+ * This function is an alias for [`Serenity.theActorInTheSpotlight`](https://serenity-js.org/api/core/class/Serenity/#theActorInTheSpotlight).
+ *
+ * ## Usage with Cucumber
+ *
+ * ```ts
+ * import { actorCalled } from '@serenity-js/core';
+ * import { Given, When } from '@cucumber/cucumber';
+ *
+ * Given(/(.*?) is a registered user/, (name: string) =>
+ *   actorCalled(name).attemptsTo(
+ *     // ... activities
+ *   ))
+ *
+ * When(/(?:he|she|they) browse their recent orders/, () =>
+ *   actorInTheSpotlight().attemptsTo(
+ *     // ... activities
+ *   ))
+ * ```
+ *
+ * ## Learn more
+ *
+ * - [`engage`](https://serenity-js.org/api/core/function/engage/)
+ * - [`actorCalled`](https://serenity-js.org/api/core/function/actorCalled/)
+ * - [`Actor`](https://serenity-js.org/api/core/class/Actor/)
+ * - [`Cast`](https://serenity-js.org/api/core/class/Cast/)
+ *
+ * @group Actors
+ */
+export declare function actorInTheSpotlight(): Actor;
+//# sourceMappingURL=instance.d.ts.map

package/esm/instance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instance.d.ts","sourceRoot":"","sources":["../src/instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,KAAK,EAAC,MAAM,uBAAuB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAiB7C;;;;GAIG;AACH,eAAO,MAAM,QAAQ,UAAwB,CAAC;AAE9C;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAEtD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0GG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,CAEzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkFG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAE/C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,mBAAmB,IAAI,KAAK,CAE3C"}