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

package/src/events/DomainEvent.ts

@@ -1,19 +1,16 @@
 import { ensure, isDefined, TinyType } from 'tiny-types';
 
-import { Timestamp } from '../model';
+import { Timestamp } from '../screenplay';
 
 /**
- * @desc
- *  Represents an internal domain event that occurs during test execution.
+ * Represents an internal domain event that occurs during test execution.
  *
- * @abstract
- * @extends {tiny-types~TinyType}
+ * @group Events
  */
 export abstract class DomainEvent extends TinyType {
 
     /**
-     * @param {Timestamp} timestamp
-     * @protected
+     * @param timestamp
      */
     protected constructor(public readonly timestamp: Timestamp = new Timestamp()) {
         super();

package/src/events/FeatureNarrativeDetected.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { CorrelationId, Description, Timestamp } from '../model';
+import { CorrelationId, Description } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class FeatureNarrativeDetected extends DomainEvent {
     public static fromJSON(o: JSONObject): FeatureNarrativeDetected {
         return new FeatureNarrativeDetected(

package/src/events/InteractionFinished.ts

@@ -1,8 +1,12 @@
 import { JSONObject } from 'tiny-types';
 
-import { ActivityDetails, CorrelationId, Outcome, SerialisedOutcome, Timestamp } from '../model';
+import { ActivityDetails, CorrelationId, Outcome, SerialisedOutcome } from '../model';
+import { Timestamp } from '../screenplay';
 import { ActivityFinished } from './ActivityFinished';
 
+/**
+ * @group Events
+ */
 export class InteractionFinished extends ActivityFinished {
     static fromJSON(o: JSONObject): InteractionFinished {
         return new InteractionFinished(

package/src/events/InteractionStarts.ts

@@ -1,8 +1,12 @@
 import { JSONObject } from 'tiny-types';
 
-import { ActivityDetails, CorrelationId, Timestamp } from '../model';
+import { ActivityDetails, CorrelationId } from '../model';
+import { Timestamp } from '../screenplay';
 import { ActivityStarts } from './ActivityStarts';
 
+/**
+ * @group Events
+ */
 export class InteractionStarts extends ActivityStarts {
     static fromJSON(o: JSONObject): InteractionStarts {
         return new InteractionStarts(

package/src/events/RetryableSceneDetected.ts

@@ -1,22 +1,20 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { CorrelationId, Timestamp } from '../model';
+import { CorrelationId } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
 /**
- * @desc
- *  Indicates that the test runner will retry running the test scenario upon failure.
+ * Indicates that the test runner will retry running the test scenario upon failure.
  *
- * @extends {DomainEvent}
+ * @group Events
  */
 export class RetryableSceneDetected extends DomainEvent {
 
     /**
-     * @desc
-     *  Deserialises the event from a JSONObject
+     * Deserialises the event from a JSONObject
      *
-     * @param {tiny-types~JSONObject} o
-     * @returns {RetryableSceneDetected}
+     * @param o
      */
     static fromJSON(o: JSONObject): RetryableSceneDetected {
         return new RetryableSceneDetected(
@@ -26,8 +24,8 @@ export class RetryableSceneDetected extends DomainEvent {
     }
 
     /**
-     * @param {CorrelationId} sceneId
-     * @param {Timestamp} [timestamp]
+     * @param sceneId
+     * @param [timestamp]
      */
     constructor(
         public readonly sceneId: CorrelationId,

package/src/events/SceneBackgroundDetected.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
 import { CorrelationId, Description, Name } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class SceneBackgroundDetected extends DomainEvent {
     public static fromJSON(o: JSONObject): SceneBackgroundDetected {
         return new SceneBackgroundDetected(
@@ -16,8 +20,9 @@ export class SceneBackgroundDetected extends DomainEvent {
         public readonly sceneId: CorrelationId,
         public readonly name: Name,
         public readonly description: Description,
+        timestamp?: Timestamp,
     ) {
-        super();
+        super(timestamp);
         ensure('sceneId', sceneId, isDefined());
         ensure('name', name, isDefined());
         ensure('description', description, isDefined());

package/src/events/SceneDescriptionDetected.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { CorrelationId, Description, Timestamp } from '../model';
+import { CorrelationId, Description } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class SceneDescriptionDetected extends DomainEvent {
     public static fromJSON(o: JSONObject): SceneDescriptionDetected {
         return new SceneDescriptionDetected(

package/src/events/SceneFinished.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { CorrelationId, Outcome, ScenarioDetails, SerialisedOutcome, Timestamp } from '../model';
+import { CorrelationId, Outcome, ScenarioDetails, SerialisedOutcome } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class SceneFinished extends DomainEvent {
     static fromJSON(o: JSONObject): SceneFinished {
         return new SceneFinished(

package/src/events/SceneFinishes.ts

@@ -1,27 +1,28 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { CorrelationId, Outcome, ScenarioDetails, SerialisedOutcome, Timestamp } from '../model';
+import { CorrelationId } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * Emitted by a Serenity/JS test runner adapter, right before a test and all its associated test hooks finish.
+ * Triggers any clean-up operations that might be required, such as discarding of the {@apilink Discardable} abilities.
+ *
+ * @group Events
+ */
 export class SceneFinishes extends DomainEvent {
     static fromJSON(o: JSONObject): SceneFinishes {
         return new SceneFinishes(
             CorrelationId.fromJSON(o.sceneId as string),
-            ScenarioDetails.fromJSON(o.details as JSONObject),
-            Outcome.fromJSON(o.outcome as SerialisedOutcome),
             Timestamp.fromJSON(o.timestamp as string),
         );
     }
 
     constructor(
         public readonly sceneId: CorrelationId,
-        public readonly details: ScenarioDetails,
-        public readonly outcome: Outcome,
         timestamp?: Timestamp,
     ) {
         super(timestamp);
         ensure('sceneId', sceneId, isDefined());
-        ensure('details', details, isDefined());
-        ensure('outcome', outcome, isDefined());
     }
 }

package/src/events/SceneParametersDetected.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { CorrelationId, ScenarioDetails, ScenarioParameters, Timestamp } from '../model';
+import { CorrelationId, ScenarioDetails, ScenarioParameters } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class SceneParametersDetected extends DomainEvent {
     public static fromJSON(o: JSONObject): SceneParametersDetected {
         return new SceneParametersDetected(

package/src/events/SceneSequenceDetected.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { CorrelationId, ScenarioDetails, Timestamp } from '../model';
+import { CorrelationId, ScenarioDetails } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class SceneSequenceDetected extends DomainEvent {
     static fromJSON(o: JSONObject): SceneSequenceDetected {
         return new SceneSequenceDetected(

package/src/events/SceneStarts.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { CorrelationId, ScenarioDetails, Timestamp } from '../model';
+import { CorrelationId, ScenarioDetails } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class SceneStarts extends DomainEvent {
     static fromJSON(o: JSONObject): SceneStarts {
         return new SceneStarts(

package/src/events/SceneTagged.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { CorrelationId, Tag, Timestamp } from '../model';
+import { CorrelationId, Tag } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class SceneTagged extends DomainEvent {
     static fromJSON(o: JSONObject): SceneTagged {
         return new SceneTagged(

package/src/events/SceneTemplateDetected.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { CorrelationId, Description, Timestamp } from '../model';
+import { CorrelationId, Description } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class SceneTemplateDetected extends DomainEvent {
     public static fromJSON(o: JSONObject): SceneTemplateDetected {
         return new SceneTemplateDetected(

package/src/events/TaskFinished.ts

@@ -1,8 +1,12 @@
 import { JSONObject } from 'tiny-types';
 
-import { ActivityDetails, CorrelationId, Outcome, SerialisedOutcome, Timestamp } from '../model';
+import { ActivityDetails, CorrelationId, Outcome, SerialisedOutcome } from '../model';
+import { Timestamp } from '../screenplay';
 import { ActivityFinished } from './ActivityFinished';
 
+/**
+ * @group Events
+ */
 export class TaskFinished extends ActivityFinished {
     static fromJSON(o: JSONObject): TaskFinished {
         return new TaskFinished(

package/src/events/TaskStarts.ts

@@ -1,8 +1,12 @@
 import { JSONObject } from 'tiny-types';
 
-import { ActivityDetails, CorrelationId, Timestamp } from '../model';
+import { ActivityDetails, CorrelationId } from '../model';
+import { Timestamp } from '../screenplay';
 import { ActivityStarts } from './ActivityStarts';
 
+/**
+ * @group Events
+ */
 export class TaskStarts extends ActivityStarts {
     static fromJSON(o: JSONObject): TaskStarts {
         return new TaskStarts(

package/src/events/TestRunFinished.ts

@@ -1,18 +1,26 @@
-import { Timestamp } from '../model';
+import { JSONObject } from 'tiny-types';
+
+import { Outcome, SerialisedOutcome } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
 /**
- * @desc
- *  Emitted when all the tests have finished running.
+ * Emitted when all the test scenarios have finished running.
+ *
+ * @group Events
  */
 export class TestRunFinished extends DomainEvent {
-    static fromJSON(v: string): TestRunFinished {
+    static fromJSON(o: JSONObject): TestRunFinished {
         return new TestRunFinished(
-            Timestamp.fromJSON(v as string),
+            Outcome.fromJSON(o.outcome as SerialisedOutcome),
+            Timestamp.fromJSON(o.timestamp as string),
         );
     }
 
-    constructor(timestamp?: Timestamp) {
+    constructor(
+        public readonly outcome: Outcome,
+        timestamp?: Timestamp,
+    ) {
         super(timestamp);
     }
 }

package/src/events/TestRunFinishes.ts

@@ -1,10 +1,11 @@
-import { Timestamp } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
 /**
- * @desc
- *  Emitted when the last test in the test suite has finished running
- *  and it's time for any last-minute reporting to take place.
+ * Emitted when the last test in the test suite has finished running
+ * and it's time for any last-minute reporting activities to take place.
+ *
+ * @group Events
  */
 export class TestRunFinishes extends DomainEvent {
     static fromJSON(v: string): TestRunFinishes {

package/src/events/TestRunStarts.ts

@@ -1,11 +1,10 @@
-import { Timestamp } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
 /**
- * @desc
- *  Emitted when the very first test is about to start
+ * Emitted when the very first test is about to start
  *
- * @extends {DomainEvent}
+ * @group Events
  */
 export class TestRunStarts extends DomainEvent {
     static fromJSON(v: string): TestRunStarts {

package/src/events/TestRunnerDetected.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { CorrelationId, Name, Timestamp } from '../model';
+import { CorrelationId, Name } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class TestRunnerDetected extends DomainEvent {
     public static fromJSON(o: JSONObject): TestRunnerDetected {
         return new TestRunnerDetected(
@@ -15,11 +19,10 @@ export class TestRunnerDetected extends DomainEvent {
     constructor(
         public readonly sceneId: CorrelationId,
         public readonly name: Name,
-        public readonly timestamp: Timestamp = new Timestamp(),
+        timestamp?: Timestamp,
     ) {
-        super();
+        super(timestamp);
         ensure('sceneId', sceneId, isDefined());
         ensure('name', name, isDefined());
-        ensure('timestamp', timestamp, isDefined());
     }
 }

package/src/events/TestSuiteFinished.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { Outcome, SerialisedOutcome, TestSuiteDetails, Timestamp } from '../model';
+import { Outcome, SerialisedOutcome, TestSuiteDetails } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class TestSuiteFinished extends DomainEvent {
     static fromJSON(o: JSONObject): TestSuiteFinished {
         return new TestSuiteFinished(

package/src/events/TestSuiteStarts.ts

@@ -1,8 +1,12 @@
 import { ensure, isDefined, JSONObject } from 'tiny-types';
 
-import { TestSuiteDetails, Timestamp } from '../model';
+import { TestSuiteDetails } from '../model';
+import { Timestamp } from '../screenplay';
 import { DomainEvent } from './DomainEvent';
 
+/**
+ * @group Events
+ */
 export class TestSuiteStarts extends DomainEvent {
     static fromJSON(o: JSONObject): TestSuiteStarts {
         return new TestSuiteStarts(

package/src/events/index.ts

@@ -4,6 +4,7 @@ export * from './ActivityRelatedArtifactGenerated';
 export * from './ActivityStarts';
 export * from './ArtifactArchived';
 export * from './ArtifactGenerated';
+export * from './AsyncOperationAborted';
 export * from './AsyncOperationAttempted';
 export * from './AsyncOperationCompleted';
 export * from './AsyncOperationFailed';

package/src/index.ts

@@ -1,8 +1,7 @@
+export * from './config';
 export * from './errors';
 export * from './instance';
 export { d, f, format } from './io';
-export { Duration, Timestamp } from './model';
 export * from './screenplay';
 export * from './Serenity';
-export { SerenityConfig } from './SerenityConfig';
 export * from './stage';