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

package/lib/Serenity.js

@@ -4,103 +4,144 @@ exports.Serenity = void 0;
 const tiny_types_1 = require("tiny-types");
 const errors_1 = require("./errors");
 const io_1 = require("./io");
-const model_1 = require("./model");
-const Clock_1 = require("./stage/Clock");
+const screenplay_1 = require("./screenplay");
 const Extras_1 = require("./stage/Extras");
 const Stage_1 = require("./stage/Stage");
 const StageManager_1 = require("./stage/StageManager");
+/**
+ * @group Serenity
+ */
 class Serenity {
     /**
-     * @param {Clock} clock
+     * @param clock
      */
-    constructor(clock = new Clock_1.Clock()) {
+    constructor(clock = new screenplay_1.Clock(), cwd = process.cwd()) {
         this.clock = clock;
         this.outputStream = process.stdout;
-        this.stage = new Stage_1.Stage(Serenity.defaultActors, new StageManager_1.StageManager(Serenity.defaultCueTimeout, clock));
+        this.stage = new Stage_1.Stage(Serenity.defaultActors, new StageManager_1.StageManager(Serenity.defaultCueTimeout, clock), new errors_1.ErrorFactory(), clock, Serenity.defaultInteractionTimeout);
+        this.classLoader = new io_1.ClassLoader(new io_1.ModuleLoader(cwd), new io_1.ClassDescriptionParser());
+        this.workingDirectory = new io_1.Path(cwd);
     }
     /**
-     * @desc
-     *  Configures Serenity/JS. Every call to this function
-     *  replaces the previous configuration provided,
-     *  so this function should called be exactly once
-     *  in your test suite.
-     *
-     * @param {SerenityConfig} config
-     * @return {void}
+     * 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.
+     *
+     * @param config
      */
     configure(config) {
+        var _a;
         const looksLikeBuilder = (0, io_1.has)({ build: 'function' });
         const looksLikeStageCrewMember = (0, io_1.has)({ assignedTo: 'function', notifyOf: 'function' });
         const cueTimeout = config.cueTimeout
-            ? (0, tiny_types_1.ensure)('cueTimeout', config.cueTimeout, (0, tiny_types_1.isInstanceOf)(model_1.Duration))
+            ? (0, tiny_types_1.ensure)('cueTimeout', config.cueTimeout, (0, tiny_types_1.isInstanceOf)(screenplay_1.Duration))
             : Serenity.defaultCueTimeout;
+        const interactionTimeout = config.interactionTimeout
+            ? (0, tiny_types_1.ensure)('interactionTimeout', config.interactionTimeout, (0, tiny_types_1.isInstanceOf)(screenplay_1.Duration))
+            : Serenity.defaultInteractionTimeout;
         if (config.outputStream) {
             this.outputStream = config.outputStream;
         }
-        this.stage = new Stage_1.Stage(Serenity.defaultActors, new StageManager_1.StageManager(cueTimeout, this.clock));
+        this.stage = new Stage_1.Stage(Serenity.defaultActors, new StageManager_1.StageManager(cueTimeout, this.clock), new errors_1.ErrorFactory((_a = config.diffFormatter) !== null && _a !== void 0 ? _a : new errors_1.NoOpDiffFormatter()), this.clock, interactionTimeout);
         if (config.actors) {
             this.engage(config.actors);
         }
         if (Array.isArray(config.crew)) {
-            this.stage.assign(...config.crew.map((stageCrewMember, i) => {
+            this.stage.assign(...config.crew.map((stageCrewMemberDescription, i) => {
+                const stageCrewMember = this.classLoader.looksLoadable(stageCrewMemberDescription)
+                    ? this.classLoader.instantiate(stageCrewMemberDescription)
+                    : stageCrewMemberDescription;
                 if (looksLikeBuilder(stageCrewMember)) {
                     return stageCrewMember.build({ stage: this.stage, outputStream: this.outputStream });
                 }
                 if (looksLikeStageCrewMember(stageCrewMember)) {
                     return stageCrewMember.assignedTo(this.stage);
                 }
-                throw new errors_1.ConfigurationError((0, io_1.formatted) `Entries under \`crew\` should implement either StageCrewMember or StageCrewMemberBuilder interfaces, \`${stageCrewMember}\` found at index ${i}`);
+                throw new errors_1.ConfigurationError((0, io_1.d) `Entries under \`crew\` should implement either StageCrewMember or StageCrewMemberBuilder interfaces, \`${stageCrewMemberDescription}\` found at index ${i}`);
             }));
         }
     }
     /**
-     * @desc
-     *  Re-configures Serenity/JS with a new {@link Cast} of {@link Actor}s
-     *  you'd like to use in any subsequent call to {@link actorCalled}.
+     * Re-configures Serenity/JS with a new {@apilink Cast} of {@apilink Actor|actors}
+     * you want to use in any subsequent calls to {@apilink actorCalled}.
+     *
+     * For your convenience, use {@apilink engage} function instead,
+     * which provides an alternative to calling {@apilink Actor.whoCan} directly in your tests
+     * and is typically invoked in a "before all" or "before each" hook of your test runner of choice.
+     *
+     * If your implementation of the {@apilink 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 {@apilink 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());
+     * ```
      *
-     *  This method provides an alternative to calling {@link Actor#whoCan}
-     *  directly in your tests and you'd typically us it in a "before each"
-     *  hook of your test runner of choice.
+     * ### Using with Mocha test runner
      *
-     * @example <caption>Engaging a cast of actors</caption>
-     *  import { Actor, Cast } from '@serenity-js/core';
+     * ```ts
+     * import { beforeEach } from 'mocha'
      *
-     *  class Actors implements Cast {
-     *      prepare(actor: Actor) {
-     *          return actor.whoCan(
-     *              // ... abilities you'd like the Actor to have
-     *          );
-     *      }
-     *  }
+     * beforeEach(() => engage(new Actors()))
+     * ```
      *
-     * engage(new Actors();
+     * ### Using with Jasmine test runner
      *
-     * @example <caption>Usage with Jasmine</caption>
-     *  import 'jasmine';
+     * ```ts
+     * import 'jasmine'
      *
-     *  beforeEach(() => engage(new Actors()));
+     * beforeEach(() => engage(new Actors()))
+     * ```
      *
-     * @example <caption>Usage with Cucumber</caption>
-     *  import { Before } from 'cucumber';
+     * ### Using with Cucumber.js test runner
      *
-     *  Before(() => engage(new Actors());
+     * ```ts
+     * import { Before } from '@cucumber/cucumber'
      *
-     * @param {Cast} actors
-     * @returns {void}
+     * Before(() => engage(new Actors()))
+     * ```
      *
-     * @see {@link Actor}
-     * @see {@link Cast}
+     * ## Learn more
+     * - {@apilink Actor}
+     * - {@apilink Cast}
+     * - {@apilink engage}
+     *
+     * @param actors
      */
     engage(actors) {
         this.stage.engage((0, tiny_types_1.ensure)('actors', actors, (0, tiny_types_1.property)('prepare', (0, tiny_types_1.isDefined)())));
     }
     /**
-     * @desc
-     *  Instantiates or retrieves an actor {@link Actor}
-     *  called `name` if one has already been instantiated.
+     * Instantiates or retrieves an {@apilink Actor}
+     * called `name` if one has already been instantiated.
      *
-     * @example <caption>Usage with Jasmine</caption>
-     *   import 'jasmine';
+     * For your convenience, use {@apilink actorCalled} function instead.
+     *
+     * ## Usage with Mocha
+     *
+     * ```typescript
+     *   import { describe, it } from 'mocha';
      *   import { actorCalled } from '@serenity-js/core';
      *
      *   describe('Feature', () => {
@@ -108,63 +149,88 @@ class Serenity {
      *      it('should have some behaviour', () =>
      *          actorCalled('James').attemptsTo(
      *              // ... activities
-     *          ));
-     *   });
+     *          ))
+     *   })
+     * ```
      *
-     * @example <caption>Usage with Cucumber</caption>
+     * ## Usage with Jasmine
+     *
+     * ```typescript
+     *   import 'jasmine';
      *   import { actorCalled } from '@serenity-js/core';
-     *   import { Given } from 'cucumber';
      *
-     *   Given(/(.*?) is a registered user/, (name: string) =>
-     *      actorCalled(name).attemptsTo(
+     *   describe('Feature', () => {
+     *
+     *      it('should have some behaviour', () =>
+     *          actorCalled('James').attemptsTo(
      *              // ... activities
-     *          ));
+     *          ))
+     *   })
+     * ```
      *
-     * @param {string} name
-     *  The name of the actor to instantiate or retrieve
+     * ## Usage with Cucumber
      *
-     * @returns {Actor}
+     * ```typescript
+     * import { actorCalled } from '@serenity-js/core';
+     * import { Given } from '@cucumber/cucumber';
      *
-     * @see {@link engage}
-     * @see {@link Actor}
-     * @see {@link Cast}
+     * Given(/(.*?) is a registered user/, (name: string) =>
+     *   actorCalled(name).attemptsTo(
+     *     // ... activities
+     *   ))
+     * ```
+     *
+     * ## Learn more
+     *
+     * - {@apilink engage}
+     * - {@apilink Actor}
+     * - {@apilink Cast}
+     * - {@apilink actorCalled}
+     *
+     * @param name
+     *  The name of the actor to instantiate or retrieve
      */
     theActorCalled(name) {
         return this.stage.theActorCalled(name);
     }
     /**
-     * @desc
-     *  Retrieves an actor who was last instantiated or retrieved
-     *  using {@link actorCalled}.
+     * Retrieves an actor who was last instantiated or retrieved
+     * using {@apilink Serenity.theActorCalled}.
      *
-     *  This function is particularly useful when automating Cucumber scenarios.
+     * This function is particularly useful when automating Cucumber scenarios.
      *
-     * @example <caption>Usage with Cucumber</caption>
-     *   import { actorCalled } from '@serenity-js/core';
-     *   import { Given, When } from 'cucumber';
+     * For your convenience, use {@apilink actorInTheSpotlight} function instead.
      *
-     *   Given(/(.*?) is a registered user/, (name: string) =>
-     *      actorCalled(name).attemptsTo(
-     *              // ... activities
-     *          ));
+     * ## Usage with Cucumber
      *
-     *   When(/(?:he|she|they) browse their recent orders/, () =>
-     *      actorInTheSpotlight().attemptsTo(
-     *              // ... activities
-     *          ));
+     * ```ts
+     * import { actorCalled } from '@serenity-js/core';
+     * import { Given, When } from '@cucumber/cucumber';
+     *
+     * Given(/(.*?) is a registered user/, (name: string) =>
+     *   actorCalled(name).attemptsTo(
+     *     // ... activities
+     *   ))
      *
-     * @returns {Actor}
+     * When(/(?:he|she|they) browse their recent orders/, () =>
+     *   actorInTheSpotlight().attemptsTo(
+     *     // ... activities
+     *   ))
+     * ```
      *
-     * @see {@link engage}
-     * @see {@link actorCalled}
-     * @see {@link Actor}
-     * @see {@link Cast}
+     * ## Learn more
+     *
+     * - {@apilink engage}
+     * - {@apilink actorCalled}
+     * - {@apilink actorInTheSpotlight}
+     * - {@apilink Actor}
+     * - {@apilink Cast}
      */
     theActorInTheSpotlight() {
         return this.stage.theActorInTheSpotlight();
     }
-    announce(event) {
-        this.stage.announce(event);
+    announce(...events) {
+        this.stage.announce(...events);
     }
     currentTime() {
         return this.stage.currentTime();
@@ -175,8 +241,11 @@ class Serenity {
     currentSceneId() {
         return this.stage.currentSceneId();
     }
-    assignNewActivityId() {
-        return this.stage.assignNewActivityId();
+    assignNewActivityId(activityDetails) {
+        return this.stage.assignNewActivityId(activityDetails);
+    }
+    createError(errorType, options) {
+        return this.stage.createError(errorType, options);
     }
     /**
      * @package
@@ -184,8 +253,12 @@ class Serenity {
     waitForNextCue() {
         return this.stage.waitForNextCue();
     }
+    cwd() {
+        return this.workingDirectory;
+    }
 }
 exports.Serenity = Serenity;
-Serenity.defaultCueTimeout = model_1.Duration.ofSeconds(5);
+Serenity.defaultCueTimeout = screenplay_1.Duration.ofSeconds(5);
+Serenity.defaultInteractionTimeout = screenplay_1.Duration.ofSeconds(5);
 Serenity.defaultActors = new Extras_1.Extras();
 //# sourceMappingURL=Serenity.js.map

package/lib/Serenity.js.map

@@ -1 +1 @@
-{"version":3,"file":"Serenity.js","sourceRoot":"","sources":["../src/Serenity.ts"],"names":[],"mappings":";;;AAAA,2CAAuE;AAEvE,qCAA8C;AAE9C,6BAAoD;AACpD,mCAA6D;AAK7D,yCAAsC;AACtC,2CAAwC;AACxC,yCAAsC;AACtC,uDAAoD;AAEpD,MAAa,QAAQ;IAOjB;;OAEG;IACH,YAA6B,QAAe,IAAI,aAAK,EAAE;QAA1B,UAAK,GAAL,KAAK,CAAqB;QAL/C,iBAAY,GAAkB,OAAO,CAAC,MAAM,CAAC;QAMjD,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAClB,QAAQ,CAAC,aAAa,EACtB,IAAI,2BAAY,CAAC,QAAQ,CAAC,iBAAiB,EAAE,KAAK,CAAC,CACtD,CAAC;IACN,CAAC;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,MAAsB;QAC5B,MAAM,gBAAgB,GAAY,IAAA,QAAG,EAAyB,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;QACrF,MAAM,wBAAwB,GAAI,IAAA,QAAG,EAAkB,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QAEzG,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU;YAChC,CAAC,CAAC,IAAA,mBAAM,EAAC,YAAY,EAAE,MAAM,CAAC,UAAU,EAAE,IAAA,yBAAY,EAAC,gBAAQ,CAAC,CAAC;YACjE,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QAEjC,IAAI,MAAM,CAAC,YAAY,EAAE;YACrB,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;SAC3C;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAClB,QAAQ,CAAC,aAAa,EACtB,IAAI,2BAAY,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAC3C,CAAC;QAEF,IAAI,MAAM,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAC9B;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YAC5B,IAAI,CAAC,KAAK,CAAC,MAAM,CACb,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,eAAe,EAAE,CAAC,EAAE,EAAE;gBACtC,IAAI,gBAAgB,CAAC,eAAe,CAAC,EAAE;oBACnC,OAAO,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;iBACxF;gBAED,IAAI,wBAAwB,CAAC,eAAe,CAAC,EAAE;oBAC3C,OAAO,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACjD;gBAED,MAAM,IAAI,2BAAkB,CACxB,IAAA,cAAS,EAAC,0GAA2G,eAAgB,qBAAsB,CAAE,EAAE,CAClK,CAAC;YACN,CAAC,CAAC,CACL,CAAC;SACL;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,MAAY;QACf,IAAI,CAAC,KAAK,CAAC,MAAM,CACb,IAAA,mBAAM,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAA,qBAAQ,EAAC,SAAS,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC,CAC7D,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,cAAc,CAAC,IAAY;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,sBAAsB;QAClB,OAAO,IAAI,CAAC,KAAK,CAAC,sBAAsB,EAAE,CAAC;IAC/C,CAAC;IAED,QAAQ,CAAC,KAAkB;QACvB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IACpC,CAAC;IAED,gBAAgB;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;IACzC,CAAC;IAED,cAAc;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;IACvC,CAAC;IAED,mBAAmB;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,cAAc;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;IACvC,CAAC;;AA/ML,4BAgNC;AA/MkB,0BAAiB,GAAM,gBAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAC7C,sBAAa,GAAU,IAAI,eAAM,EAAE,CAAC"}
+{"version":3,"file":"Serenity.js","sourceRoot":"","sources":["../src/Serenity.ts"],"names":[],"mappings":";;;AAAA,2CAAuE;AAIvE,qCAA2G;AAE3G,6BAAuF;AAEvF,6CAAiE;AAGjE,2CAAwC;AACxC,yCAAsC;AACtC,uDAAoD;AAEpD;;GAEG;AACH,MAAa,QAAQ;IAWjB;;OAEG;IACH,YACqB,QAAe,IAAI,kBAAK,EAAE,EAC3C,MAAc,OAAO,CAAC,GAAG,EAAE;QADV,UAAK,GAAL,KAAK,CAAqB;QATvC,iBAAY,GAAkB,OAAO,CAAC,MAAM,CAAC;QAYjD,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAClB,QAAQ,CAAC,aAAa,EACtB,IAAI,2BAAY,CAAC,QAAQ,CAAC,iBAAiB,EAAE,KAAK,CAAC,EACnD,IAAI,qBAAY,EAAE,EAClB,KAAK,EACL,QAAQ,CAAC,yBAAyB,CACrC,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,IAAI,gBAAW,CAC9B,IAAI,iBAAY,CAAC,GAAG,CAAC,EACrB,IAAI,2BAAsB,EAAE,CAC/B,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,IAAI,SAAI,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,MAAsB;;QAC5B,MAAM,gBAAgB,GAAY,IAAA,QAAG,EAAyB,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;QACrF,MAAM,wBAAwB,GAAI,IAAA,QAAG,EAAkB,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QAEzG,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU;YAChC,CAAC,CAAC,IAAA,mBAAM,EAAC,YAAY,EAAE,MAAM,CAAC,UAAU,EAAE,IAAA,yBAAY,EAAC,qBAAQ,CAAC,CAAC;YACjE,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QAEjC,MAAM,kBAAkB,GAAG,MAAM,CAAC,kBAAkB;YAChD,CAAC,CAAC,IAAA,mBAAM,EAAC,oBAAoB,EAAE,MAAM,CAAC,kBAAkB,EAAE,IAAA,yBAAY,EAAC,qBAAQ,CAAC,CAAC;YACjF,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC;QAEzC,IAAI,MAAM,CAAC,YAAY,EAAE;YACrB,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;SAC3C;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAClB,QAAQ,CAAC,aAAa,EACtB,IAAI,2BAAY,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,EACxC,IAAI,qBAAY,CAAC,MAAA,MAAM,CAAC,aAAa,mCAAI,IAAI,0BAAiB,EAAE,CAAC,EACjE,IAAI,CAAC,KAAK,EACV,kBAAkB,CACrB,CAAC;QAEF,IAAI,MAAM,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAC9B;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YAC5B,IAAI,CAAC,KAAK,CAAC,MAAM,CACb,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,0BAA0B,EAAE,CAAC,EAAE,EAAE;gBAEjD,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,0BAA0B,CAAC;oBAC9E,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAA2C,0BAA0B,CAAC;oBACpG,CAAC,CAAC,0BAA0B,CAAC;gBAEjC,IAAI,gBAAgB,CAAC,eAAe,CAAC,EAAE;oBACnC,OAAO,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;iBACxF;gBAED,IAAI,wBAAwB,CAAC,eAAe,CAAC,EAAE;oBAC3C,OAAO,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACjD;gBAED,MAAM,IAAI,2BAAkB,CACxB,IAAA,MAAC,EAAA,0GAA2G,0BAA2B,qBAAsB,CAAE,EAAE,CACpK,CAAC;YACN,CAAC,CAAC,CACL,CAAC;SACL;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACH,MAAM,CAAC,MAAY;QACf,IAAI,CAAC,KAAK,CAAC,MAAM,CACb,IAAA,mBAAM,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAA,qBAAQ,EAAC,SAAS,EAAE,IAAA,sBAAS,GAAE,CAAC,CAAC,CAC7D,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,cAAc,CAAC,IAAY;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,sBAAsB;QAClB,OAAO,IAAI,CAAC,KAAK,CAAC,sBAAsB,EAAE,CAAC;IAC/C,CAAC;IAED,QAAQ,CAAC,GAAG,MAA0B;QAClC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IACpC,CAAC;IAED,gBAAgB;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;IACzC,CAAC;IAED,cAAc;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;IACvC,CAAC;IAED,mBAAmB,CAAC,eAAgC;QAChD,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAC3D,CAAC;IAED,WAAW,CAA0B,SAAqC,EAAE,OAAqB;QAC7F,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,cAAc;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;IACvC,CAAC;IAED,GAAG;QACC,OAAO,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;;AA3SL,4BA4SC;AA3SkB,0BAAiB,GAAc,qBAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AACrD,kCAAyB,GAAM,qBAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AACrD,sBAAa,GAAkB,IAAI,eAAM,EAAE,CAAC"}

package/lib/adapter/OutputStream.d.ts

@@ -0,0 +1,14 @@
+/**
+ * An output stream to be injected into {@apilink StageCrewMemberBuilder|StageCrewMemberBuilders} configured via {@apilink SerenityConfig.crew}.
+ *
+ * ## Learn more
+ * - {@apilink StageCrewMemberBuilder}
+ * - {@apilink Serenity.configure}
+ * - {@apilink SerenityConfig.crew}
+ *
+ * @group Integration
+ */
+export interface OutputStream {
+    write(content: string): void;
+}
+//# sourceMappingURL=OutputStream.d.ts.map

package/lib/adapter/OutputStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutputStream.d.ts","sourceRoot":"","sources":["../../src/adapter/OutputStream.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IACzB,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC"}

package/lib/{io → adapter}/OutputStream.js.map

@@ -1 +1 @@
-{"version":3,"file":"OutputStream.js","sourceRoot":"","sources":["../../src/io/OutputStream.ts"],"names":[],"mappings":""}
+{"version":3,"file":"OutputStream.js","sourceRoot":"","sources":["../../src/adapter/OutputStream.ts"],"names":[],"mappings":""}

package/lib/adapter/TestRunnerAdapter.d.ts

@@ -0,0 +1,33 @@
+import { Outcome } from '../model';
+/**
+ * Describes an adapter needed to run a given type of tests programmatically
+ *
+ * @group Integration
+ */
+export interface TestRunnerAdapter {
+    /**
+     * Loads test scenarios.
+     */
+    load(pathsToScenarios: string[]): Promise<void>;
+    /**
+     * Returns the number of loaded scenarios
+     *
+     * @throws {@apilink LogicError}
+     *  If called before `load`
+     */
+    scenarioCount(): number;
+    /**
+     * Runs loaded test scenarios.
+     *
+     * @throws {@apilink LogicError}
+     *  If called before `load`
+     */
+    run(): Promise<void>;
+    /**
+     * Scenario success threshold for this test runner.
+     */
+    successThreshold(): Outcome | {
+        Code: number;
+    };
+}
+//# sourceMappingURL=TestRunnerAdapter.d.ts.map

package/lib/adapter/TestRunnerAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestRunnerAdapter.d.ts","sourceRoot":"","sources":["../../src/adapter/TestRunnerAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnC;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAE9B;;OAEG;IACH,IAAI,CAAC,gBAAgB,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;OAKG;IACH,aAAa,IAAI,MAAM,CAAC;IAExB;;;;;OAKG;IACH,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAErB;;OAEG;IACH,gBAAgB,IAAI,OAAO,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAClD"}

package/lib/adapter/TestRunnerAdapter.js.map

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

package/lib/adapter/index.d.ts

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

package/lib/adapter/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/adapter/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC"}

package/lib/adapter/index.js

@@ -0,0 +1,19 @@
+"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("./OutputStream"), exports);
+__exportStar(require("./TestRunnerAdapter"), exports);
+//# sourceMappingURL=index.js.map

package/lib/adapter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/adapter/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,sDAAoC"}

package/lib/config/ClassDescription.d.ts

@@ -0,0 +1,60 @@
+/**
+ * `ClassDescription` describes the Node module ID and optionally:
+ * - a named export that you want to import
+ * - a parameter that should be passed to the static `fromJSON` method if the imported type provides it.
+ *
+ * `ClassDescription` is used to describe the {@apilink StageCrewMember|StageCrewMembers} passed to {@apilink SerenityConfig}.
+ *
+ * The most basic class description is the name of a Node module that must provide a `default` export.
+ * For example, below definition would be interpreted as a request to import the `default` export from the `@serenity-js/serenity-bdd` module and instantiate it using its no-arg constructor:
+ * ```typescript
+ * import { configure } from '@serenity-js/core'
+ *
+ * configure({
+ *   crew: [
+ *     `@serenity-js/serenity-bdd`
+ *   ]
+ * })
+ * ```
+ *
+ * Class description can also include a named export to be imported. For example, below definition would be interpreted as a request
+ * to import the `SerenityBDDReporter` type from `@serenity-js/serenity-bdd` and instantiate it using its no-arg constructor:
+ *
+ * ```typescript
+ * import { configure } from '@serenity-js/core'
+ *
+ * configure({
+ *   crew: [
+ *     `@serenity-js/serenity-bdd:SerenityBDDReporter`
+ *   ]
+ * })
+ * ```
+ *
+ * However, not all types have no-arg constructors. In those cases, a type offering a `static fromJSON(configParam)` method can be described using a tuple
+ * where the first item describes the Node module and optionally the class name, and the second item describes the `configParam`.
+ *
+ * ```typescript
+ * import { configure } from '@serenity-js/core'
+ *
+ * configure({
+ *   crew: [
+ *     [ `@serenity-js/core:ArtifactArchiver`, { outputDirectory: './target/site/serenity' } ]
+ *   ]
+ * })
+ * ```
+ *
+ * Note that the class description could also describe a local Node module. This can be useful when you're writing a custom StageCrewMember implementation.
+ * For example, `./my-reporter:MyReporter` would be interpreted as a request to load the `MyReporter` type from `./my-reporter` file, located
+ * relative to the [working directory](https://nodejs.org/api/process.html#processcwd) of the current Node.js process.
+ *
+ * @group Serenity
+ */
+export type ClassDescription = string | // e.g. '@serenity-js/core:StreamReporter'
+[
+    string
+] | // e.g. [ '@serenity-js/core:StreamReporter' ]
+[
+    string,
+    any
+];
+//# sourceMappingURL=ClassDescription.d.ts.map

package/lib/config/ClassDescription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClassDescription.d.ts","sourceRoot":"","sources":["../../src/config/ClassDescription.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,MAAM,gBAAgB,GACxB,MAAM,GAAc,0CAA0C;AAC9D;IAAE,MAAM;CAAE,GAAU,8CAA8C;AAClE;IAAE,MAAM;IAAE,GAAG;CAAE,CAAC"}

package/lib/config/ClassDescription.js

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

package/lib/config/ClassDescription.js.map

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

package/lib/config/SerenityConfig.d.ts

@@ -0,0 +1,73 @@
+import { OutputStream } from '../adapter';
+import { DiffFormatter } from '../errors';
+import { Duration } from '../screenplay';
+import { Cast, StageCrewMember, StageCrewMemberBuilder } from '../stage';
+import { ClassDescription } from './ClassDescription';
+/**
+ * Describes the configuration object accepted by the {@apilink configure} function.
+ *
+ * ## Learn more
+ * - {@apilink configure}
+ * - {@apilink Cast}
+ * - {@apilink StageCrewMember}
+ * - {@apilink StageCrewMemberBuilder}
+ * - {@apilink ClassDescription}
+ * - {@apilink Stage.waitForNextCue}
+ *
+ * @group Serenity
+ */
+export declare abstract class SerenityConfig {
+    /**
+     * A {@apilink Cast} of {@apilink Actor}s to be used when {@apilink actorCalled}
+     * and {@apilink actorInTheSpotlight} functions are called.
+     */
+    actors?: Cast;
+    /**
+     * A list of {@apilink StageCrewMemberBuilder|StageCrewMemberBuilders} or {@apilink StageCrewMember|StageCrewMembers}
+     * to be notified of {@apilink DomainEvent|DomainEvents} that occur during the scenario execution.
+     *
+     * Note that the `crew` can also be configured using {@apilink ClassDescription|ClassDescriptions}.
+     * This is useful when you need to load the configuration from a static `json` file, or when the test runner doesn't support
+     * providing class instances in configuration (e.g. Playwright Test).
+     */
+    crew?: Array<StageCrewMember | StageCrewMemberBuilder | ClassDescription>;
+    /**
+     * The maximum amount of time between {@apilink SceneFinishes} and {@apilink SceneFinished} events
+     * that Serenity/JS should wait for any post-scenario
+     * async operations to complete. Those include generating the screenshots,
+     * saving reports to disk, {@apilink Discardable|dismissing the actors}, and so on.
+     *
+     * Defaults to 5 seconds.
+     *
+     * **Please note** that this is not
+     * a scenario timeout, which should be configured in your test runner.
+     */
+    cueTimeout?: Duration;
+    /**
+     * The maximum default amount of time allowed for interactions such as {@apilink Wait.until}
+     * to complete.
+     *
+     * Defaults to 5 seconds, can be overridden per interaction.
+     *
+     * **Please note** that this is not
+     * a scenario timeout, which should be configured in your test runner.
+     *
+     * #### Learn more
+     * - {@apilink Wait.until}
+     */
+    interactionTimeout?: Duration;
+    /**
+     * {@apilink DiffFormatter} that should be used by the {@apilink ErrorFactory} and the ability to {@apilink RaiseErrors}
+     * when generating diffs included in {@apilink RuntimeError} objects.
+     *
+     * By default, Serenity/JS uses {@apilink NoOpDiffFormatter}.
+     */
+    diffFormatter?: DiffFormatter;
+    /**
+     * An output stream to be injected into {@apilink StageCrewMemberBuilder|StageCrewMemberBuilders}
+     *
+     * Defaults to [`process.stdout`](https://nodejs.org/api/process.html#process_process_stdout).
+     */
+    outputStream?: OutputStream;
+}
+//# sourceMappingURL=SerenityConfig.d.ts.map

package/lib/config/SerenityConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SerenityConfig.d.ts","sourceRoot":"","sources":["../../src/config/SerenityConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;;;;;;;;;GAYG;AACH,8BAAsB,cAAc;IAEhC;;;OAGG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IAEd;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,sBAAsB,GAAG,gBAAgB,CAAC,CAAC;IAE1E;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;IAEtB;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,QAAQ,CAAC;IAE9B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;;;OAIG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;CAC/B"}

package/lib/config/SerenityConfig.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SerenityConfig = void 0;
+/**
+ * Describes the configuration object accepted by the {@apilink configure} function.
+ *
+ * ## Learn more
+ * - {@apilink configure}
+ * - {@apilink Cast}
+ * - {@apilink StageCrewMember}
+ * - {@apilink StageCrewMemberBuilder}
+ * - {@apilink ClassDescription}
+ * - {@apilink Stage.waitForNextCue}
+ *
+ * @group Serenity
+ */
+class SerenityConfig {
+}
+exports.SerenityConfig = SerenityConfig;
+//# sourceMappingURL=SerenityConfig.js.map

package/lib/config/SerenityConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SerenityConfig.js","sourceRoot":"","sources":["../../src/config/SerenityConfig.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;;;;GAYG;AACH,MAAsB,cAAc;CA2DnC;AA3DD,wCA2DC"}

package/lib/config/index.d.ts

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

package/lib/config/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC"}